Modules#

Transmit Power Reporting Constants

sl_bt_evt_connection_opened

sl_bt_evt_connection_parameters

sl_bt_evt_connection_phy_status

sl_bt_evt_connection_rssi

sl_bt_evt_connection_get_remote_tx_power_completed

sl_bt_evt_connection_tx_power

sl_bt_evt_connection_remote_tx_power

sl_bt_evt_connection_remote_used_features

sl_bt_evt_connection_data_length

sl_bt_evt_connection_closed

Connection#

Connection.

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

Enumerations#

enum
sl_bt_connection_mode1_level1 = 0x0
sl_bt_connection_mode1_level2 = 0x1
sl_bt_connection_mode1_level3 = 0x2
sl_bt_connection_mode1_level4 = 0x3
}

Indicate the Bluetooth Security Mode.

enum
sl_bt_connection_power_reporting_disable = 0x0
sl_bt_connection_power_reporting_enable = 0x1
}

These values define transmit power reporting modes in LE power control.

enum
sl_bt_connection_tx_power_flag_none = 0x0
sl_bt_connection_tx_power_at_minimum = 0x1
sl_bt_connection_tx_power_at_maximum = 0x2
}

This enum defines the flag values for a reported transmit power level.

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_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_set_power_reporting(uint8_t connection, uint8_t mode)
sl_status_t
sl_bt_connection_set_remote_power_reporting(uint8_t connection, uint8_t mode)
sl_status_t
sl_bt_connection_get_tx_power(uint8_t connection, uint8_t phy, int8_t *current_level, int8_t *max_level)
sl_status_t
sl_bt_connection_get_remote_tx_power(uint8_t connection, uint8_t phy)
sl_status_t
sl_bt_connection_set_tx_power(uint8_t connection, int16_t tx_power, int16_t *tx_power_out)
sl_status_t
sl_status_t
sl_bt_connection_get_security_status(uint8_t connection, uint8_t *security_mode, uint8_t *key_size, uint8_t *bonding_handle)
sl_status_t
sl_bt_connection_set_data_length(uint8_t connection, uint16_t tx_data_len, uint16_t tx_time_us)
sl_status_t
sl_bt_connection_close(uint8_t connection)
sl_status_t

Macros#

Enumeration Documentation#

sl_bt_connection_security_t#

sl_bt_connection_security_t

Indicate the Bluetooth Security Mode.

Enumerator
sl_bt_connection_mode1_level1

(0x0) No security

sl_bt_connection_mode1_level2

(0x1) Unauthenticated pairing with encryption

sl_bt_connection_mode1_level3

(0x2) Authenticated pairing with encryption

sl_bt_connection_mode1_level4

(0x3) Authenticated Secure Connections pairing with encryption using a 128-bit strength encryption key


Definition at line 6314 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_power_reporting_mode_t#

sl_bt_connection_power_reporting_mode_t

These values define transmit power reporting modes in LE power control.

Enumerator
sl_bt_connection_power_reporting_disable

(0x0) Disable transmit power reporting

sl_bt_connection_power_reporting_enable

(0x1) Enable transmit power reporting


Definition at line 6331 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_tx_power_flag_t#

sl_bt_connection_tx_power_flag_t

This enum defines the flag values for a reported transmit power level.

Enumerator
sl_bt_connection_tx_power_flag_none

(0x0) No flag is defined for the reported TX power level

sl_bt_connection_tx_power_at_minimum

(0x1) Transmit power level is at minimum level.

sl_bt_connection_tx_power_at_maximum

(0x2) Transmit power level is at maximum level.


Definition at line 6342 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

Function Documentation#

sl_bt_connection_set_default_parameters#

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)
Parameters
[in]min_interval

Minimum value for the connection event interval. This must be set less than or equal to max_interval.

  • Time = Value x 1.25 ms

  • Range: 0x0006 to 0x0c80

  • Time Range: 7.5 ms to 4 s

Default value: 20 ms

[in]max_interval

Maximum value for the connection event interval. This must be set greater than or equal to min_interval.

  • Time = Value x 1.25 ms

  • Range: 0x0006 to 0x0c80

  • Time Range: 7.5 ms to 4 s

Default value: 50 ms

[in]latency

Peripheral latency, which defines how many connection intervals the peripheral can skip if it has no data to send

  • Range: 0x0000 to 0x01f3

Default value: 0

[in]timeout

