nRF5 SDK for Mesh v4.1.0
Generic Power OnOff model

Modules

 Generic Power OnOff client model interface
 
 Generic Power OnOff Setup server model interface
 

Data Structures

struct  generic_ponoff_set_params_t
 Unpacked message structure typedefs are used for API interfaces and for implementing model code. More...
 
struct  generic_ponoff_status_params_t
 Parameters for the Power OnOff Status message. More...
 

Macros

#define GENERIC_PONOFF_COMPANY_ID   0xFFFF
 Model Company ID.
 
#define GENERIC_ON_POWERUP_MAX   (0x02)
 Maximum value of the OnPowerUp state, as defined in Mesh Model Specification (MshMDLv1.0.1)
 

Enumerations

enum  generic_on_powerup_values_t { GENERIC_ON_POWERUP_OFF = 0, GENERIC_ON_POWERUP_DEFAULT, GENERIC_ON_POWERUP_RESTORE }
 Valid values of OnPowerUp state. More...
 

Detailed Description

This model implements the message based interface required to set the Power OnOff value on the server. Server model itself is a stateless model. The state information resides in the user application.

Enumeration Type Documentation

◆ generic_on_powerup_values_t

Valid values of OnPowerUp state.

Enumerator
GENERIC_ON_POWERUP_OFF 

After being powered up, the element is in an off state.

GENERIC_ON_POWERUP_DEFAULT 

After being powered up, the element is in an On state and uses default state values.

GENERIC_ON_POWERUP_RESTORE 

If a transition was in progress when powered down, the element restores the target state when powered up.

Otherwise the element restores the state it was in when powered down.

Definition at line 59 of file generic_ponoff_common.h.