[The list of CLI (Command Line Interface) of MESH]
MESH Hub Application for Raspberry Pi (MESH Hub) serves the following CLI (Command Line Interface) that is executable from the Raspberry Pi terminal.
- Show MESH CLI Help
- Show the MESH Hub version
- Display the MESH settings or change the settings
- Set/Unset launching MESH Hub when the Raspberry Pi boots
- Enable/Disable a MESH Hub shield that is controlled by the Raspberry Pi GPIO
- Start, stop, and restart MESH Hub
- Display the status of MESH Hub
- Display or change the boot mode (Setup / Normal)
- Delete all data
[How to use the MESH CLI]
mesh [-h|--help|-v|--version]
option | Description |
-h|--help (no option) |
Displays how to use the CLI. Example : mesh -h |
-v|--version | Shows the MESH Hub version. Example : mesh -v |
mesh {command} [option]
Command | Option | Description |
help | No options |
Displays how to use the CLI. Example: mesh help |
version | No options | Shows the MESH Hub version. Example: mesh version |
status | No options | Shows the status of the MESH Hub. Example: mesh status |
setting | [[[--startup on|off] [--gpio on|off]] |[--show]] |
Displays the MESH settings or changes the settings. |
start | [--startup on|off] [--gpio on|off] |
Starts MESH Hub. You can change the settings by adding options. |
stop | No options | Stops MESH Hub. Example: mesh stop |
restart | [--startup on|off] [--gpio on|off] | Restarts MESH Hub. You can change the settings by adding options. Example1: mesh restart Restarts MESH Hub Example2: mesh restart --gpio off Restarts MESH Hub and disables a MESH Hub shield that is controlled by a Raspberry Pi GPIO. |
mode | [[--set normal|setup]|[--show]] |
Displays or changes the MESH mode.
Modes: normal: working correctly In the "reset" state, if the Raspberry Pi is powered on or off, the data stored in MESH will be initialized. Use the clear command to initialize, since this is only a display and cannot be specified. |
clear | [--force] | Deletes all MESH data (e.g. recipes) Example1: mesh clear Deletes all MESH data with confirmation. Example2: mesh clear --force Deletes all MESH data without confirmation. |