Skip to content

Commit 15f8853

Browse files
authored
RMaker_readme: Minor corrections (#5175)
1 parent 7856de7 commit 15f8853

File tree

2 files changed

+21
-15
lines changed

2 files changed

+21
-15
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
1-
# ESP RainMaker Switch
1+
# ESP RainMaker Custom Device
22

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

55
## What to expect in this example?
66

7-
- This example sketch uses the on board Boot button and GPIO16 to demonstrate an ESP RainMaker switch device.
7+
- This example sketch uses the on board Boot button and GPIO16 to demonstrate an ESP RainMaker AC dimmer device.
88
- 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.
9-
- Toggling the state from the phone app will toggle the switch state (GPIO16).
10-
- Pressing the Boot button will toggle the switch state (GPIO16) and the same will reflect on the phone app.
9+
- Toggling the state from the phone app will toggle the dimmer state (GPIO16).
10+
- Pressing the Boot button will toggle the dimmer state (GPIO16) and the same will reflect on the phone app.
11+
- You can also change the Level from the phone app and see it reflect on the device as a print message.
1112

1213
### Output
1314

1415
```
15-
[ 63][I][RMaker.cpp:13] event_handler(): RainMaker Initialised.
16-
[ 69][I][WiFiProv.cpp:158] beginProvision(): Already Provisioned
17-
[ 69][I][WiFiProv.cpp:162] beginProvision(): Attempting connect to AP: Viking007_2GEXT
16+
[ 87][I][RMaker.cpp:13] event_handler(): RainMaker Initialised.
17+
[ 94][I][WiFiProv.cpp:158] beginProvision(): Already Provisioned
18+
[ 95][I][WiFiProv.cpp:162] beginProvision(): Attempting connect to AP: Viking007_2GEXT
1819
19-
Toggle State to false.
20-
[ 8182][I][RMakerDevice.cpp:162] updateAndReportParam(): Device : Switch, Param Name : Power, Val : false
20+
Received value = false for Dimmer - Power
2121
Toggle State to true.
22-
[ 9835][I][RMakerDevice.cpp:162] updateAndReportParam(): Device : Switch, Param Name : Power, Val : true
23-
Received value = false for Switch - Power
24-
Received value = true for Switch - Power
25-
Toggle State to false.
26-
[ 29937][I][RMakerDevice.cpp:162] updateAndReportParam(): Device : Switch, Param Name : Power, Val : false
22+
[ 22532][I][RMakerDevice.cpp:162] updateAndReportParam(): Device : Dimmer, Param Name : Power, Val : true
23+
24+
Received value = 73 for Dimmer - Level
2725
```
26+
27+
### Resetting the device
28+
- Press and Hold the Boot button for more than 3 seconds and then release to reset Wi-Fi configuration.
29+
- Press and Hold the Boot button for more than 10 seconds and then release to reset to factory defaults.

libraries/RainMaker/examples/RMakerSwitch/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,7 @@ Received value = true for Switch - Power
2525
Toggle State to false.
2626
[ 29937][I][RMakerDevice.cpp:162] updateAndReportParam(): Device : Switch, Param Name : Power, Val : false
2727
```
28+
29+
### Resetting the device
30+
- Press and Hold the Boot button for more than 3 seconds and then release to reset Wi-Fi configuration.
31+
- Press and Hold the Boot button for more than 10 seconds and then release to reset to factory defaults.

0 commit comments

Comments
 (0)