Skip to content

Commit cc9d6a4

Browse files
committed
Added enableScenes API documentation
1 parent 3097859 commit cc9d6a4

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

Diff for: docs/source/api/rainmaker.rst

+15-4
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ ESP RainMaker is an end-to-end solution offered by Espressif to enable remote co
1313
- RainMaker library (i.e. this library, to develop the firmware)
1414
- RainMaker Cloud (backend, offering remote connectivity)
1515
- RainMaker Phone App/CLI (Client utilities for remote access)
16-
1716
The key features of ESP RainMaker are:
1817

1918
1. Ability to define own devices and parameters, of any type, in the firmware.
@@ -22,9 +21,6 @@ The key features of ESP RainMaker are:
2221

2322
Additional information about ESP RainMaker can be found `here <https://rainmaker.espressif.com/>`__.
2423

25-
#########################
26-
Arduino ESP Rainmaker API
27-
#########################
2824

2925
ESP RainMaker Agent API
3026
-----------------------
@@ -127,6 +123,21 @@ This function will return
127123
1. `ESP_OK` : On success
128124
2. Error in case of failure
129125

126+
RMaker.enableScenes
127+
*****************
128+
129+
This API enables the Scenes service for the node. It should be called after `RMaker.initNode()` and before `RMaker.start()`.
130+
For more information, check `here <https://rainmaker.espressif.com/docs/scenes.html>`__.
131+
132+
.. code-block:: arduino
133+
134+
esp_err_t enableScenes()
135+
136+
This function will return
137+
138+
1. `ESP_OK` : On success
139+
2. Error in case of failure
140+
130141
RMaker.setTimeZone
131142
******************
132143

0 commit comments

Comments
 (0)