Skip to content

Commit b1177e8

Browse files
v1.0.2 (#11)
* Added an environmental variable for MQTT Port * Fixed typos * Added logging of mqttClient errors * Upgrade npm libraries * Added port to connected message * Update in code capitalization of PackML * Bump revision
1 parent 81eaba6 commit b1177e8

File tree

5 files changed

+145
-160
lines changed

5 files changed

+145
-160
lines changed

README.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Start your container with environmental variables
1717
```shell
1818
$ docker run -it -e SITE=Site -e AREA=Area -e LINE=Line -e MQTT_HOST=mqtt://broker.hivemq.com spruiktec/packml-simulator
1919
2020-06-22T03:13:49.301Z | info: Initializing
20-
2020-06-22T03:13:49.817Z | info: Connected to mqtt://broker.hivemq.com
20+
2020-06-22T03:13:49.817Z | info: Connected to mqtt://broker.hivemq.com:1883
2121
2020-06-22T03:13:49.819Z | info: Site/Area/Line/Status/UnitModeCurrent : Production
2222
```
2323

@@ -30,7 +30,7 @@ added 421 packages from 213 contributors and audited 421 packages in 12.337s
3030
found 0 vulnerabilities
3131
$ node ./src/index.js
3232
2020-06-22T03:13:49.301Z | info: Initializing
33-
2020-06-22T03:13:49.817Z | info: Connected to mqtt://broker.hivemq.com
33+
2020-06-22T03:13:49.817Z | info: Connected to mqtt://broker.hivemq.com:1883
3434
2020-06-22T03:13:49.819Z | info: Site/Area/Line/Status/UnitModeCurrent : Production
3535
```
3636

@@ -95,10 +95,10 @@ Available Commands
9595
| `<SITE>/<AREA>/<LINE>/Command/Product/*i*/ProcessParameter/*j*/Unit` | Integer | Product *i* Process Parameter *j* Unit |
9696
| `<SITE>/<AREA>/<LINE>/Command/Product/*i*/ProcessParameter/*j*/Value` | Integer | Product *i* Process Parameter *j* Value |
9797
| `<SITE>/<AREA>/<LINE>/Command/Product/*i*/Ingredient/*j*/ID` | Integer | Product *i* Ingredient *n* ID |
98-
| `<SITE>/<AREA>/<LINE>/Command/Product/*i*/Ingredient/*j*/Parameter/*k*/ID` | Integer | Product *i* Ingredient *j* Paramter *k* ID |
99-
| `<SITE>/<AREA>/<LINE>/Command/Product/*i*/Ingredient/*j*/Parameter/*k*/Name` | Integer | Product *i* Ingredient *j* Paramter *k* Name |
100-
| `<SITE>/<AREA>/<LINE>/Command/Product/*i*/Ingredient/*j*/Parameter/*k*/Unit` | Integer | Product *i* Ingredient *j* Paramter *k* Unit |
101-
| `<SITE>/<AREA>/<LINE>/Command/Product/*i*/Ingredient/*j*/Parameter/*k*/Value` | Integer | Product *i* Ingredient *j* Paramter *k* Value |
98+
| `<SITE>/<AREA>/<LINE>/Command/Product/*i*/Ingredient/*j*/Parameter/*k*/ID` | Integer | Product *i* Ingredient *j* Parameter *k* ID |
99+
| `<SITE>/<AREA>/<LINE>/Command/Product/*i*/Ingredient/*j*/Parameter/*k*/Name` | Integer | Product *i* Ingredient *j* Parameter *k* Name |
100+
| `<SITE>/<AREA>/<LINE>/Command/Product/*i*/Ingredient/*j*/Parameter/*k*/Unit` | Integer | Product *i* Ingredient *j* Parameter *k* Unit |
101+
| `<SITE>/<AREA>/<LINE>/Command/Product/*i*/Ingredient/*j*/Parameter/*k*/Value` | Integer | Product *i* Ingredient *j* Parameter *k* Value |
102102

103103
### Status
104104

@@ -120,10 +120,10 @@ Available Status'
120120
| `<SITE>/<AREA>/<LINE>/Status/Product/*i*/ProcessParameter/*j*/Unit` | Integer | Product *i* Process Parameter *j* Unit |
121121
| `<SITE>/<AREA>/<LINE>/Status/Product/*i*/ProcessParameter/*j*/Value` | Integer | Product *i* Process Parameter *j* Value |
122122
| `<SITE>/<AREA>/<LINE>/Status/Product/*i*/Ingredient/*j*/ID` | Integer | Product *i* Ingredient *n* ID |
123-
| `<SITE>/<AREA>/<LINE>/Status/Product/*i*/Ingredient/*j*/Parameter/*k*/ID` | Integer | Product *i* Ingredient *j* Paramter *k* ID |
124-
| `<SITE>/<AREA>/<LINE>/Status/Product/*i*/Ingredient/*j*/Parameter/*k*/Name` | Integer | Product *i* Ingredient *j* Paramter *k* Name |
125-
| `<SITE>/<AREA>/<LINE>/Status/Product/*i*/Ingredient/*j*/Parameter/*k*/Unit` | Integer | Product *i* Ingredient *j* Paramter *k* Unit |
126-
| `<SITE>/<AREA>/<LINE>/Status/Product/*i*/Ingredient/*j*/Parameter/*k*/Value` | Integer | Product *i* Ingredient *j* Paramter *k* Value |
123+
| `<SITE>/<AREA>/<LINE>/Status/Product/*i*/Ingredient/*j*/Parameter/*k*/ID` | Integer | Product *i* Ingredient *j* Parameter *k* ID |
124+
| `<SITE>/<AREA>/<LINE>/Status/Product/*i*/Ingredient/*j*/Parameter/*k*/Name` | Integer | Product *i* Ingredient *j* Parameter *k* Name |
125+
| `<SITE>/<AREA>/<LINE>/Status/Product/*i*/Ingredient/*j*/Parameter/*k*/Unit` | Integer | Product *i* Ingredient *j* Parameter *k* Unit |
126+
| `<SITE>/<AREA>/<LINE>/Status/Product/*i*/Ingredient/*j*/Parameter/*k*/Value` | Integer | Product *i* Ingredient *j* Parameter *k* Value |
127127

128128
### Admin
129129

@@ -168,6 +168,10 @@ The ISA-95 model line name of this line. LINE used as the third topic in the MQT
168168

169169
The address of the MQTT server. If this is unset, _mqtt://broker.hivemq.com_ will be used.
170170

171+
### MQTT_PORT
172+
173+
The port of the MQTT server. If left blank, the MQTT library will try and determine port based on protocol.
174+
171175
### MQTT_USERNAME
172176

173177
The name of the MQTT user with subscribe and publish permissions.
@@ -209,6 +213,16 @@ For any issue, there are fundamentally three ways an individual can contribute:
209213

210214
## Changelog
211215

216+
- 1.0.2
217+
- Add environmental variable for MQTT Port
218+
- Fix typos
219+
- Add logging of mqttClient errors
220+
- Upgrade MQTT library to v4.2.1
221+
- Upgrade winston library to v3.3.3
222+
- Upgrade sonarqube-scanner library to v2.7.0
223+
- Add port to connected message
224+
- Update in code capitalization of PackML
225+
212226
- 1.0.1 Update docs
213227
- Bump npm library versions
214228
- Fix README subtitle markdown

0 commit comments

Comments
 (0)