From 15f8853819272f3d9d975060409a4e2b5042f55d Mon Sep 17 00:00:00 2001 From: Piyush Shah <8659527+shahpiyushv@users.noreply.github.com> Date: Tue, 18 May 2021 16:01:29 +0530 Subject: [PATCH] RMaker_readme: Minor corrections (#5175) --- .../RainMaker/examples/RMakerCustom/README.md | 32 ++++++++++--------- .../RainMaker/examples/RMakerSwitch/README.md | 4 +++ 2 files changed, 21 insertions(+), 15 deletions(-) diff --git a/libraries/RainMaker/examples/RMakerCustom/README.md b/libraries/RainMaker/examples/RMakerCustom/README.md index 62a5017e..42c998d4 100644 --- a/libraries/RainMaker/examples/RMakerCustom/README.md +++ b/libraries/RainMaker/examples/RMakerCustom/README.md @@ -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. diff --git a/libraries/RainMaker/examples/RMakerSwitch/README.md b/libraries/RainMaker/examples/RMakerSwitch/README.md index 62a5017e..55b5ab1e 100644 --- a/libraries/RainMaker/examples/RMakerSwitch/README.md +++ b/libraries/RainMaker/examples/RMakerSwitch/README.md @@ -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.