IzoT SDK Tools
The following table describes the main IzoT SDK tools present in $IZOT/bin:
Command | Description |
---|---|
activate | Activates the IzoT SDK virtual environment. Run deactivate (a shell function) to deactivate the virtual environment (e.g., prior to upgrading the IzoT SDK). Most IzoT SDK applications and tools require that the IzoT SDK virtual environment is active before running. |
izot_stat | Reports the status of all IzoT SDK applications running under the Supervisor. |
izot_start | Starts an IzoT SDK application running under Supervisor. Specify the name of the IzoT application (e.g., server, led, sensor, keypad, etc.) as the argument (defaults to server if none specified). The IzoT application does not restart if the device is restarted—use izot_enable to restart the application automatically on device restart. |
izot_stop | Stops an IzoT SDK application running under Supervisor. Specify the name of the IzoT application (e.g., server, led, sensor, keypad, etc.) as the argument (defaults to server if none specified). |
izot_restart | Stops and restarts an IzoT SDK application running under Supervisor. Specify the name of the IzoT application (e.g., server,led, sensor, keypad, etc.) as the argument (defaults to server if none specified). |
izot_enable | Enables an IzoT SDK application running under Supervisor to start automatically, and starts it. Specify the name of the IzoT application (e.g., server, led, sensor, keypad, etc.) as the argument (defaults to server if none specified). |
izot_disable | Stops an IzoT SDK application running under Supervisor and disables it from starting automatically. Specify the name of the IzoT application (e.g., server, led, sensor, keypad, etc.) as the argument (defaults to server if none specified). |
izot_reset | Stops the IzoT Server, deletes all known devices from its database, and then restarts the server, which rebuilds an empty database. Warning: This will delete all database information, including user accounts, and device/datapoint information. |
izot_run | Runs an IzoT SDK application after first activating the virtual environment. This can be used in Supervisor configuration files where it is not normally possible to activate the IzoT SDK virtual environment. |
supy | Runs a Python 3-based IzoT SDK application as root. Unlike sudo, this script ensures that the IzoT SDK virtual environment is preserved. |
izot_lock | Locks (or unlocks) the IzoT Server (e.g., during maintenance). Web and REST API requests will receive an error page during this time. |