Skip to content

RMaker_readme: Minor corrections #5175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions libraries/RainMaker/examples/RMakerCustom/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,29 @@
# ESP RainMaker Switch
# ESP RainMaker Custom Device

This example demonstrates how to build a switch device to be used with ESP RainMaker.
This example demonstrates how to build a custom device to be used with ESP RainMaker.

## What to expect in this example?

- This example sketch uses the on board Boot button and GPIO16 to demonstrate an ESP RainMaker switch device.
- This example sketch uses the on board Boot button and GPIO16 to demonstrate an ESP RainMaker AC dimmer device.
- After compiling and flashing the example, add your device using the [ESP RainMaker phone apps](https://rainmaker.espressif.com/docs/quick-links.html#phone-apps) by scanning the QR code.
- Toggling the state from the phone app will toggle the switch state (GPIO16).
- Pressing the Boot button will toggle the switch state (GPIO16) and the same will reflect on the phone app.
- Toggling the state from the phone app will toggle the dimmer state (GPIO16).
- Pressing the Boot button will toggle the dimmer state (GPIO16) and the same will reflect on the phone app.
- You can also change the Level from the phone app and see it reflect on the device as a print message.

### Output

```
[ 63][I][RMaker.cpp:13] event_handler(): RainMaker Initialised.
[ 69][I][WiFiProv.cpp:158] beginProvision(): Already Provisioned
[ 69][I][WiFiProv.cpp:162] beginProvision(): Attempting connect to AP: Viking007_2GEXT
[ 87][I][RMaker.cpp:13] event_handler(): RainMaker Initialised.
[ 94][I][WiFiProv.cpp:158] beginProvision(): Already Provisioned
[ 95][I][WiFiProv.cpp:162] beginProvision(): Attempting connect to AP: Viking007_2GEXT

Toggle State to false.
[ 8182][I][RMakerDevice.cpp:162] updateAndReportParam(): Device : Switch, Param Name : Power, Val : false
Received value = false for Dimmer - Power
Toggle State to true.
[ 9835][I][RMakerDevice.cpp:162] updateAndReportParam(): Device : Switch, Param Name : Power, Val : true
Received value = false for Switch - Power
Received value = true for Switch - Power
Toggle State to false.
[ 29937][I][RMakerDevice.cpp:162] updateAndReportParam(): Device : Switch, Param Name : Power, Val : false
[ 22532][I][RMakerDevice.cpp:162] updateAndReportParam(): Device : Dimmer, Param Name : Power, Val : true

Received value = 73 for Dimmer - Level
```

### Resetting the device
- Press and Hold the Boot button for more than 3 seconds and then release to reset Wi-Fi configuration.
- Press and Hold the Boot button for more than 10 seconds and then release to reset to factory defaults.
4 changes: 4 additions & 0 deletions libraries/RainMaker/examples/RMakerSwitch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,7 @@ Received value = true for Switch - Power
Toggle State to false.
[ 29937][I][RMakerDevice.cpp:162] updateAndReportParam(): Device : Switch, Param Name : Power, Val : false
```

### Resetting the device
- Press and Hold the Boot button for more than 3 seconds and then release to reset Wi-Fi configuration.
- Press and Hold the Boot button for more than 10 seconds and then release to reset to factory defaults.