◆ sdc_hci_cmd_le_set_adv_params()

uint8_t sdc_hci_cmd_le_set_adv_params ( const sdc_hci_cmd_le_set_adv_params_t * p_params )

#include <softdevice_controller/include/sdc_hci_cmd_le.h>

LE Set Advertising Parameters.

The description below is extracted from Core_v6.3, Vol 4, Part E, Section 7.8.5

This command is used by the Host to set the advertising parameters.

The Advertising_Interval_Min shall be less than or equal to the Advertising_Interval_Max. The Advertising_Interval_Min and Advertising_Interval_Max should not be the same value to enable the Controller to determine the best advertising interval given other activities.

For high duty cycle directed advertising, i.e. when Advertising_Type is 0x01 (ADV_DIRECT_IND, high duty cycle), the Advertising_Interval_Min and Advertising_Interval_Max parameters are not used and shall be ignored.

The Advertising_Type is used to determine the packet type that is used for advertising when advertising is enabled.

Own_Address_Type parameter indicates the type of address being used in the advertising packets.

If Own_Address_Type equals 0x02 or 0x03, the Peer_Address parameter contains the peer’s Identity Address and the Peer_Address_Type parameter contains the Peer’s Identity Type (i.e. 0x00 or 0x01). These parameters are used to locate the corresponding local IRK in the resolving list; this IRK is used to generate the own address used in the advertisement.

If directed advertising is performed, i.e. when Advertising_Type is set to 0x01 (ADV_DIRECT_IND, high duty cycle) or 0x04 (ADV_DIRECT_IND, low duty cycle mode), then the Peer_Address_Type and Peer_Address shall be valid.

If Own_Address_Type equals 0x02 or 0x03, the Controller generates the peer’s Resolvable Private Address using the peer’s IRK corresponding to the peer’s Identity Address contained in the Peer_Address parameter and peer’s Identity Address Type (i.e. 0x00 or 0x01) contained in the Peer_Address_Type parameter.

The Advertising_Channel_Map is a bit field that indicates the advertising channel indices that shall be used when transmitting advertising packets. At least one channel bit shall be set in the Advertising_Channel_Map parameter.

The Advertising_Filter_Policy parameter shall be ignored when directed advertising is enabled.

Errors:

See Section 4.5.2 for a list of error types and descriptions.

Type   Condition                                                             Error code
MC     Advertising is enabled in the Controller.                             Command Disallowed
                                                                             (0x0C)
MC     The advertising interval range (Advertising_Interval_Min,             Unsupported
       Advertising_Interval_Max) does not overlap with the advertising       Feature or
       interval range supported by the Controller.                           Parameter Value
                                                                             (0x11)

Event(s) generated (unless masked away):

When the HCI_LE_Set_Advertising_Parameters command has completed, an HCI_Command_Complete event shall be generated.

Parameters

[in] p_params Input parameters.

Return values

0	if success.

Returns: Returns value between 0x01-0xFF in case of error. See Vol 2, Part D, Error for a list of error codes and descriptions.