light_lightness_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 LIGHT_LIGHTNESS_COMMON_H__
#define LIGHT_LIGHTNESS_COMMON_H__

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

#define LIGHT_LIGHTNESS_COMPANY_ID 0xFFFF

#define LIGHT_LIGHTNESS_RANGE_MIN (1)

#define LIGHT_LIGHTNESS_LAST_MIN (1)

#ifndef LIGHT_LIGHTNESS_DEFAULT_RANGE_MIN
#define LIGHT_LIGHTNESS_DEFAULT_RANGE_MIN (0x1)
#endif

#ifndef LIGHT_LIGHTNESS_DEFAULT_RANGE_MAX
#define LIGHT_LIGHTNESS_DEFAULT_RANGE_MAX (0xFFFF)
#endif

#ifndef LIGHT_LIGHTNESS_DEFAULT_ON_POWERUP
#define LIGHT_LIGHTNESS_DEFAULT_ON_POWERUP (0x2)
#endif

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

#ifndef LIGHT_LIGHTNESS_DEFAULT_LIGHTNESS_LAST
#define LIGHT_LIGHTNESS_DEFAULT_LIGHTNESS_LAST (0xFFFF)
#endif

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

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

typedef enum
{
 LIGHT_LIGHTNESS_RANGE_STATUS_SUCCESS,
 LIGHT_LIGHTNESS_RANGE_STATUS_CANNOT_SET_RANGE_MIN,
 LIGHT_LIGHTNESS_RANGE_STATUS_CANNOT_SET_RANGE_MAX
} light_lightness_range_status_t;


typedef struct
{
 uint16_t lightness; 
 uint8_t tid; 
} light_lightness_set_params_t;

typedef struct
{
 uint16_t lightness; 
 uint8_t tid; 
} light_lightness_linear_set_params_t;

typedef struct
{
 uint16_t lightness; 
} light_lightness_default_set_params_t;

typedef struct
{
 uint16_t range_min; 
 uint16_t range_max; 
} light_lightness_range_set_params_t;

typedef struct
{
 int32_t delta_lightness; 
 uint8_t tid; 
} light_lightness_delta_set_params_t;

typedef struct
{
 int16_t delta; 
 uint8_t tid; 
} light_lightness_move_set_params_t;

typedef struct
{
 uint8_t on_powerup; 
} light_lightness_ponoff_set_params_t;

typedef struct
{
 uint8_t on_powerup; 
} light_lightness_ponoff_status_params_t;


typedef struct
{
 uint32_t dtt_ms; 
} light_lightness_dtt_set_params_t;


typedef struct
{
 uint32_t dtt_ms; 
} light_lightness_dtt_status_params_t;


typedef struct
{
 uint16_t present_lightness; 
 uint16_t target_lightness; 
 uint32_t remaining_time_ms; 
} light_lightness_status_params_t;

typedef struct
{
 uint16_t present_lightness; 
 uint16_t target_lightness; 
 uint32_t remaining_time_ms; 
} light_lightness_linear_status_params_t;

typedef struct
{
 uint16_t lightness; 
} light_lightness_last_status_params_t;

typedef struct
{
 uint16_t lightness; 
} light_lightness_default_status_params_t;

typedef struct
{
 uint8_t status; 
 uint16_t range_min; 
 uint16_t range_max; 
} light_lightness_range_status_params_t;

typedef struct
{
 uint8_t onpowerup; 
 uint16_t actual_lightness; 
 uint16_t last_lightness; 
 uint16_t default_lightness; 
 light_lightness_range_status_params_t range; 
} light_lightness_saved_values_t;

#endif /* LIGHT_LIGHTNESS_COMMON_H__ */