Instancja
Ten moduł zawiera funkcje sterujące instancją OpenThread.
Podsumowanie
Definicje |
|
---|---|
otChangedFlags
|
typedef,uint32_t
Ten typ reprezentuje pole bitu wskazujące konkretny stan/konfigurację, które uległo zmianie. |
otInstance
|
typedef,struct otInstance
Ta struktura reprezentuje strukturę instancji OpenThread. |
otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
|
typedef,void(*
Ten wskaźnik funkcji jest wywoływany, aby powiadamiać o pewnych zmianach konfiguracji lub stanu w OpenThread. |
Funkcje |
|
---|---|
otGetRadioVersionString(otInstance *aInstance)
|
const char *
Ta funkcja pobiera ciąg tekstowy wersji OpenThread.
|
otGetVersionString(void)
|
const char *
Ta funkcja pobiera ciąg znaków wersji OpenThread.
|
otInstanceErasePersistentInfo(otInstance *aInstance)
|
Ta funkcja usuwa wszystkie trwałe informacje z OpenThread (ustawienia sieci) zapisane w pamięci nieulotnej.
|
otInstanceFactoryReset(otInstance *aInstance)
|
void
Usuwa wszystkie ustawienia z pamięci nieulotnej, a potem resetuje platformę.
|
otInstanceFinalize(otInstance *aInstance)
|
void
Ta funkcja wyłącza bibliotekę OpenThread.
|
otInstanceGetUptime(otInstance *aInstance)
|
uint64_t
Ta funkcja zwraca bieżącą dostępność instancji (w ms).
|
otInstanceGetUptimeAsString(otInstance *aInstance, char *aBuffer, uint16_t aSize)
|
void
Ta funkcja zwraca bieżący czas działania instancji jako ciąg znaków w postaci zrozumiałej dla człowieka.
|
otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize)
|
Ta funkcja inicjuje bibliotekę OpenThread.
|
otInstanceInitSingle(void)
|
Ta funkcja inicjuje statyczną pojedynczą instancję biblioteki OpenThread.
|
otInstanceIsInitialized(otInstance *aInstance)
|
bool
Ta funkcja wskazuje, czy instancja jest prawidłowa czy inicjowana.
|
otInstanceReset(otInstance *aInstance)
|
void
Ta metoda powoduje zresetowanie platformy.
|
otInstanceResetRadioStack(otInstance *aInstance)
|
void
Ta metoda resetuje wewnętrzne stany stosu radia OpenThread.
|
otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
|
void
Ta funkcja usuwa wywołanie zwrotne, które informuje o zmianie konfiguracji lub stanu konfiguracji OpenThread.
|
otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
|
Ta funkcja rejestruje wywołanie zwrotne, które wskazuje, kiedy w OpenThread wprowadzono zmiany w konfiguracji lub stanie.
|
Wyliczenia
anonimowy enum
anonymous enum
Te wyliczenie definiuje flagi przekazywane w ramach funkcji otStateChangedCallback
.
Usługi | |
---|---|
OT_CHANGED_ACTIVE_DATASET
|
Aktywny zbiór danych operacyjnych został zmieniony. |
OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL
|
Nowy oczekujący kanał wątku ma zmianę. |
OT_CHANGED_COMMISSIONER_STATE
|
Zmieniono stan komisarza. |
OT_CHANGED_IP6_ADDRESS_ADDED
|
Adres IPv6 został dodany. |
OT_CHANGED_IP6_ADDRESS_REMOVED
|
Adres IPv6 został usunięty. |
OT_CHANGED_IP6_MULTICAST_SUBSCRIBED
|
Zasubskrybowano adres multicast IPv6. |
OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED
|
Anulowano subskrypcję adresu multicast IPv6. |
OT_CHANGED_JOINER_STATE
|
Zmieniono stan złączenia. |
OT_CHANGED_NAT64_TRANSLATOR_STATE
|
Zmienił się stan tłumacza NAT64. |
OT_CHANGED_NETWORK_KEY
|
Klucz sieci został zmieniony. |
OT_CHANGED_PENDING_DATASET
|
Zmieniony oczekujący zbiór danych operacyjnych. |
OT_CHANGED_PSKC
|
Zmieniono PSKc. |
OT_CHANGED_SECURITY_POLICY
|
Zasada zabezpieczeń została zmieniona. |
OT_CHANGED_SUPPORTED_CHANNEL_MASK
|
Zmieniono obsługiwaną maskę kanału. |
OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL
|
Zmieniono konfigurację routera szkieletowego. |
OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE
|
Zmieniono stan routera szkieletowego. |
OT_CHANGED_THREAD_CHANNEL
|
Zmieniono kanał sieciowy wątku. |
OT_CHANGED_THREAD_CHILD_ADDED
|
Dziecko zostało dodane. |
OT_CHANGED_THREAD_CHILD_REMOVED
|
Dziecko zostało usunięte. |
OT_CHANGED_THREAD_EXT_PANID
|
Zmieniono identyfikator rozszerzonego numeru PAN sieci wątków. |
OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER
|
Zmieniono sekwencję kluczy wątków. |
OT_CHANGED_THREAD_LL_ADDR
|
Adres lokalny linku został zmieniony. |
OT_CHANGED_THREAD_ML_ADDR
|
Lokalny adres sieci typu mesh został zmieniony. |
OT_CHANGED_THREAD_NETDATA
|
Zmieniono dane sieci wątku. |
OT_CHANGED_THREAD_NETIF_STATE
|
Zmieniono stan interfejsu sieciowego wątku. |
OT_CHANGED_THREAD_NETWORK_NAME
|
Zmieniono nazwę sieci wątku. |
OT_CHANGED_THREAD_PANID
|
Identyfikator PAN sieci sieciowej został zmieniony. |
OT_CHANGED_THREAD_PARTITION_ID
|
Zmieniono identyfikator partycji. |
OT_CHANGED_THREAD_RLOC_ADDED
|
Dodano RLOC. |
OT_CHANGED_THREAD_RLOC_REMOVED
|
Usunięto RLOC. |
OT_CHANGED_THREAD_ROLE
|
Zmieniono rolę (wyłączoną, odłączoną, podrzędną, router, lidera). |
Definicje
Flagi OtChanged
uint32_t otChangedFlags
Ten typ reprezentuje pole bitu wskazujące konkretny stan/konfigurację, które uległo zmianie.
Zobacz definicje OT_CHANGED_*
.
otStateChangedCallback
void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
Ten wskaźnik funkcji jest wywoływany, aby powiadamiać o pewnych zmianach konfiguracji lub stanu w OpenThread.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
Funkcje
WersjaOotGetRadioVersion
const char * otGetRadioVersionString( otInstance *aInstance )
Ta funkcja pobiera ciąg tekstowy wersji OpenThread.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wskaźnik do wersji radiowej OpenThread.
|
WersjaOtGetVersion
const char * otGetVersionString( void )
Ta funkcja pobiera ciąg znaków wersji OpenThread.
Szczegóły | |
---|---|
Zwroty |
Wskaźnik do wersji OpenThread.
|
otInstanceDELETEPersistentInfo
otError otInstanceErasePersistentInfo( otInstance *aInstance )
Ta funkcja usuwa wszystkie trwałe informacje z OpenThread (ustawienia sieci) zapisane w pamięci nieulotnej.
Wykasowanie danych działa tylko wtedy, gdy urządzenie jest w stanie/roli disabled
.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
ototFactoryReset
void otInstanceFactoryReset( otInstance *aInstance )
Usuwa wszystkie ustawienia z pamięci nieulotnej, a potem resetuje platformę.
Szczegóły | |||
---|---|---|---|
Parametry |
|
Zakończ instancję
void otInstanceFinalize( otInstance *aInstance )
Ta funkcja wyłącza bibliotekę OpenThread.
Wywołaj tę funkcję, gdy OpenThread nie jest już używany.
Szczegóły | |||
---|---|---|---|
Parametry |
|
Funkcja OTInstanceGetUptime
uint64_t otInstanceGetUptime( otInstance *aInstance )
Ta funkcja zwraca bieżącą dostępność instancji (w ms).
Ta funkcja wymaga włączenia funkcji OPENTHREAD_CONFIG_UPTIME_ENABLE
.
Czas działania jest podany jako liczba milisekund od zainicjowania instancji OpenThread.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Czas działania (liczba milisekund).
|
Adres_wyciągu_uruchomienia instancji
void otInstanceGetUptimeAsString( otInstance *aInstance, char *aBuffer, uint16_t aSize )
Ta funkcja zwraca bieżący czas działania instancji jako ciąg znaków w postaci zrozumiałej dla człowieka.
Ta funkcja wymaga włączenia funkcji OPENTHREAD_CONFIG_UPTIME_ENABLE
.
Ciąg ma format „
Jeśli powstały ciąg znaków nie zmieści się w aBuffer
(znaku aSize
), zostanie on skrócony, ale dane wyjściowe będą zawsze zerowane na podstawie wartości null.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
otInitInit
otInstance * otInstanceInit( void *aInstanceBuffer, size_t *aInstanceBufferSize )
Ta funkcja inicjuje bibliotekę OpenThread.
Ta funkcja inicjuje OpenThread i przygotowuje ją do kolejnych wywołań interfejsu OpenThread API. Tę funkcję należy wywołać przed innymi wywołaniami OpenThread.
Ta funkcja jest dostępna i można jej używać tylko wtedy, gdy jest włączona obsługa wielu instancji OpenThread.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwroty |
Wskaźnik do nowej instancji OpenThread.
|
otInstanceFinalize
otInstanceInitsingle
otInstance * otInstanceInitSingle( void )
Ta funkcja inicjuje statyczną pojedynczą instancję biblioteki OpenThread.
Ta funkcja inicjuje OpenThread i przygotowuje ją do kolejnych wywołań interfejsu OpenThread API. Tę funkcję należy wywołać przed innymi wywołaniami OpenThread.
Ta funkcja jest dostępna i można jej używać tylko wtedy, gdy obsługa wielu instancji OpenThread jest wyłączona.
Szczegóły | |
---|---|
Zwroty |
Wskaźnik do pojedynczej instancji OpenThread.
|
OTOT – inicjalizacja
bool otInstanceIsInitialized( otInstance *aInstance )
Ta funkcja wskazuje, czy instancja jest prawidłowa czy inicjowana.
Instancja jest uznawana za prawidłową, jeśli zostanie pozyskana i zainicjowana przy użyciu otInstanceInitSingle()
(w pojedynczej instancji) lub otInstanceInit()
(w wielu przypadkach). Kolejne wywołanie otInstanceFinalize()
powoduje, że instancja jest uznawana za niezainicjowaną.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
TRUE, jeśli dana instancja jest prawidłowa lub zainicjowana. W przeciwnym razie ma wartość FALSE.
|
resetowanie instancji
void otInstanceReset( otInstance *aInstance )
Ta metoda powoduje zresetowanie platformy.
Reset powoduje wykasowanie wszystkich informacji o stanie/danych OpenThread (przechowywanych w pamięci zmiennej). otPlatformReset
nie usuwa trwałych stanów ani informacji zapisanych w pamięci nieulotnej.
Szczegóły | |||
---|---|---|---|
Parametry |
|
Pakiet OTInstanceResetRadioStack
void otInstanceResetRadioStack( otInstance *aInstance )
Ta metoda resetuje wewnętrzne stany stosu radia OpenThread.
Wywołania zwrotne i konfiguracje są zachowywane.
Ten interfejs API jest dostępny tylko w kompilacjach radiowych (OPENTHREAD_RADIO = 1
).
Szczegóły | |||
---|---|---|---|
Parametry |
|
otRemoveStateChangeCallback
void otRemoveStateChangeCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Ta funkcja usuwa wywołanie zwrotne, które informuje o zmianie konfiguracji lub stanu konfiguracji OpenThread.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
otSetStateChangedCallback
otError otSetStateChangedCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
Ta funkcja rejestruje wywołanie zwrotne, które wskazuje, kiedy w OpenThread wprowadzono zmiany w konfiguracji lub stanie.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
Makra
OT_UPTIME_STRING_SIZE
OT_UPTIME_STRING_SIZE 24
Zalecany rozmiar reprezentujący czas działania ciągu znaków.
Zasoby
Tematy referencyjne interfejsu API OpenThread pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dodać do naszej dokumentacji, zapoznaj się z materiałami.