BlueNRG-MS pack for STM32CubeMX: GATT events

STM32CubeMX BlueNRG-MS

BlueNRG-MS pack for STM32CubeMX  V4.4.0
The BlueNRG-MS pack is an additional software for STM32CubeMX.

Data Structures

struct  _evt_gatt_attr_modified_IDB05A1
 
struct  _evt_gatt_attr_modified_IDB04A1
 
struct  _evt_gatt_procedure_timeout
 
struct  _evt_att_exchange_mtu_resp
 
struct  _evt_att_find_information_resp
 
struct  _evt_att_find_by_type_val_resp
 
struct  _evt_att_read_by_type_resp
 
struct  _evt_att_read_resp
 
struct  _evt_att_read_blob_resp
 
struct  _evt_att_read_mult_resp
 
struct  _evt_att_read_by_group_resp
 
struct  _evt_att_prepare_write_resp
 
struct  _evt_att_exec_write_resp
 
struct  _evt_gatt_indication
 
struct  _evt_gatt_notification
 
struct  _evt_gatt_procedure_complete
 
struct  _evt_gatt_error_resp
 
struct  _evt_gatt_disc_read_char_by_uuid_resp
 
struct  _evt_gatt_write_permit_req
 
struct  _evt_gatt_read_permit_req
 
struct  _evt_gatt_read_multi_permit_req
 
struct  _evt_gatt_tx_pool_available
 
struct  _evt_gatt_server_confirmation
 
struct  _evt_gatt_prepare_write_permit_req
 

Macros

#define EVT_BLUE_GATT_ATTRIBUTE_MODIFIED   (0x0C01)
 
#define EVT_BLUE_GATT_PROCEDURE_TIMEOUT   (0x0C02)
 
#define EVT_BLUE_ATT_EXCHANGE_MTU_RESP   (0x0C03)
 
#define EVT_BLUE_ATT_FIND_INFORMATION_RESP   (0x0C04)
 
#define EVT_BLUE_ATT_FIND_BY_TYPE_VAL_RESP   (0x0C05)
 
#define EVT_BLUE_ATT_READ_BY_TYPE_RESP   (0x0C06)
 
#define EVT_BLUE_ATT_READ_RESP   (0x0C07)
 
#define EVT_BLUE_ATT_READ_BLOB_RESP   (0x0C08)
 
#define EVT_BLUE_ATT_READ_MULTIPLE_RESP   (0x0C09)
 
#define EVT_BLUE_ATT_READ_BY_GROUP_TYPE_RESP   (0x0C0A)
 
#define EVT_BLUE_ATT_PREPARE_WRITE_RESP   (0x0C0C)
 
#define EVT_BLUE_ATT_EXEC_WRITE_RESP   (0x0C0D)
 
#define EVT_BLUE_GATT_INDICATION   (0x0C0E)
 
#define EVT_BLUE_GATT_NOTIFICATION   (0x0C0F)
 
#define EVT_BLUE_GATT_PROCEDURE_COMPLETE   (0x0C10)
 
#define EVT_BLUE_GATT_ERROR_RESP   (0x0C11)
 
#define EVT_BLUE_GATT_DISC_READ_CHAR_BY_UUID_RESP   (0x0C12)
 
#define EVT_BLUE_GATT_WRITE_PERMIT_REQ   (0x0C13)
 
#define EVT_BLUE_GATT_READ_PERMIT_REQ   (0x0C14)
 
#define EVT_BLUE_GATT_READ_MULTI_PERMIT_REQ   (0x0C15)
 
#define EVT_BLUE_GATT_TX_POOL_AVAILABLE   (0x0C16)
 
#define EVT_BLUE_GATT_SERVER_CONFIRMATION_EVENT   (0x0C17)
 
#define EVT_BLUE_GATT_PREPARE_WRITE_PERMIT_REQ   (0x0C18)
 

Typedefs

typedef __packed struct _evt_gatt_attr_modified_IDB05A1 evt_gatt_attr_modified_IDB05A1
 
typedef __packed struct _evt_gatt_attr_modified_IDB04A1 evt_gatt_attr_modified_IDB04A1
 
typedef __packed struct _evt_gatt_procedure_timeout evt_gatt_procedure_timeout
 
typedef __packed struct _evt_att_exchange_mtu_resp evt_att_exchange_mtu_resp
 
