Function openthread_sys::otThreadSetJoinerAdvertisement

source ·

pub unsafe extern "C" fn otThreadSetJoinerAdvertisement(
    aInstance: *mut otInstance,
    aOui: u32,
    aAdvData: *const u8,
    aAdvDataLength: u8
) -> otError

Expand description

Sets the Thread Joiner Advertisement when discovering Thread network.

Thread Joiner Advertisement is used to allow a Joiner to advertise its own application-specific information (such as Vendor ID, Product ID, Discriminator, etc.) via a newly-proposed Joiner Advertisement TLV, and to make this information available to Commissioners or Commissioner Candidates without human interaction.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aOui The Vendor IEEE OUI value that will be included in the Joiner Advertisement. Only the least significant 3 bytes will be used, and the most significant byte will be ignored. @param[in] aAdvData A pointer to the AdvData that will be included in the Joiner Advertisement. @param[in] aAdvDataLength The length of AdvData in bytes.

@retval OT_ERROR_NONE Successfully set Joiner Advertisement. @retval OT_ERROR_INVALID_ARGS Invalid AdvData.