mirror of
https://github.com/espressif/esp-rainmaker.git
synced 2026-01-19 16:03:45 +00:00
31d4b375e3
The following are now part of a separate repo (and included as git submodule): - MQTT glue layer - Work Queue - Utilities (reset, reboot, time sync, timezone, etc.) - Factory Storage Even CLI is now a part of a seperate repo, included here as a git submodule.
60 lines
2.4 KiB
Markdown
60 lines
2.4 KiB
Markdown
# ESP RainMaker (Beta)
|
|
|
|
> Note: We have recently made some changes to the APIs. Please refer [this file](CHANGES.md) for details.
|
|
|
|
## Introduction
|
|
|
|
ESP RainMaker is an end-to-end solution offered by Espressif to enable remote control and monitoring for ESP32-S2 and ESP32 based products without any configuration required in the Cloud. The primary components of this solution are:
|
|
|
|
- Claiming Service (to get the Cloud connectivity credentials)
|
|
- RainMaker Agent (i.e. this repo, to develop the firmware)
|
|
- RainMaker Cloud (backend, offering remote connectivity)
|
|
- RainMaker Phone App/CLI (Client utilities for remote access)
|
|
|
|
|
|
The key features of ESP RainMaker are:
|
|
|
|
1. Ability to define own devices and parameters, of any type, in the firmware.
|
|
2. Zero configuration required on the Cloud.
|
|
3. Phone apps that dynamically render the UI as per the device information.
|
|
|
|
## Get ESP RainMaker
|
|
|
|
Please clone this repository using the below command:
|
|
|
|
```
|
|
git clone --recursive https://github.com/espressif/esp-rainmaker.git
|
|
```
|
|
|
|
> Note the --recursive option. This is required to pull in the various dependencies into esp-rainmaker. In case you have already cloned the repository without this option, execute this to pull in the submodules: `git submodule update --init --recursive`
|
|
|
|
Please check the ESP RainMaker documentation [here](https://rainmaker.espressif.com/docs/get-started.html) to get started.
|
|
|
|
Each example has its own README with additional information about using the example.
|
|
|
|
## Supported ESP-IDF versions
|
|
|
|
ESP RainMaker can work with ESP IDF 4.0 and above.
|
|
|
|
## Phone Apps
|
|
|
|
### Android
|
|
|
|
- [Google PlayStore](https://play.google.com/store/apps/details?id=com.espressif.rainmaker)
|
|
- [Direct APK](https://github.com/espressif/esp-rainmaker/wiki)
|
|
- [Source Code](https://github.com/espressif/esp-rainmaker-android)
|
|
|
|
### iOS
|
|
- [Apple App Store](https://apps.apple.com/app/esp-rainmaker/id1497491540)
|
|
- [Source Code](https://github.com/espressif/esp-rainmaker-ios)
|
|
|
|
### API Documentation Build Status
|
|
|
|
[](https://docs.espressif.com/projects/esp-rainmaker/en/latest/)
|
|
|
|
## Discussions
|
|
|
|
[ESP32 Forum](https://www.esp32.com/viewforum.php?f=41)
|
|
|
|
[](https://gitter.im/esp-rainmaker/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|