CLI Usage

Setup

If you haven't setup the CLI, follow the steps here before moving ahead with the usage.

Commands and Usage:

Note : On Windows, use python rainmaker.py <sub-command>

1. First User has to sign up using the following command :

    ./rainmaker.py signup <email>
   

2. After Signup, User has to do the login for the CLI using the following command :

    ./rainmaker.py login [--email <email>]
   

If email is not provided, browser window will open for login.

3. After successful login user can use the Rainmaker CLI.

Running the utility

Usage

    ./rainmaker.py [OPTIONS] COMMAND [ARGS]...

Options :

No.	Parameter	Description
1	-h, --help	show this help message and exit

Commands :

  Run `./rainmaker.py {command} -h` for additional help 

No.	Parameter	Description
1	signup	Sign up for ESP Rainmaker
2	login	Login to ESP Rainmaker
3	forgotpassword	Reset the password
4	getnodes	List all nodes associated with the user
5	getnodeconfig	Get node configuration
6	getnodestatus	Get online/offline status of the node
7	setparams	Set node parameters. Note: Enter JSON data in singe quotes
8	getparams	Get node parameters
9	removenode	Remove user node mapping
10	provision	Provision the node to join Wi-Fi network
12	getmqtthost	Get the MQTT Host URL to be used in the firmware

Note : For ./rainmaker.py setparams command, the JSON data argument needs to be specified differently as per your Host OS.

MacOS/Linux: '{"Light": {"brightness": 50, "output": false}}'

Windows: '{\"Light": {\"brightness\": 50, \"output\": false}}'