Ta strona została przetłumaczona przez Cloud Translation API.

Instancja

Ten moduł zawiera funkcje sterujące instancją OpenThread.

Podsumowanie

Wyliczenia
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, OT_CHANGED_NAT64_TRANSLATOR_STATE = 1 << 30 }	enum \| typ wyliczeniowy Te wyliczenie definiuje flagi przekazywane w ramach funkcji `otStateChangedCallback`.

Wyliczenia

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,
  OT_CHANGED_NAT64_TRANSLATOR_STATE = 1 << 30
}

enum | typ wyliczeniowy

Te wyliczenie definiuje flagi przekazywane w ramach funkcji otStateChangedCallback.

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)`	`otError` 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)`	`otInstance *` Ta funkcja inicjuje bibliotekę OpenThread.
`otInstanceInitSingle(void)`	`otInstance *` 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)`	`otError` 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_*.

instancja ot

struct otInstance otInstance

Ta struktura reprezentuje strukturę instancji OpenThread.

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

`[in] aFlags`	Pole bitowe wskazujące konkretny stan, który się zmienił. Zobacz definicje `OT_CHANGED_*`.
`[in] aContext`	Wskazanie kontekstu aplikacji.

Funkcje

WersjaOotGetRadioVersion

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Ta funkcja pobiera ciąg tekstowy wersji OpenThread.

Szczegóły

Parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

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

[in] aInstance

Wskaźnik do instancji OpenThread.

Zwracane wartości

`OT_ERROR_NONE`	Wszystkie trwałe informacje/stan zostały usunięte.
`OT_ERROR_INVALID_STATE`	Urządzenie nie jest w stanie/roli `disabled`.

ototFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Usuwa wszystkie ustawienia z pamięci nieulotnej, a potem resetuje platformę.

Szczegóły

Parametry

[in] aInstance

Wskaźnik do instancji OpenThread.

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

[in] aInstance

Wskaźnik do instancji OpenThread.

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

[in] aInstance

Wskaźnik do instancji OpenThread.

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 „::.” (godziny, minuty, sekundy i milisekundy (jeśli czas działania jest krótszy niż 1 dzień) lub „”.

d.::." (jeśli trwa dłużej niż 1 dzień).

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

`[in] aInstance`	Wskaźnik do instancji OpenThread.
`[out] aBuffer`	Wskaźnik do tablicy znaków, aby wyświetlić ciąg znaków.
`[in] aSize`	Rozmiar `aBuffer` (w bajtach). Zalecamy korzystanie z `OT_UPTIME_STRING_SIZE`.

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

`[in] aInstanceBuffer`	Bufor używany przez OpenThread do przydzielania struktury otInstance.
`[in,out] aInstanceBufferSize`	Rozmiar danych wejściowych, czyli rozmiar bufora instancji. Wartość wyjściowa: jeśli jest za mało miejsca na otInstance, liczba bajtów wymaganych przez otInstance.

Zwroty

Wskaźnik do nowej instancji OpenThread.

Zobacz też:
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

[in] aInstance

Wskaźnik do instancji OpenThread.

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

[in] aInstance

Wskaźnik do instancji OpenThread.

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

[in] aInstance

Wskaźnik do instancji OpenThread.

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

`[in] aInstance`	Wskaźnik do instancji OpenThread.
`[in] aCallback`	Wskaźnik do funkcji, która jest wywoływana z określonymi zmianami konfiguracji lub stanu.
`[in] aContext`	Wskazanie kontekstu aplikacji.

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

`[in] aInstance`	Wskaźnik do instancji OpenThread.
`[in] aCallback`	Wskaźnik do funkcji, która jest wywoływana z określonymi zmianami konfiguracji lub stanu.
`[in] aContext`	Wskazanie kontekstu aplikacji.

Zwracane wartości

`OT_ERROR_NONE`	Wywołanie zwrotne zostało dodane do listy wywołań zwrotnych.
`OT_ERROR_ALREADY`	Wywołanie zwrotne zostało już zarejestrowane.
`OT_ERROR_NO_BUFS`	Nie udało się dodać wywołania zwrotnego z powodu ograniczeń zasobów.

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.