scene_setup_server.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_SETUP_SERVER_H__
#define SCENE_SETUP_SERVER_H__

#include <stdint.h>
#include "scene_common.h"
#include "scene_messages.h"
#include "generic_dtt_server.h"

#define SCENE_SERVER_MODEL_ID 0x1203

#define SCENE_SETUP_SERVER_MODEL_ID 0x1204

/* Forward declaration */
typedef struct __scene_server_t scene_server_t;

/* Forward declaration */
typedef struct __scene_setup_server_t scene_setup_server_t;

typedef void (*scene_state_store_cb_t)(const scene_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 const scene_store_params_t * p_in,
 scene_register_status_params_t * p_out);

typedef void (*scene_state_delete_cb_t)(const scene_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 const scene_delete_params_t * p_in,
 scene_register_status_params_t * p_out);

typedef void (*scene_state_get_cb_t)(const scene_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 scene_status_params_t * p_out);

typedef void (*scene_state_register_get_cb_t)(const scene_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 scene_register_status_params_t * p_out);

typedef void (*scene_state_recall_cb_t)(const scene_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 const scene_recall_params_t * p_in,
 const model_transition_t * p_in_transition,
 scene_status_params_t * p_out);

typedef struct scene_setup_server
{
 scene_state_store_cb_t store_cb; 
 scene_state_delete_cb_t delete_cb; 
 scene_state_get_cb_t get_cb; 
 scene_state_register_get_cb_t register_get_cb; 
 scene_state_recall_cb_t recall_cb; 
} scene_setup_server_state_cbs_t;

typedef struct
{
 bool force_segmented;
 nrf_mesh_transmic_size_t transmic_size;

 /* There are no callbacks for the state for this model, these
 * callbacks are defined for the setup server. */
} scene_server_settings_t;

struct __scene_server_t
{
 access_model_handle_t model_handle;

 tid_tracker_t tid_tracker;

 scene_server_settings_t settings;
};

uint32_t scene_server_status_publish(const scene_server_t * p_server,
 const scene_status_params_t * p_params);

typedef struct
{
 scene_setup_server_state_cbs_t scene_cbs;
} scene_setup_server_callbacks_t;

typedef struct
{
 uint8_t element_index;
 bool force_segmented;
 nrf_mesh_transmic_size_t transmic_size;

 const scene_setup_server_callbacks_t * p_callbacks;
} scene_setup_server_settings_t;

struct __scene_setup_server_t
{
 access_model_handle_t model_handle;

 scene_server_t scene_srv;

 generic_dtt_server_t * p_gen_dtt_server;

 scene_setup_server_settings_t settings;

 uint8_t state_handle;
};

uint32_t scene_setup_server_init(scene_setup_server_t * p_s_server, uint8_t element_index);

#endif /* SCENE_SETUP_SERVER_H__ */