Module bluenrg::event

Vendor-specific events for BlueNRG controllers.

The BlueNRG implementation defines several additional events that are packaged as vendor-specific events by the Bluetooth HCI. This module defines those events and functions to deserialize buffers into them.

Modules

command

Return parameters for vendor-specific commands.

Structs

AttErrorResponse	The Error Response is used to state that a given request cannot be performed, and to provide the reason. See the Bluetooth Core Specification, v4.1, Vol 3, Part F, Section 3.4.1.1.
AttExchangeMtuResponse	This event is generated in response to an Exchange MTU request.
AttFindByTypeValueResponse	This event is generated in response to a Find By Type Value Request.
AttFindInformationResponse	This event is generated in response to a Find Information Request. See Find Information Response in Bluetooth Core v4.0 spec.
AttPrepareWritePermitRequest	This event is given to the application when a prepare write request is received by the server from the client.
AttPrepareWriteResponse	This event is generated in response to a Prepare Write Request. See the Bluetooth Core v4.1 spec, Vol 3, Part F, section 3.4.6.1 and 3.4.6.2
AttReadByGroupTypeResponse	This event is generated in response to a Read By Group Type Request. See the Bluetooth Core v4.1 spec, Vol 3, section 3.4.4.9 and 3.4.4.10.
AttReadByTypeResponse	This event is generated in response to a Read By Type Request.
AttReadMultiplePermitRequest	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 gatt_allow_read command to indicate to the stack that it can send the response to the client.
AttReadPermitRequest	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 allow_read command to indicate to the stack that it can send the response to the client.
AttReadResponse	This event is generated in response to a Read Request.
AttributeData	Attribute data returned in the AttReadByGroupTypeResponse event.
AttributeDataIterator	Iterator over the attribute data returned in the AttReadByGroupTypeResponse.
AttributeHandle	Newtype for an attribute handle. These handles are IDs, not general integers, and should not be manipulated as such.
AttributeValue	Defines the attribute value returned by a GATT Indication or GATT Notification event.
BdAddr	Newtype for BDADDR.
ConnectionHandle	Newtype for a connection handle.
ConnectionInterval	Define a connection interval range with its latency and supervision timeout. This value is passed to the controller, which determines the actual connection interval.
EventFlags	Bitfield for the Events Lost event. Each bit indicates a different type of event that was not handled.
FaultData	Fault data reported after a crash.
GapDeviceFound	The event is given by the GAP layer to the upper layers when a device is discovered during scanning as a consequence of one of the GAP procedures started by the upper layers.
GapPairingComplete	This event is generated when the pairing process has completed successfully or a pairing procedure timeout has occurred or the pairing has failed. This is to notify the application that we have paired with a remote device so that it can take further actions or to notify that a timeout has occurred so that the upper layer can decide to disconnect the link.
GapProcedureComplete	This event is sent by the GAP to the upper layers when a procedure previously started has been terminated by the upper layer or has completed for any other reason
GattAttributeModified	This event is generated to the application by the ATT server when a client modifies any attribute on the server, as consequence of one of the following ATT procedures:
GattProcedureComplete	This event is generated when a GATT client procedure completes either with error or successfully.
GattTxPoolAvailable	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 InsufficientResources.
GroupEndHandle	Newtype for Group End handles
HandleInfoPair	Simple container for the handle information returned in AttFindByTypeValueResponse.
HandleInfoPairIterator	Iterator into valid HandleInfoPair structs returned in the ATT Find By Type Value Response event.
HandleUuid128Pair	One format of the handle-UUID pairs in the AttFindInformationResponse event. The UUIDs are 128 bits.
HandleUuid128PairIterator	Iterator over handle-UUID pairs for 128-bit UUIDs.
HandleUuid16Pair	One format of the handle-UUID pairs in the AttFindInformationResponse event. The UUIDs are 16 bits.
HandleUuid16PairIterator	Iterator over handle-UUID pairs for 16-bit UUIDs.
HandleValuePair	A single handle-value pair returned by the ATT Read by Type response.
HandleValuePairIterator	Iterator over the valid handle-value pairs returned with the ATT Read by Type response.
L2CapConnectionUpdateRequest	The event is given by the L2CAP layer when a connection update request is received from the peripheral.
L2CapConnectionUpdateResponse	This event is generated when the central device responds to the L2CAP connection update request packet.
L2CapProcedureTimeout	This event is generated when the central device does not respond to the connection update request within 30 seconds.
NameBuffer	Newtype for the name buffer returned after successful NameDiscovery.
Uuid16	Newtype for the 16-bit UUID buffer.
Uuid128	Newtype for the 128-bit UUID buffer.

Enums

AttError	Potential error codes for the ATT Error Response. See Table 3.3 in the Bluetooth Core Specification, v4.1, Vol 3, PartF, Section 3.4.1.1 and The Bluetooth Core Specification Supplement, Table 1.1.
AttRequest	Possible ATT requests. See Table 3.37 in the Bluetooth Core Spec v4.1, Vol 3, Part F, Section 3.4.8.
BdAddrType	Potential values for BDADDR
BlueNRGError	Enumeration of potential errors when sending commands or deserializing events.
BlueNRGEvent	Vendor-specific events for the BlueNRG-MS controllers.
ConnectionIntervalError	Types of errors that can occure when creating a ConnectionInterval.
CrashReason	Specific reason for the fault reported with FaultData.
GapDeviceFoundEvent	Types of advertisement reports.
GapPairingStatus	Reasons the GAP Pairing Complete event was generated.
GapProcedure	Procedures whose completion may be reported by GapProcedureComplete.
GapProcedureStatus	Possible results of a GAP procedure.
GattProcedureStatus	Allowed status codes for the GATT Procedure Complete event.
HandleUuidPairIterator	Possible iterators over handle-UUID pairs that can be returnedby the ATT find information response. All pairs from the same event have the same format.
L2CapConnectionUpdateResult	Potential results that can be used in the L2CAP connection update response.
L2CapRejectionReason	Reasons why an L2CAP command was rejected. see the Bluetooth specification, v4.1, Vol 3, Part A, Section 4.1.
ResetReason	Potential reasons the controller sent the HalInitialized event.
Status	Enumeration of vendor-specific status codes.

Constants

MAX_NAME_LEN

Maximum length of the name returned in the NameDiscovery procedure.