ESP RAINMAKER

ESP RAINMAKER

  • Smart Home
  • Docs
  • API
  • Help
  • Blog
  • GitHub

›CLI

Get Started

  • Get Started

Develop Firmware

  • Basics
  • Standard Types

Specifications

  • Concepts
  • Node - Cloud communication
  • Client - Cloud communication
  • User - Node Mapping
  • Claiming
  • User Roles

Services

  • OTA FW Upgrades
  • Time Service
  • Scheduling
  • Local Control Service
  • Scenes
  • System Service

CLI

  • Setup
  • Usage

3rd Party Integrations

  • 3rd Party Integrations

Other Features

  • Node Sharing
  • Local Control
  • ESP Insights (Beta)

What's Next?

  • What's Next?

Documentation Feedback

  • Documentation Feedback

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.

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

Running the utility

Usage

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

Options :

No.ParameterDescription
1-h, --helpshow this help message and exit

Commands :

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

No.ParameterDescription
1signupSign up for ESP Rainmaker
2loginLogin to ESP Rainmaker
3logoutLogout current (logged-in) user
4forgotpasswordReset the password
5getnodesList all nodes associated with the user
6getnodeconfigGet node configuration
7getnodestatusGet online/offline status of the node
8setparamsSet node parameters. Note: Enter JSON data in singe quotes
9getparamsGet node parameters
10removenodeRemove user node mapping
11provisionProvision the node to join Wi-Fi network
12getmqtthostGet the MQTT Host URL to be used in the firmware
13claimClaim the node connected to the given serial port (Get cloud credentials)
14otaupgradeUpload OTA Firmware image and start OTA Upgrade
15getuserinfoGet details of current (logged-in) user
16sharingNode Sharing Operations

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}}"

← Setup3rd Party Integrations →
  • Setup
  • Commands and Usage:
    • Running the utility
Copyright © 2022 Espressif SystemsPrivacy PolicyTerms of UseCookie Policy