timer

Functions
bool	create (RAK_TIMER_ID id, RAK_TIMER_HANDLER handler, RAK_TIMER_MODE mode)
bool	start (RAK_TIMER_ID id, uint32_t ms, void *data)
bool	stop (RAK_TIMER_ID id)

Detailed Description

Function Documentation

create()

bool create	(	RAK_TIMER_ID	id,
		RAK_TIMER_HANDLER	handler,
		RAK_TIMER_MODE	mode
	)

Description

Create a timer.

Syntax

api.system.timer.create(id, handler, mode)

Parameters

id	the timer ID
handler	the handler function for this timer
mode	the mode of this timer

Returns

bool

Return values

TRUE	for creating timer successfully
FALSE	for creating timer failure

Example

     void handler(void *data)
     {
       Serial.printf("[%lu]This is the handler\r\n", millis());
     }
     void setup()
     {
       Serial.begin(115200);

       if (api.system.timer.create(RAK_TIMER_0, (RAK_TIMER_HANDLER)handler, RAK_TIMER_PERIODIC) != true) {
         Serial.printf("Creating timer failed.\r\n");
       } else if (api.system.timer.start(RAK_TIMER_0, 1000, NULL) != true) {
         Serial.printf("Starting timer failed.\r\n");
       }
     }
     void loop()
     {
     }

start()

bool start	(	RAK_TIMER_ID	id,
		uint32_t	ms,
		void *	data
	)

Description

Start a timer.

Syntax

api.system.timer.start(id, ms, data)

Parameters

id	the timer ID
ms	the period of timer
data	the data passed to timer handler function

Returns

bool

Return values

TRUE	for starting timer successfully
FALSE	for starting timer failure

Example

     void handler(void *data)
     {
       Serial.printf("[%lu]This is the handler\r\n", millis());
     }
     void setup()
     {
       Serial.begin(115200);

       if (api.system.timer.create(RAK_TIMER_0, (RAK_TIMER_HANDLER)handler, RAK_TIMER_PERIODIC) != true) {
         Serial.printf("Creating timer failed.\r\n");
       } else if (api.system.timer.start(RAK_TIMER_0, 1000, NULL) != true) {
         Serial.printf("Starting timer failed.\r\n");
       }
     }
     void loop()
     {
     }

stop()

bool stop

(

RAK_TIMER_ID

id

)

Description

Stop a timer.

Syntax

api.system.timer.stop(id)

Parameters

id	the timer ID

Returns

bool

Return values

TRUE	for stoping timer successfully
FALSE	for stoping timer failure

Example

     void handler(void *data)
     {
       Serial.printf("[%lu]This is the handler\r\n", millis());
     }
     void setup()
     {
       Serial.begin(115200);

       if (api.system.timer.create(RAK_TIMER_0, (RAK_TIMER_HANDLER)handler, RAK_TIMER_PERIODIC) != true) {
         Serial.printf("Creating timer failed.\r\n");
       } else if (api.system.timer.start(RAK_TIMER_0, 1000, NULL) != true) {
         Serial.printf("Starting timer failed.\r\n");
       }
     }
     void loop()
     {
       if (millis() > 60000) {
         if (api.system.timer.stop(RAK_TIMER_0) != true) {
           Serial.printf("Stoping timer failed.\r\n");
         }
       }
     }