typedef __packed struct _evt_att_find_information_resp evt_att_find_information_resp
 
typedef __packed struct _evt_att_find_by_type_val_resp evt_att_find_by_type_val_resp
 
typedef __packed struct _evt_att_read_by_type_resp evt_att_read_by_type_resp
 
typedef __packed struct _evt_att_read_resp evt_att_read_resp
 
typedef __packed struct _evt_att_read_blob_resp evt_att_read_blob_resp
 
typedef __packed struct _evt_att_read_mult_resp evt_att_read_mult_resp
 
typedef __packed struct _evt_att_read_by_group_resp evt_att_read_by_group_resp
 
typedef __packed struct _evt_att_prepare_write_resp evt_att_prepare_write_resp
 
typedef __packed struct _evt_att_exec_write_resp evt_att_exec_write_resp
 
typedef __packed struct _evt_gatt_indication evt_gatt_indication
 
typedef __packed struct _evt_gatt_notification evt_gatt_attr_notification
 
typedef __packed struct _evt_gatt_procedure_complete evt_gatt_procedure_complete
 
typedef __packed struct _evt_gatt_error_resp evt_gatt_error_resp
 
typedef __packed struct _evt_gatt_disc_read_char_by_uuid_resp evt_gatt_disc_read_char_by_uuid_resp
 
typedef __packed struct _evt_gatt_write_permit_req evt_gatt_write_permit_req
 
typedef __packed struct _evt_gatt_read_permit_req evt_gatt_read_permit_req
 
typedef __packed struct _evt_gatt_read_multi_permit_req evt_gatt_read_multi_permit_req
 
typedef __packed struct _evt_gatt_tx_pool_available evt_gatt_tx_pool_available
 
typedef __packed struct _evt_gatt_server_confirmation evt_gatt_server_confirmation
 
typedef __packed struct _evt_gatt_prepare_write_permit_req evt_gatt_prepare_write_permit_req
 

Detailed Description

The structures are the data field of evt_blue_aci.

Macro Definition Documentation

◆ EVT_BLUE_ATT_EXCHANGE_MTU_RESP

#define EVT_BLUE_ATT_EXCHANGE_MTU_RESP   (0x0C03)

This event is generated in response to an Exchange MTU request. See aci_gatt_exchange_configuration(). See _evt_att_exchange_mtu_resp.

◆ EVT_BLUE_ATT_EXEC_WRITE_RESP

#define EVT_BLUE_ATT_EXEC_WRITE_RESP   (0x0C0D)

This event is generated in response to an Execute Write Request. For more info see Execute Write Response in Bluetooth Core v4.0 spec. See _evt_att_exec_write_resp.

◆ EVT_BLUE_ATT_FIND_BY_TYPE_VAL_RESP

#define EVT_BLUE_ATT_FIND_BY_TYPE_VAL_RESP   (0x0C05)

This event is generated in response to a Find By Type Value Request. See Find By Type Value Response in Bluetooth Core v4.0 spec. See _evt_att_find_by_type_val_resp.

◆ EVT_BLUE_ATT_FIND_INFORMATION_RESP

#define EVT_BLUE_ATT_FIND_INFORMATION_RESP   (0x0C04)

This event is generated in response to a Find Information Request. See aci_att_find_information_req() and Find Information Response in Bluetooth Core v4.0 spec. See _evt_att_find_information_resp.

◆ EVT_BLUE_ATT_PREPARE_WRITE_RESP

#define EVT_BLUE_ATT_PREPARE_WRITE_RESP   (0x0C0C)

This event is generated in response to a Prepare Write Request. For more info see Prepare Write Response in Bluetooth Core v4.0 spec. See _evt_att_prepare_write_resp.

◆ EVT_BLUE_ATT_READ_BLOB_RESP

#define EVT_BLUE_ATT_READ_BLOB_RESP   (0x0C08)

This event is generated in response to a Read Blob Request. See aci_gatt_read_long_charac_val(). For more info see Read Blob Response in Bluetooth Core v4.0 spec. See _evt_att_read_blob_resp.

◆ EVT_BLUE_ATT_READ_BY_GROUP_TYPE_RESP

#define EVT_BLUE_ATT_READ_BY_GROUP_TYPE_RESP   (0x0C0A)

