Command line interface¶
Command Line Interface (CLI) for OpenHydroponics
hypo provides a way to interact with the OpenHydroponics network via the command line. It allows users to execute various commands and pass arguments to perform specific tasks.
hypo¶
hypo [OPTIONS] COMMAND [ARGS]...
Options
- --node <node>¶
Node UUID. If not set, this is read from the environmental variable HYPO_NODE
- --bus <bus>¶
Select the dbus bus to connect to.
- Options:
system | session
config¶
Get and set node configuration
hypo config [OPTIONS] COMMAND [ARGS]...
get¶
Get node endpoint configuration
hypo config get [OPTIONS] ENDPOINT CONFIG
Arguments
- ENDPOINT¶
Required argument
- CONFIG¶
Required argument
set¶
Set node endpoint configuration
hypo config set [OPTIONS] ENDPOINT name=value
Arguments
- ENDPOINT¶
Required argument
- name=value¶
Optional argument(s)
ls¶
List all nodes found on the CANbus and its endpoints. Each node is identified by its UUID. The UUID is a unique identifier for each node.
hypo ls [OPTIONS]
Example output:
output¶
Commands to control node output endpoints
hypo output [OPTIONS] COMMAND [ARGS]...
set¶
Set node endpoint output to a value. The value is a float between 0 and 100. For example, to set the endpoint 1 output to 50%, use:
hypo output set [OPTIONS] ENDPOINT VALUE
Arguments
- ENDPOINT¶
Required argument
- VALUE¶
Required argument