Api_system_shutdown

Data Structures

struct  gos_shutdown_options_t
 

Functions

gos_result_t gos_shutdown (const gos_shutdown_options_t *options)
 Put module into shutdown mode. More...
 

Detailed Description

Function Documentation

◆ gos_shutdown()

gos_result_t gos_shutdown ( const gos_shutdown_options_t options)

Put module into shutdown mode.

In shutdown mode there is no RAM retention. Upon wakeup the device reboots into its reset state.

See Gecko OS Command API documentation: shutdown.

Note
Leave the options argument NULL to use the configured Gecko OS settings
Parameters
[in]optionsOptions for how the device should wakeup, see gos_shutdown_options_t, leave NULL to use configured Gecko OS settings
Returns
gos_result_t result of API