openthread_sys

Function otThreadSetPreferredRouterId

Source 
pub unsafe extern "C" fn otThreadSetPreferredRouterId(
    aInstance: *mut otInstance,
    aRouterId: u8,
) -> otError
Expand description

Set the preferred Router Id.

Upon becoming a router/leader the node attempts to use this Router Id. If the preferred Router Id is not set or if it can not be used, a randomly generated router id is picked. This property can be set only when the device role is either detached or disabled.

@note This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aRouterId The preferred Router Id.

@retval OT_ERROR_NONE Successfully set the preferred Router Id. @retval OT_ERROR_INVALID_STATE Could not set (role is not detached or disabled)