Supervision timeout, which defines the time that the connection is maintained although the devices can't communicate at the currently configured connection intervals.

  • Range: 0x000a to 0x0c80

  • Time = Value x 10 ms

  • Time Range: 100 ms to 32 s

  • The value in milliseconds must be larger than (1 + latency) * max_interval * 2, where max_interval is given in milliseconds

Set the supervision timeout at a value which allows communication attempts over at least a few connection intervals.

Default value: 1000 ms

[in]min_ce_length

Minimum length of the connection event. It must be less than or equal to max_ce_length.

This value defines the minimum time that should be given to the connection event in a situation where other tasks need to run immediately after the connection event. When the value is very small, the connection event still has at least one TX/RX operation. If this value is increased, more time is reserved for the connection event so it can transmit and receive more packets in a connection interval.

Use the default value if the application doesn't care about the connection event length or doesn't want to do fine tuning.

  • Time = Value x 0.625 ms

  • Range: 0x0000 to 0xffff

Default value: 0x0000

[in]max_ce_length

Maximum length of the connection event. It must be greater than or equal to min_ce_length.

This value is used for limiting the connection event length so that a connection that has large amounts of data to transmit or receive doesn't block other tasks. Limiting the connection event is a hard stop. If there is no enough time to send or receive a packet, the connection event will be closed.

If the value is set to 0, the connection event still has at least one TX/RX operation. This is useful to limit power consumption or leave more time to other tasks.

Use the default value if the application doesn't care about the connection event length or doesn't want to do fine tuning.

  • Time = Value x 0.625 ms

  • Range: 0x0000 to 0xffff

Default value: 0xffff

Set default Bluetooth connection parameters. The values are valid for all subsequent connections initiated by this device.

min_ce_length and max_ce_length specify the preference of the connection event length so that the Link Layer can prioritize tasks accordingly in simultaneous connections, or scanning and so on. A connection event starts at an anchor point of a connection interval and lasts until the lesser of max_ce_length and the actual connection interval. Packets that do not fit into the connection event will be sent in the next connection interval.

To change parameters of an already established connection, use the command sl_bt_connection_set_parameters.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 6922 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_set_default_preferred_phy#

sl_status_t sl_bt_connection_set_default_preferred_phy (uint8_t preferred_phy, uint8_t accepted_phy)
Parameters
[in]preferred_phy

Preferred PHYs. This parameter is a bitfield and multiple PHYs can be set.

  • 0x01: 1M PHY

  • 0x02: 2M PHY

  • 0x04: Coded PHY

  • 0xff: Any PHYs

Default: 0xff (no preference)

[in]accepted_phy

Accepted PHYs in remotely-initiated PHY update request. This parameter is a bitfield and multiple PHYs can be set.

  • 0x01: 1M PHY

  • 0x02: 2M PHY

  • 0x04: Coded PHY

  • 0xff: Any PHYs

Default: 0xff (all PHYs accepted)

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.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 6964 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_set_default_data_length#

sl_status_t sl_bt_connection_set_default_data_length (uint16_t tx_data_len)
Parameters
[in]tx_data_len

Preferred maximum payload octets of a packet that the local Controller will send

Range: Range: 27 (0x1B) to 251 (0xFB)

Default: 251

Set the default preferred maximum TX payload length to be used for new connections.

When a connection is open, the maximum TX payload length is 27. Either device could initiate a data length update procedure and event sl_bt_evt_connection_data_length is generated when the data length has been changed on the connection.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 6989 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_open#

sl_status_t sl_bt_connection_open (bd_addr address, uint8_t address_type, uint8_t initiating_phy, uint8_t * connection)
Parameters
[in]address

Address of the device to connect to

[in]address_type

Enum sl_bt_gap_address_type_t. Address type of the device to connect to. Values:

  • sl_bt_gap_public_address (0x0): Public device address

  • sl_bt_gap_static_address (0x1): Static device address

  • sl_bt_gap_random_resolvable_address (0x2): Resolvable private random address

  • sl_bt_gap_random_nonresolvable_address (0x3): Non-resolvable private random address

  • sl_bt_gap_public_address_resolved_from_rpa (0x4): Public identity address resolved from a resolvable private address (RPA)

  • sl_bt_gap_static_address_resolved_from_rpa (0x5): Static identity address resolved from a resolvable private address (RPA)

[in]initiating_phy

Enum sl_bt_gap_phy_t. The initiating PHY. Values:

  • sl_bt_gap_phy_1m (0x1): 1M PHY

  • sl_bt_gap_phy_coded (0x4): Coded PHY, 125k (S=8) or 500k (S=2)

