PLXS Definitions and Data Structures

General Description

Contains the PLXS specific definitions and data structures used in the PLXS API.

Data Structures
struct	cy_stc_ble_plxss_char_t
	PLXS Characteristic with descriptors. More...
struct	cy_stc_ble_plxss_t
	Structure with PLXS attribute handles. More...
struct	cy_stc_ble_plxsc_char_t
	PLXS Characteristic with descriptors. More...
struct	cy_stc_ble_plxsc_t
	Structure with Discovered Attributes Information of Pulse Oximeter service. More...
struct	cy_stc_ble_plxs_char_value_t
	PLXS Characteristic Value parameter structure. More...
struct	cy_stc_ble_plxs_descr_value_t
	PLXS Characteristic descriptor value parameter structure. More...
struct	cy_stc_ble_plxss_config_t
	Service configuration structure (server) More...
struct	cy_stc_ble_plxsc_config_t
	Service Configuration structure (client) More...

Enumerations
enum	cy_en_ble_plxs_char_index_t {   CY_BLE_PLXS_SCMT,   CY_BLE_PLXS_CTMT,   CY_BLE_PLXS_FEAT,   CY_BLE_PLXS_RACP,   CY_BLE_PLXS_CHAR_COUNT }
	PLXS Characteristic indexes. More...
enum	cy_en_ble_plxs_descr_index_t {   CY_BLE_PLXS_CCCD,   CY_BLE_PLXS_DESCR_COUNT }
	PLXS Characteristic Descriptors indexes. More...
enum	cy_en_ble_plxs_racp_opc_t {   CY_BLE_PLXS_RACP_OPC_RESERVED = 0u,   CY_BLE_PLXS_RACP_OPC_REPORT_REC,   CY_BLE_PLXS_RACP_OPC_DELETE_REC,   CY_BLE_PLXS_RACP_OPC_ABORT_OPN,   CY_BLE_PLXS_RACP_OPC_REPORT_NUM_REC,   CY_BLE_PLXS_RACP_OPC_NUM_REC_RSP,   CY_BLE_PLXS_RACP_OPC_RSP_CODE }
	Record Access Control Point Characteristic fields defines Opcode of the Record Access Control Point Characteristic value type. More...
enum	cy_en_ble_plxs_racp_opr_t {   CY_BLE_PLXS_RACP_OPR_NULL = 0u,   CY_BLE_PLXS_RACP_OPR_ALL,   CY_BLE_PLXS_RACP_OPR_LESS,   CY_BLE_PLXS_RACP_OPR_GREAT,   CY_BLE_PLXS_RACP_OPR_WITHIN,   CY_BLE_PLXS_RACP_OPR_FIRST,   CY_BLE_PLXS_RACP_OPR_LAST }
	Operator of the Record Access Control Point Characteristic value type. More...
enum	cy_en_ble_plxs_racp_opd_t {   CY_BLE_PLXS_RACP_OPD_NA = 0u,   CY_BLE_PLXS_RACP_OPD_1,   CY_BLE_PLXS_RACP_OPD_2,   CY_BLE_PLXS_RACP_OPD_NO_INCL,   CY_BLE_PLXS_RACP_OPD_4,   CY_BLE_PLXS_RACP_OPD_NUM_REC,   CY_BLE_PLXS_RACP_OPD_RSP }
	Operand of the Record Access Control Point Characteristic value type. More...
enum	cy_en_ble_plxs_racp_rsp_t {   CY_BLE_PLXS_RACP_RSP_NA = 0u,   CY_BLE_PLXS_RACP_RSP_SUCCESS,   CY_BLE_PLXS_RACP_RSP_UNSPRT_OPC,   CY_BLE_PLXS_RACP_RSP_INV_OPR,   CY_BLE_PLXS_RACP_RSP_UNSPRT_OPR,   CY_BLE_PLXS_RACP_RSP_INV_OPD,   CY_BLE_PLXS_RACP_RSP_NO_REC,   CY_BLE_PLXS_RACP_RSP_UNSUCCESS,   CY_BLE_PLXS_RACP_RSP_NO_COMPL,   CY_BLE_PLXS_RACP_RSP_UNSPRT_OPD }
	Operand Response Code Values of the Record Access Control Point Characteristic value type. More...

Enumeration Type Documentation

cy_en_ble_plxs_char_index_t

enum cy_en_ble_plxs_char_index_t

PLXS Characteristic indexes.

Enumerator
CY_BLE_PLXS_SCMT	The PLX Spot-check Measurement Characteristic, if supported, is used to send Spot-check measurements of SpO2 (Percent oxygen saturation of hemoglobin) and PR (pulse rate). This Characteristic is a variable length structure containing the Flags field, the SpO2PR-Spot-Check field, and depending on the contents of the Flags field, the Timestamp field, the Measurement Status field, the Device and Sensor Status field, and/or the Pulse Amplitude Index field.
CY_BLE_PLXS_CTMT	The PLX Continuous Measurement Characteristic, if supported, is used to send periodic pulse oximetry measurements. This Characteristic is a variable length structure containing the Flags field (to indicate presence of optional fields), the SpO2PR-Normal field, and depending on the contents of the Flags field, the SpO2PR-Fast field, the SpO2PR-Slow field, the Measurement Status field, the Device and Sensor Status field, and/or the Pulse Amplitude Index field.
CY_BLE_PLXS_FEAT	The PLX Features Characteristic is used to describe the supported features of the server. Included in the Characteristic is a PLX Features field, and, depending on the contents of the PLX Features field, the Measurement Status Support field, and the Device and Sensor Status Support field.
CY_BLE_PLXS_RACP	This control point is used with a service to provide basic management functionality for the PLX Sensor patient record database. This enables functions including counting records, transmitting records and clearing records based on filter criterion. The filter criterion in the Operand field is defined by the service that references this Characteristic as is the format of a record (that may be comprised of one or more Characteristics) and the sequence of transferred records.
CY_BLE_PLXS_CHAR_COUNT	Total Count of PLXS Characteristics.

