@@ -36,9 +36,12 @@ debian this is available from the `python3-paho-mqtt` package.
3636
3737== OPTIONS
3838
39- **keys=**__pin1_[,_pin2_,...]_::
40- The name of HAL pins, signals and other values to publish using MQTT.
41- The names are also used as the JSON keys in the MQTT message published with the broker.
39+ *keys*=_pin1[,pin2,...]_::
40+
41+ The name of HAL pins, signals and other values to publish using
42+ MQTT. The names are also used as the JSON keys in the MQTT
43+ message published with the broker. If multiple "keys=" options
44+ are specified, the lists are merged.
4245
4346*--dryrun*::
4447 Do not set up MQTT connection, only print message to stdout.
@@ -88,23 +91,32 @@ Any set of HAL pins and signals can be published.
8891This setup might be a useful starting point:
8992
9093----
91- loadusr -W mqtt-publisher [MQTT]DRYRUN --mqtt-broker=[MQTT]BROKER
92- --mqtt-user=[MQTT]USERNAME --mqtt-password=[MQTT]PASSWORD
93- keys=halui.axis.a.pos-feedback,halui.axis.b.pos-feedback,
94- halui.axis.c.pos-feedback,halui.axis.u.pos-feedback,
95- halui.axis.v.pos-feedback,halui.axis.w.pos-feedback,
96- halui.axis.x.pos-feedback,halui.axis.y.pos-feedback,
97- halui.axis.z.pos-feedback,halui.estop.is-activated,
98- halui.joint.0.is-homed,halui.joint.1.is-homed,halui.joint.2.is-homed,
99- halui.joint.3.is-homed,halui.joint.4.is-homed,halui.joint.5.is-homed,
100- halui.joint.6.is-homed,halui.joint.7.is-homed,halui.joint.8.is-homed,
101- halui.machine.is-on,halui.max-velocity.value,halui.mode.is-auto,
102- halui.mode.is-manual,halui.mode.is-mdi,halui.mode.is-teleop,
103- halui.program.is-running'
94+ loadusr -W mqtt-publisher \
95+ [MQTT]DRYRUN \
96+ --mqtt-broker=[MQTT]BROKER
97+ --mqtt-user=[MQTT]USERNAME \
98+ --mqtt-password=[MQTT]PASSWORD \
99+ keys=halui.axis.a.pos-feedback,halui.axis.b.pos-feedback,\
100+ halui.axis.c.pos-feedback,halui.axis.u.pos-feedback,\
101+ halui.axis.v.pos-feedback,halui.axis.w.pos-feedback,\
102+ halui.axis.x.pos-feedback,halui.axis.y.pos-feedback,\
103+ halui.axis.z.pos-feedback \
104+ keys=halui.estop.is-activated, halui.joint.0.is-homed,\
105+ halui.joint.1.is-homed,halui.joint.2.is-homed,halui.joint.3.is-homed,\
106+ halui.joint.4.is-homed,halui.joint.5.is-homed,halui.joint.6.is-homed,\
107+ halui.joint.7.is-homed,halui.joint.8.is-homed \
108+ keys=halui.machine.is-on,halui.max-velocity.value,halui.mode.is-auto,
109+ halui.mode.is-manual,halui.mode.is-mdi,halui.mode.is-teleop,
110+ halui.program.is-running
104111----
105112
106- Note: The list of keys can not include space after comma.
107- The lines are appear broken only to avoid too long lines in the documentation.
113+ Note: It is recommended to use the line continuation character "\" as
114+ shown here to improve readability. But note that spaces must be left in
115+ to delimit options, and must not be included (including at the beginning
116+ of a line) inside a single option.
117+
118+ HAL limits a single option/token (for example "keys=") to 255 characters.
119+ To work around this issue use multiple "keys=" entries as shown.
108120
109121== SEE ALSO
110122
0 commit comments