Connection#

Modules#

sl_bt_evt_connection_opened
Indicates that a new connection was opened.

sl_bt_evt_connection_parameters
Triggered whenever the connection parameters are changed and at any time a connection is established.

sl_bt_evt_connection_phy_status
Indicates that PHY update procedure is completed.

sl_bt_evt_connection_rssi
Triggered when an connection_get_rssi command has completed.

sl_bt_evt_connection_closed
Indicates that a connection was closed.

Enumerations#

enum   connection_security_t {
    connection_mode1_level1 = 0x0,
    connection_mode1_level2 = 0x1,
    connection_mode1_level3 = 0x2,
    connection_mode1_level4 = 0x3
}
Security Modes.

Functions#

sl_status_t  sl_bt_connection_set_default_parameters
    (uint16_t min_interval, uint16_t max_interval, uint16_t latency, uint16_t timeout, uint16_t min_ce_length, uint16_t max_ce_length)

sl_status_t  sl_bt_connection_set_default_preferred_phy    

(uint8_t preferred_phy, uint8_t accepted_phy)

sl_status_t  sl_bt_connection_open\     (bd_addr address, uint8_t address_type, uint8_t initiating_phy, uint8_t *connection)

sl_status_t  sl_bt_connection_set_parameters\     (uint8_t connection, uint16_t min_interval, uint16_t max_interval, uint16_t latency, uint16_t timeout, uint16_t min_ce_length, uint16_t max_ce_length)

sl_status_t  sl_bt_connection_set_preferred_phy
(uint8_t connection, uint8_t preferred_phy, uint8_t accepted_phy)

sl_status_t  sl_bt_connection_disable_slave_latency\     (uint8_t connection, uint8_t disable)

sl_status_t  sl_bt_connection_get_rssi\     (uint8_t connection)

sl_status_t  sl_bt_connection_read_channel_map\     (uint8_t connection, size_t max_channel_map_size, size_t *channel_map_len, uint8_t *channel_map)

sl_status_t  sl_bt_connection_close\     (uint8_t connection)

Detailed Description#

Connection.

The commands and events in this class are related to managing connection establishment, parameter setting, and disconnection procedures.

Enumeration Type Documentation#

connection_security_t#

enum connection_security_t

Security Modes.

Function Documentation#

sl_bt_connection_set_default_parameters()#

Set the default Bluetooth connection parameters. The values are valid for all subsequent connections initiated by this device. To change parameters of an already established connection, use the command sl_bt_connection_set_parameters.

Parameters#

Returns SL_STATUS_OK if successful. Error code otherwise.

sl_bt_connection_set_default_preferred_phy()#

Set default preferred and accepted PHYs. PHY settings will be used for all subsequent connections. Non-preferred PHY can also be set if the remote device does not accept any of the preferred PHYs.

The parameter accepted_phy is used to specify PHYs that the stack can accept in a remotely-initiated PHY update request. A PHY update will not happen if none of the accepted PHYs are present in the request.

NOTE: 2M and Coded PHYs are not supported by all devices.

Parameters

Returns SL_STATUS_OK if successful. Error code otherwise.

sl_bt_connection_open()#

Connect to an advertising device with the specified initiating PHY on which connectable advertisements on primary advertising channels are received. The Bluetooth stack will enter a state where it continuously scans for the connectable advertising packets from the remote device, which matches the Bluetooth address given as a parameter. Scan parameters set in sl_bt_scanner_set_timing are used in this operation. Upon receiving the advertising packet, the module will send a connection request packet to the target device to initiate a Bluetooth connection. To cancel an ongoing connection process, use sl_bt_connection_close command with the handle received in response from this command.

A connection is opened in no-security mode. If the GATT client needs to read or write the attributes on GATT server requiring encryption or authentication, it must first encrypt the connection using an appropriate authentication method.

If a connection can't be established (for example, the remote device has gone out of range, has entered into deep sleep, or is not advertising), the stack will try to connect forever. In this case, the application will not get an event related to the connection request. To recover from this situation, the application can implement a timeout and call sl_bt_connection_close to cancel the connection request.

This command fails with the connection limit exceeded error if the number of connections attempted exceeds the configured MAX_CONNECTIONS value.

This command fails with the invalid parameter error if the initiating PHY value is invalid or the device does not support PHY.

Later calls of this command have to wait for the ongoing command to complete. A received event sl_bt_evt_connection_opened indicates that the connection opened successfully and a received event sl_bt_evt_connection_closed indicates that connection failures have occurred.

Parameters

Returns SL_STATUS_OK if successful. Error code otherwise. Events

• sl_bt_evt_connection_opened - This event is triggered after the connection is opened and indicates whether the devices are already bonded and whether the role of the Bluetooth device is Slave or Master.

• sl_bt_evt_connection_parameters - This event indicates the connection parameters and security mode of the connection.

sl_bt_connection_set_parameters()#

Request a change in the connection parameters of a Bluetooth connection.

Parameters

Events

• sl_bt_evt_connection_parameters - Triggered after new connection parameters are applied on the connection.

sl_bt_connection_set_preferred_phy()#

Sets preferred and accepted PHYs for the given connection. Event sl_bt_evt_connection_phy_status is received when PHY update procedure is completed. Non-preferred PHY can also be set if remote device does not accept any of the preferred PHYs.

The parameter accepted_phy is used for specifying the PHYs that the stack can accept in a remote initiated PHY update request. A PHY update will not occur if none of the accepted PHYs presents in the request.

NOTE: 2M and Coded PHYs are not supported by all devices.

Parameters

ReturnsSL_STATUS_OK if successful. Error code otherwise.

Events

• sl_bt_evt_connection_phy_status

sl_bt_connection_disable_slave_latency()#

Temporarily enable or disable slave latency. Used only when Bluetooth device is acting as slave. When slave latency is disabled, the slave latency connection parameter is not set to 0 but the device will wake up on every connection interval to receive and send packets.

Parameters

ReturnsSL_STATUS_OK if successful. Error code otherwise.

sl_bt_connection_get_rssi()#

Get the latest RSSI value of a Bluetooth connection. The RSSI value will be reported in a sl_bt_evt_connection_rssi event.

Parameters

ReturnsSL_STATUS_OK if successful. Error code otherwise. Events

• sl_bt_evt_connection_rssi - Triggered when this command has completed.

sl_bt_connection_read_channel_map()#

Read channel map for a specified connection.

Parameters

• 1: Channel n is used.

The most significant bits are reserved for future use. |

ReturnsSL_STATUS_OK if successful. Error code otherwise.

sl_bt_connection_close()#

Close a Bluetooth connection or cancel an ongoing connection establishment process. The parameter is a connection handle which is reported in sl_bt_evt_connection_opened event or sl_bt_connection_open command response.

Parameters

ReturnsSL_STATUS_OK if successful. Error code otherwise. Events

• sl_bt_evt_connection_closed