scene_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 SCENE_COMMON_H__
#define SCENE_COMMON_H__

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

#define SCENE_COMPANY_ID 0xFFFF

#define SCENE_REGISTER_SCENE_NUMBER_MIN (1)

#define SCENE_NUMBER_NO_SCENE (0x0000)

/* See "@tagMeshDevPr, section 4.1.3". 0 is a prohibited value for property ID, so it can represent
 * "no property id" without concern for a collision.
 */
#define SCENE_NO_PROPERTY_ID 0

#define SCENE_SCENES_MAX (65535)

#ifndef SCENE_REGISTER_ARRAY_SIZE
#define SCENE_REGISTER_ARRAY_SIZE (16)
#endif

typedef enum
{
 SCENE_STATUS_SUCCESS,
 SCENE_STATUS_REGISTER_FULL,
 SCENE_STATUS_NOT_FOUND
} scene_status_t;

typedef struct
{
 uint16_t scene_number; 
} scene_store_params_t;


typedef struct
{
 uint16_t scene_number; 
 uint8_t tid; 
} scene_recall_params_t;

typedef struct
{
 uint8_t status_code; 
 uint16_t current_scene; 
 uint16_t target_scene; 
 uint32_t remaining_time_ms; 
} scene_status_params_t;

typedef struct
{
 uint8_t status_code; 
 uint16_t current_scene; 
 uint16_t scenes[SCENE_REGISTER_ARRAY_SIZE]; 
} scene_register_status_params_t;

typedef struct
{
 uint16_t scene_number; 
} scene_delete_params_t;

#endif /* SCENE_COMMON_H__ */