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


#include <stdint.h>
#include "access.h"
#include "access_reliable.h"
#include "sensor_common.h"
#include "sensor_messages.h"
#define SENSOR_CLIENT_MODEL_ID 0x1102

typedef struct
{
 uint8_t format; /* only 1 bit */
 uint8_t length; /* 4 or 7 bits */
 uint16_t property_id; /* 11 or 16 bits */
} unpacked_marshalled_sensor_data_t;



typedef struct
{
 unpacked_marshalled_sensor_data_t mpid;
 uint8_t * raw_value;
} unpacked_sensor_data_t;


/* Forward declaration */
typedef struct __sensor_client_t sensor_client_t;

typedef void (*sensor_state_status_cb_t)(const sensor_client_t * p_self,
 const access_message_rx_meta_t * p_meta,
 const sensor_status_msg_pkt_t * p_in,
 uint16_t bytes);

typedef void (*sensor_descriptor_state_status_cb_t)(const sensor_client_t * p_self,
 const access_message_rx_meta_t * p_meta,
 const sensor_descriptor_t * p_in,
 uint16_t num_descriptors);

typedef void (*sensor_cadence_state_status_cb_t)(const sensor_client_t *p_self,
 const access_message_rx_meta_t *p_meta,
 const sensor_cadence_status_msg_pkt_t *p_in,
 uint16_t length);

typedef void (*sensor_column_state_status_cb_t)(const sensor_client_t *p_self,
 const access_message_rx_meta_t *p_meta,
 const sensor_column_status_msg_pkt_t *p_in,
 uint16_t length);

typedef void (*sensor_series_state_status_cb_t)(const sensor_client_t * p_self,
 const access_message_rx_meta_t * p_meta,
 const sensor_series_status_msg_pkt_t * p_in,
 uint16_t length);

typedef void (*sensor_settings_state_status_cb_t)(const sensor_client_t * p_self,
 const access_message_rx_meta_t * p_meta,
 const sensor_settings_status_msg_pkt_t * p_in,
 uint16_t length);

typedef void (*sensor_setting_state_status_cb_t)(const sensor_client_t * p_self,
 const access_message_rx_meta_t * p_meta,
 const sensor_setting_status_msg_pkt_t * p_in,
 uint16_t length);

typedef struct
{
 sensor_state_status_cb_t sensor_status_cb;
 sensor_descriptor_state_status_cb_t sensor_descriptor_status_cb;
 sensor_cadence_state_status_cb_t sensor_cadence_status_cb;
 sensor_column_state_status_cb_t sensor_column_status_cb;
 sensor_series_state_status_cb_t sensor_series_status_cb;
 sensor_settings_state_status_cb_t sensor_settings_status_cb;
 sensor_setting_state_status_cb_t sensor_setting_status_cb;

 access_reliable_cb_t ack_transaction_status_cb;
 access_publish_timeout_cb_t periodic_publish_cb;
} sensor_client_callbacks_t;

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

 const sensor_client_callbacks_t *p_callbacks;
} sensor_client_settings_t;

struct __sensor_client_t
{
 access_model_handle_t model_handle;

 access_reliable_t access_message;

 sensor_client_settings_t settings;

 uint8_t * p_message_buffer;

 uint16_t message_buffer_bytes;
};

uint32_t sensor_client_init(sensor_client_t *p_client, uint16_t element_index);

uint32_t sensor_client_cadence_set(sensor_client_t * p_client,
 const sensor_cadence_set_msg_pkt_t * p_params,
 uint16_t length);

uint32_t sensor_client_cadence_set_unack(sensor_client_t * p_client,
 const sensor_cadence_set_msg_pkt_t * p_params,
 uint16_t length,
 uint8_t repeats);

uint32_t sensor_client_setting_set(sensor_client_t * p_client,
 const sensor_setting_set_msg_pkt_t * p_params,
 uint16_t length);
uint32_t sensor_client_setting_set_unack(sensor_client_t * p_client,
 const sensor_setting_set_msg_pkt_t * p_params,
 uint16_t length,
 uint8_t repeats);
uint32_t sensor_client_get(sensor_client_t * p_client, uint16_t property_id);

uint32_t sensor_client_descriptor_get(sensor_client_t * p_client, uint16_t property_id);

uint32_t sensor_client_cadence_get(sensor_client_t * p_client, uint16_t property_id);

uint32_t sensor_client_settings_get(sensor_client_t * p_client, uint16_t property_id);

uint32_t sensor_client_setting_get(sensor_client_t * p_client,
 uint16_t property_id,
 uint16_t setting_property_id);

uint32_t sensor_client_column_get(sensor_client_t * p_client,
 sensor_column_get_msg_pkt_t * p_rawbuf,
 uint16_t length);

uint32_t sensor_client_series_get(sensor_client_t * p_client,
 sensor_series_get_msg_pkt_t * p_raw_colbuf,
 uint16_t length);


#endif /* SENSOR_CLIENT_H__ */