otTcatVendorInfo

#include <openthread/tcat.h>

This structure represents a TCAT vendor information.

Summary

The content of this structure MUST persist and remain unchanged while a TCAT session is running.

Public attributes
mAdvertisedDeviceIds
Vendor managed advertised device ID array.
mApplicationServiceIsTcp[4]
bool
Array with boolean values indicating if the service is of TCP type (otherwise UDP).
mApplicationServiceName[4]
const char *
Array with application service names as C string with maximum length OT_TCAT_SERVICE_NAME_MAX_LENGTH or NULL if not supported.
mDoNotActivateAfterLeaving
bool
Prevent activating advertising indefinitely after the TCAT command OT_TCAT_TLV_STOP_THREAD_INTERFACE or OT_TCAT_TLV_DECOMMISSION has been received.
mGeneralDeviceId
Vendor managed general device ID array (if NULL: device ID is set to EUI-64 in binary format)
mInstallCode
const char *
Vendor managed install code string.
mKeepActiveAfterJoining
bool
Continue advertising after thread interface has joined a network.
mProvisioningUrl
const char *
Provisioning URL path string.
mPskdString
const char *
Vendor managed pre-shared key for device.
mTlvSupportHandler
Optional pointer to a function to control TCAT TLV support.
mVendorData
const char *
Vendor specific data string.
mVendorModel
const char *
Vendor model string.
mVendorName
const char *
Vendor name string.
mVendorSwVersion
const char *
Vendor software version string.

Public attributes

mAdvertisedDeviceIds

const otTcatAdvertisedDeviceId * otTcatVendorInfo::mAdvertisedDeviceIds

Vendor managed advertised device ID array.

Array is terminated like C string with OT_TCAT_DEVICE_ID_EMPTY.

mApplicationServiceIsTcp

bool otTcatVendorInfo::mApplicationServiceIsTcp[4]

Array with boolean values indicating if the service is of TCP type (otherwise UDP).

mApplicationServiceName

const char * otTcatVendorInfo::mApplicationServiceName[4]

Array with application service names as C string with maximum length OT_TCAT_SERVICE_NAME_MAX_LENGTH or NULL if not supported.

mDoNotActivateAfterLeaving

bool otTcatVendorInfo::mDoNotActivateAfterLeaving

Prevent activating advertising indefinitely after the TCAT command OT_TCAT_TLV_STOP_THREAD_INTERFACE or OT_TCAT_TLV_DECOMMISSION has been received.

mGeneralDeviceId

const otTcatGeneralDeviceId * otTcatVendorInfo::mGeneralDeviceId

Vendor managed general device ID array (if NULL: device ID is set to EUI-64 in binary format)

mInstallCode

const char * otTcatVendorInfo::mInstallCode

Vendor managed install code string.

mKeepActiveAfterJoining

bool otTcatVendorInfo::mKeepActiveAfterJoining

Continue advertising after thread interface has joined a network.

mProvisioningUrl

const char * otTcatVendorInfo::mProvisioningUrl

Provisioning URL path string.

mPskdString

const char * otTcatVendorInfo::mPskdString

Vendor managed pre-shared key for device.

mTlvSupportHandler

otHandleTcatTlvSupport otTcatVendorInfo::mTlvSupportHandler

Optional pointer to a function to control TCAT TLV support.

mVendorData

const char * otTcatVendorInfo::mVendorData

Vendor specific data string.

mVendorModel

const char * otTcatVendorInfo::mVendorModel

Vendor model string.

mVendorName

const char * otTcatVendorInfo::mVendorName

Vendor name string.

mVendorSwVersion

const char * otTcatVendorInfo::mVendorSwVersion

Vendor software version string.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.