Google은 흑인 공동체를 위한 인종적 평등을 추구하기 위해 노력하고 있습니다. 자세히 알아보기

일반적인

이 모듈에는 모든 스레드 역할에 대한 기능이 포함되어 있습니다.

요약

네트워크 데이터 게시자는 네트워크 데이터를 모니터링하고 항목을 추가 또는 제거할지 여부를 관리하여 스레드 네트워크 데이터에서 유사한 서비스 및/또는 접두사(메시 접두사 또는 외부 경로) 항목의 수를 제한하는 메커니즘을 제공합니다.

이 모듈의 모든 기능을 필요로 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE 가 활성화되어 있어야합니다.

열거

anonymous enum {
OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19
}
열거
otDeviceRole {
OT_DEVICE_ROLE_DISABLED = 0,
OT_DEVICE_ROLE_DETACHED = 1,
OT_DEVICE_ROLE_CHILD = 2,
OT_DEVICE_ROLE_ROUTER = 3,
OT_DEVICE_ROLE_LEADER = 4
}
열거
스레드 장치 역할을 나타냅니다.
otNetDataPublisherEvent {
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
열거
이 열거형은 게시자 콜백에서 보고된 이벤트를 나타냅니다.
otRoutePreference {
OT_ROUTE_PREFERENCE_LOW = -1,
OT_ROUTE_PREFERENCE_MED = 0,
OT_ROUTE_PREFERENCE_HIGH = 1
}
열거
유효 값 정의 mPreference 에서 otExternalRouteConfigotBorderRouterConfig .

형식 정의

otBorderRouterConfig 형식 정의
이 구조는 경계 라우터 구성을 나타냅니다.
otExternalRouteConfig 형식 정의
이 구조는 외부 경로 구성을 나타냅니다.
otIpCounters 형식 정의
struct otIpCounters
이 구조는 IP 레벨 카운터를 나타냅니다.
otLeaderData 형식 정의
struct otLeaderData
이 구조는 스레드 리더 데이터를 나타냅니다.
otLinkModeConfig 형식 정의
이 구조는 MLE 링크 모드 구성을 나타냅니다.
otMleCounters 형식 정의
이 구조는 스레드 MLE 카운터를 나타냅니다.
otNeighborInfoIterator 형식 정의
int16_t
인접 테이블을 반복하는 데 사용됩니다.
otNetDataDnsSrpServicePublisherCallback )(otNetDataPublisherEvent aEvent, void *aContext) 형식 정의
void(*
이 함수 포인터 유형은 스레드 네트워크 데이터에 "DNS/SRP 서비스" 항목이 추가되거나 제거될 때 알리는 데 사용되는 콜백을 정의합니다.
otNetDataPrefixPublisherCallback )(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) 형식 정의
void(*
이 함수 포인터 유형은 접두사(메시 또는 외부 경로) 항목이 스레드 네트워크 데이터에 추가되거나 제거될 때 알리는 데 사용되는 콜백을 정의합니다.
otNetDataPublisherEvent 형식 정의
이 열거형은 게시자 콜백에서 보고된 이벤트를 나타냅니다.
otNetworkDataIterator 형식 정의
uint32_t
네트워크 데이터 정보를 반복하는 데 사용됩니다.
otNetworkDiagChildEntry 형식 정의
이 구조는 네트워크 진단 하위 테이블 항목을 나타냅니다.
otNetworkDiagConnectivity 형식 정의
이 구조는 네트워크 진단 연결 값을 나타냅니다.
otNetworkDiagIterator 형식 정의
uint16_t
네트워크 진단 TLV를 반복하는 데 사용됩니다.
otNetworkDiagMacCounters 형식 정의
이 구조는 네트워크 진단 Mac 카운터 값을 나타냅니다.
otNetworkDiagRoute 형식 정의
이 구조는 네트워크 진단 경로 TLV 값을 나타냅니다.
otNetworkDiagRouteData 형식 정의
이 구조는 네트워크 진단 경로 데이터를 나타냅니다.
otNetworkDiagTlv 형식 정의
이 구조는 네트워크 진단 TLV를 나타냅니다.
otReceiveDiagnosticGetCallback )(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) 형식 정의
void(*
이 함수 포인터는 네트워크 진단 받기 응답이 수신될 때 호출됩니다.
otRoutePreference 형식 정의
유효 값 정의 mPreference 에서 otExternalRouteConfigotBorderRouterConfig .
otServerConfig 형식 정의
이 구조는 서버 구성을 나타냅니다.
otServiceConfig 형식 정의
이 구조는 서비스 구성을 나타냅니다.
otThreadAnycastLocatorCallback )(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) 형식 정의
void(*
이 함수 포인터 유형은의 결과를 통지하기 위해 콜백을 정의 otThreadLocateAnycastDestination() 요청.
otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) 형식 정의
void(*
이 함수 포인터는 MLE 발견 요청 메시지가 수신될 때마다 호출됩니다.
otThreadDiscoveryRequestInfo 형식 정의
이 구조는 스레드 검색 요청 데이터를 나타냅니다.
otThreadParentResponseCallback )(otThreadParentResponseInfo *aInfo, void *aContext) 형식 정의
void(*
이 함수 포인터는 MLE 부모 응답 메시지가 수신될 때마다 호출됩니다.
otThreadParentResponseInfo 형식 정의
이 구조는 MLE 상위 응답 데이터를 나타냅니다.

기능

otNetDataGet ( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
이 방법은 파티션의 스레드 네트워크 데이터의 전체 또는 안정적인 복사본을 제공합니다.
otNetDataGetNextOnMeshPrefix ( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
이 함수는 파티션의 네트워크 데이터에서 다음 On Mesh 접두사를 가져옵니다.
otNetDataGetNextRoute ( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
이 함수는 파티션의 네트워크 데이터에서 다음 외부 경로를 가져옵니다.
otNetDataGetNextService ( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
이 함수는 파티션의 네트워크 데이터에서 다음 서비스를 가져옵니다.
otNetDataGetStableVersion ( otInstance *aInstance)
uint8_t
안정적인 네트워크 데이터 버전을 얻으십시오.
otNetDataGetVersion ( otInstance *aInstance)
uint8_t
네트워크 데이터 버전을 가져옵니다.
otNetDataIsDnsSrpServiceAdded ( otInstance *aInstance)
bool
이 기능은 현재 "DNS/SRP 서비스" 항목이 스레드 네트워크 데이터에 추가되었는지 여부를 나타냅니다.
otNetDataIsPrefixAdded ( otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
이 기능은 현재 게시된 접두사 항목(메시 또는 외부 경로)이 스레드 네트워크 데이터에 추가되었는지 여부를 나타냅니다.
otNetDataPublishDnsSrpServiceAnycast ( otInstance *aInstance, uint8_t aSequenceNUmber)
void
이 기능은 스레드 네트워크 데이터에 게시할 "DNS/SRP 서비스 애니캐스트 주소"를 요청합니다.
otNetDataPublishDnsSrpServiceUnicast ( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
이 기능은 스레드 네트워크 데이터에 게시할 "DNS/SRP 서비스 유니캐스트 주소"를 요청합니다.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid ( otInstance *aInstance, uint16_t aPort)
void
이 기능은 스레드 네트워크 데이터에 게시할 "DNS/SRP 서비스 유니캐스트 주소"를 요청합니다.
otNetDataPublishExternalRoute ( otInstance *aInstance, const otExternalRouteConfig *aConfig)
이 함수는 스레드 네트워크 데이터에 게시할 외부 경로 접두사를 요청합니다.
otNetDataPublishOnMeshPrefix ( otInstance *aInstance, const otBorderRouterConfig *aConfig)
이 함수는 Thread Network Data에 게시할 on-mesh 접두사를 요청합니다.
otNetDataSetDnsSrpServicePublisherCallback ( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
이 함수는 게시된 "DNS/SRP 서비스"가 실제로 스레드 네트워크 데이터에 추가되거나 제거될 때 알리기 위한 콜백을 설정합니다.
otNetDataSetPrefixPublisherCallback ( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
이 함수는 게시된 접두사 항목이 실제로 스레드 네트워크 데이터에 추가되거나 제거될 때 알리기 위한 콜백을 설정합니다.
otNetDataSteeringDataCheckJoiner ( otInstance *aInstance, const otExtAddress *aEui64)
조향 데이터에 조이너가 포함되어 있는지 확인합니다.
otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
스티어링 데이터에 식별자 값이 지정된 Joiner가 포함되어 있는지 확인합니다.
otNetDataUnpublishDnsSrpService ( otInstance *aInstance)
void
이 기능은 스레드 네트워크 데이터에서 이전에 추가된 "DNS/SRP(Anycast 또는 Unicast) 서비스" 항목의 게시를 취소합니다.
otNetDataUnpublishPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix)
이 기능은 이전에 게시된 접두사(온메시 또는 외부 경로)를 게시 취소합니다.
otThreadBecomeChild ( otInstance *aInstance)
어린 시절에 다시 애착을 시도하십시오.
otThreadBecomeDetached ( otInstance *aInstance)
스레드 네트워크에서 분리합니다.
otThreadDeviceRoleToString ( otDeviceRole aRole)
const char *
장치 역할을 사람이 읽을 수 있는 문자열로 변환합니다.
otThreadDiscover ( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
이 기능은 스레드 검색 스캔을 시작합니다.
otThreadGetChildTimeout ( otInstance *aInstance)
uint32_t
하위 역할에서 작동할 때 사용되는 스레드 하위 시간 제한을 가져옵니다.
otThreadGetDeviceRole ( otInstance *aInstance)
장치 역할을 가져옵니다.
otThreadGetDomainName ( otInstance *aInstance)
const char *
스레드 도메인 이름을 가져옵니다.
otThreadGetExtendedPanId ( otInstance *aInstance)
IEEE 802.15.4 확장 PAN ID를 가져옵니다.
otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance)
스레드 도메인 유니캐스트 주소에 대해 수동으로 지정된 인터페이스 식별자를 가져옵니다.
otThreadGetIp6Counters ( otInstance *aInstance)
const otIpCounters *
IPv6 카운터를 가져옵니다.
otThreadGetKeySequenceCounter ( otInstance *aInstance)
uint32_t
thrKeySequenceCounter를 가져옵니다.
otThreadGetKeySwitchGuardTime ( otInstance *aInstance)
uint32_t
thrKeySwitchGuardTime을 가져옵니다.
otThreadGetLeaderData ( otInstance *aInstance, otLeaderData *aLeaderData)
이 함수는 스레드 리더 데이터를 가져옵니다.
otThreadGetLeaderRloc ( otInstance *aInstance, otIp6Address *aLeaderRloc)
이 함수는 리더의 RLOC에 대한 포인터를 반환합니다.
otThreadGetLeaderRouterId ( otInstance *aInstance)
uint8_t
리더의 라우터 ID를 가져옵니다.
otThreadGetLeaderWeight ( otInstance *aInstance)
uint8_t
지도자의 무게를 얻으십시오.
otThreadGetLinkLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
이 함수는 스레드 링크-로컬 모든 스레드 노드 멀티캐스트 주소를 반환합니다.
otThreadGetLinkLocalIp6Address ( otInstance *aInstance)
const otIp6Address *
이 함수는 스레드 링크 로컬 IPv6 주소를 반환합니다.
otThreadGetLinkMode ( otInstance *aInstance)
MLE 링크 모드 구성을 가져옵니다.
otThreadGetMeshLocalEid ( otInstance *aInstance)
const otIp6Address *
이 함수는 메시 로컬 EID 주소에 대한 포인터를 반환합니다.
otThreadGetMeshLocalPrefix ( otInstance *aInstance)
이 함수는 메시 로컬 접두사에 대한 포인터를 반환합니다.
otThreadGetMleCounters ( otInstance *aInstance)
const otMleCounters *
스레드 MLE 카운터를 가져옵니다.
otThreadGetNetworkKey ( otInstance *aInstance, otNetworkKey *aNetworkKey)
void
스레드 네트워크 키를 가져옵니다.
otThreadGetNetworkKeyRef ( otInstance *aInstance)
가져 오기 otNetworkKeyRef 스레드 네트워크 키 위해.
otThreadGetNetworkName ( otInstance *aInstance)
const char *
스레드 네트워크 이름을 가져옵니다.
otThreadGetNextDiagnosticTlv (const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
이 함수는 메시지에서 다음 네트워크 진단 TLV를 가져옵니다.
otThreadGetNextNeighborInfo ( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
이 함수는 다음 이웃 정보를 가져옵니다.
otThreadGetParentAverageRssi ( otInstance *aInstance, int8_t *aParentRssi)
이 함수는 스레드 상위에 대한 평균 RSSI를 검색합니다.
otThreadGetParentInfo ( otInstance *aInstance, otRouterInfo *aParentInfo)
이 함수는 스레드 라우터에 대한 진단 정보를 부모로 검색합니다.
otThreadGetParentLastRssi ( otInstance *aInstance, int8_t *aLastRssi)
이 함수는 Thread Parent에서 마지막 패킷의 RSSI를 검색합니다.
otThreadGetPartitionId ( otInstance *aInstance)
uint32_t
파티션 ID를 가져옵니다.
otThreadGetRealmLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
이 함수는 스레드 영역-로컬 모든 스레드 노드 멀티캐스트 주소를 반환합니다.
otThreadGetRloc ( otInstance *aInstance)
const otIp6Address *
이 함수는 RLOC(Thread Routing Locator) 주소에 대한 포인터를 반환합니다.
otThreadGetRloc16 ( otInstance *aInstance)
uint16_t
RLOC16을 가져옵니다.
otThreadGetServiceAloc ( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
이 함수는 주어진 서비스 ID에 대한 서비스 ALOC를 검색합니다.
otThreadGetVersion (void)
uint16_t
이 함수는 스레드 프로토콜 버전을 가져옵니다.
otThreadIsAnycastLocateInProgress ( otInstance *aInstance)
bool
이 함수는 애니캐스트 찾기 요청이 현재 진행 중인지 여부를 나타냅니다.
otThreadIsDiscoverInProgress ( otInstance *aInstance)
bool
이 함수는 MLE 스레드 검색이 현재 진행 중인지 확인합니다.
otThreadIsSingleton ( otInstance *aInstance)
bool
이 기능은 노드가 네트워크의 유일한 라우터인지 여부를 나타냅니다.
otThreadLocateAnycastDestination ( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
이 함수는 지정된 애니캐스트 주소의 가장 가까운 목적지를 찾도록 요청합니다.
otThreadRegisterParentResponseCallback ( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
이 함수는 MLE 부모 응답 데이터를 수신하기 위한 콜백을 등록합니다.
otThreadResetIp6Counters ( otInstance *aInstance)
void
IPv6 카운터를 재설정합니다.
otThreadResetMleCounters ( otInstance *aInstance)
void
스레드 MLE 카운터를 재설정합니다.
otThreadSendAddressNotification ( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
이 기능은 사전 주소 알림(ADDR_NTF.ntf) 메시지를 보냅니다.
otThreadSendDiagnosticGet ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
네트워크 진단 가져오기 요청을 보냅니다.
otThreadSendDiagnosticReset ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
네트워크 진단 재설정 요청을 보냅니다.
otThreadSendProactiveBackboneNotification ( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
이 기능은 백본 링크에 사전 백본 알림(PRO_BB.ntf) 메시지를 보냅니다.
otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout)
void
하위 역할로 작업할 때 사용되는 스레드 하위 시간 제한을 설정합니다.
otThreadSetDiscoveryRequestCallback ( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
이 함수는 MLE Discovery Request 데이터를 수신하기 위한 콜백을 설정합니다.
otThreadSetDomainName ( otInstance *aInstance, const char *aDomainName)
스레드 도메인 이름을 설정합니다.
otThreadSetEnabled ( otInstance *aInstance, bool aEnabled)
이 함수는 스레드 프로토콜 작업을 시작합니다.
otThreadSetExtendedPanId ( otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
IEEE 802.15.4 확장 PAN ID를 설정합니다.
otThreadSetFixedDuaInterfaceIdentifier ( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
스레드 도메인 유니캐스트 주소에 대해 수동으로 지정된 인터페이스 식별자를 설정/삭제합니다.
otThreadSetJoinerAdvertisement ( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
이 메서드는 Thread 네트워크를 검색할 때 Thread Joiner Advertisement를 설정합니다.
otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter)
void
thrKeySequenceCounter를 설정합니다.
otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
thrKeySwitchGuardTime을 설정합니다.
otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig)
MLE 링크 모드 구성을 설정합니다.
otThreadSetMeshLocalPrefix ( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
이 함수는 메시 로컬 접두사를 설정합니다.
otThreadSetNetworkKey ( otInstance *aInstance, const otNetworkKey *aKey)
스레드 네트워크 키를 설정합니다.
otThreadSetNetworkKeyRef ( otInstance *aInstance, otNetworkKeyRef aKeyRef)
스레드 A와 네트워크 키 설정 otNetworkKeyRef .
otThreadSetNetworkName ( otInstance *aInstance, const char *aNetworkName)
스레드 네트워크 이름을 설정합니다.

구조체

otBorderRouterConfig

이 구조는 경계 라우터 구성을 나타냅니다.

otExternalRoute 구성

이 구조는 외부 경로 구성을 나타냅니다.

otIpCounters

이 구조는 IP 레벨 카운터를 나타냅니다.

otLeaderData

이 구조는 스레드 리더 데이터를 나타냅니다.

otLinkMode 구성

이 구조는 MLE 링크 모드 구성을 나타냅니다.

otMleCounters

이 구조는 스레드 MLE 카운터를 나타냅니다.

ot이웃 정보

이 구조는 인접 스레드 노드에 대한 진단 정보를 보유합니다.

otNetworkDiagChild 항목

이 구조는 네트워크 진단 하위 테이블 항목을 나타냅니다.

otNetworkDiag연결성

이 구조는 네트워크 진단 연결 값을 나타냅니다.

otNetworkDiagMac 카운터

이 구조는 네트워크 진단 Mac 카운터 값을 나타냅니다.

otNetworkDiagRoute

이 구조는 네트워크 진단 경로 TLV 값을 나타냅니다.

otNetworkDiagRouteData

이 구조는 네트워크 진단 경로 데이터를 나타냅니다.

otNetworkDiagTlv

이 구조는 네트워크 진단 TLV를 나타냅니다.

otRouterInfo

이 구조는 스레드 라우터에 대한 진단 정보를 보유합니다.

otServerConfig

이 구조는 서버 구성을 나타냅니다.

otServiceConfig

이 구조는 서비스 구성을 나타냅니다.

otThread디스커버리 요청 정보

이 구조는 스레드 검색 요청 데이터를 나타냅니다.

otThreadParentResponseInfo

이 구조는 MLE 상위 응답 데이터를 나타냅니다.

열거

익명의 열거형

 anonymous enum
속성
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

배터리 수준 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

채널 페이지 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

자식 테이블 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

연결성 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

MAC 확장 주소 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

IPv6 주소 목록 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

리더 데이터 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

MAC 카운터 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

최대 하위 시간 초과 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

모드 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

네트워크 데이터 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

루트64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

주소16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

공급 전압 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Timeout TLV(SED의 최대 폴링 시간)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

유형 목록 TLV.

otDeviceRole

 otDeviceRole

스레드 장치 역할을 나타냅니다.

속성
OT_DEVICE_ROLE_CHILD

스레드 하위 역할.

OT_DEVICE_ROLE_DETACHED

현재 스레드 네트워크/파티션에 참여하고 있지 않습니다.

OT_DEVICE_ROLE_DISABLED

스레드 스택이 비활성화됩니다.

OT_DEVICE_ROLE_LEADER

스레드 리더 역할.

OT_DEVICE_ROLE_ROUTER

스레드 라우터 역할.

otNetDataPublisherEvent

 otNetDataPublisherEvent

이 열거형은 게시자 콜백에서 보고된 이벤트를 나타냅니다.

속성
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

게시된 항목이 스레드 네트워크 데이터에 추가됩니다.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

게시된 항목이 스레드 네트워크 데이터에서 제거됩니다.

otRoutePreference

 otRoutePreference

유효 값 정의 mPreference 에서 otExternalRouteConfigotBorderRouterConfig .

속성
OT_ROUTE_PREFERENCE_HIGH

높은 경로 선호도.

OT_ROUTE_PREFERENCE_LOW

낮은 경로 선호도.

OT_ROUTE_PREFERENCE_MED

중간 경로 기본 설정.

형식 정의

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

이 구조는 경계 라우터 구성을 나타냅니다.

otExternalRoute 구성

struct otExternalRouteConfig otExternalRouteConfig

이 구조는 외부 경로 구성을 나타냅니다.

otIpCounters

struct otIpCounters otIpCounters

이 구조는 IP 레벨 카운터를 나타냅니다.

otLeaderData

struct otLeaderData otLeaderData

이 구조는 스레드 리더 데이터를 나타냅니다.

otLinkMode 구성

struct otLinkModeConfig otLinkModeConfig

이 구조는 MLE 링크 모드 구성을 나타냅니다.

otMleCounters

struct otMleCounters otMleCounters

이 구조는 스레드 MLE 카운터를 나타냅니다.

otNeighborInfo반복자

int16_t otNeighborInfoIterator

인접 테이블을 반복하는 데 사용됩니다.

otNetDataDnsSrpServicePublisher콜백

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

이 함수 포인터 유형은 스레드 네트워크 데이터에 "DNS/SRP 서비스" 항목이 추가되거나 제거될 때 알리는 데 사용되는 콜백을 정의합니다.

제거에 콜백 항목이 제거하는지 여부와 상관없이 호출 Publisher (예를 들면, 너무 많은 유사한 네트워크 데이터에 이미 존재하는 항목이있는 경우) 항목의 게시를 취소하거나 명시 적으로 호출을 통해 (즉,에 대한 호출 otNetDataUnpublishDnsSrpService() ).

세부
매개변수
[in] aEvent
이벤트를 나타냅니다(항목이 추가 또는 제거되었는지 여부).
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.

otNetDataPrefixPublisherCallback

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

이 함수 포인터 유형은 접두사(메시 또는 외부 경로) 항목이 스레드 네트워크 데이터에 추가되거나 제거될 때 알리는 데 사용되는 콜백을 정의합니다.

제거에 콜백 항목이 제거하는지 여부와 상관없이 호출 Publisher (예를 들어, 이미 네트워크 데이터에 존재하는 너무 많은 유사한 항목이있는 경우) 또는 항목의 게시를 취소 할 수있는 명시 적 호출을 통해이.

세부
매개변수
[in] aEvent
이벤트를 나타냅니다(항목이 추가 또는 제거되었는지 여부).
[in] aPrefix
접두사 항목에 대한 포인터입니다.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

이 열거형은 게시자 콜백에서 보고된 이벤트를 나타냅니다.

otNetworkDataIterator

uint32_t otNetworkDataIterator

네트워크 데이터 정보를 반복하는 데 사용됩니다.

otNetworkDiagChild 항목

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

이 구조는 네트워크 진단 하위 테이블 항목을 나타냅니다.

otNetworkDiag연결성

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

이 구조는 네트워크 진단 연결 값을 나타냅니다.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

네트워크 진단 TLV를 반복하는 데 사용됩니다.

otNetworkDiagMac 카운터

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

이 구조는 네트워크 진단 Mac 카운터 값을 나타냅니다.

참조 RFC 2863를 멤버 필드의 정의를.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

이 구조는 네트워크 진단 경로 TLV 값을 나타냅니다.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

이 구조는 네트워크 진단 경로 데이터를 나타냅니다.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

이 구조는 네트워크 진단 TLV를 나타냅니다.

otReceiveDiagnosticGetCallback

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

이 함수 포인터는 네트워크 진단 받기 응답이 수신될 때 호출됩니다.

세부
매개변수
[in] aError
응답을 받지 못했을 때 발생하는 오류입니다.
[in] aMessage
수신된 Network Diagnostic Get 응답 페이로드를 포함하는 메시지 버퍼에 대한 포인터입니다. 경우에만 사용할 수 있습니다 aError 있다 OT_ERROR_NONE .
[in] aMessageInfo
에 대한 메시지 정보에 대한 포인터 aMessage . 경우에만 사용할 수 있습니다 aError 있다 OT_ERROR_NONE .
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.

otRoutePreference

enum otRoutePreference otRoutePreference

유효 값 정의 mPreference 에서 otExternalRouteConfigotBorderRouterConfig .

otServerConfig

struct otServerConfig otServerConfig

이 구조는 서버 구성을 나타냅니다.

otServiceConfig

struct otServiceConfig otServiceConfig

이 구조는 서비스 구성을 나타냅니다.

otThreadAnycastLocator콜백

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

이 함수 포인터 유형은의 결과를 통지하기 위해 콜백을 정의 otThreadLocateAnycastDestination() 요청.

세부
매개변수
[in] aContext
임의의 컨텍스트에 대한 포인터(콜백이 등록될 때 제공됨).
[in] aError
요청을 처리할 때 오류가 발생했습니다. OT_ERROR_NONE은 성공을 나타냅니다. OT_ERROR_RESPONSE_TIMEOUT은 목적지를 찾을 수 없음을 나타냅니다. OT_ERROR_ABORT는 요청이 중단되었음을 나타냅니다.
[in] aMeshLocalAddress
애니 캐스트 주소의 가장 가까운 대상의 메쉬 지역 EID에 대한 포인터 때 aError OT_ERROR_NONE, 그 이외의 경우는 NULL이다.
[in] aRloc16
발견된 경우 목적지의 RLOC16, 그렇지 않으면 유효하지 않은 RLOC16(0xfffe).

otThread디스커버리 요청 콜백

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

이 함수 포인터는 MLE 발견 요청 메시지가 수신될 때마다 호출됩니다.

세부
매개변수
[in] aInfo
검색 요청 정보 데이터에 대한 포인터입니다.
[in] aContext
콜백 애플리케이션 특정 컨텍스트에 대한 포인터입니다.

otThread디스커버리 요청 정보

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

이 구조는 스레드 검색 요청 데이터를 나타냅니다.

otThreadParentResponse콜백

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

이 함수 포인터는 MLE 부모 응답 메시지가 수신될 때마다 호출됩니다.

세부
매개변수
[in] aStats
통계 데이터를 보유하는 스택의 위치에 대한 포인터입니다.
[in] aContext
콜백 클라이언트 관련 컨텍스트에 대한 포인터입니다.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

이 구조는 MLE 상위 응답 데이터를 나타냅니다.

기능

otNetDataGet

otError otNetDataGet(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

이 방법은 파티션의 스레드 네트워크 데이터의 전체 또는 안정적인 복사본을 제공합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aStable
안정 버전을 복사할 때 TRUE, 정식 버전을 복사할 때 FALSE입니다.
[out] aData
데이터 버퍼에 대한 포인터입니다.
[in,out] aDataLength
항목에서 데이터 버퍼의 크기가 가리키는 aData . 종료 시 복사된 바이트 수입니다.

otNetDataGetNextOnMesh접두사

otError otNetDataGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

이 함수는 파티션의 네트워크 데이터에서 다음 On Mesh 접두사를 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in,out] aIterator
네트워크 데이터 반복기 컨텍스트에 대한 포인터입니다. 첫 번째 온 메시 항목을 얻으려면 OT_NETWORK_DATA_ITERATOR_INIT로 설정해야 합니다.
[out] aConfig
On Mesh Prefix 정보가 배치될 위치에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
다음 On Mesh 접두사를 성공적으로 찾았습니다.
OT_ERROR_NOT_FOUND
스레드 네트워크 데이터에 후속 On Mesh 접두사가 없습니다.

otNetDataGetNextRoute

otError otNetDataGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

이 함수는 파티션의 네트워크 데이터에서 다음 외부 경로를 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in,out] aIterator
네트워크 데이터 반복기 컨텍스트에 대한 포인터입니다. 첫 번째 외부 경로 항목을 얻으려면 OT_NETWORK_DATA_ITERATOR_INIT로 설정해야 합니다.
[out] aConfig
외부 경로 정보가 배치될 위치에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
다음 외부 경로를 성공적으로 찾았습니다.
OT_ERROR_NOT_FOUND
스레드 네트워크 데이터에 후속 외부 경로 항목이 없습니다.

otNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

이 함수는 파티션의 네트워크 데이터에서 다음 서비스를 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in,out] aIterator
네트워크 데이터 반복기 컨텍스트에 대한 포인터입니다. 첫 번째 서비스 항목을 얻으려면 OT_NETWORK_DATA_ITERATOR_INIT로 설정해야 합니다.
[out] aConfig
서비스 정보가 배치될 위치에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
다음 서비스를 성공적으로 찾았습니다.
OT_ERROR_NOT_FOUND
파티션의 네트워크 데이터에 후속 서비스가 없습니다.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

안정적인 네트워크 데이터 버전을 얻으십시오.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
안정적인 네트워크 데이터 버전.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

네트워크 데이터 버전을 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
네트워크 데이터 버전.

otNetDataIsDnsSrpService 추가됨

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

이 기능은 현재 "DNS/SRP 서비스" 항목이 스레드 네트워크 데이터에 추가되었는지 여부를 나타냅니다.

이 기능은 기능이 필요 OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE 활성화 될 수 있습니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
반환 값
TRUE
게시된 DNS/SRP 서비스 항목이 스레드 네트워크 데이터에 추가됩니다.
FALSE
항목이 스레드 네트워크 데이터에 추가되지 않았거나 게시할 항목이 없습니다.

otNetDataIsPrefix추가됨

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

이 기능은 현재 게시된 접두사 항목(메시 또는 외부 경로)이 스레드 네트워크 데이터에 추가되었는지 여부를 나타냅니다.

이 기능은 기능이 필요 OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE 활성화 될 수 있습니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aPrefix
접두사에 대한 포인터(NULL이 아니어야 함).
반환 값
TRUE
게시된 접두사 항목이 스레드 네트워크 데이터에 추가됩니다.
FALSE
항목이 스레드 네트워크 데이터에 추가되지 않았거나 게시할 항목이 없습니다.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

이 기능은 스레드 네트워크 데이터에 게시할 "DNS/SRP 서비스 애니캐스트 주소"를 요청합니다.

이 기능은 기능이 필요 OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE 활성화 될 수 있습니다.

이 함수를 호출하면 제거하고 (이전 호출에서의에 게시 된 이전의 "DNS / SRP 서비스"항목을 대체 할 otNetDataPublishDnsSrpService{Type}() 함수).

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aSequenceNUmber
DNS/SRP 애니캐스트 서비스의 시퀀스 번호입니다.

otNetDataPublishDnsSrpService유니캐스트

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

이 기능은 스레드 네트워크 데이터에 게시할 "DNS/SRP 서비스 유니캐스트 주소"를 요청합니다.

이 기능은 기능이 필요 OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE 활성화 될 수 있습니다.

이 함수를 호출하면 제거하고 (이전 호출에서의에 게시 된 이전의 "DNS / SRP 서비스"항목을 대체 할 otNetDataPublishDnsSrpService{Type}() 함수).

이 기능은 서비스 TLV 데이터에 주소 및 포트 정보를 포함하여 "DNS/SRP 서비스 유니캐스트 주소"를 게시합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aAddress
게시할 DNS/SRP 서버 주소입니다(NULL이 아니어야 함).
[in] aPort
게시할 SRP 서버 포트 번호입니다.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

이 기능은 스레드 네트워크 데이터에 게시할 "DNS/SRP 서비스 유니캐스트 주소"를 요청합니다.

이 기능은 기능이 필요 OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE 활성화 될 수 있습니다.

이 함수를 호출하면 제거하고 (이전 호출에서의에 게시 된 이전의 "DNS / SRP 서비스"항목을 대체 할 otNetDataPublishDnsSrpService{Type}() 함수).

달리 otNetDataPublishDnsSrpServiceUnicast() 제공되는 게시 된 주소가 필요하며 서비스 TLV 데이터의 정보를 포함,이 기능은 장치의 메쉬 지역 EID를 사용하고 서버 TLV 데이터의 정보가 포함되어 있습니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aPort
게시할 SRP 서버 포트 번호입니다.

otNetDataPublishExternalRoute

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

이 함수는 스레드 네트워크 데이터에 게시할 외부 경로 접두사를 요청합니다.

이 기능은 기능이 필요 OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE 활성화 될 수 있습니다.

만 안정적인 항목 (즉, 게시 할 수 있습니다 aConfig.mStable TRUE이어야한다).

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aConfig
게시할 외부 경로 구성(NULL이 아니어야 함).
반환 값
OT_ERROR_NONE
외부 경로가 성공적으로 게시되었습니다.
OT_ERROR_INVALID_ARGS
aConfig 유효 (나쁜 접두사, 유효하지 않은 플래그 조합 여부를 안정적) 없습니다.
OT_ERROR_ALREADY
동일한 접두사를 가진 항목이 이미 게시된 목록에 있습니다.
OT_ERROR_NO_BUFS
새 요청에 대한 항목을 할당할 수 없습니다. 게시자의 구성에 의해 결정 (ON 메쉬 프리픽스 외부 경로 사이에 공유) 항목 제한된 지원 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

otNetDataPublishOnMesh접두사

otError otNetDataPublishOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

이 함수는 Thread Network Data에 게시할 on-mesh 접두사를 요청합니다.

이 기능은 기능이 필요 OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE 활성화 될 수 있습니다.

만 안정적인 항목 (즉, 게시 할 수 있습니다 aConfig.mStable TRUE이어야한다).

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aConfig
게시할 on-mesh 접두사 구성(NULL이 아니어야 함).
반환 값
OT_ERROR_NONE
메시 접두사가 성공적으로 게시되었습니다.
OT_ERROR_INVALID_ARGS
aConfig 유효 (나쁜 접두사, 유효하지 않은 플래그 조합 여부를 안정적) 없습니다.
OT_ERROR_ALREADY
동일한 접두사를 가진 항목이 이미 게시된 목록에 있습니다.
OT_ERROR_NO_BUFS
새 요청에 대한 항목을 할당할 수 없습니다. 게시자의 구성에 의해 결정 (ON 메쉬 프리픽스 외부 경로 사이에 공유) 항목 제한된 지원 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

otNetDataSetDnsSrpServicePublisher콜백

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

이 함수는 게시된 "DNS/SRP 서비스"가 실제로 스레드 네트워크 데이터에 추가되거나 제거될 때 알리기 위한 콜백을 설정합니다.

이 함수에 대한 후속 호출은 이전에 설정된 콜백 함수를 대체합니다.

이 기능은 기능이 필요 OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE 활성화 될 수 있습니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aCallback
콜백 함수 포인터(필요하지 않은 경우 NULL일 수 있음).
[in] aContext
(때 사용하는 응용 프로그램 별 컨텍스트에 대한 포인터 aCallback 호출된다).

otNetDataSetPrefixPublisherCallback

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

이 함수는 게시된 접두사 항목이 스레드 네트워크 데이터에 실제로 추가되거나 제거될 때 알리기 위한 콜백을 설정합니다.

이 함수에 대한 후속 호출은 이전에 설정된 콜백 함수를 대체합니다.

이 기능은 기능이 필요 OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE 활성화 될 수 있습니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aCallback
콜백 함수 포인터(필요하지 않은 경우 NULL일 수 있음).
[in] aContext
(때 사용하는 응용 프로그램 별 컨텍스트에 대한 포인터 aCallback 호출된다).

otNetDataSteeringDataCheckJoiner

otError otNetDataSteeringDataCheckJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

조향 데이터에 조이너가 포함되어 있는지 확인합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aEui64
Joiner의 IEEE EUI-64에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
aEui64 스티어링 된 데이터에 포함된다.
OT_ERROR_INVALID_STATE
스티어링 데이터가 없습니다.
OT_ERROR_NOT_FOUND
aEui64 스티어링 된 데이터에 포함되지 않는다.

otNetDataSteeringDataCheckJoinerWithDiscerner

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

스티어링 데이터에 식별자 값이 지정된 Joiner가 포함되어 있는지 확인합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aDiscerner
Joiner Discerner에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
aDiscerner 스티어링 된 데이터에 포함된다.
OT_ERROR_INVALID_STATE
스티어링 데이터가 없습니다.
OT_ERROR_NOT_FOUND
aDiscerner 스티어링 된 데이터에 포함되지 않는다.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

이 기능은 스레드 네트워크 데이터에서 이전에 추가된 "DNS/SRP(Anycast 또는 Unicast) 서비스" 항목의 게시를 취소합니다.

이 기능은 기능이 필요 OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE 활성화 될 수 있습니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.

otNetDataUnpublishPrefix

otError otNetDataUnpublishPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

이 기능은 이전에 게시된 접두사(온메시 또는 외부 경로)를 게시 취소합니다.

이 기능은 기능이 필요 OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE 활성화 될 수 있습니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aPrefix
게시를 취소할 접두사입니다(NULL이 아니어야 함).
반환 값
OT_ERROR_NONE
접두사가 성공적으로 게시 취소되었습니다.
OT_ERROR_NOT_FOUND
게시된 목록에서 접두사를 찾을 수 없습니다.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

어린 시절에 다시 애착을 시도하십시오.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
성공적으로 아이가 되기 위한 시도를 시작합니다.
OT_ERROR_INVALID_STATE
스레드가 비활성화되었습니다.

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

스레드 네트워크에서 분리합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
스레드 네트워크에서 성공적으로 분리되었습니다.
OT_ERROR_INVALID_STATE
스레드가 비활성화되었습니다.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

장치 역할을 사람이 읽을 수 있는 문자열로 변환합니다.

세부
매개변수
[in] aRole
변환할 장치 역할입니다.
보고
나타내는 문자열 aRole .

otThread디스커버

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

이 기능은 스레드 검색 스캔을 시작합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aScanChannels
스캔할 채널을 나타내는 비트 벡터(예: OT_CHANNEL_11_MASK).
[in] aPanId
PAN ID 필터(필터를 비활성화하려면 브로드캐스트 PAN으로 설정).
[in] aJoiner
Discovery Request TLV에 있는 Joiner 플래그의 값입니다.
[in] aEnableEui64Filtering
EUI-64에 대한 응답을 필터링하려면 TRUE이고 그렇지 않으면 FALSE입니다.
[in] aCallback
MLE 검색 응답을 수신하거나 검색이 완료될 때 호출되는 함수에 대한 포인터입니다.
[in] aCallbackContext
애플리케이션별 컨텍스트에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
스레드 검색 스캔을 성공적으로 시작했습니다.
OT_ERROR_INVALID_STATE
IPv6 인터페이스가 활성화되지 않았습니다(netif가 작동하지 않음).
OT_ERROR_NO_BUFS
검색 요청에 대한 메시지를 할당할 수 없습니다.
OT_ERROR_BUSY
스레드 검색 스캔이 이미 진행 중입니다.

otThreadGetChild 시간 초과

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

하위 역할에서 작동할 때 사용되는 스레드 하위 시간 제한을 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
스레드 하위 시간 초과 값(초)입니다.
또한보십시오:
otThreadSetChild 시간 초과

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

장치 역할을 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
반환 값
OT_DEVICE_ROLE_DISABLED
스레드 스택이 비활성화됩니다.
OT_DEVICE_ROLE_DETACHED
장치가 현재 스레드 네트워크/파티션에 참여하고 있지 않습니다.
OT_DEVICE_ROLE_CHILD
장치는 현재 스레드 하위로 작동하고 있습니다.
OT_DEVICE_ROLE_ROUTER
장치는 현재 스레드 라우터로 작동하고 있습니다.
OT_DEVICE_ROLE_LEADER
장치는 현재 스레드 리더로 작동하고 있습니다.

otThreadGet도메인이름

const char * otThreadGetDomainName(
  otInstance *aInstance
)

스레드 도메인 이름을 가져옵니다.

이 기능은 Thread 1.2부터 사용할 수 있습니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
스레드 도메인 이름에 대한 포인터입니다.
또한보십시오:
otThreadSet도메인이름

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

IEEE 802.15.4 확장 PAN ID를 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
IEEE 802.15.4 확장 PAN ID에 대한 포인터입니다.
또한보십시오:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

스레드 도메인 유니캐스트 주소에 대해 수동으로 지정된 인터페이스 식별자를 가져옵니다.

때이 기능은 스레드 1.2 이후에서만 사용할 수 있습니다 OPENTHREAD_CONFIG_DUA_ENABLE 활성화됩니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
수동으로 설정된 인터페이스 식별자에 대한 포인터이거나 설정되지 않은 경우 NULL입니다.
또한보십시오:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6카운터

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

IPv6 카운터를 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
IPv6 카운터에 대한 포인터입니다.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

thrKeySequenceCounter를 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
thrKeySequenceCounter 값입니다.
또한보십시오:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

thrKeySwitchGuardTime을 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
thrKeySwitchGuardTime 값(시간)입니다.
또한보십시오:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

이 함수는 스레드 리더 데이터를 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[out] aLeaderData
지시선 데이터가 배치되는 위치에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
리더 데이터를 성공적으로 검색했습니다.
OT_ERROR_DETACHED
현재 첨부되어 있지 않습니다.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

이 함수는 리더의 RLOC에 대한 포인터를 반환합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[out] aLeaderRloc
리더의 RLOC에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
리더의 RLOC이 성공적으로 작성되었습니다 aLeaderRloc .
OT_ERROR_INVALID_ARGS
aLeaderRloc NULL이다.
OT_ERROR_DETACHED
현재 스레드 파티션에 연결되어 있지 않습니다.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

리더의 라우터 ID를 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
리더의 라우터 ID입니다.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

지도자의 무게를 얻으십시오.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
리더의 무게.

otThreadGetLinkLocalAllThreadNodes멀티캐스트 주소

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

이 함수는 스레드 링크-로컬 모든 스레드 노드 멀티캐스트 주소를 반환합니다.

주소는 다음을 포함하는 링크 로컬 유니캐스트 접두사 기반 멀티캐스트 주소[RFC 3306]입니다.

  • flgs를 3으로 설정(P = 1 및 T = 1)
  • 범위를 2로 설정
  • Plen을 64로 설정
  • 메시 로컬 접두사로 설정된 네트워크 접두사
  • 그룹 ID가 1로 설정됨

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
스레드 링크-로컬 모든 스레드 노드 멀티캐스트 주소에 대한 포인터입니다.

otThreadGetLinkLocalIp6주소

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

이 함수는 스레드 링크 로컬 IPv6 주소를 반환합니다.

스레드 링크 로컬 주소는 IEEE802.15.4 확장 주소를 인터페이스 식별자로 사용하여 파생됩니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
스레드 링크 로컬 IPv6 주소에 대한 포인터입니다.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

MLE 링크 모드 구성을 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
MLE 링크 모드 구성.
또한보십시오:
otThreadSetLinkMode

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

이 함수는 메시 로컬 EID 주소에 대한 포인터를 반환합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
메시 로컬 EID 주소에 대한 포인터입니다.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

이 함수는 메시 로컬 접두사에 대한 포인터를 반환합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
메시 로컬 접두사에 대한 포인터입니다.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

스레드 MLE 카운터를 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
스레드 MLE 카운터에 대한 포인터입니다.

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

스레드 네트워크 키를 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[out] aNetworkKey
에 대한 포인터 otNetworkkey 스레드 네트워크 키를 반환합니다.
또한보십시오:
otThreadSet네트워크 키

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

가져 오기 otNetworkKeyRef 스레드 네트워크 키 위해.

이 기능은 빌드 타임 기능이 필요 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE 활성화 될 수 있습니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
메모리에 저장된 스레드 네트워크 키에 대한 참조입니다.
또한보십시오:
otThreadSet네트워크 키 참조

otThreadGet네트워크 이름

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

스레드 네트워크 이름을 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
스레드 네트워크 이름에 대한 포인터입니다.
또한보십시오:
otThreadSet네트워크 이름

otThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

이 함수는 메시지에서 다음 네트워크 진단 TLV를 가져옵니다.

이 함수에 대한 후속 호출은 현재 반환 값이 OT_ERROR_NONE인 경우에만 허용됩니다.

세부
매개변수
[in] aMessage
메시지에 대한 포인터입니다.
[in,out] aIterator
네트워크 진단 반복기 컨텍스트에 대한 포인터입니다. 첫 번째 네트워크 진단 TLV를 얻으려면 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT로 설정해야 합니다.
[out] aNetworkDiagTlv
네트워크 진단 TLV 정보가 배치될 위치에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
다음 네트워크 진단 TLV를 성공적으로 찾았습니다.
OT_ERROR_NOT_FOUND
메시지에 후속 네트워크 진단 TLV가 없습니다.
OT_ERROR_PARSE
다음 네트워크 진단을 구문 분석하지 못했습니다.

otThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

이 함수는 다음 이웃 정보를 가져옵니다.

이웃 테이블의 항목을 통과하는 데 사용됩니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in,out] aIterator
반복자 컨텍스트에 대한 포인터입니다. 첫 번째 이웃 항목을 얻으려면 OT_NEIGHBOR_INFO_ITERATOR_INIT로 설정해야 합니다.
[out] aInfo
이웃 정보에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
테이블에서 다음 이웃 항목을 성공적으로 찾았습니다.
OT_ERROR_NOT_FOUND
테이블에 후속 인접 항목이 없습니다.
OT_ERROR_INVALID_ARGS
aIterator 또는 aInfo NULL이다.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

이 함수는 스레드 상위에 대한 평균 RSSI를 검색합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[out] aParentRssi
상위 RSSI를 배치해야 하는 위치에 대한 포인터입니다.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

The function retrieves diagnostic information for a Thread Router as parent.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aParentInfo
A pointer to where the parent router information is placed.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

The function retrieves the RSSI of the last packet from the Thread Parent.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aLastRssi
A pointer to where the last RSSI should be placed.
Return Values
OT_ERROR_NONE
Successfully retrieved the RSSI data.
OT_ERROR_FAILED
Unable to get RSSI data.
OT_ERROR_INVALID_ARGS
aLastRssi is NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Get the Partition ID.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
The Partition ID.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

This function returns the Thread Realm-Local All Thread Nodes multicast address.

The address is a realm-local Unicast Prefix-Based Multcast Address [RFC 3306], with:

  • flgs set to 3 (P = 1 and T = 1)
  • scop set to 3
  • plen set to 64
  • network prefix set to the Mesh Local Prefix
  • group ID set to 1

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
A pointer to Thread Realm-Local All Thread Nodes multicast address.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

This function returns a pointer to the Thread Routing Locator (RLOC) address.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
A pointer to the Thread Routing Locator (RLOC) address.

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Get the RLOC16.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
The RLOC16.

otThreadGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

This function retrieves the Service ALOC for given Service ID.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aServiceId
Service ID to get ALOC for.
[out] aServiceAloc
A pointer to output the Service ALOC. MUST NOT BE NULL.
Return Values
OT_ERROR_NONE
Successfully retrieved the Service ALOC.
OT_ERROR_DETACHED
The Thread interface is not currently attached to a Thread Partition.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

This function gets the Thread protocol version.

Details
Returns
the Thread protocol version.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

This function indicates whether an anycast locate request is currently in progress.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
TRUE if an anycast locate request is currently in progress, FALSE otherwise.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

This function determines if an MLE Thread Discovery is currently in progress.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

This function indicates whether a node is the only router on the network.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Return Values
TRUE
It is the only router in the network.
FALSE
It is a child or is not a single router in the network.

otThreadLocateAnycastDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

This function requests the closest destination of a given anycast address to be located.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

If a previous request is ongoing, a subsequent call to this function will cancel and replace the earlier request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aAnycastAddress
The anycast address to locate. MUST NOT be NULL.
[in] aCallback
The callback function to report the result.
[in] aContext
An arbitrary context used with aCallback .
Return Values
OT_ERROR_NONE
The request started successfully. aCallback will be invoked to report the result.
OT_ERROR_INVALID_ARGS
The aAnycastAddress is not a valid anycast address or aCallback is NULL.
OT_ERROR_NO_BUFS
Out of buffer to prepare and send the request message.

otThreadRegisterParentResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

This function registers a callback to receive MLE Parent Response data.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aCallback
A pointer to a function that is called upon receiving an MLE Parent Response message.
[in] aContext
A pointer to callback client-specific context.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reset the IPv6 counters.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reset the Thread MLE counters.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadSendAddressNotification

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
The destination to send the ADDR_NTF.ntf message.
[in] aTarget
The target address of the ADDR_NTF.ntf message.
[in] aMlIid
The ML-IID of the ADDR_NTF.ntf message.

otThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

Send a Network Diagnostic Get request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
A pointer to destination address.
[in] aTlvTypes
An array of Network Diagnostic TLV types.
[in] aCount
Number of types in aTlvTypes.
[in] aCallback
A pointer to a function that is called when Network Diagnostic Get response is received or NULL to disable the callback.
[in] aCallbackContext
A pointer to application-specific context.
Return Values
OT_ERROR_NONE
Successfully queued the DIAG_GET.req.
OT_ERROR_NO_BUFS
Insufficient message buffers available to send DIAG_GET.req.

otThreadSendDiagnosticReset

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

Send a Network Diagnostic Reset request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
A pointer to destination address.
[in] aTlvTypes
An array of Network Diagnostic TLV types. Currently only Type 9 is allowed.
[in] aCount
Number of types in aTlvTypes
Return Values
OT_ERROR_NONE
Successfully queued the DIAG_RST.ntf.
OT_ERROR_NO_BUFS
Insufficient message buffers available to send DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

This function sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aTarget
The target address of the PRO_BB.ntf message.
[in] aMlIid
The ML-IID of the PRO_BB.ntf message.
[in] aTimeSinceLastTransaction
Time since last transaction (in seconds).
Return Values
OT_ERROR_NONE
Successfully sent PRO_BB.ntf on backbone link.
OT_ERROR_NO_BUFS
If insufficient message buffers available.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Set the Thread Child Timeout used when operating in the Child role.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aTimeout
The timeout value in seconds.
See also:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

This function sets a callback to receive MLE Discovery Request data.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aCallback
A pointer to a function that is called upon receiving an MLE Discovery Request message.
[in] aContext
A pointer to callback application-specific context.

otThreadSetDomainName

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

Set the Thread Domain Name.

This function is only available since Thread 1.2. This function succeeds only when Thread protocols are disabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDomainName
A pointer to the Thread Domain Name.
Return Values
OT_ERROR_NONE
Successfully set the Thread Domain Name.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

This function starts Thread protocol operation.

The interface must be up when calling this function.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aEnabled
TRUE if Thread is enabled, FALSE otherwise.
Return Values
OT_ERROR_NONE
Successfully started Thread protocol operation.
OT_ERROR_INVALID_STATE
The network interface was not not up.

otThreadSetExtendedPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

Set the IEEE 802.15.4 Extended PAN ID.

This function can only be called while Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aExtendedPanId
A pointer to the IEEE 802.15.4 Extended PAN ID.
Return Values
OT_ERROR_NONE
Successfully set the Extended PAN ID.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Set/Clear the Interface Identifier manually specified for the Thread Domain Unicast Address.

This function is only available since Thread 1.2 when OPENTHREAD_CONFIG_DUA_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aIid
A pointer to the Interface Identifier to set or NULL to clear.
Return Values
OT_ERROR_NONE
Successfully set/cleared the Interface Identifier.
OT_ERROR_INVALID_ARGS
The specified Interface Identifier is reserved.
See also:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

This method 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.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[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.
[in] aAdvData
A pointer to the AdvData that will be included in the Joiner Advertisement.
[in] aAdvDataLength
The length of AdvData in bytes.
Return Values
OT_ERROR_NONE
Successfully set Joiner Advertisement.
OT_ERROR_INVALID_ARGS
Invalid AdvData.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Set the thrKeySequenceCounter.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeySequenceCounter
The thrKeySequenceCounter value.
See also:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Set the thrKeySwitchGuardTime.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeySwitchGuardTime
The thrKeySwitchGuardTime value (in hours).
See also:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Set the MLE Link Mode configuration.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aConfig
A pointer to the Link Mode configuration.
Return Values
OT_ERROR_NONE
Successfully set the MLE Link Mode configuration.
See also:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

This function sets the Mesh Local Prefix.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aMeshLocalPrefix
A pointer to the Mesh Local Prefix.
Return Values
OT_ERROR_NONE
Successfully set the Mesh Local Prefix.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.

otThreadSetNetworkKey

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

Set the Thread Network Key.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKey
A pointer to a buffer containing the Thread Network Key.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Key.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Set the Thread Network Key as a otNetworkKeyRef .

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

This function requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeyRef
Reference to the Thread Network Key.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Key.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

Set the Thread Network Name.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aNetworkName
A pointer to the Thread Network Name.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Name.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkName

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maximum AdvData Length of Joiner Advertisement.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initializer for otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maximum value length of Thread Base TLV.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Value to initialize otNetworkDataIterator .

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Size of Network Diagnostic Child Table entry.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initializer for otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Maximum Number of Network Diagnostic TLV Types to Request or Reset.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maximum Router ID.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Max size of Server Data in bytes. Theoretical limit, practically much lower.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Max size of Service Data in bytes.