nRF5 SDK for Mesh v4.2.0
light_lightness_mc.h
1 /* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without modification,
5  * are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form, except as embedded into a Nordic
11  * Semiconductor ASA integrated circuit in a product or a software update for
12  * such product, must reproduce the above copyright notice, this list of
13  * conditions and the following disclaimer in the documentation and/or other
14  * materials provided with the distribution.
15  *
16  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
17  * contributors may be used to endorse or promote products derived from this
18  * software without specific prior written permission.
19  *
20  * 4. This software, with or without modification, must only be used with a
21  * Nordic Semiconductor ASA integrated circuit.
22  *
23  * 5. Any software provided in binary form under this license must not be reverse
24  * engineered, decompiled, modified and/or disassembled.
25  *
26  * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
27  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28  * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
29  * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
30  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
32  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
35  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef LIGHT_LIGHTNESS_MC_H__
39 #define LIGHT_LIGHTNESS_MC_H__
40 
41 #include <stdint.h>
42 
43 #include "light_lightness_common.h"
44 #include "mesh_config.h"
45 #include "mesh_opt.h"
46 
56 #define LIGHT_LIGHTNESS_ONPOWERUP_EID_START (MESH_APP_MODEL_LIGHT_LIGHTNESS_ID_START + (1 * LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX))
57 #define LIGHT_LIGHTNESS_LAST_EID_START (MESH_APP_MODEL_LIGHT_LIGHTNESS_ID_START + (2 * LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX))
58 #define LIGHT_LIGHTNESS_DEFAULT_EID_START (MESH_APP_MODEL_LIGHT_LIGHTNESS_ID_START + (3 * LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX))
59 #define LIGHT_LIGHTNESS_RANGE_MIN_EID_START (MESH_APP_MODEL_LIGHT_LIGHTNESS_ID_START + (4 * LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX))
60 #define LIGHT_LIGHTNESS_RANGE_MAX_EID_START (MESH_APP_MODEL_LIGHT_LIGHTNESS_ID_START + (5 * LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX))
61 #define LIGHT_LIGHTNESS_RANGE_STATUS_EID_START (MESH_APP_MODEL_LIGHT_LIGHTNESS_ID_START + (6 * LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX))
62 #define LIGHT_LIGHTNESS_ACTUAL_EID_START (MESH_APP_MODEL_LIGHT_LIGHTNESS_ID_START + (7 * LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX))
63 #define LIGHT_LIGHTNESS_DTT_EID_START (MESH_APP_MODEL_LIGHT_LIGHTNESS_ID_START + (8 * LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX))
64 
66 #define LIGHT_LIGHTNESS_ONPOWERUP_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_ONPOWERUP_EID_START)
67 
69 #define LIGHT_LIGHTNESS_LAST_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_LAST_EID_START)
70 
72 #define LIGHT_LIGHTNESS_DEFAULT_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_DEFAULT_EID_START)
73 
75 #define LIGHT_LIGHTNESS_RANGE_MIN_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_RANGE_MIN_EID_START)
76 
78 #define LIGHT_LIGHTNESS_RANGE_MAX_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_RANGE_MAX_EID_START)
79 
81 #define LIGHT_LIGHTNESS_RANGE_STATUS_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_RANGE_STATUS_EID_START)
82 
84 #define LIGHT_LIGHTNESS_ACTUAL_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_ACTUAL_EID_START)
85 
87 #define LIGHT_LIGHTNESS_DTT_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_DTT_EID_START)
88 
90 typedef enum
91 {
99 
109 uint32_t light_lightness_mc_onpowerup_state_set(uint8_t index, uint8_t value);
110 
121 uint32_t light_lightness_mc_onpowerup_state_get(uint8_t index, uint8_t * p_value);
122 
123 
134 uint32_t light_lightness_mc_last_state_set(uint8_t index, uint16_t value, light_lightness_mc_write_destination_t write_to);
135 
149 uint32_t light_lightness_mc_last_state_get(uint8_t index, uint16_t * p_value);
150 
151 
161 uint32_t light_lightness_mc_default_state_set(uint8_t index, uint16_t value);
162 
173 uint32_t light_lightness_mc_default_state_get(uint8_t index, uint16_t * p_value);
174 
175 
189 uint32_t light_lightness_mc_range_status_state_set(uint8_t index, uint8_t value);
190 
201 uint32_t light_lightness_mc_range_status_state_get(uint8_t index, uint8_t * p_value);
202 
203 
213 uint32_t light_lightness_mc_range_min_state_set(uint8_t index, uint16_t value);
214 
225 uint32_t light_lightness_mc_range_min_state_get(uint8_t index, uint16_t * p_value);
226 
227 
237 uint32_t light_lightness_mc_range_max_state_set(uint8_t index, uint16_t value);
238 
249 uint32_t light_lightness_mc_range_max_state_get(uint8_t index, uint16_t * p_value);
250 
251 
261 uint32_t light_lightness_mc_actual_state_set(uint8_t index, uint16_t value);
262 
273 uint32_t light_lightness_mc_actual_state_get(uint8_t index, uint16_t * p_value);
274 
275 
285 uint32_t light_lightness_mc_dtt_state_set(uint8_t index, uint32_t value);
286 
297 uint32_t light_lightness_mc_dtt_state_get(uint8_t index, uint32_t * p_value);
298 
309 uint32_t light_lightness_mc_open(uint8_t * p_handle);
310 
314 void light_lightness_mc_clear(void);
315 
319 void light_lightness_mc_init(void);
320 
323 #endif /* LIGHT_LIGHTNESS_MC_H__ */
uint32_t light_lightness_mc_range_min_state_set(uint8_t index, uint16_t value)
Set internal Light Lightness Range Min state variable.
uint32_t light_lightness_mc_default_state_get(uint8_t index, uint16_t *p_value)
Get internal Light Lightness Default state variable.
uint32_t light_lightness_mc_last_state_set(uint8_t index, uint16_t value, light_lightness_mc_write_destination_t write_to)
Set internal Light Lightness Last state variable.
The value is only stored to flash.
uint32_t light_lightness_mc_default_state_set(uint8_t index, uint16_t value)
Set internal Light Lightness Default state variable.
The value is stored to flash and RAM.
uint32_t light_lightness_mc_range_status_state_get(uint8_t index, uint8_t *p_value)
Get internal Range Status state variable.
uint32_t light_lightness_mc_range_status_state_set(uint8_t index, uint8_t value)
Set internal Range Status state variable.
uint32_t light_lightness_mc_dtt_state_get(uint8_t index, uint32_t *p_value)
Get internal Default Transition Time state variable.
uint32_t light_lightness_mc_range_max_state_get(uint8_t index, uint16_t *p_value)
Get internal Light Lightness Range Max state variable.
uint32_t light_lightness_mc_open(uint8_t *p_handle)
Create an instance of the Light Lightness Setup Server model states and return the corresponding hand...
uint32_t light_lightness_mc_actual_state_get(uint8_t index, uint16_t *p_value)
Get internal Light Lightness Actual state variable.
uint32_t light_lightness_mc_onpowerup_state_get(uint8_t index, uint8_t *p_value)
Get internal Generic OnPowerUp state variable.
uint32_t light_lightness_mc_range_min_state_get(uint8_t index, uint16_t *p_value)
Get internal Light Lightness Range Min state variable.
void light_lightness_mc_init(void)
Initialize the Light Lightness Setup Server persistent memory.
uint32_t light_lightness_mc_actual_state_set(uint8_t index, uint16_t value)
Set internal Light Lightness Actual state variable.
void light_lightness_mc_clear(void)
Clear all stored data and reset state contexts to default values.
uint32_t light_lightness_mc_dtt_state_set(uint8_t index, uint32_t value)
Set internal Default Transition Time state variable.
uint32_t light_lightness_mc_onpowerup_state_set(uint8_t index, uint8_t value)
Set internal Generic OnPowerUp state variable.
uint32_t light_lightness_mc_range_max_state_set(uint8_t index, uint16_t value)
Set internal Light Lightness Range Max state variable.
light_lightness_mc_write_destination_t
Destination to write the value into.
uint32_t light_lightness_mc_last_state_get(uint8_t index, uint16_t *p_value)
Get internal Light Lightness Last state variable.

Documentation feedback | Developer Zone | Subscribe | Updated