[out]connection

Handle that will be assigned to the connection after the connection is established. This handle is valid only if the result code of this response is 0 (zero).

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.

Subsequent 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.

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 the role of the device in this connection.

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


Definition at line 7058 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_set_parameters#

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)
Parameters
[in]connection

Connection Handle

[in]min_interval

Minimum value for the connection event interval. This must be set less than or equal to max_interval.

  • Time = Value x 1.25 ms

  • Range: 0x0006 to 0x0c80

  • Time Range: 7.5 ms to 4 s

[in]max_interval

Maximum value for the connection event interval. This must be set greater than or equal to min_interval.

  • Time = Value x 1.25 ms

  • Range: 0x0006 to 0x0c80

  • Time Range: 7.5 ms to 4 s

[in]latency

Peripheral latency, which defines how many connection intervals the peripheral can skip if it has no data to send

  • Range: 0x0000 to 0x01f3

[in]timeout

Supervision timeout, which defines the time that the connection is maintained although the devices can't communicate at the currently configured connection intervals.

  • Range: 0x000a to 0x0c80

  • Time = Value x 10 ms

  • Time Range: 100 ms to 32 s

  • The value in milliseconds must be larger than (1 + latency) * max_interval * 2, where max_interval is given in milliseconds

Set the supervision timeout at a value which allows communication attempts over at least a few connection intervals.

[in]min_ce_length

Minimum length of the connection event. It must be less than or equal to max_ce_length.

This value defines the minimum time that should be given to the connection event in a situation where other tasks need to run immediately after the connection event. When the value is very small, the connection event still has at least one TX/RX operation. If this value is increased, more time is reserved for the connection event so it can transmit and receive more packets in a connection interval.

Use the default value if the application doesn't care about the connection event length or doesn't want to do fine tuning.

  • Time = Value x 0.625 ms

  • Range: 0x0000 to 0xffff

Default value: 0x0000

[in]max_ce_length

Maximum length of the connection event. It must be greater than or equal to min_ce_length.

This value is used for limiting the connection event length so that a connection that has large amounts of data to transmit or receive doesn't block other tasks. Limiting the connection event is a hard stop. If there is no enough time to send or receive a packet, the connection event will be closed.

If the value is set to 0, the connection event still has at least one TX/RX operation. This is useful to limit power consumption or leave more time to other tasks.

Use the default value if the application doesn't care about the connection event length or doesn't want to do fine tuning.

  • Time = Value x 0.625 ms

  • Range: 0x0000 to 0xffff

Default value: 0xffff

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

min_ce_length and max_ce_length specify the preference of the connection event length so that the Link Layer can prioritize tasks accordingly in simultaneous connections, or scanning and so on. A connection event starts at an anchor point of a connection interval and lasts until the lesser of max_ce_length and the actual connection interval. Packets that do not fit into the connection event will be sent in the next connection interval.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 7150 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_set_preferred_phy#

sl_status_t sl_bt_connection_set_preferred_phy (uint8_t connection, uint8_t preferred_phy, uint8_t accepted_phy)
Parameters
[in]connection

Connection handle

[in]preferred_phy

Preferred PHYs. This parameter is a bitfield and multiple PHYs can be set.

  • 0x01: 1M PHY

  • 0x02: 2M PHY

  • 0x04: 125k Coded PHY (S=8)

  • 0x08: 500k Coded PHY (S=2)

Default: 0xff (no preference)

[in]accepted_phy

Accepted PHYs in remotely-initiated PHY update requests. This parameter is a bitfield and multiple PHYs can be set.

  • 0x01: 1M PHY

  • 0x02: 2M PHY

  • 0x04: Coded PHY

  • 0xff: Any PHYs

Default: 0xff (all PHYs accepted)

Set preferred and accepted PHYs for a 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.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 7198 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_disable_slave_latency#

sl_status_t sl_bt_connection_disable_slave_latency (uint8_t connection, uint8_t disable)
Parameters
[in]connection

Connection Handle

[in]disable

0 enable, 1 disable peripheral latency. Default: 0

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

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 7215 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_get_rssi#

sl_status_t sl_bt_connection_get_rssi (uint8_t connection)
Parameters
[in]connection

Connection handle

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

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 7232 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_read_channel_map#

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)
Parameters
[in]connection

Connection Handle

[in]max_channel_map_size