This event is generated in response to a Read By Group Type Request. See aci_gatt_disc_all_prim_services(). For more info see Read By Group type Response in Bluetooth Core v4.0 spec. See _evt_att_read_by_group_resp.

◆ EVT_BLUE_ATT_READ_BY_TYPE_RESP

#define EVT_BLUE_ATT_READ_BY_TYPE_RESP   (0x0C06)

This event is generated in response to a Read By Type Request. See aci_gatt_find_included_services() and aci_gatt_disc_all_charac_of_serv(). For more info see Read By Type Response in Bluetooth Core v4.0 spec. See _evt_att_read_by_type_resp.

◆ EVT_BLUE_ATT_READ_MULTIPLE_RESP

#define EVT_BLUE_ATT_READ_MULTIPLE_RESP   (0x0C09)

This event is generated in response to a Read Multiple Request. For more info see Read Multiple Response in Bluetooth Core v4.0 spec. See _evt_att_read_mult_resp.

◆ EVT_BLUE_ATT_READ_RESP

#define EVT_BLUE_ATT_READ_RESP   (0x0C07)

This event is generated in response to a Read Request. See aci_gatt_read_charac_val(). For more info see Read Response in Bluetooth Core v4.0 spec. See _evt_att_read_resp.

◆ EVT_BLUE_GATT_ATTRIBUTE_MODIFIED

#define EVT_BLUE_GATT_ATTRIBUTE_MODIFIED   (0x0C01)

This event (if enabled, see Gatt Event Mask) is raised to the application by the GATT server when a client modifies any attribute on the server, as consequence of one of the following GATT procedures:

  • write without response
  • signed write without response
  • write characteristic value
  • write long characteristic value
  • reliable write. See _evt_gatt_attr_modified_IDB04A1 or _evt_gatt_attr_modified__IDB05A1.

◆ EVT_BLUE_GATT_DISC_READ_CHAR_BY_UUID_RESP

#define EVT_BLUE_GATT_DISC_READ_CHAR_BY_UUID_RESP   (0x0C12)

This event can be generated during a "Discover Characteristics By UUID" procedure or a "Read using Characteristic UUID" procedure. The attribute value will be a service declaration as defined in Bluetooth Core v4.0 spec (vol.3, Part G, ch. 3.3.1), when a "Discover Characteristics By UUID" has been started. It will be the value of the Characteristic if a "Read using Characteristic UUID" has been performed. See _evt_gatt_disc_read_char_by_uuid_resp.

◆ EVT_BLUE_GATT_ERROR_RESP

#define EVT_BLUE_GATT_ERROR_RESP   (0x0C11)

This event is generated when an Error Response is received from the server. The error response can be given by the server at the end of one of the GATT discovery procedures. This does not mean that the procedure ended with an error, but this error event is part of the procedure itself. See _evt_gatt_error_resp.

◆ EVT_BLUE_GATT_INDICATION

#define EVT_BLUE_GATT_INDICATION   (0x0C0E)

This event is generated when an indication is received from the server. For more info see Handle Value Indication in Bluetooth Core v4.0 spec. See _evt_gatt_indication.

◆ EVT_BLUE_GATT_NOTIFICATION

#define EVT_BLUE_GATT_NOTIFICATION   (0x0C0F)

This event is generated when a notification is received from the server. For more info see Handle Value Notification in Bluetooth Core v4.0 spec. See _evt_gatt_notification.

◆ EVT_BLUE_GATT_PREPARE_WRITE_PERMIT_REQ

#define EVT_BLUE_GATT_PREPARE_WRITE_PERMIT_REQ   (0x0C18)

This event is given to the application when a prepare write request is received by the server from the client. This event will be given to the application only if the event bit for this event generation is set when the characteristic was added. When this event is received, the application has to check whether the value being requested for write is allowed to be written and respond with the command aci_gatt_write_response(). Based on the response from the application, the attribute value will be modified by the stack. If the write is rejected by the application, then the value of the attribute will not be modified and an error response will be sent to the client, with the error code as specified by the application. See evt_gatt_write_permit_req.

◆ EVT_BLUE_GATT_PROCEDURE_COMPLETE

#define EVT_BLUE_GATT_PROCEDURE_COMPLETE   (0x0C10)

