|
@@ -1,6 +1,10 @@
|
|
# EdgeX Message Bus action
|
|
# EdgeX Message Bus action
|
|
|
|
|
|
-The action is used for publish output message into EdgeX message bus.
|
|
|
|
|
|
+The action is used for publishing output message into EdgeX message bus.
|
|
|
|
+
|
|
|
|
+**Please notice that, if you're using the ZeorMQ message bus, the action will create a NEW EdgeX message bus (with the address where running Kuiper service), but not by leveraging the original message bus (normally it's the address & port exposed by application service). **
|
|
|
|
+
|
|
|
|
+**Also, you need to expose the port number to host server before running the Kuiper server if you want to have the service available to other hosts.**
|
|
|
|
|
|
| Property name | Optional | Description |
|
|
| Property name | Optional | Description |
|
|
| ------------- | -------- | ------------------------------------------------------------ |
|
|
| ------------- | -------- | ------------------------------------------------------------ |
|
|
@@ -32,7 +36,7 @@ Below optional configurations are supported, please check MQTT specification for
|
|
|
|
|
|
## Examples
|
|
## Examples
|
|
|
|
|
|
-### Publish result to EdgeX message bus without keeping original metadata
|
|
|
|
|
|
+### Publish result to a new EdgeX message bus without keeping original metadata
|
|
In this case, the original metadata value (such as ``id, pushed, created, modified, origin`` in ``Events`` structure, and ``id, created, modified, origin, pushed, device`` in ``Reading`` structure will not be kept). Kuiper acts as another EdgeX micro service here, and it has own ``device name``. A ``deviceName`` property is provided, and allows user to specify the device name of Kuiper. Below is one example,
|
|
In this case, the original metadata value (such as ``id, pushed, created, modified, origin`` in ``Events`` structure, and ``id, created, modified, origin, pushed, device`` in ``Reading`` structure will not be kept). Kuiper acts as another EdgeX micro service here, and it has own ``device name``. A ``deviceName`` property is provided, and allows user to specify the device name of Kuiper. Below is one example,
|
|
|
|
|
|
1) Data received from EdgeX message bus ``events`` topic,
|
|
1) Data received from EdgeX message bus ``events`` topic,
|
|
@@ -81,7 +85,7 @@ Please notice that,
|
|
- The device name of ``Event`` structure is changed to ``kuiper``
|
|
- The device name of ``Event`` structure is changed to ``kuiper``
|
|
- All of metadata for ``Events and Readings`` structure will be updated with new value. ``Created`` field is updated to another value generated by Kuiper (here is ``0``).
|
|
- All of metadata for ``Events and Readings`` structure will be updated with new value. ``Created`` field is updated to another value generated by Kuiper (here is ``0``).
|
|
|
|
|
|
-### Publish result to EdgeX message bus with keeping original metadata
|
|
|
|
|
|
+### Publish result to a new EdgeX message bus with keeping original metadata
|
|
But for some scenarios, you may want to keep some of original metadata. Such as keep the device name as original value that published to Kuiper (``demo`` in the sample), and also other metadata of readings arrays. In such case, Kuiper is acting as a filter - to filter NOT concerned messages, but still keep original data.
|
|
But for some scenarios, you may want to keep some of original metadata. Such as keep the device name as original value that published to Kuiper (``demo`` in the sample), and also other metadata of readings arrays. In such case, Kuiper is acting as a filter - to filter NOT concerned messages, but still keep original data.
|
|
|
|
|
|
Below is an example,
|
|
Below is an example,
|