Size of output buffer passed in channel_map

[out]channel_map_len

On return, set to the length of output data written to channel_map

[out]channel_map

This parameter is 5 bytes and contains 37 1-bit fields.

The nth field (in the range 0 to 36) contains the value for the link layer channel index n.

  • 0: Channel n is unused.

  • 1: Channel n is used.

The most significant bits are reserved for future use.

Read channel map for a specified connection.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 7258 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_set_power_reporting#

sl_status_t sl_bt_connection_set_power_reporting (uint8_t connection, uint8_t mode)
Parameters
[in]connection

Handle of the connection

[in]mode

Enum sl_bt_connection_power_reporting_mode_t. Transmit power reporting mode. Values:

  • sl_bt_connection_power_reporting_disable (0x0): Disable transmit power reporting

  • sl_bt_connection_power_reporting_enable (0x1): Enable transmit power reporting

Enable or disable the transmit power reporting for the local device on a connection. When transmit power reporting is enabled, event sl_bt_evt_connection_tx_power is generated when transmit power on the local device changes.

The command is a built-in feature in the stack and is supported regardless of whether the LE Power Control feature is used. By default, power reporting for local device is enabled.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 7288 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_set_remote_power_reporting#

sl_status_t sl_bt_connection_set_remote_power_reporting (uint8_t connection, uint8_t mode)
Parameters
[in]connection

Handle of the connection

[in]mode

Enum sl_bt_connection_power_reporting_mode_t. Transmit power reporting mode. Values:

  • sl_bt_connection_power_reporting_disable (0x0): Disable transmit power reporting

  • sl_bt_connection_power_reporting_enable (0x1): Enable transmit power reporting

Enable or disable reporting the transmit power change on the remote device. The application must include the LE Power Control feature (bluetooth_feature_power_control) in order to use this command.

When the remote transmit power reporting is enabled, event sl_bt_evt_connection_remote_tx_power is generated when transmit power on the remote device changes.

By default, power reporting for the remote device is disabled.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 7317 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_get_tx_power#

sl_status_t sl_bt_connection_get_tx_power (uint8_t connection, uint8_t phy, int8_t * current_level, int8_t * max_level)
Parameters
[in]connection

Handle of the connection

[in]phy

Enum sl_bt_gap_phy_coding_t. The PHY. Values:

  • sl_bt_gap_phy_coding_1m_uncoded (0x1): 1M PHY

  • sl_bt_gap_phy_coding_2m_uncoded (0x2): 2M PHY

  • sl_bt_gap_phy_coding_125k_coded (0x4): 125k Coded PHY (S=8)

  • sl_bt_gap_phy_coding_500k_coded (0x8): 500k Coded PHY (S=2)

[out]current_level

The current transmit power level of the PHY on the connection. Values:

[out]max_level

The maximum transmit power level of the PHY on the connection. Values: Range -127 to +20 in dBm.

Get the transmit power of the local device on the given connection and PHY. The application must include the LE Power Control feature (bluetooth_feature_power_control) in order to use this command.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 7343 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_get_remote_tx_power#

sl_status_t sl_bt_connection_get_remote_tx_power (uint8_t connection, uint8_t phy)
Parameters
[in]connection

Handle of the connection

[in]phy

Enum sl_bt_gap_phy_coding_t. The PHY. Values:

  • sl_bt_gap_phy_coding_1m_uncoded (0x1): 1M PHY

  • sl_bt_gap_phy_coding_2m_uncoded (0x2): 2M PHY

  • sl_bt_gap_phy_coding_125k_coded (0x4): 125k Coded PHY (S=8)

  • sl_bt_gap_phy_coding_500k_coded (0x8): 500k Coded PHY (S=2)

Get the transmit power of the remote device on the given connection and PHY. The application must include the LE Power Control feature (bluetooth_feature_power_control) in order to use this command. Transmit power levels are returned in event sl_bt_evt_connection_get_remote_tx_power_completed after the operation completed.

Returns

  • SL_STATUS_OK if the command is accepted. Error code otherwise.

Events


Definition at line 7370 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_set_tx_power#

sl_status_t sl_bt_connection_set_tx_power (uint8_t connection, int16_t tx_power, int16_t * tx_power_out)
Parameters
[in]connection

The connection handle

[in]tx_power

The requested TX power. Unit: 0.1 dBm

[out]tx_power_out

The selected TX power. Unit: 0.1 dBm

