Helium is an integrated platform of smart sensors, communication, edge and cloud compute that enables numerous sensing applications.
This package makes it easy to talk to the Helium API. It offers:
- A command line interface to interact with the various Helium endpoints
- A service API that shows how to communicate with the Helium API and interpret the results.
Use this if you're actively developing or extending
$ virtualenv env
$ source env/bin/activate
$ pip install -e .From PyPi. Use this if you want to use the command line tool on its own.
$ pip install helium-commanderNote that on some systems you may have to use sudo to install the package system-wide
$ sudo pip install helium-commanderhelium-commander can also be installed using the Nix package manager. Clone the repository and run:
$ nix-env --install --file default.nixTo upgrade on version releases, run:
$ nix-env --upgrade --file default.nixTo use the helium command, explore the help options:
$ helium --help
Usage: helium [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
--format [csv|json|tty] The output format (default 'tty')
--uuid Whether to display long identifiers
--host TEXT The Helium base API URL. Can also be specified
using the HELIUM_API_URL environment variable.
--api-key TEXT your Helium API key. Can also be specified using
the HELIUM_API_KEY environment variable
-h, --help Show this message and exit.
Commands:
cloud-script Operations on cloud-scripts.
element Operations on elements.
label Operations on labels of sensors.
organization Operations on the authorized organization
sensor Operations on physical or virtual sensors.
sensor-script Operations on sensor-scripts.
user Operations on the user.