nRF5 SDK for Mesh v5.0.0
light_ctl_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_CTL_MC_H__
39 #define LIGHT_CTL_MC_H__
40 
41 #include <stdint.h>
42 #include "light_ctl_common.h"
43 #include "mesh_config.h"
44 #include "mesh_opt.h"
45 #include "model_config_file.h"
46 
47 #if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
48 #include "scene_common.h"
49 #endif
50 
64 #if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
65 #define LIGHT_CTL_SETUP_SERVER_STORED_WITH_SCENE_STATES \
66  (LIGHT_CTL_SETUP_SERVER_INSTANCES_MAX + (SCENE_REGISTER_ARRAY_SIZE * LIGHT_CTL_SETUP_SERVER_INSTANCES_MAX))
67 #else
68 #define LIGHT_CTL_SETUP_SERVER_STORED_WITH_SCENE_STATES \
69  (LIGHT_CTL_SETUP_SERVER_INSTANCES_MAX)
70 #endif
71 
72 #define LIGHT_CTL_TEMPERATURE_EID_START (MESH_APP_MODEL_LIGHT_CTL_SERVER_ID_START)
73 #define LIGHT_CTL_TEMPERATURE_EID_END (LIGHT_CTL_TEMPERATURE_EID_START + LIGHT_CTL_SETUP_SERVER_STORED_WITH_SCENE_STATES - 1)
74 #define LIGHT_CTL_DELTA_UV_EID_START (LIGHT_CTL_TEMPERATURE_EID_END + 1)
75 #define LIGHT_CTL_DELTA_UV_EID_END (LIGHT_CTL_DELTA_UV_EID_START + LIGHT_CTL_SETUP_SERVER_STORED_WITH_SCENE_STATES - 1)
76 #define LIGHT_CTL_TEMPERATURE_DEFAULT_EID_START (LIGHT_CTL_DELTA_UV_EID_END + 1)
77 #define LIGHT_CTL_DEFAULT_TEMPERATURE_EID_END (LIGHT_CTL_TEMPERATURE_DEFAULT_EID_START + LIGHT_CTL_SETUP_SERVER_INSTANCES_MAX - 1)
78 #define LIGHT_CTL_DELTA_UV_DEFAULT_EID_START (LIGHT_CTL_DEFAULT_TEMPERATURE_EID_END + 1)
79 #define LIGHT_CTL_DELTA_UV_DEFAULT_EID_END (LIGHT_CTL_DELTA_UV_DEFAULT_EID_START + LIGHT_CTL_SETUP_SERVER_INSTANCES_MAX - 1)
80 #define LIGHT_CTL_TEMPERATURE_RANGE_EID_START (LIGHT_CTL_DELTA_UV_DEFAULT_EID_END + 1)
81 #define LIGHT_CTL_TEMPERATURE_RANGE_EID_END (LIGHT_CTL_TEMPERATURE_RANGE_EID_START + LIGHT_CTL_SETUP_SERVER_INSTANCES_MAX - 1)
82 
84 #define LIGHT_CTL_TEMPERATURE_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_CTL_TEMPERATURE_EID_START)
85 
87 #define LIGHT_CTL_DELTA_UV_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_CTL_DELTA_UV_EID_START)
88 
90 #define LIGHT_CTL_TEMPERATURE_DEFAULT_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_CTL_TEMPERATURE_DEFAULT_EID_START)
91 
93 #define LIGHT_CTL_DELTA_UV_DEFAULT_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_CTL_DELTA_UV_DEFAULT_EID_START)
94 
96 #define LIGHT_CTL_TEMPERATURE_RANGE_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_CTL_TEMPERATURE_RANGE_EID_START)
97 
98 
108 uint32_t light_ctl_mc_temperature32_state_set(uint8_t index, uint32_t value);
109 
120 uint32_t light_ctl_mc_temperature32_state_get(uint8_t index, uint32_t * p_value);
121 
131 uint32_t light_ctl_mc_delta_uv_state_set(uint8_t index, int16_t value);
132 
143 uint32_t light_ctl_mc_delta_uv_state_get(uint8_t index, int16_t * p_value);
144 
154 uint32_t light_ctl_mc_default_temperature32_state_set(uint8_t index, uint32_t value);
155 
166 uint32_t light_ctl_mc_default_temperature32_state_get(uint8_t index, uint32_t * p_value);
167 
177 uint32_t light_ctl_mc_default_delta_uv_state_set(uint8_t index, int16_t value);
178 
189 uint32_t light_ctl_mc_default_delta_uv_state_get(uint8_t index, int16_t * p_value);
190 
201 
213 
214 #if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
215 
227 uint32_t light_ctl_mc_scene_temperature32_state_store(uint8_t index, uint8_t scene_index, uint32_t value);
228 
241 uint32_t light_ctl_mc_scene_temperature32_state_recall(uint8_t index, uint8_t scene_index, uint32_t * p_value);
242 
254 uint32_t light_ctl_mc_scene_delta_uv_state_store(uint8_t index, uint8_t scene_index, int16_t value);
255 
268 uint32_t light_ctl_mc_scene_delta_uv_state_recall(uint8_t index, uint8_t scene_index, int16_t * p_value);
269 
270 #endif /* (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN) */
271 
282 uint32_t light_ctl_mc_open(uint8_t * p_handle);
283 
287 void light_ctl_mc_clear(void);
288 
292 void light_ctl_mc_init(void);
293 
295 #endif /* LIGHT_CTL_MC_H__ */
uint32_t light_ctl_mc_scene_temperature32_state_recall(uint8_t index, uint8_t scene_index, uint32_t *p_value)
Recalls internal Light CTL Temperature32 state variable for a specific scene index.
uint32_t light_ctl_mc_open(uint8_t *p_handle)
Create an instance of the Light CTL Setup Server model states and return the corresponding handle...
uint32_t light_ctl_mc_scene_temperature32_state_store(uint8_t index, uint8_t scene_index, uint32_t value)
Stores internal Light CTL Temperature32 state variable for a specific scene index.
void light_ctl_mc_init(void)
Initialize the Light CTL Setup Server persistent memory.
uint32_t light_ctl_mc_scene_delta_uv_state_store(uint8_t index, uint8_t scene_index, int16_t value)
Stores internal Light CTL Delta UV state variable for a specific scene index.
uint32_t light_ctl_mc_default_temperature32_state_set(uint8_t index, uint32_t value)
Set internal Light CTL Temperature32 Default state variable.
uint32_t light_ctl_mc_delta_uv_state_set(uint8_t index, int16_t value)
Set internal Light CTL Delta UV state variable.
uint32_t light_ctl_mc_delta_uv_state_get(uint8_t index, int16_t *p_value)
Get internal Light CTL Delta UV state variable.
uint32_t light_ctl_mc_scene_delta_uv_state_recall(uint8_t index, uint8_t scene_index, int16_t *p_value)
Recalls internal Light CTL Delta UV state variable for a specific scene index.
uint32_t light_ctl_mc_default_temperature32_state_get(uint8_t index, uint32_t *p_value)
Get internal Light CTL Temperature32 Default state variable.
uint32_t light_ctl_mc_default_delta_uv_state_get(uint8_t index, int16_t *p_value)
Get internal Light CTL Delta UV Default state variable.
uint32_t light_ctl_mc_temperature32_state_set(uint8_t index, uint32_t value)
Set internal Light CTL Temperature32 state variable.
void light_ctl_mc_clear(void)
Clear all stored data and reset state contexts to default values.
uint32_t light_ctl_mc_temperature32_state_get(uint8_t index, uint32_t *p_value)
Get internal Light CTL Temperature32 state variable.
uint32_t light_ctl_mc_temperature32_range_state_get(uint8_t index, light_ctl_temperature_range_set_params_t *p_value)
Get internal Range Status state variable.
Message format for the CTL Temperature Range Set message.
uint32_t light_ctl_mc_default_delta_uv_state_set(uint8_t index, int16_t value)
Set internal Light CTL Delta UV Default state variable.
uint32_t light_ctl_mc_temperature32_range_state_set(uint8_t index, light_ctl_temperature_range_set_params_t *p_value)
Set internal Range state variable.

Documentation feedback | Developer Zone | Subscribe | Updated