sdc_hci_cmd_le_set_path_loss_reporting_enable()

uint8_t sdc_hci_cmd_le_set_path_loss_reporting_enable	(	const sdc_hci_cmd_le_set_path_loss_reporting_enable_t *	p_params,
		sdc_hci_cmd_le_set_path_loss_reporting_enable_return_t *	p_return
	)

#include <softdevice_controller/include/sdc_hci_cmd_le.h>

LE Set Path Loss Reporting Enable.

The description below is extracted from Core_v5.4, Vol 4, Part E, Section 7.8.120

The HCI_LE_Set_Path_Loss_Reporting_Enable command is used to enable or disable path loss reporting for the ACL connection identified by the Connection_Handle parameter.

If the Enable parameter is set to 0x01 and no prior LE Power Control Request procedure has been initiated on the ACL connection, then the Controller may need to initiate a new LE Power Control Request procedure on that ACL.

Path loss reporting is disabled when the connection is first created.

If the Host issues this command before it has issued the HCI_LE_Set_Path_- Loss_Reporting_Parameters command on this connection, the Controller shall return the error code Command Disallowed (0x0C).

If the Connection_Handle parameter does not identify a current ACL connection, the Controller shall return the error code Unknown Connection Identifier (0x02).

Enabling path loss monitoring when it is already enabled or disabling path loss monitoring when it is already disabled has no effect.

Event(s) generated (unless masked away): When the HCI_LE_Set_Path_Loss_Reporting_Enable command has completed, an HCI_Command_Complete event shall be generated.

When reporting is enabled and was previously disabled, the Controller shall generate an HCI_LE_Path_Loss_Threshold event as soon as it has a reliable measurement of the path loss. If the Controller has to query the remote Controller for its transmit power level, then it shall generate this event within Tpath_loss_enable from the time it receives a response to its query. Otherwise, the Controller shall generate this event within Tpath_loss_enable from the time the command is issued. Tpath_loss_enable shall be Min_Time_Spent + 6 connection events or, if longer, 2 connection events where the Controller actually receives a packet from the peer, where Min_Time_Spent is specified by the HCI_LE_Set_Path_Loss_Reporting_Parameters command.

After the initial event on reporting being enabled, the Controller shall generate this event each time it determines that the path loss has moved to a different zone and stayed in that zone for Min_Time_Spent.As stated in [Vol 6] Part B, Section 4.5.16, two consecutive events must not indicate the same zone.

Parameters

[in]	p_params	Input parameters.
[out]	p_return	Extra return 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.