| STM32L - BlueNRG-1 BLE stack APIs, Events and Constants

- Main Page
- Modules
- Classes
- Files

Classes | Typedefs | Functions
HCI LE meta events

HCI LE meta events layer. More...

## Classes

struct | Advertising_Report_t_s

## Typedefs

typedef struct Advertising_Report_t_s | Advertising_Report_t

## Functions

| WEAK_FUNCTION (void hci_le_connection_complete_event(uint8_t Status, uint16_t Connection_Handle, uint8_t Role, uint8_t Peer_Address_Type, uint8_t Peer_Address[6], uint16_t Conn_Interval, uint16_t Conn_Latency, uint16_t Supervision_Timeout, uint8_t Master_Clock_Accuracy))
| The LE Connection Complete event indicates to both of the Hosts forming the connection that a new connection has been created. Upon the creation of the connection a Connection_Handle shall be assigned by the Controller, and passed to the Host in this event. If the connection establishment fails this event shall be provided to the Host that had issued the LE_Create_Connection command. This event indicates to the Host which issued a LE_Create_Connection command and received a Command Status event if the connection establishment failed or was successful. The Master_Clock_Accuracy parameter is only valid for a slave. On a master, this parameter shall be set to 0x00. More...
| WEAK_FUNCTION (void hci_le_advertising_report_event(uint8_t Num_Reports, Advertising_Report_t Advertising_Report[]))
| The LE Advertising Report event indicates that a Bluetooth device or multiple Bluetooth devices have responded to an active scan or received some information during a passive scan. The Controller may queue these advertising reports and send information from multiple devices in one LE Advertising Report event. More...
| WEAK_FUNCTION (void hci_le_connection_update_complete_event(uint8_t Status, uint16_t Connection_Handle, uint16_t Conn_Interval, uint16_t Conn_Latency, uint16_t Supervision_Timeout))
| The LE Connection Update Complete event is used to indicate that the Controller process to update the connection has completed. On a slave, if no connection parameters are updated, then this event shall not be issued. On a master, this event shall be issued if the Connection_Update command was sent. More...
| WEAK_FUNCTION (void hci_le_read_remote_used_features_complete_event(uint8_t Status, uint16_t Connection_Handle, uint8_t LE_Features[8]))
| The LE Read Remote Used Features Complete event is used to indicate the completion of the process of the Controller obtaining the used features of the remote Bluetooth device specified by the Connection_Handle event parameter. More...
| WEAK_FUNCTION (void hci_le_long_term_key_request_event(uint16_t Connection_Handle, uint8_t Random_Number[8], uint16_t Encrypted_Diversifier))
| The LE Long Term Key Request event indicates that the master device is attempting to encrypt or re-encrypt the link and is requesting the Long Term Key from the Host. (See [Vol 6] Part B, Section 5.1.3). More...

## Detailed Description

HCI LE meta events layer.

## Typedef Documentation

typedef struct Advertising_Report_t_s Advertising_Report_t

Documentation for Advertising_Report_t

## Function Documentation

WEAK_FUNCTION | ( | void | hci_le_connection_complete_eventuint8_t Status, uint16_t Connection_Handle, uint8_t Role, uint8_t Peer_Address_Type, uint8_t Peer_Address[6], uint16_t Conn_Interval, uint16_t Conn_Latency, uint16_t Supervision_Timeout, uint8_t Master_Clock_Accuracy | ) |

The LE Connection Complete event indicates to both of the Hosts forming the connection that a new connection has been created. Upon the creation of the connection a Connection_Handle shall be assigned by the Controller, and passed to the Host in this event. If the connection establishment fails this event shall be provided to the Host that had issued the LE_Create_Connection command. This event indicates to the Host which issued a LE_Create_Connection command and received a Command Status event if the connection establishment failed or was successful. The Master_Clock_Accuracy parameter is only valid for a slave. On a master, this parameter shall be set to 0x00.

