인스턴스
이 모듈에는 OpenThread 인스턴스를 제어하는 함수가 포함되어 있습니다.
요약
Typedef |
|
---|---|
otChangedFlags
|
typedefuint32_t
변경된 특정 상태/구성을 나타내는 비트 필드를 나타냅니다. |
otInstance
|
typedefstruct otInstance
OpenThread 인스턴스 구조를 나타냅니다. |
otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
|
typedefvoid(*
포인터가 호출되어 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 라이브러리를 사용 중지합니다.
|
otInstanceGetId(otInstance *aInstance)
|
uint32_t
인스턴스 식별자를 가져옵니다.
|
otInstanceGetUptime(otInstance *aInstance)
|
uint64_t
현재 인스턴스 업타임 (밀리초)을 반환합니다.
|
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 내에서 특정 구성 또는 상태가 변경될 때 이를 나타내는 콜백을 등록합니다.
|
열거형
익명 enum
anonymous enum
otStateChangedCallback
의 일부로 전달되는 플래그를 정의합니다.
Typedef
otChangedFlags
uint32_t otChangedFlags
변경된 특정 상태/구성을 나타내는 비트 필드를 나타냅니다.
OT_CHANGED_*
정의를 참고하세요.
otStateChangedCallback
void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
포인터가 호출되어 OpenThread 내에서 특정 구성 또는 상태 변경을 알립니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
함수
otGetRadioVersionString
const char * otGetRadioVersionString( otInstance *aInstance )
OpenThread 라디오 버전 문자열을 가져옵니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
||
반환 |
OpenThread 라디오 버전에 대한 포인터입니다.
|
otGetVersionString
const char * otGetVersionString( void )
OpenThread 버전 문자열을 가져옵니다.
세부정보 | |
---|---|
반환 |
OpenThread 버전 포인터
|
otInstanceClearPersistentInfo
otError otInstanceErasePersistentInfo( otInstance *aInstance )
비휘발성 메모리에 저장된 모든 OpenThread 영구 정보 (네트워크 설정)를 삭제합니다.
기기가 disabled
상태/역할인 경우에만 삭제가 완료됩니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
||||
반환 값 |
|
OInstanceFactoryReset
void otInstanceFactoryReset( otInstance *aInstance )
비휘발성 메모리에 저장된 모든 설정을 삭제한 다음 플랫폼 재설정을 트리거합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
otInstanceFinalize
void otInstanceFinalize( otInstance *aInstance )
OpenThread 라이브러리를 사용 중지합니다.
OpenThread가 더 이상 사용되지 않을 때 이 함수를 호출합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
otInstanceGetId
uint32_t otInstanceGetId( otInstance *aInstance )
인스턴스 식별자를 가져옵니다.
인스턴스가 생성될 때 인스턴스 식별자가 임의 값으로 설정되며 초기화 후에는 값이 변경되지 않습니다.
세부정보 | |
---|---|
반환 |
인스턴스 식별자입니다.
|
otInstanceGetUptime
uint64_t otInstanceGetUptime( otInstance *aInstance )
현재 인스턴스 업타임 (밀리초)을 반환합니다.
OPENTHREAD_CONFIG_UPTIME_ENABLE
를 사용 설정해야 합니다.
OpenThread 인스턴스가 초기화된 이후의 밀리초가 밀리초 단위로 지정됩니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
||
반환 |
업타임 (밀리초 단위)
|
otInstanceGetUptimeAsString
void otInstanceGetUptimeAsString( otInstance *aInstance, char *aBuffer, uint16_t aSize )
현재 인스턴스 업타임을 사람이 읽을 수 있는 문자열로 반환합니다.
OPENTHREAD_CONFIG_UPTIME_ENABLE
를 사용 설정해야 합니다.
문자열은 시, 분, 초, 밀리초 (가동시간이 1일 미만인 경우) 또는 '의 경우 '
결과 문자열이 aBuffer
에 맞지 않는 경우 (aSize
문자 내에서) 문자열이 잘리지만 출력된 문자열은 항상 null로 끝납니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
otInstanceInit
otInstance * otInstanceInit( void *aInstanceBuffer, size_t *aInstanceBufferSize )
OpenThread 라이브러리를 초기화합니다.
OpenThread를 초기화하고 후속 OpenThread API 호출에 대해 준비합니다. 이 함수는 OpenThread에 대한 다른 호출 전에 호출되어야 합니다.
여러 OpenThread 인스턴스에 대한 지원이 사용 설정된 경우에만 사용할 수 있습니다.
세부정보 | |||||
---|---|---|---|---|---|
매개변수 |
|
||||
반환 |
새 OpenThread 인스턴스에 대한 포인터입니다.
|
otInstanceFinalize
otInstanceInitSingle
otInstance * otInstanceInitSingle( void )
OpenThread 라이브러리의 정적 단일 인스턴스를 초기화합니다.
OpenThread를 초기화하고 후속 OpenThread API 호출에 대해 준비합니다. 이 함수는 OpenThread에 대한 다른 호출 전에 호출되어야 합니다.
여러 OpenThread 인스턴스에 대한 지원이 사용 중지된 경우에만 사용할 수 있습니다.
세부정보 | |
---|---|
반환 |
단일 OpenThread 인스턴스에 대한 포인터입니다.
|
otInstanceIsInitialized
bool otInstanceIsInitialized( otInstance *aInstance )
인스턴스가 유효하거나 초기화되었는지 여부를 나타냅니다.
인스턴스는 otInstanceInitSingle()
(단일 인스턴스인 경우) 또는 otInstanceInit()
(멀티 인스턴스인 경우)를 사용하여 획득되고 초기화된 경우 유효한 것으로 간주됩니다. 이후에 otInstanceFinalize()
를 호출하면 인스턴스가 초기화되지 않은 것으로 간주됩니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
||
반환 |
지정된 인스턴스가 유효하거나 초기화된 경우 TRUE, 그렇지 않은 경우 FALSE입니다.
|
OInstanceReset
void otInstanceReset( otInstance *aInstance )
플랫폼 재설정을 트리거합니다.
재설정 프로세스를 통해 휘발성 메모리에 저장된 모든 OpenThread 상태/정보가 삭제됩니다. otPlatformReset
는 비휘발성 메모리에 저장된 영구 상태/정보를 삭제하지 않습니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
otInstanceResetRadioStack
void otInstanceResetRadioStack( otInstance *aInstance )
OpenThread 라디오 스택의 내부 상태를 재설정합니다.
콜백 및 구성은 유지됩니다.
이 API는 라디오 빌드 (OPENTHREAD_RADIO = 1
)에서만 사용할 수 있습니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
otRemoveStateChangeCallback
void otRemoveStateChangeCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
OpenThread 내에서 특정 구성 또는 상태가 변경되는 시점을 나타내는 콜백을 삭제합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
otSetStateChangedCallback
otError otSetStateChangedCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
OpenThread 내에서 특정 구성 또는 상태가 변경될 때 이를 나타내는 콜백을 등록합니다.
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
||||||
반환 값 |
|
매크로
OT_UPTIME_STRING_SIZE세
OT_UPTIME_STRING_SIZE 24
업타임의 문자열 표현에 권장되는 크기입니다.
자료
OpenThread API 참조 주제는 GitHub에서 제공되는 소스 코드에서 비롯됩니다. 자세한 내용을 보거나 문서에 참여하려면 리소스를 참고하세요.