Skip to main content

HELP

Syntax​

HELP

Description​

Lists the commands accepted by the device, with a one-line description of each. The list is generated by the firmware, so it always matches the installed version. The pages of this reference document the supported commands; the HELP text is informational and may contain additional service commands that are not part of the public protocol.

Response​

A header that recalls the reply and event formats, then one line per command:

--- UDP commands (port 55152) ---
  Replies: [#id ]OK <CMD> [k=v ...] | [#id ]ERR <CMD> <reason>, on UDP text port 55153
  Events: EVT <topic> ... on DEST (UDP text port 55153)
  <COMMAND>   <short description>
  ...

The list can span several datagrams.

Example​

help.py
from hmcls_udp import Board

board = Board("192.168.1.11")
for line in board.query("HELP", timeout=1.0):
    print(line)