sensor_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 SENSOR_SERVER_H__
#define SENSOR_SERVER_H__

#include <stdint.h>
#include "access.h"
#include "sensor_common.h"
#include "model_common.h"
#include "sensor_messages.h"

#define SENSOR_SERVER_MODEL_ID 0x1100

#define SENSOR_SETUP_SERVER_MODEL_ID 0x1101

/* Forward declaration */
typedef struct __sensor_server_t sensor_server_t;

/* Forward declaration */
typedef struct __sensor_setup_server_t sensor_setup_server_t;


typedef void (*sensor_descriptor_get_cb_t)(const sensor_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 uint16_t property_id,
 sensor_descriptor_status_msg_pkt_t ** pp_out,
 uint16_t * p_out_bytes);

typedef void (*sensor_state_get_cb_t)(const sensor_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 uint16_t property_id,
 sensor_status_msg_pkt_t ** pp_out,
 uint16_t * p_out_bytes);

typedef void (*sensor_column_get_cb_t)(const sensor_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 const sensor_column_get_msg_pkt_t * p_in,
 uint16_t in_bytes,
 sensor_column_status_msg_pkt_t ** pp_out,
 uint16_t * p_out_bytes);

typedef void (*sensor_series_get_cb_t)(const sensor_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 const sensor_series_get_msg_pkt_t * p_in,
 uint16_t in_bytes,
 sensor_series_status_msg_pkt_t ** pp_out,
 uint16_t * p_out_bytes);


typedef void (*sensor_cadence_get_cb_t)(const sensor_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 uint16_t property_id,
 sensor_cadence_status_msg_pkt_t ** pp_out,
 uint16_t * p_out_bytes);

typedef void (*sensor_cadence_set_cb_t)(const sensor_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 uint16_t property_id,
 const sensor_cadence_set_msg_pkt_t * p_in,
 uint16_t in_bytes,
 sensor_cadence_status_msg_pkt_t ** pp_out,
 uint16_t * p_out_bytes);
typedef void (*sensor_settings_get_cb_t)(const sensor_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 uint16_t property_id,
 sensor_settings_status_msg_pkt_t ** pp_out,
 uint16_t * p_out_bytes);

typedef void (*sensor_setting_get_cb_t)(const sensor_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 uint16_t property_id,
 uint16_t setting_property_id,
 sensor_setting_status_msg_pkt_t ** pp_out,
 uint16_t * p_out_bytes);

typedef void (*sensor_setting_set_cb_t)(const sensor_setup_server_t * p_self,
 const access_message_rx_meta_t * p_meta,
 uint16_t property_id,
 uint16_t settings_property_id,
 const sensor_setting_set_msg_pkt_t * p_in,
 uint16_t in_bytes,
 sensor_setting_status_msg_pkt_t ** pp_out,
 uint16_t * p_out_bytes);

typedef void (*sensor_publication_schedule_cb_t)(const sensor_setup_server_t * p_self);

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.
 */
} sensor_server_settings_t;

struct __sensor_server_t
{
 access_model_handle_t model_handle;

 sensor_server_settings_t settings;
};

typedef struct
{
 sensor_descriptor_get_cb_t descriptor_get_cb;
 sensor_state_get_cb_t get_cb;
 sensor_column_get_cb_t column_get_cb;
 sensor_series_get_cb_t series_get_cb;
 sensor_cadence_get_cb_t cadence_get_cb;
 sensor_cadence_set_cb_t cadence_set_cb;
 sensor_settings_get_cb_t settings_get_cb;
 sensor_setting_get_cb_t setting_get_cb;
 sensor_setting_set_cb_t setting_set_cb;
 sensor_publication_schedule_cb_t publication_schedule_cb;
} sensor_setup_server_cbs_t;

typedef struct
{
 sensor_setup_server_cbs_t sensor_cbs;
} sensor_setup_server_callbacks_t;

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

 uint16_t * property_array;

 const sensor_setup_server_callbacks_t * p_callbacks;
} sensor_setup_server_settings_t;

struct __sensor_setup_server_t
{
 access_model_handle_t model_handle;

 sensor_server_t sensor_srv;

 sensor_setup_server_settings_t settings;
};

uint32_t sensor_server_status_publish(const sensor_server_t * p_server,
 const sensor_status_msg_pkt_t * p_data,
 uint16_t data_length,
 sensor_opcode_t status_opcode);

uint32_t sensor_server_setup_status_publish(const sensor_setup_server_t * p_s_server,
 const sensor_status_msg_pkt_t * p_data,
 uint16_t data_length,
 sensor_opcode_t status_opcode);

uint32_t sensor_setup_server_init(sensor_setup_server_t * p_server, uint16_t element_index);

#endif /* SENSOR_SERVER_H__ */