nRF5 SDK for Mesh v5.0.0
app_light_lc.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 APP_LIGHT_LC_H__
39 #define APP_LIGHT_LC_H__
40 
41 #include <stdint.h>
42 
43 #include "app_light_lightness.h"
44 #include "light_lc_setup_server.h"
45 #if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
46 #include "app_scene.h"
47 #endif
48 
87 #define APP_LIGHT_LC_SETUP_SERVER_DEF(_name, _force_segmented, _mic_size) \
88  APP_TIMER_DEF(_name ## _fsm_timer); \
89  APP_TIMER_DEF(_name ## _light_pi_timer); \
90  APP_TIMER_DEF(_name ## _sensor_delay_timer); \
91  static app_light_lc_setup_server_t _name = \
92  { \
93  .light_lc_setup_srv.settings.force_segmented = _force_segmented, \
94  .light_lc_setup_srv.settings.transmic_size = _mic_size, \
95  .light_lc_setup_srv.fsm_timer.p_timer_id = &_name ## _fsm_timer, \
96  .light_lc_setup_srv.light_pi_timer.p_timer_id = &_name ## _light_pi_timer, \
97  .light_lc_setup_srv.sensor_delay_timer.p_timer_id = &_name ## _sensor_delay_timer, \
98  };
99 
100 /* Forward declaration */
101 typedef struct __app_light_lc_setup_server_t app_light_lc_setup_server_t;
102 
105 {
107  light_lc_setup_server_t light_lc_setup_srv;
108 
110  app_light_lightness_setup_server_t * p_app_ll;
111 #if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
112 
114  app_scene_model_interface_t scene_if;
117  app_scene_setup_server_t * p_app_scene;
118 #endif
119 };
120 
140 uint32_t app_light_lc_model_init(app_light_lc_setup_server_t * p_app,
141  uint8_t element_index,
142  app_light_lightness_setup_server_t * p_app_ll);
143 
162 uint32_t app_light_lc_ponoff_binding(app_light_lc_setup_server_t * p_app, bool * p_lc_control);
163 
164 #if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
165 
177 uint32_t app_light_lc_scene_context_set(app_light_lc_setup_server_t * p_app,
178  app_scene_setup_server_t * p_app_scene);
179 #endif
180 
182 #endif /* APP_LIGHT_LC_H__*/
uint32_t app_light_lc_ponoff_binding(app_light_lc_setup_server_t *p_app, bool *p_lc_control)
Informs the model that the system is ready to have the powerup onoff bindings.
uint32_t app_light_lc_model_init(app_light_lc_setup_server_t *p_app, uint8_t element_index, app_light_lightness_setup_server_t *p_app_ll)
Initializes the behavioral module for the Light LC Setup Server model.
app_scene_model_interface_t scene_if
Internal variable.
Definition: app_light_lc.h:114
app_scene_setup_server_t * p_app_scene
Internal variable.
Definition: app_light_lc.h:117
uint32_t app_light_lc_scene_context_set(app_light_lc_setup_server_t *p_app, app_scene_setup_server_t *p_app_scene)
Sets the scene context.
light_lc_setup_server_t light_lc_setup_srv
LC setup server context.
Definition: app_light_lc.h:107
Application level structure holding the LC Setup server model context.
Definition: app_light_lc.h:104
app_light_lightness_setup_server_t * p_app_ll
Pointer to the light lightness app structure.
Definition: app_light_lc.h:110

Documentation feedback | Developer Zone | Subscribe | Updated