This model implements the message based interface required to set the Lightness value on the server. More...
Modules | |
| Light Lightness client model interface | |
| Persistence module for the Light Lightness Setup Server model related states | |
| This module provides APIs for handling persistence of the Light Lightness Setup Server model related states. | |
| Light Lightness Setup Server model interface | |
| This model extends Light Lightness server, Generic Level server, Generic PowerOnOff Setup server, Generic PowerOnOff server, Generic OnOff server, and Generic Default Transition Time server. | |
| Light Lightness model utility functions | |
Data Structures | |
| struct | light_lightness_set_params_t |
| Unpacked message structure typedefs are used for API interfaces and for implementing model code. More... | |
| struct | light_lightness_linear_set_params_t |
| Message format for the light_lightness Linear set message. More... | |
| struct | light_lightness_default_set_params_t |
| Message format for the light_lightness Default set message. More... | |
| struct | light_lightness_range_set_params_t |
| Message format for the light_lightness Range set message. More... | |
| struct | light_lightness_delta_set_params_t |
| Message format for the light_lightness delta set "message". More... | |
| struct | light_lightness_move_set_params_t |
| Message format for the light_lightness move set "message". More... | |
| struct | light_lightness_ponoff_set_params_t |
| Parameters for the Power OnOff Set message. More... | |
| struct | light_lightness_ponoff_status_params_t |
| Parameters for the Power OnOff Status message. More... | |
| struct | light_lightness_dtt_set_params_t |
| Parameters for the DTT Set message. More... | |
| struct | light_lightness_dtt_status_params_t |
| Parameters for the DTT Status message. More... | |
| struct | light_lightness_status_params_t |
| Parameters for the light_lightness Status message. More... | |
| struct | light_lightness_linear_status_params_t |
| Parameters for the light_lightness Linear Status message. More... | |
| struct | light_lightness_last_status_params_t |
| Parameters for the light_lightness Last Status message. More... | |
| struct | light_lightness_default_status_params_t |
| Parameters for the light_lightness Default Status message. More... | |
| struct | light_lightness_range_status_params_t |
| Parameters for the light_lightness Range Status message. More... | |
| struct | light_lightness_saved_values_t |
| Parameter format for code while booting - the stored values will be read and passed to the model to do the state binding and set the current lightness based on these stored values. More... | |
Macros | |
| #define | LIGHT_LIGHTNESS_COMPANY_ID 0xFFFF |
| Model Company ID. | |
| #define | LIGHT_LIGHTNESS_RANGE_MIN (1) |
| Minimum allowed value of the Light Lightness Range state defined in Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.2.5. | |
| #define | LIGHT_LIGHTNESS_LAST_MIN (1) |
| Minimum allowed value of the Light Lightness Last state defined in Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 6.1.2.3. | |
| #define | LIGHT_LIGHTNESS_DEFAULT_RANGE_MIN (0x1) |
| Defines minimum value for the Light Lightness Range state. More... | |
| #define | LIGHT_LIGHTNESS_DEFAULT_RANGE_MAX (0xFFFF) |
| Defines maximum value for the Light Lightness Range state. More... | |
| #define | LIGHT_LIGHTNESS_DEFAULT_ON_POWERUP (0x2) |
| Defines default value for the Generic OnPowerUp state. More... | |
| #define | LIGHT_LIGHTNESS_DEFAULT_LIGHTNESS_ACTUAL (0x0) |
| Defines default value for the Light Lightness Actual state. More... | |
| #define | LIGHT_LIGHTNESS_DEFAULT_LIGHTNESS_LAST (0xFFFF) |
| Defines default value for the Light Lightness Last state. More... | |
| #define | LIGHT_LIGHTNESS_DEFAULT_LIGHTNESS_DEFAULT (0x0) |
| Defines default value for the Light Lightness Default state. More... | |
| #define | LIGHT_LIGHTNESS_DEFAULT_DTT (0x0) |
| Defines default value for the Generic Default Transition Time state. | |
Detailed Description
This model implements the message based interface required to set the Lightness value on the server.
Server model itself is a stateless model. The state information resides in the user application.
Macro Definition Documentation
◆ LIGHT_LIGHTNESS_DEFAULT_RANGE_MIN
| #define LIGHT_LIGHTNESS_DEFAULT_RANGE_MIN (0x1) |
Defines minimum value for the Light Lightness Range state.
- Note
- Value less than LIGHT_LIGHTNESS_RANGE_MIN is prohibited.
Definition at line 73 of file light_lightness_common.h.
◆ LIGHT_LIGHTNESS_DEFAULT_RANGE_MAX
| #define LIGHT_LIGHTNESS_DEFAULT_RANGE_MAX (0xFFFF) |
Defines maximum value for the Light Lightness Range state.
- Note
- Value less than LIGHT_LIGHTNESS_RANGE_MIN is prohibited.
Definition at line 82 of file light_lightness_common.h.
◆ LIGHT_LIGHTNESS_DEFAULT_ON_POWERUP
| #define LIGHT_LIGHTNESS_DEFAULT_ON_POWERUP (0x2) |
Defines default value for the Generic OnPowerUp state.
See generic_on_powerup_values_t for the allowed values.
It affects the initial value of the lightness level after the first device boot-up. See light_lightness_ponoff_binding_setup for more details.
Definition at line 94 of file light_lightness_common.h.
◆ LIGHT_LIGHTNESS_DEFAULT_LIGHTNESS_ACTUAL
| #define LIGHT_LIGHTNESS_DEFAULT_LIGHTNESS_ACTUAL (0x0) |
Defines default value for the Light Lightness Actual state.
It affects the initial value of the lightness level after the first device boot-up. See light_lightness_ponoff_binding_setup for more details.
Definition at line 104 of file light_lightness_common.h.
◆ LIGHT_LIGHTNESS_DEFAULT_LIGHTNESS_LAST
| #define LIGHT_LIGHTNESS_DEFAULT_LIGHTNESS_LAST (0xFFFF) |
Defines default value for the Light Lightness Last state.
- Note
- Value less than LIGHT_LIGHTNESS_LAST_MIN is prohibited.
It affects the initial value of the lightness level after the first device boot-up. See light_lightness_ponoff_binding_setup for more details.
Definition at line 116 of file light_lightness_common.h.
◆ LIGHT_LIGHTNESS_DEFAULT_LIGHTNESS_DEFAULT
| #define LIGHT_LIGHTNESS_DEFAULT_LIGHTNESS_DEFAULT (0x0) |
Defines default value for the Light Lightness Default state.
It affects the initial value of the lightness level after the first device boot-up. See light_lightness_ponoff_binding_setup for more details.
Definition at line 126 of file light_lightness_common.h.
Enumeration Type Documentation
◆ light_lightness_range_status_t
Status values for light_lightness_range_status_params_t.
Definition at line 137 of file light_lightness_common.h.