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

사례

이 모듈에는 OpenThread 인스턴스를 제어하는 ​​기능이 포함되어 있습니다.

요약

열거

anonymous enum {
OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
OT_CHANGED_THREAD_ROLE = 1 << 2,
OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
OT_CHANGED_THREAD_NETDATA = 1 << 9,
OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
OT_CHANGED_THREAD_CHANNEL = 1 << 14,
OT_CHANGED_THREAD_PANID = 1 << 15,
OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
OT_CHANGED_NETWORK_KEY = 1 << 18,
OT_CHANGED_PSKC = 1 << 19,
OT_CHANGED_SECURITY_POLICY = 1 << 20,
OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
OT_CHANGED_JOINER_STATE = 1 << 27,
OT_CHANGED_ACTIVE_DATASET = 1 << 28,
OT_CHANGED_PENDING_DATASET = 1 << 29
}
열거
이 열거의 한 부분으로 전달되는 플래그를 정의 otStateChangedCallback .

형식 정의

otChangedFlags 형식 정의
uint32_t
이 유형은 변경된 특정 상태/구성을 나타내는 비트 필드를 나타냅니다.
otInstance 형식 정의
struct otInstance
이 구조는 OpenThread 인스턴스 구조를 나타냅니다.
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) 형식 정의
void(*
이 함수 포인터는 OpenThread 내의 특정 구성 또는 상태 변경을 알리기 위해 호출됩니다.

기능

otGetRadioVersionString ( otInstance *aInstance)
const char *
이 함수는 OpenThread 라디오 버전 문자열을 가져옵니다.
otGetVersionString (void)
const char *
이 함수는 OpenThread 버전 문자열을 가져옵니다.
otInstanceErasePersistentInfo ( otInstance *aInstance)
이 기능은 비휘발성 메모리에 저장된 모든 OpenThread 영구 정보(네트워크 설정)를 지웁니다.
otInstanceFactoryReset ( otInstance *aInstance)
void
이 방법은 비휘발성 메모리에 저장된 모든 설정을 삭제한 다음 플랫폼 재설정을 트리거합니다.
otInstanceFinalize ( otInstance *aInstance)
void
이 함수는 OpenThread 라이브러리를 비활성화합니다.
otInstanceGetUptime ( otInstance *aInstance)
uint64_t
이 함수는 현재 인스턴스 가동 시간(msec)을 반환합니다.
otInstanceGetUptimeAsString ( otInstance *aInstance, char *aBuffer, uint16_t aSize)
void
이 함수는 현재 인스턴스 가동 시간을 사람이 읽을 수 있는 문자열로 반환합니다.
otInstanceInit (void *aInstanceBuffer, size_t *aInstanceBufferSize)
이 함수는 OpenThread 라이브러리를 초기화합니다.
otInstanceInitSingle (void)
이 함수는 OpenThread 라이브러리의 정적 단일 인스턴스를 초기화합니다.
otInstanceIsInitialized ( otInstance *aInstance)
bool
이 함수는 인스턴스가 유효/초기화되었는지 여부를 나타냅니다.
otInstanceReset ( otInstance *aInstance)
void
이 메서드는 플랫폼 재설정을 트리거합니다.
otInstanceResetRadioStack ( otInstance *aInstance)
void
이 메서드는 OpenThread 라디오 스택의 내부 상태를 재설정합니다.
otRemoveStateChangeCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
이 함수는 OpenThread 내에서 특정 구성이나 상태가 변경될 때를 나타내는 콜백을 제거합니다.
otSetStateChangedCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
이 함수는 OpenThread 내에서 특정 구성 또는 상태가 변경될 때를 나타내는 콜백을 등록합니다.

열거

익명의 열거형

 anonymous enum

이 열거의 한 부분으로 전달되는 플래그를 정의 otStateChangedCallback .

속성
OT_CHANGED_ACTIVE_DATASET

활성 운영 데이터 세트가 변경되었습니다.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

채널 관리자의 새 보류 스레드 채널이 변경되었습니다.

OT_CHANGED_COMMISSIONER_STATE

위원 상태가 변경되었습니다.

OT_CHANGED_IP6_ADDRESS_ADDED

IPv6 주소가 추가되었습니다.

OT_CHANGED_IP6_ADDRESS_REMOVED

IPv6 주소가 제거되었습니다.

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

IPv6 멀티캐스트 주소에 가입했습니다.

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

IPv6 멀티캐스트 주소에서 구독 취소되었습니다.

OT_CHANGED_JOINER_STATE

조이너 상태가 변경되었습니다.

OT_CHANGED_NETWORK_KEY

네트워크 키가 변경되었습니다.

OT_CHANGED_PENDING_DATASET

보류 중인 운영 데이터 세트가 변경되었습니다.

OT_CHANGED_PSKC

PSKc가 변경되었습니다.

OT_CHANGED_SECURITY_POLICY

보안 정책이 변경되었습니다.

OT_CHANGED_SUPPORTED_CHANNEL_MASK

지원되는 채널 마스크가 변경되었습니다.

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

로컬 백본 라우터 구성이 변경되었습니다.

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

백본 라우터 상태가 변경되었습니다.

OT_CHANGED_THREAD_CHANNEL

스레드 네트워크 채널이 변경되었습니다.

OT_CHANGED_THREAD_CHILD_ADDED

아이가 추가되었습니다.

OT_CHANGED_THREAD_CHILD_REMOVED

아이가 제거되었습니다.

OT_CHANGED_THREAD_EXT_PANID

스레드 네트워크 확장 PAN ID가 변경되었습니다.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

스레드 키 시퀀스가 ​​변경되었습니다.

OT_CHANGED_THREAD_LL_ADDR

링크 로컬 주소가 변경되었습니다.

OT_CHANGED_THREAD_ML_ADDR

메시 로컬 주소가 변경되었습니다.

OT_CHANGED_THREAD_NETDATA

스레드 네트워크 데이터가 변경되었습니다.

OT_CHANGED_THREAD_NETIF_STATE

스레드 네트워크 인터페이스 상태가 변경되었습니다.

OT_CHANGED_THREAD_NETWORK_NAME

스레드 네트워크 이름이 변경되었습니다.

OT_CHANGED_THREAD_PANID

스레드 네트워크 PAN ID가 변경되었습니다.

OT_CHANGED_THREAD_PARTITION_ID

파티션 ID가 변경되었습니다.

OT_CHANGED_THREAD_RLOC_ADDED

RLOC가 추가되었습니다.

OT_CHANGED_THREAD_RLOC_REMOVED

RLOC가 제거되었습니다.

OT_CHANGED_THREAD_ROLE

역할(비활성화됨, 분리됨, 자식, 라우터, 리더)이 변경되었습니다.

형식 정의

otChangedFlags

uint32_t otChangedFlags

이 유형은 변경된 특정 상태/구성을 나타내는 비트 필드를 나타냅니다.

참조 OT_CHANGED_* 정의를.

ot인스턴스

struct otInstance otInstance

이 구조는 OpenThread 인스턴스 구조를 나타냅니다.

otStateChanged콜백

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

이 함수 포인터는 OpenThread 내의 특정 구성 또는 상태 변경을 알리기 위해 호출됩니다.

세부
매개변수
[in] aFlags
변경된 특정 상태를 나타내는 비트 필드입니다. 참조 OT_CHANGED_* 정의를.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.

기능

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

이 함수는 OpenThread 라디오 버전 문자열을 가져옵니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
OpenThread 라디오 버전에 대한 포인터입니다.

otGetVersionString

const char * otGetVersionString(
  void
)

이 함수는 OpenThread 버전 문자열을 가져옵니다.

세부
보고
OpenThread 버전에 대한 포인터입니다.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

이 기능은 비휘발성 메모리에 저장된 모든 OpenThread 영구 정보(네트워크 설정)를 지웁니다.

삭제는 장치가있는 경우에만 성공적으로 disabled 상태 / 역할.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
모든 영구 정보/상태가 성공적으로 지워졌습니다.
OT_ERROR_INVALID_STATE
장치가 아닌 disabled 상태 / 역할.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

이 방법은 비휘발성 메모리에 저장된 모든 설정을 삭제한 다음 플랫폼 재설정을 트리거합니다.

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

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

이 함수는 OpenThread 라이브러리를 비활성화합니다.

OpenThread가 더 이상 사용되지 않을 때 이 함수를 호출하십시오.

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

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

이 함수는 현재 인스턴스 가동 시간(msec)을 반환합니다.

이 기능은 필요 OPENTHREAD_CONFIG_UPTIME_ENABLE 가 활성화되어 있어야합니다.

가동 시간은 OpenThread 인스턴스가 초기화된 이후 경과된 시간(밀리초)으로 제공됩니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
가동 시간(밀리초)입니다.

otInstanceGetUptimeAsString

void otInstanceGetUptimeAsString(
  otInstance *aInstance,
  char *aBuffer,
  uint16_t aSize
)

이 함수는 현재 인스턴스 가동 시간을 사람이 읽을 수 있는 문자열로 반환합니다.

이 기능은 필요 OPENTHREAD_CONFIG_UPTIME_ENABLE 가 활성화되어 있어야합니다.

문자열은 " 형식을 따릅니다. : : . " 시, 분, 초 및 밀리초(가동 시간이 하루 미만인 경우) 또는 "

NS. : : . "(하루 이상인 경우).

결과 문자열에 맞지 않는 경우 aBuffer (자사 내에서 aSize 문자) 문자열이 잘립니다하지만 출력 된 문자열은 항상 널 종료입니다됩니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[out] aBuffer
문자열을 출력할 char 배열에 대한 포인터입니다.
[in] aSize
의 크기 aBuffer (바이트). 사용하는 것이 좋습니다 OT_UPTIME_STRING_SIZE .

otInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

이 함수는 OpenThread 라이브러리를 초기화합니다.

이 함수는 OpenThread를 초기화하고 후속 OpenThread API 호출을 위해 준비합니다. 이 함수는 OpenThread에 대한 다른 호출보다 먼저 호출되어야 합니다.

이 기능은 여러 OpenThread 인스턴스에 대한 지원이 활성화된 경우에만 사용할 수 있습니다.

세부
매개변수
[in] aInstanceBuffer
otInstance 구조를 할당하는 데 사용할 OpenThread용 버퍼입니다.
[in,out] aInstanceBufferSize
입력 시 InstanceBuffer의 크기입니다. 출력 시 otInstance에 대한 공간이 충분하지 않은 경우 otInstance에 필요한 바이트 수입니다.
보고
새 OpenThread 인스턴스에 대한 포인터입니다.
또한보십시오:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

이 함수는 OpenThread 라이브러리의 정적 단일 인스턴스를 초기화합니다.

이 함수는 OpenThread를 초기화하고 후속 OpenThread API 호출을 위해 준비합니다. 이 함수는 OpenThread에 대한 다른 호출보다 먼저 호출되어야 합니다.

이 기능은 여러 OpenThread 인스턴스에 대한 지원이 비활성화된 경우에만 사용할 수 있습니다.

세부
보고
단일 OpenThread 인스턴스에 대한 포인터입니다.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

이 함수는 인스턴스가 유효/초기화되었는지 여부를 나타냅니다.

이 취득하거나하여 초기화되는 경우 예는 유효한 것으로 간주된다 otInstanceInitSingle() (단일 인스턴스의 경우) 또는 otInstanceInit() (다중 인스턴스를 경우). 에 대한 후속 호출 otInstanceFinalize() 초기화되지 않은 것으로 간주하는 경우가 발생합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
보고
주어진 인스턴스가 유효/초기화되면 TRUE, 그렇지 않으면 FALSE입니다.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

이 메서드는 플랫폼 재설정을 트리거합니다.

재설정 프로세스는 모든 OpenThread 상태/정보(휘발성 메모리에 저장됨)가 지워지도록 합니다. 있습니다 otPlatformReset 비 휘발성 메모리에 저장 한 영구 상태 / 정보를 삭제하지 않습니다.

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

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

이 메서드는 OpenThread 라디오 스택의 내부 상태를 재설정합니다.

콜백 및 구성이 유지됩니다.

라디오 (빌드에서이 API 만 사용할 수 있습니다 OPENTHREAD_RADIO = 1 )를.

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

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

이 함수는 OpenThread 내에서 특정 구성이나 상태가 변경될 때를 나타내는 콜백을 제거합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aCallback
특정 구성 또는 상태 변경으로 호출되는 함수에 대한 포인터입니다.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.

otSetStateChanged콜백

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

이 함수는 OpenThread 내에서 특정 구성 또는 상태가 변경될 때를 나타내는 콜백을 등록합니다.

세부
매개변수
[in] aInstance
OpenThread 인스턴스에 대한 포인터입니다.
[in] aCallback
특정 구성 또는 상태 변경으로 호출되는 함수에 대한 포인터입니다.
[in] aContext
애플리케이션별 컨텍스트에 대한 포인터입니다.
반환 값
OT_ERROR_NONE
콜백 목록에 콜백을 추가했습니다.
OT_ERROR_ALREADY
콜백이 이미 등록되었습니다.
OT_ERROR_NO_BUFS
리소스 제약으로 인해 콜백을 추가할 수 없습니다.

매크로

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

가동 시간의 문자열 표현에 권장되는 크기입니다.