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

- Main Page
- Modules
- Classes
- Files

Functions
ACI GAP events

ACI GAP events layer. More...

## Functions

| WEAK_FUNCTION (void aci_gap_limited_discoverable_event(void))
| This event is generated by the controller when the limited discoverable mode ends due to timeout. The timeout is 180 seconds. More...
| WEAK_FUNCTION (void aci_gap_pairing_complete_event(uint16_t Connection_Handle, uint8_t Status))
| 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. More...
| WEAK_FUNCTION (void aci_gap_pass_key_req_event(uint16_t Connection_Handle))
| This event is generated by the Security manager to the application when a passkey is required for pairing. When this event is received, the application has to respond with the aci_gap_pass_key_resp command. More...
| WEAK_FUNCTION (void aci_gap_proc_complete_event(uint8_t Procedure_Code, uint8_t Status, uint8_t Data_Length, uint8_t Data[]))
| 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. More...

## Detailed Description

ACI GAP events layer.

## Function Documentation

WEAK_FUNCTION | ( | void | aci_gap_limited_discoverable_eventvoid | ) |

This event is generated by the controller when the limited discoverable mode ends due to timeout. The timeout is 180 seconds.

This event is generated when a pairing request is issued in response to a slave security request from a master which has previously bonded with the slave. When this event is received, the upper layer has to issue the command aci_gap_allow_rebond in order to allow the slave to continue the pairing process with the master.

This event is generated when the slave security request is successfully sent to the master.

Return values

  None |

WEAK_FUNCTION | ( | void | aci_gap_pairing_complete_eventuint16_t Connection_Handle, uint8_t Status | ) |

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.

Parameters

  Connection_Handle | Connection handle on which the pairing procedure completed
  Status | Pairing status

Return values

  None |

WEAK_FUNCTION | ( | void | aci_gap_pass_key_req_eventuint16_t Connection_Handle | ) |

This event is generated by the Security manager to the application when a passkey is required for pairing. When this event is received, the application has to respond with the aci_gap_pass_key_resp command.

This event is generated when the client has sent the confirmation to a previously sent indication.

This event is generated in response to an Execute Write Request.

This event is generated by the client/server to the application on a GATT timeout (30 seconds). This is a critical event that should not happen during normal operating conditions. It is an indication of either a major disruption in the communication link or a mistake in the application which does not provide a reply to GATT procedures. After this event, the GATT channel is closed and no more GATT communication can be performed. The applications is exptected to issue an aci_gap_terminate to disconnect from the peer device. It is important to leave an 100 ms blank window before sending the aci_gap_terminate, since immediately after this event, system could save important information in non volatile memory.

This event is sent only by a privacy enabled Peripheral. The event is sent to the upper layers when the peripheral is unsuccessful in resolving the resolvable address of the peer device after connecting to it.

This event is generated by the Security manager to the application when the application has set that authorization is required for reading/writing of attributes. This event will be generated as soon as the pairing is complete. When this event is received, aci_gap_authorization_resp command should be used to respond by the application.

Parameters

  Connection_Handle | Connection handle for which the passkey has been requested.

Return values

  None |

Parameters

  Connection_Handle | Connection handle for which authorization has been requested.

Return values

  None |

Parameters

  Connection_Handle | Connection handle for which the private address could not be resolved with any of the stored IRK's.

Return values

  None |

Parameters

  Connection_Handle | Connection handle on which the GATT procedure has timed out

Return values

  None |

Parameters

  Connection_Handle | Connection handle related to the response

Return values

  None |

Parameters

  Connection_Handle | Connection handle related to the event

Return values

  None |

WEAK_FUNCTION | ( | void | aci_gap_proc_complete_eventuint8_t Procedure_Code, uint8_t Status, uint8_t Data_Length, uint8_t Data[] | ) |

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.

Parameters

  Procedure_Code | Terminated procedure. 0x01 LIMITED_DISCOVERY_PROC, 0x02 GENERAL_DISCOVERY_PROC, 0x04 NAME_DISCOVERY_PROC, 0x08 AUTO_CONNECTION_ESTABLISHMENT_PROC, 0x10 GENERAL_CONNECTION_ESTABLISHMENT_PROC, 0x20 SELECTIVE_CONNECTION_ESTABLISHMENT_PROC, 0x40 DIRECT_CONNECTION_ESTABLISHMENT_PROC 0x80 OBSERVATION_PROC
  Status | Error code
  Data_Length | Length of Data in octets
  Data | Procedure Specific Data:
  - For Name Discovery Procedure: the name of the peer device if the procedure completed successfully.

Return values

  None |