app_scene.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 APP_SCENE_H__
#define APP_SCENE_H__

#include <stdint.h>

#include "scene_setup_server.h"
#include "app_transition.h"
#include "nrf_mesh_config_examples.h"

#define APP_SCENE_SETUP_SERVER_DEF(_name, _force_segmented, _mic_size, _transition_cb, _p_dtt_server); \
 APP_TIMER_DEF(_name ## _timer); \
 static app_scene_setup_server_t _name = \
 { \
 .scene_setup_server.settings.force_segmented = _force_segmented, \
 .scene_setup_server.settings.transmic_size = _mic_size, \
 .state.transition.timer.p_timer_id = &_name ## _timer, \
 .app_scene_transition_cb = _transition_cb, \
 .scene_setup_server.p_gen_dtt_server = _p_dtt_server \
 };

#ifndef APP_SCENE_MODEL_COUNT
#define APP_SCENE_MODEL_COUNT (1)
#endif

typedef struct
{
 uint16_t current_scene_number;
 uint16_t target_scene_number;

 app_transition_t transition;
} app_scene_state_t;

/* Forward declaration */
typedef struct __app_scene_setup_server_t app_scene_setup_server_t;
/* Forward declaration */
typedef struct __app_scene_model_interface_t app_scene_model_interface_t;

typedef void (*app_scene_transition_cb_t)(const app_scene_setup_server_t * p_app,
 uint32_t transition_time_ms,
 uint16_t target_scene);

typedef void (*app_scene_store_cb_t)(const app_scene_model_interface_t * p_app_model_if,
 uint8_t scene_index);


typedef void (*app_scene_recall_cb_t)(const app_scene_model_interface_t * p_app_model_if,
 uint8_t scene_index,
 uint32_t delay_ms,
 uint32_t transition_time_ms);

typedef void (*app_scene_delete_cb_t)(const app_scene_model_interface_t * p_app_model_if,
 uint8_t scene_index);


typedef struct
{
 app_scene_store_cb_t scene_store_cb;
 app_scene_recall_cb_t scene_recall_cb;
 app_scene_delete_cb_t scene_delete_cb;
} app_scene_callbacks_t;

/* Interface that is to be used by other App Models. */
struct __app_scene_model_interface_t
{
 const app_scene_callbacks_t * p_callbacks;
};

struct __app_scene_setup_server_t
{
 scene_setup_server_t scene_setup_server;

 app_scene_transition_cb_t app_scene_transition_cb;

 app_scene_state_t state;
 app_scene_model_interface_t * scene_models[APP_SCENE_MODEL_COUNT];
 uint32_t next_model_interface;
};

uint32_t app_scene_model_init(app_scene_setup_server_t * p_app, uint8_t element_index);

uint32_t app_scene_model_add(app_scene_setup_server_t * p_app,
 app_scene_model_interface_t * p_app_scene_model_interface);

void app_scene_model_scene_changed(app_scene_setup_server_t * p_app);

#endif /* APP_SCENE_H__ */