Skip to content

Commit 5e66ab1

Browse files
tomhollingworthTom Hollingworth
andauthored
Upgrade libraries & README (#42)
### Add - Add SparkplugB topic and payload details to README ### Change - Bump Revision from v2.0.3 to v2.0.4 - Change mqtt from 4.2.8 to 4.3.8 - Change sonarqube-scanner from 2.8.1 to 2.9.1 - Change sparkplug-client from 3.2.2 to 3.2.4 - Change winston from 3.3.3 to 3.13.0 --------- Co-authored-by: Tom Hollingworth <[email protected]>
1 parent ed9177b commit 5e66ab1

File tree

7 files changed

+2057
-1981
lines changed

7 files changed

+2057
-1981
lines changed

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ LABEL org.opencontainers.image.authors="[email protected]"
66
LABEL org.opencontainers.image.source="https://github.com/Spruik/PackML-MQTT-Simulator"
77
LABEL org.opencontainers.image.url="https://spruiktec.com/"
88
LABEL org.opencontainers.image.vendor="Spruik Technologies LLC"
9-
LABEL org.opencontainers.image.version="2.0.3"
9+
LABEL org.opencontainers.image.version="2.0.4"
1010

1111
WORKDIR /machine
1212

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ $ docker run -it -e CLIENT_TYPE=sparkplugb -e SITE=Site -e AREA=Area -e LINE=Lin
3939
2020-06-22T03:13:49.819Z | info: Site/Area/Line/Status/UnitModeCurrent : Production
4040
```
4141

42-
Once up and running, use an Sparkplug B device commands to publish to `Command.Reset` and `Command.Start` metrics to get the simulated machine into the execute state.
42+
Once up and running, use an Sparkplug B device commands to publish to `Command/Reset` and `Command/Start` metrics to get the simulated machine into the execute state. The topic in the above example is: `spBv1.0/Site/DCMD/Area/Line`.
4343

4444
### Node
4545

@@ -192,7 +192,11 @@ Available Admin Status
192192

193193
## Interfacing via SparkplugB v1.0
194194

195-
Refer to the [Sparkplug B Payload and Topic Payload Definition Specification](https://www.eclipse.org/tahu/spec/Sparkplug%20Topic%20Namespace%20and%20State%20ManagementV2.2-with%20appendix%20B%20format%20-%20Eclipse.pdf).
195+
Refer to the [Sparkplug B Payload and Topic Payload Definition Specification](https://www.eclipse.org/tahu/spec/Sparkplug%20Topic%20Namespace%20and%20State%20ManagementV2.2-with%20appendix%20B%20format%20-%20Eclipse.pdf).
196+
197+
The simulator creates a device and listens to the device commands message (DCMD) topic with metrics representing the available commands without the `<SITE>/<AREA>/<LINE>/` prefix. Consider the command topic `<SITE>/<AREA>/<LINE>/Command/Reset`, when writing as a SparkplugB device command message use the metric name `Command/Reset`. Publishing device command messages are published against `spBv1.0/<SPARKPLUG_GROUP_ID>/DCMD/<SPARKPLUG_EDGE_NODE>/<LINE>` based on site environmental variables.
198+
199+
The simulator will also rebirth when requested at the node level by publishing to `spBv1.0/<SPARKPLUG_GROUP_ID>/NCMD/<SPARKPLUG_EDGE_NODE>` with a metric `Node Control/Rebirth` and a true value.
196200

197201
Below is an example of publishing to Igniition v8.1.5 SCADA with Cirrus Link Modules. The MQTT Engine was configured with the corresponding namespace filter for the simulation environmental variables.
198202

@@ -295,6 +299,14 @@ For any issue, there are fundamentally three ways an individual can contribute:
295299

296300
## Changelog
297301

302+
- 2.0.4
303+
- Update README
304+
- Update mqtt from 4.2.8 to 4.3.8
305+
- Update sonarqube-scanner from 2.8.1 to 2.9.1
306+
- Update sparkplug-client from 3.2.2 to 3.2.4
307+
- Update winston from 3.3.3 to 3.13.0
308+
- Bump Revision
309+
298310
- 2.0.3
299311
- Update path-parse from 1.0.6 to 1.0.7
300312
- Change README run command env. variable MQTT_HOST to MQTT_URL

chart/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ name: packml-sim
33
description: PackML Machine Simulator
44
type: application
55
version: 0.0.2
6-
appVersion: 2.0.3
6+
appVersion: 2.0.4

0 commit comments

Comments
 (0)