Commit c6b850b

authored

Rainmaker: Added enableSystemService API (#7875)

* Rainmaker: Added enableSystemService API * Fixed broken links in espnow docs

1 parent 77e7fa5 commit c6b850bCopy full SHA for c6b850b

File tree

+38

-2

lines changed

+38

-2

lines changed

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -13,13 +13,13 @@ Examples`
`13`	`13`	`ESP-NOW Master`
`14`	`14`	`**************`
`15`	`15`
`16`		`-.. literalinclude:: ../../../libraries/ESP32/examples/ESPNow/Basic/Master/Master.ino`
	`16`	`+.. literalinclude:: ../../../libraries/ESP32/examples/ESPNow/ESPNow_Basic_Master/ESPNow_Basic_Master.ino`
`17`	`17`	`:language: arduino`
`18`	`18`
`19`	`19`	`ESP-NOW Slave`
`20`	`20`	`*************`
`21`	`21`
`22`		`-.. literalinclude:: ../../../libraries/ESP32/examples/ESPNow/Basic/Slave/Slave.ino`
	`22`	`+.. literalinclude:: ../../../libraries/ESP32/examples/ESPNow/ESPNow_Basic_Slave/ESPNow_Basic_Slave.ino`
`23`	`23`	`:language: arduino`
`24`	`24`
`25`	`25`	`Resources`

Lines changed: 20 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -139,6 +139,26 @@ This function will return`
`139`	`139`	1. `ESP_OK` : On success
`140`	`140`	`2. Error in case of failure`
`141`	`141`
	`142`	`+RMaker.enableSystemService`
	`143`	`+**************************`
	`144`	`+`
	`145`	+This API enables the System service for the node. It should be called after `RMaker.initNode()` and before `RMaker.start()`.
	`146`	+For more information, check `here <https://rainmaker.espressif.com/docs/sys-service.html>`__.
	`147`	`+`
	`148`	`+.. code-block:: arduino`
	`149`	`+`
	`150`	`+ esp_err_t enableSystemService(uint16_t flags, int8_t reboot_seconds, int8_t reset_seconds, int8_t reset_reboot_seconds)`
	`151`	`+`
	`152`	+* ``flags`` : Logical OR of system service flags (SYSTEM_SERV_FLAG_REBOOT, SYSTEM_SERV_FLAG_FACTORY_RESET, SYSTEM_SERV_FLAG_WIFI_RESET) as required or SYSTEM_SERV_FLAGS_ALL.
	`153`	+* ``reboot_seconds`` Time in seconds after which the device should reboot. Recommended value: 2
	`154`	+* ``reset_seconds`` Time in seconds after which the device should reset(Wi-Fi or Factory). Recommended value: 2
	`155`	+* ``reset_reboot_seconds`` Time in seconds after which the device should reboot after it has been reset. Zero as a value would mean there won't be any reboot after the reset. Recommended value: 2
	`156`	`+`
	`157`	`+This function will return`
	`158`	`+`
	`159`	+1. `ESP_OK` : On success
	`160`	`+2. Error in case of failure`
	`161`	`+`
`142`	`162`	`RMaker.setTimeZone`
`143`	`163`	`******************`
`144`	`164`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -99,6 +99,8 @@ void setup()`
`99`	`99`
`100`	`100`	`RMaker.enableScenes();`
`101`	`101`
	`102`	`+ RMaker.enableSystemService(SYSTEM_SERV_FLAGS_ALL, 2, 2, 2);`
	`103`	`+`
`102`	`104`	`RMaker.start();`
`103`	`105`
`104`	`106`	`WiFi.onEvent(sysProvEvent);`

Lines changed: 13 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -155,5 +155,18 @@ esp_err_t RMakerClass::enableScenes()`
`155`	`155`	`}`
`156`	`156`	`return err;`
`157`	`157`	`}`
	`158`	`+`
	`159`	`+esp_err_t RMakerClass::enableSystemService(uint16_t flags, int8_t reboot_seconds, int8_t reset_seconds, int8_t reset_reboot_seconds)`
	`160`	`+{`
	`161`	`+ esp_rmaker_system_serv_config_t config = {`
	`162`	`+ .flags = flags,`
	`163`	`+ .reboot_seconds = reboot_seconds,`
	`164`	`+ .reset_seconds = reset_seconds,`
	`165`	`+ .reset_reboot_seconds = reset_reboot_seconds`
	`166`	`+ };`
	`167`	`+ err = esp_rmaker_system_service_enable(&config);`
	`168`	`+ return err;`
	`169`	`+}`
	`170`	`+`
`158`	`171`	`RMakerClass RMaker;`
`159`	`172`	`#endif`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ class RMakerClass`
`36`	`36`	`esp_err_t enableTZService();`
`37`	`37`	`esp_err_t enableOTA(ota_type_t type, const char *cert = ESP_RMAKER_OTA_DEFAULT_SERVER_CERT);`
`38`	`38`	`esp_err_t enableScenes();`
	`39`	`+ esp_err_t enableSystemService(uint16_t flags, int8_t reboot_seconds = 2, int8_t reset_seconds = 2, int8_t reset_reboot_seconds = 2);`
`39`	`40`	`esp_err_t start();`
`40`	`41`	`esp_err_t stop();`
`41`	`42`	`};`

Comments

(0)