Parameters

  Status | Error code
  Connection_Handle | Connection_Handle to be used to identify a connection between two Bluetooth devices. Range: 0x0000-0x0EFF (0x0F00 - 0x0FFF Reserved for future use)
  Role | 0x00 Connection is master 0x01 Connection is slave 0x02-0xFF Reserved for future use
  Peer_Address_Type | The address type of the peer device: 0x00 Public Device Address 0x01 Random Device Address 0x02-0xFF Reserved for future use
  Peer_Address | Public Device Address or Random Device Address of the peer device
  Conn_Interval | Connection interval used on this connection. Range: 0x0006 to 0x0C80 Time = N * 1.25 msec Time Range: 7.5 msec to 4000 msec.
  Conn_Latency | Slave latency for the connection in number of connection events. Range: 0x0000 to 0x01F3
  Supervision_Timeout | N = 0xXXXX Supervision timeout for the LE Link. (See [Vol 6] Part B, Section 4.5.2) Range: 0x000A to 0x0C80 Time = N * 10 msec Time Range: 100 msec to 32 seconds 0x0000 - 0x0009 and 0x0C81 - 0xFFFF Reserved for future use
  Master_Clock_Accuracy | 0x00 500 ppm 0x01 250 ppm 0x02 150 ppm 0x03 100 ppm 0x04 75 ppm 0x05 50 ppm 0x06 30 ppm 0x07 20 ppm 0x08-0xFF Reserved for future use

Return values

  None |

WEAK_FUNCTION | ( | void | hci_le_advertising_report_eventuint8_t Num_Reports, Advertising_Report_t Advertising_Report[] | ) |

The LE Advertising Report event indicates that a Bluetooth device or multiple Bluetooth devices have responded to an active scan or received some information during a passive scan. The Controller may queue these advertising reports and send information from multiple devices in one LE Advertising Report event.

Parameters

  Num_Reports | 0x01 - 0x19 Number of responses in event.
  Advertising_Report | See Advertising_Report_t

Return values

  None |

WEAK_FUNCTION | ( | void | hci_le_connection_update_complete_eventuint8_t Status, uint16_t Connection_Handle, uint16_t Conn_Interval, uint16_t Conn_Latency, uint16_t Supervision_Timeout | ) |

The LE Connection Update Complete event is used to indicate that the Controller process to update the connection has completed. On a slave, if no connection parameters are updated, then this event shall not be issued. On a master, this event shall be issued if the Connection_Update command was sent.

Parameters

  Status | Error code
  Connection_Handle | Connection_Handle to be used to identify a connection between two Bluetooth devices. Range: 0x0000-0x0EFF (0x0F00 - 0x0FFF Reserved for future use)
  Conn_Interval | Connection interval used on this connection. Range: 0x0006 to 0x0C80 Time = N * 1.25 msec Time Range: 7.5 msec to 4000 msec.
  Conn_Latency | Slave latency for the connection in number of connection events. Range: 0x0000 to 0x01F3
  Supervision_Timeout | N = 0xXXXX Supervision timeout for the LE Link. (See [Vol 6] Part B, Section 4.5.2) Range: 0x000A to 0x0C80 Time = N * 10 msec Time Range: 100 msec to 32 seconds 0x0000 - 0x0009 and 0x0C81 - 0xFFFF Reserved for future use

Return values

  None |

WEAK_FUNCTION | ( | void | hci_le_read_remote_used_features_complete_eventuint8_t Status, uint16_t Connection_Handle, uint8_t LE_Features[8] | ) |

The LE Read Remote Used Features Complete event is used to indicate the completion of the process of the Controller obtaining the used features of the remote Bluetooth device specified by the Connection_Handle event parameter.

Parameters

  Status | Error code
  Connection_Handle | Connection_Handle to be used to identify a connection between two Bluetooth devices. Range: 0x0000-0x0EFF (0x0F00 - 0x0FFF Reserved for future use)
  LE_Features | Bit Mask List of used LE features. For details see LE Link Layer specification.

Return values

  None |

WEAK_FUNCTION | ( | void | hci_le_long_term_key_request_eventuint16_t Connection_Handle, uint8_t Random_Number[8], uint16_t Encrypted_Diversifier | ) |

The LE Long Term Key Request event indicates that the master device is attempting to encrypt or re-encrypt the link and is requesting the Long Term Key from the Host. (See [Vol 6] Part B, Section 5.1.3).

Parameters

  Connection_Handle | Connection_Handle to be used to identify a connection between two Bluetooth devices. Range: 0x0000-0x0EFF (0x0F00 - 0x0FFF Reserved for future use)
  Random_Number | 64-bit random number
  Encrypted_Diversifier | 16-bit encrypted diversifier

Return values

  None |