light_lightness_mc.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_LIGHTNESS_MC_H__
#define LIGHT_LIGHTNESS_MC_H__

#include <stdint.h>

#include "light_lightness_common.h"
#include "mesh_config.h"
#include "mesh_opt.h"
#include "model_config_file.h"

#if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
#include "scene_common.h"
#endif

#if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
#define STORED_WITH_SCENE_INSTANCES (LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX + \
 (SCENE_REGISTER_ARRAY_SIZE * LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX))
#else
#define STORED_WITH_SCENE_INSTANCES (LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX)
#endif

#define LIGHT_LIGHTNESS_ONPOWERUP_EID_START (MESH_APP_MODEL_LIGHT_LIGHTNESS_ID_START)
#define LIGHT_LIGHTNESS_LAST_EID_START (LIGHT_LIGHTNESS_ONPOWERUP_EID_START + LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX)
#define LIGHT_LIGHTNESS_DEFAULT_EID_START (LIGHT_LIGHTNESS_LAST_EID_START + LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX)
#define LIGHT_LIGHTNESS_RANGE_MIN_EID_START (LIGHT_LIGHTNESS_DEFAULT_EID_START + LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX)
#define LIGHT_LIGHTNESS_RANGE_MAX_EID_START (LIGHT_LIGHTNESS_RANGE_MIN_EID_START + LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX)
#define LIGHT_LIGHTNESS_RANGE_STATUS_EID_START (LIGHT_LIGHTNESS_RANGE_MAX_EID_START + LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX)
#define LIGHT_LIGHTNESS_ACTUAL_EID_START (LIGHT_LIGHTNESS_RANGE_STATUS_EID_START + LIGHT_LIGHTNESS_SETUP_SERVER_INSTANCES_MAX)
#define LIGHT_LIGHTNESS_DTT_EID_START (LIGHT_LIGHTNESS_ACTUAL_EID_START + STORED_WITH_SCENE_INSTANCES)

#define LIGHT_LIGHTNESS_ONPOWERUP_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_ONPOWERUP_EID_START)

#define LIGHT_LIGHTNESS_LAST_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_LAST_EID_START)

#define LIGHT_LIGHTNESS_DEFAULT_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_DEFAULT_EID_START)

#define LIGHT_LIGHTNESS_RANGE_MIN_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_RANGE_MIN_EID_START)

#define LIGHT_LIGHTNESS_RANGE_MAX_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_RANGE_MAX_EID_START)

#define LIGHT_LIGHTNESS_RANGE_STATUS_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_RANGE_STATUS_EID_START)

#define LIGHT_LIGHTNESS_ACTUAL_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_ACTUAL_EID_START)

#define LIGHT_LIGHTNESS_DTT_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LIGHTNESS_DTT_EID_START)

typedef enum
{
 LIGHT_LIGHTNESS_MC_WRITE_DESTINATION_FLASH_ONLY,
 LIGHT_LIGHTNESS_MC_WRITE_DESTINATION_ALL
} light_lightness_mc_write_destination_t;

uint32_t light_lightness_mc_onpowerup_state_set(uint8_t index, uint8_t value);

uint32_t light_lightness_mc_onpowerup_state_get(uint8_t index, uint8_t * p_value);


uint32_t light_lightness_mc_last_state_set(uint8_t index, uint16_t value, light_lightness_mc_write_destination_t write_to);

uint32_t light_lightness_mc_last_state_get(uint8_t index, uint16_t * p_value);


uint32_t light_lightness_mc_default_state_set(uint8_t index, uint16_t value);

uint32_t light_lightness_mc_default_state_get(uint8_t index, uint16_t * p_value);


uint32_t light_lightness_mc_range_status_state_set(uint8_t index, uint8_t value);

uint32_t light_lightness_mc_range_status_state_get(uint8_t index, uint8_t * p_value);


uint32_t light_lightness_mc_range_min_state_set(uint8_t index, uint16_t value);

uint32_t light_lightness_mc_range_min_state_get(uint8_t index, uint16_t * p_value);


uint32_t light_lightness_mc_range_max_state_set(uint8_t index, uint16_t value);

uint32_t light_lightness_mc_range_max_state_get(uint8_t index, uint16_t * p_value);


uint32_t light_lightness_mc_actual_state_set(uint8_t index, uint16_t value);

uint32_t light_lightness_mc_actual_state_get(uint8_t index, uint16_t * p_value);


uint32_t light_lightness_mc_dtt_state_set(uint8_t index, uint32_t value);

uint32_t light_lightness_mc_dtt_state_get(uint8_t index, uint32_t * p_value);

#if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)

uint32_t light_lightness_mc_scene_actual_state_store(uint8_t index, uint8_t scene_index,
 uint16_t value);

uint32_t light_lightness_mc_scene_actual_state_recall(uint8_t index, uint8_t scene_index,
 uint16_t * p_value);
#endif

uint32_t light_lightness_mc_open(uint8_t * p_handle);

void light_lightness_mc_clear(void);

void light_lightness_mc_init(void);

#endif /* LIGHT_LIGHTNESS_MC_H__ */