Set the transmit power of a connection. The application must include component bluetooth_feature_user_power_control in order to use this command for controlling the transmit power of the connection at application level. This command is unavailable if the standard Bluetooth feature LE power control (component bluetooth_feature_power_control) is used by the application.

The actual selected power level is returned from this command. The value may be different than the requested one because of Bluetooth feature restrictions or radio characteristics.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 7393 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_read_remote_used_features#

sl_status_t sl_bt_connection_read_remote_used_features (uint8_t connection)
Parameters
[in]connection

Connection Handle

Read link layer features supported by the remote device.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 7409 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_get_security_status#

sl_status_t sl_bt_connection_get_security_status (uint8_t connection, uint8_t * security_mode, uint8_t * key_size, uint8_t * bonding_handle)
Parameters
[in]connection

Connection handle

[out]security_mode

Enum sl_bt_connection_security_t. Connection security mode. Values:

  • sl_bt_connection_mode1_level1 (0x0): No security

  • sl_bt_connection_mode1_level2 (0x1): Unauthenticated pairing with encryption

  • sl_bt_connection_mode1_level3 (0x2): Authenticated pairing with encryption

  • sl_bt_connection_mode1_level4 (0x3): Authenticated Secure Connections pairing with encryption using a 128-bit strength encryption key

[out]key_size

The size of encryption key

[out]bonding_handle

Bonding handle. Values:

  • SL_BT_INVALID_BONDING_HANDLE (0xff): No bonding

  • Other: Bonding handle

Get the security status of the connection.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 7434 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_set_data_length#

sl_status_t sl_bt_connection_set_data_length (uint8_t connection, uint16_t tx_data_len, uint16_t tx_time_us)
Parameters
[in]connection

Connection handle

[in]tx_data_len

Preferred maximum payload octets of a packet that the local Controller will send

Range: 27 (0x1B) to 251 (0xFB)

[in]tx_time_us

Preferred maximum TX time in microseconds that the local Controller will take to send a packet

Range: 328 (0x0148) to 17040 (0x4290)

Request to update the maximum TX payload length and maximum packet TX time of a Bluetooth connection.

Event sl_bt_evt_connection_data_length is generated when the data length has been changed on the connection.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 7467 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_close#

sl_status_t sl_bt_connection_close (uint8_t connection)
Parameters
[in]connection

Handle of the connection to be closed

Close a Bluetooth connection gracefully by performing the ACL Termination procedure 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.

Disconnecting a connection is an asynchronous operation. The disconnection is completed when a sl_bt_evt_connection_closed event for the given connection handle is received. To open a new connection to the same remote device, wait for the sl_bt_evt_connection_closed event and then initiate the connection.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 7493 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_connection_forcefully_close#

sl_status_t sl_bt_connection_forcefully_close (uint8_t connection)
Parameters
[in]connection

Handle of the connection to be closed

Forcefully close a Bluetooth connection without performing the ACL Termination procedure. The parameter is a connection handle which is reported in sl_bt_evt_connection_opened event or sl_bt_connection_open command response.

Closing a connection using this command could result in the observation of connection loss or supervision timeout on the remote device. Only use this command for special cases, for example, when disconnecting a connection with sl_bt_connection_close did not complete in expected time period.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 7515 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

Macro Definition Documentation#

sl_bt_cmd_connection_set_default_parameters_id#

#define sl_bt_cmd_connection_set_default_parameters_id
Value:
0x00060020

Definition at line 6272 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_set_default_preferred_phy_id#

#define sl_bt_cmd_connection_set_default_preferred_phy_id
Value:
0x01060020

Definition at line 6273 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_set_default_data_length_id#

#define sl_bt_cmd_connection_set_default_data_length_id
Value:
0x10060020

Definition at line 6274 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_open_id#

#define sl_bt_cmd_connection_open_id
Value:
0x04060020

Definition at line 6275 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_set_parameters_id#

#define sl_bt_cmd_connection_set_parameters_id
Value:
0x06060020

Definition at line 6276 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_set_preferred_phy_id#

#define sl_bt_cmd_connection_set_preferred_phy_id
Value:
0x08060020

Definition at line 6277 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_disable_slave_latency_id#

#define sl_bt_cmd_connection_disable_slave_latency_id
Value:
0x03060020

Definition at line 6278 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_get_rssi_id#

#define sl_bt_cmd_connection_get_rssi_id
Value:
0x02060020

Definition at line 6279 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_read_channel_map_id#

