Api.system.lpm.set()

LPWAN Modules / EVBs RAK3172
1

Hello,

In this example, I see this piece of code: api.system.lpm.set(1);

However, in the api description, I don’t see it documented.
What am I missing ?

Thanks

2

The documentation needs to be updated. It will be included soon.

3

Hello Bernd,

When you wrote “soon”, what kind of time reference did you have in mind ?

Thanks

4

Should have been in the last doc update (a few weeks ago), but seems it is still missing.

api.system.lpm.get();
  /**@par	Description
       *     	This api allows to get the low power mode
       *
       * @par	Syntax
       *	api.system.lpm.get()
       * @retval	1 for low power mode enabled
       * @retval	0 for low power mode disabled
       * @par         Example
       * @verbatim
     void setup()
     {
         Serial.begin(115200);

         Serial.printf("Set the low power mode %s\n\r", api.system.lpm.set(1) ? "Success" : "Fail");
     }

     void loop()
     {
         Serial.printf("The low power mode = %d\n\r", api.system.lpm.get());

         delay(1000);
     }

         @endverbatim
       */

api.system.lpm.set();
 /**@par	Description
       *     	This api allows to set the low power mode
       *
       * @par	Syntax
       *	api.system.lpm.set(value)
       *
       * @note	Only 0 or 1 is acceptable
       * @param	value	0 or 1
 * @return	bool
       * @retval	TRUE for setting low power mode success
       * @retval	FALSE for setting low power mode failure
       * @par         Example
       * @verbatim
     void setup()
     {
         Serial.begin(115200);

         Serial.printf("Set the low power mode %s\n\r", api.system.lpm.set(1) ? "Success" : "Fail");
     }

     void loop()
     {
         Serial.printf("The low power mode = %d\n\r", api.system.lpm.get());

         delay(1000);
     }

         @endverbatim
       */