scene_client.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_CLIENT_H__
#define SCENE_CLIENT_H__

#include <stdint.h>
#include "access.h"
#include "access_reliable.h"
#include "scene_common.h"
#include "scene_messages.h"

#define SCENE_CLIENT_MODEL_ID 0x1205

/* Forward declaration */
typedef struct __scene_client_t scene_client_t;

typedef void (*scene_state_status_cb_t)(const scene_client_t * p_self,
 const access_message_rx_meta_t * p_meta,
 const scene_status_params_t * p_in);

typedef void (*scene_register_state_status_cb_t)(const scene_client_t * p_self,
 const access_message_rx_meta_t * p_meta,
 const scene_register_status_params_t * p_in);

typedef struct
{
 scene_state_status_cb_t scene_status_cb; 
 scene_register_state_status_cb_t scene_register_status_cb; 
 access_reliable_cb_t ack_transaction_status_cb;
 access_publish_timeout_cb_t periodic_publish_cb;
} scene_client_callbacks_t;

typedef struct
{
 uint32_t timeout;
 bool force_segmented;
 nrf_mesh_transmic_size_t transmic_size;

 const scene_client_callbacks_t *p_callbacks;
} scene_client_settings_t;

typedef union
{
 scene_store_msg_pkt_t store; 
 scene_delete_msg_pkt_t delete; 
 scene_recall_msg_pkt_t recall; 
} scene_client_msg_data_t;

struct __scene_client_t
{
 access_model_handle_t model_handle;
 scene_client_msg_data_t msg_pkt;
 /* Acknowledged message context variable */
 access_reliable_t access_message;

 scene_client_settings_t settings;
};

uint32_t scene_client_init(scene_client_t * p_client, uint8_t element_index);

uint32_t scene_client_store(scene_client_t * p_client, const scene_store_params_t * p_params);

uint32_t scene_client_store_unack(scene_client_t * p_client, const scene_store_params_t * p_params,
 uint8_t repeats);

uint32_t scene_client_delete(scene_client_t * p_client, const scene_delete_params_t * p_params);

uint32_t scene_client_delete_unack(scene_client_t * p_client, const scene_delete_params_t * p_params,
 uint8_t repeats);

uint32_t scene_client_recall(scene_client_t * p_client, const scene_recall_params_t * p_params, 
 const model_transition_t * p_transition);

uint32_t scene_client_recall_unack(scene_client_t * p_client, const scene_recall_params_t * p_params,
 const model_transition_t * p_transition, uint8_t repeats);

uint32_t scene_client_get(scene_client_t * p_client);

uint32_t scene_client_register_get(scene_client_t * p_client);

#endif /* SCENE_CLIENT_H__ */