#define sl_bt_cmd_connection_read_channel_map_id
Value:
0x07060020

Definition at line 6280 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_set_power_reporting_id#

#define sl_bt_cmd_connection_set_power_reporting_id
Value:
0x09060020

Definition at line 6281 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_set_remote_power_reporting_id#

#define sl_bt_cmd_connection_set_remote_power_reporting_id
Value:
0x0a060020

Definition at line 6282 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_get_tx_power_id#

#define sl_bt_cmd_connection_get_tx_power_id
Value:
0x0b060020

Definition at line 6283 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_get_remote_tx_power_id#

#define sl_bt_cmd_connection_get_remote_tx_power_id
Value:
0x0c060020

Definition at line 6284 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_set_tx_power_id#

#define sl_bt_cmd_connection_set_tx_power_id
Value:
0x12060020

Definition at line 6285 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_read_remote_used_features_id#

#define sl_bt_cmd_connection_read_remote_used_features_id
Value:
0x0d060020

Definition at line 6286 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_get_security_status_id#

#define sl_bt_cmd_connection_get_security_status_id
Value:
0x0e060020

Definition at line 6287 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_set_data_length_id#

#define sl_bt_cmd_connection_set_data_length_id
Value:
0x11060020

Definition at line 6288 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_close_id#

#define sl_bt_cmd_connection_close_id
Value:
0x05060020

Definition at line 6289 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_cmd_connection_forcefully_close_id#

#define sl_bt_cmd_connection_forcefully_close_id
Value:
0x0f060020

Definition at line 6290 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_set_default_parameters_id#

#define sl_bt_rsp_connection_set_default_parameters_id
Value:
0x00060020

Definition at line 6291 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_set_default_preferred_phy_id#

#define sl_bt_rsp_connection_set_default_preferred_phy_id
Value:
0x01060020

Definition at line 6292 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_set_default_data_length_id#

#define sl_bt_rsp_connection_set_default_data_length_id
Value:
0x10060020

Definition at line 6293 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_open_id#

#define sl_bt_rsp_connection_open_id
Value:
0x04060020

Definition at line 6294 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_set_parameters_id#

#define sl_bt_rsp_connection_set_parameters_id
Value:
0x06060020

Definition at line 6295 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_set_preferred_phy_id#

#define sl_bt_rsp_connection_set_preferred_phy_id
Value:
0x08060020

Definition at line 6296 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_disable_slave_latency_id#

#define sl_bt_rsp_connection_disable_slave_latency_id
Value:
0x03060020

Definition at line 6297 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_get_rssi_id#

#define sl_bt_rsp_connection_get_rssi_id
Value:
0x02060020

Definition at line 6298 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_read_channel_map_id#

#define sl_bt_rsp_connection_read_channel_map_id
Value:
0x07060020

Definition at line 6299 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_set_power_reporting_id#

#define sl_bt_rsp_connection_set_power_reporting_id
Value:
0x09060020

Definition at line 6300 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_set_remote_power_reporting_id#

#define sl_bt_rsp_connection_set_remote_power_reporting_id
Value:
0x0a060020

Definition at line 6301 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_get_tx_power_id#

#define sl_bt_rsp_connection_get_tx_power_id
Value:
0x0b060020

Definition at line 6302 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_get_remote_tx_power_id#

#define sl_bt_rsp_connection_get_remote_tx_power_id
Value:
0x0c060020

Definition at line 6303 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_set_tx_power_id#

#define sl_bt_rsp_connection_set_tx_power_id
Value:
0x12060020

Definition at line 6304 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_read_remote_used_features_id#

#define sl_bt_rsp_connection_read_remote_used_features_id
Value:
0x0d060020

Definition at line 6305 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_get_security_status_id#

#define sl_bt_rsp_connection_get_security_status_id
Value:
0x0e060020

Definition at line 6306 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_set_data_length_id#

#define sl_bt_rsp_connection_set_data_length_id
Value:
0x11060020

Definition at line 6307 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_close_id#

#define sl_bt_rsp_connection_close_id
Value:
0x05060020

Definition at line 6308 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h

sl_bt_rsp_connection_forcefully_close_id#

#define sl_bt_rsp_connection_forcefully_close_id
Value:
0x0f060020

Definition at line 6309 of file /mnt/raid/workspaces/ws.SZ9MaSA5u/overlay/gsdk/protocol/bluetooth/build_debug/bt_api/sw/bgapi/inc/sl_bt_api.h