cy_en_ble_plxs_descr_index_t

enum cy_en_ble_plxs_descr_index_t

PLXS Characteristic Descriptors indexes.

Enumerator
CY_BLE_PLXS_CCCD	Client Characteristic Configuration Descriptor index.
CY_BLE_PLXS_DESCR_COUNT	Total Count of Descriptors.

cy_en_ble_plxs_racp_opc_t

enum cy_en_ble_plxs_racp_opc_t

Record Access Control Point Characteristic fields defines Opcode of the Record Access Control Point Characteristic value type.

Enumerator
CY_BLE_PLXS_RACP_OPC_RESERVED	Reserved for future use (Operator:N/A)
CY_BLE_PLXS_RACP_OPC_REPORT_REC	Report stored records (Operator: Value from Operator Table)
CY_BLE_PLXS_RACP_OPC_DELETE_REC	Delete stored records (Operator: Value from Operator Table)
CY_BLE_PLXS_RACP_OPC_ABORT_OPN	Abort operation (Operator: Null 'value of 0x00 from Operator Table')
CY_BLE_PLXS_RACP_OPC_REPORT_NUM_REC	Report number of stored records (Operator: Value from Operator Table)
CY_BLE_PLXS_RACP_OPC_NUM_REC_RSP	Number of stored records response (Operator: Null 'value of 0x00 from Operator Table')
CY_BLE_PLXS_RACP_OPC_RSP_CODE	Response Code (Operator: Null 'value of 0x00 from Operator Table')

cy_en_ble_plxs_racp_opr_t

enum cy_en_ble_plxs_racp_opr_t

Operator of the Record Access Control Point Characteristic value type.

Enumerator
CY_BLE_PLXS_RACP_OPR_NULL	Null.
CY_BLE_PLXS_RACP_OPR_ALL	All records.
CY_BLE_PLXS_RACP_OPR_LESS	Less than or equal to.
CY_BLE_PLXS_RACP_OPR_GREAT	Greater than or equal to.
CY_BLE_PLXS_RACP_OPR_WITHIN	Within range of (inclusive)
CY_BLE_PLXS_RACP_OPR_FIRST	First record(i.e. oldest record)
CY_BLE_PLXS_RACP_OPR_LAST	Last record (i.e. most recent record)

cy_en_ble_plxs_racp_opd_t

enum cy_en_ble_plxs_racp_opd_t

Operand of the Record Access Control Point Characteristic value type.

Enumerator
CY_BLE_PLXS_RACP_OPD_NA	N/A.
CY_BLE_PLXS_RACP_OPD_1	Filter parameters (as appropriate to Operator and Service)
CY_BLE_PLXS_RACP_OPD_2	Filter parameters (as appropriate to Operator and Service)
CY_BLE_PLXS_RACP_OPD_NO_INCL	Not included.
CY_BLE_PLXS_RACP_OPD_4	Filter parameters (as appropriate to Operator and Service)
CY_BLE_PLXS_RACP_OPD_NUM_REC	Number of Records (Field size defined per service)
CY_BLE_PLXS_RACP_OPD_RSP	Request Op Code, Response Code Value.

cy_en_ble_plxs_racp_rsp_t

enum cy_en_ble_plxs_racp_rsp_t

Operand Response Code Values of the Record Access Control Point Characteristic value type.

Enumerator
CY_BLE_PLXS_RACP_RSP_NA	N/A.
CY_BLE_PLXS_RACP_RSP_SUCCESS	Normal response for successful operation.
CY_BLE_PLXS_RACP_RSP_UNSPRT_OPC	Normal response if unsupported Op Code is received.
CY_BLE_PLXS_RACP_RSP_INV_OPR	Normal response if Operator received does not meet the requirements of the service (e.g. Null was expected)
CY_BLE_PLXS_RACP_RSP_UNSPRT_OPR	Normal response if unsupported Operator is received.
CY_BLE_PLXS_RACP_RSP_INV_OPD	Normal response if Operand received does not meet the requirements of the service.
CY_BLE_PLXS_RACP_RSP_NO_REC	Normal response if request to report stored records or request to delete stored records resulted in no records meeting criteria.
CY_BLE_PLXS_RACP_RSP_UNSUCCESS	Normal response if request for Abort cannot be completed.
CY_BLE_PLXS_RACP_RSP_NO_COMPL	Normal response if request for Abort cannot be completed.
CY_BLE_PLXS_RACP_RSP_UNSPRT_OPD	Normal response if unsupported Operand is received.