light_lc_common.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 LC_SERVER_COMMON_H__
#define LC_SERVER_COMMON_H__

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

#define LIGHT_LC_SERVER_COMPANY_ID (0xFFFF)

#define LIGHT_LC_PROPERTY_BUF_SIZE (4)

#define LIGHT_LC_MODE_OFF (0)

#ifndef LIGHT_LC_DEFAULT_MODE
#define LIGHT_LC_DEFAULT_MODE (0x0)
#endif

#ifndef LIGHT_LC_DEFAULT_OCC_MODE
#define LIGHT_LC_DEFAULT_OCC_MODE (0x0)
#endif

#ifndef LIGHT_LC_DEFAULT_LIGHT_ONOFF
#define LIGHT_LC_DEFAULT_LIGHT_ONOFF (0x0)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_LUXLEVEL_ON
#define LIGHT_LC_DEFAULT_PR_LUXLEVEL_ON (75000)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_LUXLEVEL_PROLONG
#define LIGHT_LC_DEFAULT_PR_LUXLEVEL_PROLONG (20000)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_LUXLEVEL_STANDBY
#define LIGHT_LC_DEFAULT_PR_LUXLEVEL_STANDBY (7000)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_LIGHTNESS_ON
#define LIGHT_LC_DEFAULT_PR_LIGHTNESS_ON (0xAFFF)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_LIGHTNESS_PROLONG
#define LIGHT_LC_DEFAULT_PR_LIGHTNESS_PROLONG (0x3FFF)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_LIGHTNESS_STANDBY
#define LIGHT_LC_DEFAULT_PR_LIGHTNESS_STANDBY (0x1000)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_REGULATOR_ACCURACY
#define LIGHT_LC_DEFAULT_PR_REGULATOR_ACCURACY (4)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_REGULATOR_KIU
#define LIGHT_LC_DEFAULT_PR_REGULATOR_KIU (250.0)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_REGULATOR_KID
#define LIGHT_LC_DEFAULT_PR_REGULATOR_KID (25.0)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_REGULATOR_KPU
#define LIGHT_LC_DEFAULT_PR_REGULATOR_KPU (80.0)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_REGULATOR_KPD
#define LIGHT_LC_DEFAULT_PR_REGULATOR_KPD (80.0)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_TIME_FADE_MS
#define LIGHT_LC_DEFAULT_PR_TIME_FADE_MS (4500)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_TIME_FADE_ON_MS
#define LIGHT_LC_DEFAULT_PR_TIME_FADE_ON_MS (2000)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_TIME_FADE_STANDBY_AUTO_MS
#define LIGHT_LC_DEFAULT_PR_TIME_FADE_STANDBY_AUTO_MS (3500)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_TIME_FADE_STANDBY_MANUAL_MS
#define LIGHT_LC_DEFAULT_PR_TIME_FADE_STANDBY_MANUAL_MS (3500)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_TIME_PROLONG_MS
#define LIGHT_LC_DEFAULT_PR_TIME_PROLONG_MS (7000)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_TIME_RUN_ON_MS
#define LIGHT_LC_DEFAULT_PR_TIME_RUN_ON_MS (10000)
#endif

#ifndef LIGHT_LC_DEFAULT_PR_TIME_OCCUPANCY_DELAY_MS
#define LIGHT_LC_DEFAULT_PR_TIME_OCCUPANCY_DELAY_MS (0)
#endif

#ifndef LIGHT_LC_LIGHT_PI_SUMMATION_INTERVAL_MS
#define LIGHT_LC_LIGHT_PI_SUMMATION_INTERVAL_MS (100)
#endif

#define LIGHT_LC_LIGHT_PI_SUMMATION_INTERVAL_MIN_MS (10)

#define LIGHT_LC_LIGHT_PI_SUMMATION_INTERVAL_MAX_MS (100)

#ifndef LIGHT_LC_LIGHT_PI_CONVERSION_DIVISOR
#define LIGHT_LC_LIGHT_PI_CONVERSION_DIVISOR (50)
#endif

typedef enum
{
 LIGHT_LC_STATE_NULL_ENTRY,
 LIGHT_LC_STATE_LIGHT_LC_MODE,
 LIGHT_LC_STATE_LIGHT_LC_OCC_MODE,
 LIGHT_LC_STATE_LIGHT_LC_LIGHT_ONOFF,
 LIGHT_LC_STATE_AMBIENT_LUXLEVEL_ON,
 LIGHT_LC_STATE_AMBIENT_LUXLEVEL_PROLONG,
 LIGHT_LC_STATE_AMBIENT_LUXLEVEL_STANDBY,
 LIGHT_LC_STATE_LIGHTNESS_ON,
 LIGHT_LC_STATE_LIGHTNESS_PROLONG,
 LIGHT_LC_STATE_LIGHTNESS_STANDBY,
 LIGHT_LC_STATE_REGULATOR_ACCURACY,
 LIGHT_LC_STATE_REGULATOR_KID,
 LIGHT_LC_STATE_REGULATOR_KIU,
 LIGHT_LC_STATE_REGULATOR_KPD,
 LIGHT_LC_STATE_REGULATOR_KPU,
 LIGHT_LC_STATE_TIME_FADE,
 LIGHT_LC_STATE_TIME_FADE_ON,
 LIGHT_LC_STATE_TIME_FADE_STANDBY_AUTO,
 LIGHT_LC_STATE_TIME_FADE_STANDBY_MANUAL,
 LIGHT_LC_STATE_TIME_OCCUPANCY_DELAY,
 LIGHT_LC_STATE_TIME_PROLONG,
 LIGHT_LC_STATE_TIME_RUN_ON,
} light_lc_state_t;


typedef struct
{
 bool mode; 
} light_lc_mode_set_params_t;

typedef struct
{
 bool occupancy_mode; 
} light_lc_occupancy_mode_set_params_t;

typedef struct
{
 bool light_on_off; 
 uint8_t tid; 
} light_lc_light_onoff_set_params_t;

typedef struct
{
 uint16_t property_id; 
 /* Although the property value field is a variable size, it is
 * never bigger than 4 bytes, so we put a 4 byte buffer here to
 * use */
 uint8_t property_buffer[LIGHT_LC_PROPERTY_BUF_SIZE];
} light_lc_property_set_params_t;

typedef struct
{
 uint16_t property_id; 
} light_lc_property_get_params_t;

typedef struct
{
 bool mode; 
} light_lc_mode_status_params_t;

typedef struct
{
 bool occupancy_mode; 
} light_lc_occupancy_mode_status_params_t;

typedef struct
{
 bool present_light_onoff; 
 bool target_light_onoff; 
 uint32_t remaining_time_ms; 
} light_lc_light_onoff_status_params_t;

typedef struct
{
 uint16_t property_id; 
 /* Although the property value field is a variable size, it is
 * never bigger than 4 bytes, so we put a 4 byte buffer here to
 * use */
 uint8_t property_buffer[LIGHT_LC_PROPERTY_BUF_SIZE];
} light_lc_property_status_params_t;

#endif /* LC_SERVER_COMMON_H__ */