sensor_messages.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_MESSAGES_H__
#define SENSOR_MESSAGES_H__

#include <stdint.h>
#include "sensor_common.h"
#include "nrf_mesh_assert.h"

/* @tagMeshMdlSp - 4.1 "The number of sensors within a multisensor is
 * limited by the size of the message payload for the Sensor
 * Descriptor Status message" ... "up to 38 Sensor Descriptor states
 * may be sent" */
#define MAX_NUM_SENSORS 38

#define SENSOR_DESCRIPTOR_MINLEN 2
#define SENSOR_DESCRIPTOR_STATE_SIZE 8
#define SENSOR_DESCRIPTOR_MAXLEN (MAX_NUM_SENSORS * SENSOR_DESCRIPTOR_STATE_SIZE)

#define SENSOR_SETTING_SET_MINLEN 5

#define SENSOR_CADENCE_SET_MINLEN 8

#define SENSOR_STATUS_MINLEN 3
#define SENSOR_STATUS_MAXLEN_SINGLE_SENSOR 130
#define SENSOR_STATUS_MAXLEN 379

typedef enum
{
 SENSOR_OPCODE_DESCRIPTOR_GET = 0x8230,
 SENSOR_OPCODE_DESCRIPTOR_STATUS = 0x51,
 SENSOR_OPCODE_GET = 0x8231,
 SENSOR_OPCODE_STATUS = 0x52,
 SENSOR_OPCODE_COLUMN_GET = 0x8232,
 SENSOR_OPCODE_COLUMN_STATUS = 0x53,
 SENSOR_OPCODE_SERIES_GET = 0X8233,
 SENSOR_OPCODE_SERIES_STATUS = 0x54,
 SENSOR_OPCODE_CADENCE_GET = 0x8234,
 SENSOR_OPCODE_CADENCE_SET = 0x55,
 SENSOR_OPCODE_CADENCE_SET_UNACKNOWLEDGED = 0x56,
 SENSOR_OPCODE_CADENCE_STATUS = 0x57,
 SENSOR_OPCODE_SETTINGS_GET = 0x8235,
 SENSOR_OPCODE_SETTINGS_STATUS = 0x58,
 SENSOR_OPCODE_SETTING_GET = 0x8236,
 SENSOR_OPCODE_SETTING_SET = 0x59,
 SENSOR_OPCODE_SETTING_SET_UNACKNOWLEDGED = 0x5A,
 SENSOR_OPCODE_SETTING_STATUS = 0x5B,
} sensor_opcode_t;

/* Note that the partial message types are assumed to be parsed as uint8_t buffers beyond the few
 fields at the top that are defined in the structure. uint8_t is the straightforward way to handle
 variably-sized fields.
*/

typedef struct __attribute((packed))
{
 uint16_t property_id; 
} sensor_descriptor_get_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint64_t sensor_property_id : 16;
 uint64_t sensor_positive_tolerance : 12;
 uint64_t sensor_negative_tolerance : 12;
 uint64_t sensor_sampling_function : 8;
 uint64_t sensor_measurement_period : 8;
 uint64_t sensor_update_interval : 8;
} sensor_descriptor_pkt_t;

STATIC_ASSERT(SENSOR_DESCRIPTOR_STATE_SIZE == sizeof(sensor_descriptor_pkt_t),
 "Wrong packed sensor_descriptor_pkt_t.");

typedef union __attribute((packed))
{
 uint16_t property_id;
 sensor_descriptor_pkt_t descriptors;
} sensor_descriptor_status_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint16_t property_id; 
} sensor_cadence_get_msg_pkt_t;

typedef uint8_t sensor_cadence_status_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint16_t property_id; 
} sensor_cadence_set_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint16_t property_id; 
} sensor_settings_get_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint16_t property_id; 
 uint16_t setting_property_ids[];
} sensor_settings_status_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint16_t property_id; 
 uint16_t setting_property_id; 
} sensor_setting_get_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint16_t property_id; 
 uint16_t setting_property_id; 
 uint8_t setting_raw[];
} sensor_setting_set_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint16_t property_id; 
 uint16_t setting_property_id; 
 uint8_t setting_access;
 uint8_t setting_raw[];
} sensor_setting_status_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint16_t property_id; 
} sensor_get_msg_pkt_t;

typedef uint8_t sensor_status_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint16_t property_id; 
 uint8_t raw_value_x[]; 
} sensor_column_get_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint16_t property_id; 
 uint8_t raw_value_xwy[]; 
} sensor_column_status_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint16_t property_id; 
 uint8_t raw_value_x1x2[]; 
} sensor_series_get_msg_pkt_t;

typedef struct __attribute((packed))
{
 uint16_t property_id; 
 uint8_t raw_value_xwy[]; 
} sensor_series_status_msg_pkt_t;

#endif /* SENSOR_MESSAGES_H__ */