Skip to content

README.md

Latest commit

 

History

History
169 lines (123 loc) · 5.65 KB

README.md

File metadata and controls

169 lines (123 loc) · 5.65 KB
Raw

ESP RainMaker CLI Documentation

This directory contains detailed documentation and examples for the ESP RainMaker CLI tool.

Overview

The ESP RainMaker CLI (Command Line Interface) provides a set of commands to interact with the ESP RainMaker cloud service. It allows you to manage nodes, control devices, set parameters, manage schedules, handle node sharing, and perform other operations related to your ESP RainMaker devices.

Installation

Global Installation

pip install esp-rainmaker-cli

Using a Virtual Environment (recommended)

# Create a virtual environment
python3 -m venv rainmaker-env

# Activate the virtual environment
# On macOS/Linux:
source rainmaker-env/bin/activate
# On Windows:
# rainmaker-env\Scripts\activate

# Install ESP RainMaker CLI
pip install esp-rainmaker-cli

# When finished, you can deactivate the virtual environment
deactivate

Available Commands

The CLI supports the following main commands:

Configuration and Profile Management

  • configure --region <region> - Configure ESP RainMaker region (china, global)
  • profile list - List all available profiles
  • profile current - Show current profile information
  • profile switch <name> - Switch to a different profile
  • profile add <name> --base-url <url> - Add a new custom profile
  • profile remove <name> - Remove a custom profile

User Management

  • login - Log in to the ESP RainMaker service
  • logout - Log out from the ESP RainMaker service
  • signup - Sign up for a new ESP RainMaker account
  • forgotpassword - Reset a forgotten password
  • getuserinfo - Get details of the currently logged-in user

Node Management

  • getnodes - List all nodes associated with the user
  • getnodeconfig - Get node configuration
  • getnodestatus - Get online/offline status of the node
  • getnodedetails - Get detailed information for all nodes or a specific node
  • removenode - Remove user node mapping
  • node add-tags - Add tags to a node
  • node remove-tags - Remove tags from a node
  • node set-metadata - Set or update metadata for a node
  • node delete-metadata - Delete metadata from a node

Parameter Management

  • getparams - Get node parameters
  • setparams - Set node parameters

Schedule Management

  • getschedules - Get schedule information for a specific node
  • setschedule - Manage schedules for a specific node (add/edit/remove/enable/disable)

Node Sharing

  • sharing add_user - Request to add user for sharing nodes
  • sharing remove_user - Remove user from shared nodes
  • sharing accept - Accept sharing request
  • sharing decline - Decline sharing request
  • sharing cancel - Cancel sharing request
  • sharing list_nodes - List nodes sharing details
  • sharing list_requests - List pending requests

Node-level sharing is deprecated; prefer group sharing (see Group Management) — even for a single node, create a group and share it.

Group Management

  • group add - Create a new group
  • group remove - Delete a group
  • group edit - Edit group properties
  • group list - List all groups (optionally with hierarchy)
  • group show - Show group details
  • group add-nodes - Add nodes to a group
  • group remove-nodes - Remove nodes from a group
  • group list-nodes - List nodes in a group
  • group sharing add - Share group(s) / matter fabric(s) with a user
  • group sharing remove - Remove group sharing with a user
  • group sharing list - List sharing details for groups
  • group sharing list-requests - List pending group sharing requests
  • group sharing accept - Accept a group sharing request
  • group sharing decline - Decline a group sharing request
  • group sharing cancel - Cancel a pending group sharing request

Command Response (Beta)

  • create_cmd_request - Create a command response request for nodes
  • get_cmd_requests - Get command response requests details

Device Setup

  • claim - Claim the node connected to a serial port (get cloud credentials)
  • provision - Provision the node to join Wi-Fi network

Cache Management

  • cache enable - Enable node cache on the current profile
  • cache disable - Disable node cache on the current profile
  • cache show - Show cached data (all nodes or a specific node with --nodeid)
  • cache clear - Clear cached data (all nodes or a specific node with --nodeid)

Video Streaming

  • stream <nodeid> - Stream video from a camera device via WebRTC (KVS signaling)

Other Operations

  • getmqtthost - Get the MQTT Host URL to be used in the firmware
  • raw-api - Make authenticated raw API calls to RainMaker backend for testing/debugging

Detailed Documentation

For detailed documentation on specific commands, refer to the following files:

Examples

Each command documentation includes practical examples of usage.

Getting Help

You can get help on any command by running:

esp-rainmaker-cli <command> --help

For the full list of available commands:

esp-rainmaker-cli --help