core/no.nordicsemi.kotlin.ble.core/Bluetooth5AdvertisingSetParameters

Bluetooth5AdvertisingSetParameters

class Bluetooth5AdvertisingSetParameters(val connectable: Boolean, val discoverable: Boolean = connectable, val interval: Duration = AdvertisingInterval.MEDIUM, val txPowerLevel: Int = TxPowerLevel.MEDIUM, val includeTxPowerLevel: Boolean = false, val primaryPhy: PrimaryPhy = PrimaryPhy.PHY_LE_1M, val secondaryPhy: Phy = Phy.PHY_LE_1M, val anonymous: Boolean = false, val scannable: Boolean = false) : AdvertisingSetParameters

The advertising parameters for advertising using Advertising Extension from Bluetooth 5.

Advertising Extension allows to advertise with longer packets, up to 1650 bytes. The exact number depends on the hardware. It also allows to use PHY LE 2M and PHY Coded for high throughput and long range, respectively.

Parameters

connectable

Whether the advertisement will be connectable.

discoverable

Whether the General Discoverable flag (in case advertising is started without a timeout) or Limited Discoverable flag (if a timeout is specified) should be added to the scannable or connectable advertisement.

By default, a connectable advertisements will be discoverable.

Devices connecting to non-discoverable advertisements cannot initiate bonding.

This flag is ignored for non-scannable and non-connectable advertisements.

interval

The advertising interval, in range 20 ms - 10.24 sec. Use AdvertisingInterval for recommended values.

txPowerLevel

The requested TX power level for advertising. The actual TX power level may be different, depending on the hardware and implementation. Use TxPowerLevel for recommended values.

Constructors

Bluetooth5AdvertisingSetParameters

constructor(connectable: Boolean, discoverable: Boolean = connectable, interval: Duration = AdvertisingInterval.MEDIUM, txPowerLevel: Int = TxPowerLevel.MEDIUM, includeTxPowerLevel: Boolean = false, primaryPhy: PrimaryPhy = PrimaryPhy.PHY_LE_1M, secondaryPhy: Phy = Phy.PHY_LE_1M, anonymous: Boolean = false, scannable: Boolean = false)

Properties

anonymous

val anonymous: Boolean = false

Whether the advertisement will be anonymous.

connectable

val connectable: Boolean

Whether the advertisement will be connectable.

discoverable

val discoverable: Boolean

Whether the General Discoverable flag should be added to the scannable or connectable advertisement. By default, a connectable advertisements will be discoverable. Devices connecting to non-discoverable advertisements cannot initiate bonding. This flag is ignored for non-scannable and non-connectable advertisements.

includeTxPowerLevel

val includeTxPowerLevel: Boolean = false

Should the TX power level be included in the advertisement in the header, outside the AD structure.

interval

val interval: Duration

primaryPhy

val primaryPhy: PrimaryPhy

The primary advertising PHY.

scannable

val scannable: Boolean = false

Whether the advertisement type should be scannable. Bluetooth 5 advertisements can only be either scannable or only connectable.

secondaryPhy

val secondaryPhy: Phy

The secondary advertising PHY.

txPowerLevel

val txPowerLevel: Int

The requested TX power level for advertising. The actual TX power level may be different, depending on the hardware and implementation.