Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

bless/cy_ble_rscs.h

Go to file
 
 
Cannot retrieve contributors at this time
224 lines (178 sloc) 9.13 KB
Raw Blame
Open in GitHub Desktop
/***************************************************************************//**
* \file cy_ble_rscs.h
* \version 3.60
*
* \brief
* Contains the function prototypes and constants for Running Speed and Cadence
* service.
*
********************************************************************************
* \copyright
* Copyright 2017-2021, Cypress Semiconductor Corporation. All rights reserved.
* You may use this file only in accordance with the license, terms, conditions,
* disclaimers, and limitations in the end user license agreement accompanying
* the software package with which this file was provided.
*******************************************************************************/
#ifndef CY_BLE_RSCS_H
#define CY_BLE_RSCS_H
#include "cy_ble.h"
#if defined(CY_IP_MXBLESS)
/* C binding of definitions if building with C++ compiler */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/*******************************************************************************
* API Constants
*******************************************************************************/
#define CY_BLE_RSCS_INVALID_CHAR_INDEX (0xFFu)
/* SC Control Point Characteristic Op Codes */
#define CY_BLE_RSCS_SET_CUMMULATIVE_VALUE (0x01u)
#define CY_BLE_RSCS_START_SENSOR_CALIBRATION (0x02u)
#define CY_BLE_RSCS_UPDATE_SENSOR_LOCATION (0x03u)
#define CY_BLE_RSCS_REQ_SUPPORTED_SENSOR_LOCATION (0x04u)
#define CY_BLE_RSCS_RESPONSE_CODE (0x10u)
/* SC Control Point Characteristic Response Codes */
#define CY_BLE_RSCS_ERR_SUCCESS (0x01u)
#define CY_BLE_RSCS_ERR_OP_CODE_NOT_SUPPORTED (0x02u)
#define CY_BLE_RSCS_ERR_INVALID_PARAMETER (0x03u)
#define CY_BLE_RSCS_ERR_OPERATION_FAILED (0x04u)
/*******************************************************************************
* Data Types
*******************************************************************************/
/**
* \addtogroup group_ble_service_api_RSCS_definitions
* \{
*/
/** RSCS Characteristic indexes */
typedef enum
{
CY_BLE_RSCS_RSC_MEASUREMENT, /**< RSC Measurement Characteristic index */
CY_BLE_RSCS_RSC_FEATURE, /**< RSC Feature Characteristic index */
CY_BLE_RSCS_SENSOR_LOCATION, /**< Sensor Location Characteristic index */
CY_BLE_RSCS_SC_CONTROL_POINT, /**< SC Control Point Characteristic index */
CY_BLE_RSCS_CHAR_COUNT /**< Total Count of RSCS Characteristics */
} cy_en_ble_rscs_char_index_t;
/** RSCS Characteristic Descriptors indexes */
typedef enum
{
CY_BLE_RSCS_CCCD, /**< Client Characteristic Configuration Descriptor index */
CY_BLE_RSCS_DESCR_COUNT /**< Total Count of Descriptors */
} cy_en_ble_rscs_descr_index_t;
/** Running Speed and Cadence Service Characteristic Value parameter structure */
typedef struct
{
cy_stc_ble_conn_handle_t connHandle; /**< Peer Device Handle */
cy_en_ble_rscs_char_index_t charIndex; /**< Index of Running Speed and Cadence Service Characteristic */
cy_stc_ble_gatt_value_t *value; /**< Characteristic Value */
} cy_stc_ble_rscs_char_value_t;
/** Running Speed and Cadence Service Characteristic descriptor Value parameter structure */
typedef struct
{
cy_stc_ble_conn_handle_t connHandle; /**< Connection handle */
cy_en_ble_rscs_char_index_t charIndex; /**< Characteristic index of the Service */
cy_en_ble_rscs_descr_index_t descrIndex; /**< Characteristic index Descriptor the Service */
cy_stc_ble_gatt_value_t *value; /**< Pointer to value of the Service Characteristic descriptor */
} cy_stc_ble_rscs_descr_value_t;
/** RSCS Characteristic with descriptors */
typedef struct
{
cy_ble_gatt_db_attr_handle_t charHandle; /**< Handle of the Characteristic value */
cy_ble_gatt_db_attr_handle_t descrHandle[CY_BLE_RSCS_DESCR_COUNT]; /**< Handle of the descriptor */
} cy_stc_ble_rscss_char_t;
/** Structure with Running Speed and Cadence Service attribute handles */
typedef struct
{
/** Running Speed and Cadence Service Handle */
cy_ble_gatt_db_attr_handle_t serviceHandle;
/** Array of Running Speed and Cadence Service Characteristics + Descriptors handles */
cy_stc_ble_rscss_char_t charInfo[CY_BLE_RSCS_CHAR_COUNT];
} cy_stc_ble_rscss_t;
/** RSCS Service Full Characteristic information type */
typedef struct
{
/** Characteristic handle + properties */
cy_stc_ble_srvr_char_info_t charInfo;
/** Characteristic Descriptors Handles handle */
cy_ble_gatt_db_attr_handle_t descriptors[CY_BLE_RSCS_DESCR_COUNT];
/** End handle of Characteristic */
cy_ble_gatt_db_attr_handle_t endHandle;
} cy_stc_ble_rscsc_srvr_full_char_info_t;
/** Structure with Discovered Attributes Information of Running Speed and Cadence Service */
typedef struct
{
/** Characteristics handles array */
cy_stc_ble_rscsc_srvr_full_char_info_t characteristics[CY_BLE_RSCS_CHAR_COUNT];
} cy_stc_ble_rscsc_t;
/** Service configuration structure (server) */
typedef struct
{
/** Service GATT DB Handles structure */
const cy_stc_ble_rscss_t *attrInfo;
} cy_stc_ble_rscss_config_t;
/** Service Configuration structure (client) */
typedef struct
{
/** Structure with Discovered Attributes Information */
cy_stc_ble_rscsc_t *attrInfo;
/** The Discovery Service index */
uint8_t serviceDiscIdx;
} cy_stc_ble_rscsc_config_t;
/** \} */
/*******************************************************************************
* Function Prototypes
*******************************************************************************/
/**
* \addtogroup group_ble_service_api_RSCS_server_client
* \{
*/
cy_en_ble_api_result_t Cy_BLE_RSCSS_Init(const cy_stc_ble_rscss_config_t *config);
cy_en_ble_api_result_t Cy_BLE_RSCSC_Init(const cy_stc_ble_rscsc_config_t *config);
void Cy_BLE_RSCS_RegisterAttrCallback(cy_ble_callback_t callbackFunc);
/** \} */
/**
* \addtogroup group_ble_service_api_RSCS_server
* \{
*/
cy_en_ble_api_result_t Cy_BLE_RSCSS_SetCharacteristicValue(cy_en_ble_rscs_char_index_t charIndex, uint8_t attrSize,
uint8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_RSCSS_GetCharacteristicValue(cy_en_ble_rscs_char_index_t charIndex, uint8_t attrSize,
uint8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_RSCSS_GetCharacteristicDescriptor(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_rscs_char_index_t charIndex,
cy_en_ble_rscs_descr_index_t descrIndex, uint8_t attrSize,
uint8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_RSCSS_SendNotification(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_rscs_char_index_t charIndex, uint8_t attrSize,
uint8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_RSCSS_SendIndication(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_rscs_char_index_t charIndex, uint8_t attrSize,
uint8_t *attrValue);
/** \} */
/**
* \addtogroup group_ble_service_api_RSCS_client
* \{
*/
cy_en_ble_api_result_t Cy_BLE_RSCSC_SetCharacteristicValue(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_rscs_char_index_t charIndex, uint8_t attrSize,
uint8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_RSCSC_GetCharacteristicValue(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_rscs_char_index_t charIndex);
cy_en_ble_api_result_t Cy_BLE_RSCSC_SetCharacteristicDescriptor(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_rscs_char_index_t charIndex,
cy_en_ble_rscs_descr_index_t descrIndex, uint8_t attrSize,
uint8_t *attrValue);
cy_en_ble_api_result_t Cy_BLE_RSCSC_GetCharacteristicDescriptor(cy_stc_ble_conn_handle_t connHandle,
cy_en_ble_rscs_char_index_t charIndex,
uint8_t descrIndex);
/** \} */
/*******************************************************************************
* External Data references
*******************************************************************************/
extern const cy_stc_ble_rscss_config_t *cy_ble_rscssConfigPtr;
extern const cy_stc_ble_rscsc_config_t *cy_ble_rscscConfigPtr;
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* CY_IP_MXBLESS */
#endif /* CY_BLE_RSCS_H */
/* [] END OF FILE */