light_lc_setup_server.h

/* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 * Semiconductor ASA integrated circuit in a product or a software update for
 * such product, must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 * Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 * engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef LIGHT_LC_SETUP_SERVER_H__
#define LIGHT_LC_SETUP_SERVER_H__

#include <stdint.h>
#include "access.h"
#include "model_common.h"
#include "fsm.h"

#include "generic_onoff_server.h"
#include "light_lc_common.h"
#include "timer_scheduler.h"

#define LIGHT_LC_SERVER_MODEL_ID 0x130F

#define LIGHT_LC_SETUP_SERVER_MODEL_ID 0x1310

/* Forward declaration */
typedef struct __light_lc_server_t light_lc_server_t;

/* Forward declaration */
typedef struct __light_lc_setup_server_t light_lc_setup_server_t;

typedef void (*light_lc_persist_state_set_cb_t)(const light_lc_setup_server_t * p_s_server,
 const light_lc_state_t lc_state,
 const void *p_set_value);

typedef void (*light_lc_persist_state_get_cb_t)(const light_lc_setup_server_t * p_s_server,
 const light_lc_state_t lc_state,
 void * p_get_value);

typedef void (*light_lc_actual_set_cb_t)(const light_lc_setup_server_t * p_s_server,
 uint16_t actual_lightness);

typedef void (*light_lc_actual_get_cb_t)(const light_lc_setup_server_t * p_s_server,
 uint16_t * p_actual_lightness);

typedef struct
{
 light_lc_persist_state_set_cb_t light_lc_persist_set_cb;
 light_lc_persist_state_get_cb_t light_lc_persist_get_cb;
 light_lc_actual_set_cb_t light_lc_actual_set_cb;
 light_lc_actual_get_cb_t light_lc_actual_get_cb;
} light_lc_setup_server_state_cbs_t;

typedef struct
{
 uint8_t element_index;
 bool force_segmented;
 nrf_mesh_transmic_size_t transmic_size;

} light_lc_server_settings_t;

struct __light_lc_server_t
{
 access_model_handle_t model_handle;

 tid_tracker_t tid_tracker;

 generic_onoff_server_t generic_onoff_srv;

 light_lc_server_settings_t settings;
};


uint32_t light_lc_server_mode_status_publish(const light_lc_server_t * p_server,
 const light_lc_mode_status_params_t * p_params);

uint32_t light_lc_server_occ_mode_status_publish(light_lc_server_t * p_server,
 const light_lc_occupancy_mode_status_params_t * p_params);

uint32_t light_lc_server_light_onoff_status_publish(light_lc_server_t * p_server,
 const light_lc_light_onoff_status_params_t * p_params);

typedef struct
{
 light_lc_setup_server_state_cbs_t light_lc_cbs;
} light_lc_setup_server_callbacks_t;

typedef struct
{
 /* states not stored in flash */
 uint32_t ambient_luxlevel;
 bool ambient_luxlevel_valid;
 uint32_t luxlevel_out;
 uint16_t lightness_out;

 uint8_t handle;
} light_lc_setup_server_state_t;

typedef struct
{
 uint8_t element_index;
 bool force_segmented;
 nrf_mesh_transmic_size_t transmic_size;

 const light_lc_setup_server_callbacks_t * p_callbacks;
} light_lc_setup_server_settings_t;

typedef struct
{
 uint32_t requested_transition_time_ms;
 uint32_t requested_delay_ms;
 bool transition_time_is_provided;
 bool requested_light_onoff;

 uint32_t transition_time_ms;
 uint8_t present_light_onoff;
 uint8_t target_light_onoff;

 /* The lightness output is in the transition, and both of these
 * lightness values are linear */
 uint16_t initial_present_lightness;
 uint16_t target_lightness;

 /* The lux level output is in the transition, too */
 uint32_t initial_present_luxlevel;
 uint32_t target_luxlevel;
} light_lc_transition_info_t;

struct __light_lc_setup_server_t
{
 access_model_handle_t model_handle;

 light_lc_server_t lc_srv;

 light_lc_setup_server_state_t state;

 light_lc_transition_info_t transition_info;

 timer_event_t onoff_timer;

 fsm_t fsm;

 model_timer_t fsm_timer;

 model_timer_t light_pi_timer;

 model_timer_t sensor_delay_timer;

 light_lc_setup_server_settings_t settings;
};

uint32_t light_lc_setup_server_init(light_lc_setup_server_t * p_s_server,
 uint8_t element_index);

uint32_t light_lc_setup_server_property_status_publish(const light_lc_setup_server_t * p_s_server,
 const light_lc_property_status_params_t * p_params);


uint32_t light_lc_setup_server_ponoff_binding_setup(light_lc_setup_server_t * p_s_server,
 uint8_t onpowerup,
 bool * p_lc_control);

#endif /* LIGHT_LC_SETUP_SERVER_H__ */