This event is generated when a GATT client procedure completes either with error or successfully. See _evt_gatt_procedure_complete.

◆ EVT_BLUE_GATT_PROCEDURE_TIMEOUT

#define EVT_BLUE_GATT_PROCEDURE_TIMEOUT   (0x0C02)

This event is generated by the client/server to the application on a GATT timeout (30 seconds). See _evt_gatt_procedure_timeout.

◆ EVT_BLUE_GATT_READ_MULTI_PERMIT_REQ

#define EVT_BLUE_GATT_READ_MULTI_PERMIT_REQ   (0x0C15)

This event is given to the application when a read multiple request or read by type request is received by the server from the client. This event will be given to the application only if the event bit for this event generation is set when the characteristic was added. On receiving this event, the application can update the values of the handles if it desires and when done it has to send the aci_gatt_allow_read command to indicate to the stack that it can send the response to the client. See evt_gatt_read_multi_permit_req.

◆ EVT_BLUE_GATT_READ_PERMIT_REQ

#define EVT_BLUE_GATT_READ_PERMIT_REQ   (0x0C14)

This event is given to the application when a read request or read blob request is received by the server from the client. This event will be given to the application only if the event bit for this event generation is set when the characteristic was added. On receiving this event, the application can update the value of the handle if it desires and when done it has to use the aci_gatt_allow_read() command to indicate to the stack that it can send the response to the client. See evt_gatt_read_permit_req.

◆ EVT_BLUE_GATT_SERVER_CONFIRMATION_EVENT

#define EVT_BLUE_GATT_SERVER_CONFIRMATION_EVENT   (0x0C17)

This event is raised on the server when the client confirms the reception of an indication.

◆ EVT_BLUE_GATT_TX_POOL_AVAILABLE

#define EVT_BLUE_GATT_TX_POOL_AVAILABLE   (0x0C16)

This event is raised when the number of available TX buffers is above a threshold TH (TH = 2). The event will be given only if a previous ACI command returned with BLE_STATUS_INSUFFICIENT_RESOURCES. On receiving this event, the application can continue to send notifications by calling aci_gatt_update_char_value(). See evt_gatt_tx_pool_vailable.

◆ EVT_BLUE_GATT_WRITE_PERMIT_REQ

#define EVT_BLUE_GATT_WRITE_PERMIT_REQ   (0x0C13)

This event is given to the application when a write request, write command or signed write command is received by the server from the client. This event will be given to the application only if the event bit for this event generation is set when the characteristic was added. When this event is received, the application has to check whether the value being requested for write is allowed to be written and respond with the command aci_gatt_write_response(). If the write is rejected by the application, then the value of the attribute will not be modified. In case of a write request, an error response will be sent to the client, with the error code as specified by the application. In case of write/signed write commands, no response is sent to the client but the attribute is not modified. See evt_gatt_write_permit_req.

Typedef Documentation

◆ evt_att_exchange_mtu_resp

◆ evt_att_exec_write_resp

◆ evt_att_find_by_type_val_resp

◆ evt_att_find_information_resp

◆ evt_att_prepare_write_resp

◆ evt_att_read_blob_resp

◆ evt_att_read_by_group_resp

◆ evt_att_read_by_type_resp

◆ evt_att_read_mult_resp

◆ evt_att_read_resp

typedef __packed struct _evt_att_read_resp evt_att_read_resp

◆ evt_gatt_attr_modified_IDB04A1

◆ evt_gatt_attr_modified_IDB05A1

◆ evt_gatt_attr_notification

◆ evt_gatt_disc_read_char_by_uuid_resp

◆ evt_gatt_error_resp

typedef __packed struct _evt_gatt_error_resp evt_gatt_error_resp

◆ evt_gatt_indication

typedef __packed struct _evt_gatt_indication evt_gatt_indication

◆ evt_gatt_prepare_write_permit_req

◆ evt_gatt_procedure_complete

◆ evt_gatt_procedure_timeout

◆ evt_gatt_read_multi_permit_req

◆ evt_gatt_read_permit_req

◆ evt_gatt_server_confirmation

◆ evt_gatt_tx_pool_available

◆ evt_gatt_write_permit_req

Generated on Mon Apr 15 2019 18:10:40 for BlueNRG-MS pack for STM32CubeMX by   doxygen 1.8.13