Skip to content

Commit 6d90ba6

Browse files
committed
Update setup
1 parent 46aa1a3 commit 6d90ba6

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

setup.py

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,47 @@
4848
''',
4949
long_description="""
5050
BigClown gateway between USB and MQTT broker.
51+
52+
Documentation is here https://www.bigclown.com/doc/tools/bcg/
53+
54+
55+
usage: bcg [-h] [-c CONFIG] [-d DEVICE] [-H MQTT_HOST] [-P MQTT_PORT]
56+
[--no-wait] [--mqtt-username MQTT_USERNAME]
57+
[--mqtt-password MQTT_PASSWORD] [--mqtt-cafile MQTT_CAFILE]
58+
[--mqtt-certfile MQTT_CERTFILE] [--mqtt-keyfile MQTT_KEYFILE] [-D]
59+
[-v]
60+
COMMAND ...
61+
62+
BigClown gateway between USB serial port and MQTT broker
63+
64+
positional arguments:
65+
COMMAND
66+
devices show devices
67+
help show help
68+
69+
optional arguments:
70+
-h, --help show this help message and exit
71+
-c CONFIG, --config CONFIG
72+
path to configuration file (YAML format)
73+
-d DEVICE, --device DEVICE
74+
device
75+
-H MQTT_HOST, --mqtt-host MQTT_HOST
76+
MQTT host to connect to (default is localhost)
77+
-P MQTT_PORT, --mqtt-port MQTT_PORT
78+
MQTT port to connect to (default is 1883)
79+
--no-wait no wait on connect or reconnect serial port
80+
--mqtt-username MQTT_USERNAME
81+
MQTT username
82+
--mqtt-password MQTT_PASSWORD
83+
MQTT password
84+
--mqtt-cafile MQTT_CAFILE
85+
MQTT cafile
86+
--mqtt-certfile MQTT_CERTFILE
87+
MQTT certfile
88+
--mqtt-keyfile MQTT_KEYFILE
89+
MQTT keyfile
90+
-D, --debug print debug messages
91+
-v, --version show program's version number and exit
92+
5193
"""
5294
)

0 commit comments

Comments
 (0)