ruuvi_interface_communication.h

Go to the documentation of this file.

#ifndef RUUVI_INTERFACE_COMMUNICATION_H
#define RUUVI_INTERFACE_COMMUNICATION_H
#include "ruuvi_driver_enabled_modules.h"
#include "ruuvi_driver_error.h"
 
#if RI_COMM_ENABLED
#  define RUUVI_NRF5_SDK15_COMMUNICATION_ENABLED  RUUVI_NRF5_SDK15_ENABLED
#endif
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#define RI_COMM_DIS_STRLEN 48
 
#define RI_COMM_MSG_REPEAT_FOREVER (0U)
 
#if defined(RI_ADV_EXTENDED_ENABLED) && RI_ADV_EXTENDED_ENABLED
#   if !defined(RI_COMM_BLE_PAYLOAD_MAX_LENGTH)
#       error "RI_COMM_BLE_PAYLOAD_MAX_LENGTH must be defined when RI_ADV_EXTENDED_ENABLED=1"
#   endif
#else
#if defined(RI_RE_CA_UART_ENABLED) && RI_RE_CA_UART_ENABLED
#     define RI_COMM_BLE_PAYLOAD_MAX_LENGTH (31U)
#else
#     define RI_COMM_BLE_PAYLOAD_MAX_LENGTH (24U)
#endif
#endif
 
#if defined(RI_RE_CA_UART_ENABLED) && RI_RE_CA_UART_ENABLED
#define RI_COMM_MESSAGE_MAX_LENGTH (20 + RI_COMM_BLE_PAYLOAD_MAX_LENGTH)
#else
#define RI_COMM_MESSAGE_MAX_LENGTH (RI_COMM_BLE_PAYLOAD_MAX_LENGTH)
#endif
 
typedef struct ri_comm_message_t
{
    _Static_assert (RI_COMM_MESSAGE_MAX_LENGTH <= UINT8_MAX,
                    "Data length must fit in uint8_t");
    uint8_t data[RI_COMM_MESSAGE_MAX_LENGTH]; 
    uint8_t data_length;                      
    uint8_t repeat_count;                     
    // RI_COMM_MSG_REPEAT_FOREVER for infinite sends, 1 for send once.
} ri_comm_message_t;
 
typedef enum
{
    RI_COMM_CONNECTED,    
    RI_COMM_DISCONNECTED, 
    RI_COMM_SENT,         
    RI_COMM_RECEIVED,     
    RI_COMM_TIMEOUT,      
    RI_COMM_ABORTED       
} ri_comm_evt_t;          
 
typedef struct
{
    char fw_version[RI_COMM_DIS_STRLEN];   
    char model[RI_COMM_DIS_STRLEN];        
    char hw_version[RI_COMM_DIS_STRLEN];   
    char manufacturer[RI_COMM_DIS_STRLEN]; 
    char deviceid[RI_COMM_DIS_STRLEN];     
    char deviceaddr[RI_COMM_DIS_STRLEN];   
} ri_comm_dis_init_t;                      
 
typedef enum
{
    RI_GATT_TURBO,
    RI_GATT_STANDARD,
    RI_GATT_LOW_POWER
} ri_gatt_params_t;
 
typedef struct ri_comm_channel_t ri_comm_channel_t;
 
/* @brief Callback handler for communication events */
typedef void (*ri_comm_cb_t) (void * p_data, size_t data_len);
 
typedef rd_status_t (*ri_comm_xfer_fp_t) (ri_comm_message_t * const
        msg);
 
typedef rd_status_t (*ri_comm_init_fp_t) (ri_comm_channel_t * const channel);
 
typedef rd_status_t (*ri_comm_evt_handler_fp_t) (const ri_comm_evt_t
        evt, void * p_data, size_t data_len);
 
struct ri_comm_channel_t
{
    ri_comm_xfer_fp_t send;    
    ri_comm_xfer_fp_t read;    
    ri_comm_init_fp_t init;    
    ri_comm_init_fp_t uninit;  
    ri_comm_evt_handler_fp_t
    on_evt;  
};
 
rd_status_t ri_comm_id_get (uint64_t * const id);
 
#endif