espressif/esp-rainmaker-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
149 commits 2 branches 0 tags 723 KiB
  • Python 99.6%
  • HTML 0.4%
Find a file
Exact
Piyush Shah dee32b620f
Some checks failed
PyPI release / build_and_upload (push) Has been cancelled
Details
Merge branch 'feat/ble-adapter-option' into 'master' 
provision: Add --ble_adapter CLI option for selecting HCI adapter

See merge request app-frameworks/esp-rainmaker-cli!98
2026-06-19 17:49:09 +05:30
.github/workflows Adjust workflow to use the latest action versions and python3.9 2024-05-07 21:03:22 +08:00
docs provision: Add --ble_adapter CLI option for selecting HCI adapter 2026-06-15 12:01:14 +05:30
rainmaker provision: Add --ble_adapter CLI option for selecting HCI adapter 2026-06-15 12:01:14 +05:30
rmaker_cmd provision: Add --ble_adapter CLI option for selecting HCI adapter 2026-06-15 12:01:14 +05:30
rmaker_lib sec2: Fix provisioning and local control for Security 2 devices 2026-06-10 00:26:01 +05:30
rmaker_tools provision: Add --ble_adapter CLI option for selecting HCI adapter 2026-06-15 12:01:14 +05:30
server_cert Add __init__.py to subpackages to fix missing files in pypi package 2024-08-23 12:37:43 +05:30
.gitignore Minor restructuring and changes required to upload rainmaker cli to pypi 2024-05-23 15:42:21 +05:30
.gitlab-ci.yml ci: add multi-python wheel build test and update dependencies 2026-04-09 17:34:34 +05:30
__init__.py features: Provisioning and Local Control 2025-11-13 15:50:20 +05:30
CHANGELOG.md provision: Add --ble_adapter CLI option for selecting HCI adapter 2026-06-15 12:01:14 +05:30
LICENSE Minor restructuring and changes required to upload rainmaker cli to pypi 2024-05-23 15:42:21 +05:30
README.md features: Provisioning and Local Control 2025-11-13 15:50:20 +05:30
requirements.txt ci: add multi-python wheel build test and update dependencies 2026-04-09 17:34:34 +05:30
setup.py ci: add multi-python wheel build test and update dependencies 2026-04-09 17:34:34 +05:30

README.md

ESP RainMaker CLI

PyPI version

Welcome to the esp-rainmaker-cli repository!

This repository contains the source of ESP RainMaker Command Line utility.

About RainMaker

ESP RainMaker is an end-to-end solution offered by Espressif to enable remote control and monitoring for ESP32 based products without any configuration required in the Cloud.

How to install

esp-rainmaker-cli is available on Python Package Index (PyPI). It can be installed using pip.

python3 -m pip install esp-rainmaker-cli

Usage

Please check the CLI Usage guide for more information.

For more help, you can also run the following command:

esp-rainmaker-cli --help

Key Features

🔧 Enhanced Device Provisioning

Support for BLE, SoftAP, and Console transport modes with Security 0/1/2 schemes. Use the new --pop flag for cleaner syntax.

esp-rainmaker-cli provision --pop abcd1234 --transport ble --device_name PROV_device

⚡ ESP Local Control

Direct device communication on your local network with 5-10x faster response times using the --local flag.

For detailed documentation, see Provisioning Guide and ESP Local Control Guide.

Development Guide

Development mode allows you to run the latest version of esp-rainmaker-cli from the repository. If you are making any changes to the tool then in order to test the changes please follow the below steps.

python3 -m pip install -e .

This will install esp-rainmaker-cli's dependencies and create an executable script wrappers in the user's bin directory. The wrappers will run the scripts found in the git working directory directly, so any time the working directory contents change it will pick up the new versions.