Instancja

Ten moduł zawiera funkcje, które kontrolują 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
}
enum | typ wyliczeniowy
Te wyliczenie definiuje flagi przekazywane jako część otStateChangedCallback.

Typy

otChangedFlags typedef
uint32_t
Ten typ reprezentuje pole bita, które wskazuje zmieniony stan/konfigurację.
otInstance typedef
struct otInstance
Ta struktura reprezentuje strukturę instancji OpenThread.
otStateChangedCallback)(otChangedFlags aFlags, void *aContext) typedef
void(*
Ten wskaźnik funkcji jest wywoływany w celu powiadamiania o pewnych zmianach konfiguracji lub stanu w OpenThread.

Funkcje

otGetRadioVersionString(otInstance *aInstance)
const char *
Ta funkcja pobiera ciąg wersji wersji OpenThread.
otGetVersionString(void)
const char *
Ta funkcja pobiera ciąg wersji OpenThread.
otInstanceErasePersistentInfo(otInstance *aInstance)
Ta funkcja usuwa wszystkie trwałe informacje z OpenThread (ustawienia sieci) przechowywane w pamięci ulotnej.
otInstanceFactoryReset(otInstance *aInstance)
void
Ta metoda usuwa wszystkie ustawienia przechowywane w pamięci ulotnej, a następnie uruchamia resetowanie platformy.
otInstanceFinalize(otInstance *aInstance)
void
Ta funkcja wyłącza bibliotekę OpenThread.
otInstanceGetUptime(otInstance *aInstance)
uint64_t
Ta funkcja zwraca aktualną 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 zrozumiały 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 radiowego OpenThread.
otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
Ta funkcja usuwa wywołanie zwrotne, które wskazuje, kiedy w OpenThread wprowadzono zmiany w konfiguracji lub stanie.
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

anonimowa enum

 anonymous enum

Te wyliczenie definiuje flagi przekazywane jako część otStateChangedCallback.

Właściwości
OT_CHANGED_ACTIVE_DATASET

Zmieniono aktywny zbiór danych operacyjnych.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

Zmieniono nowy oczekujący kanał Menedżera kanałów.

OT_CHANGED_COMMISSIONER_STATE

Zmieniono stan komisarza.

OT_CHANGED_IP6_ADDRESS_ADDED

Dodano adres IPv6.

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 IPv6 multicast.

OT_CHANGED_JOINER_STATE

Zmieniono stan złącza.

OT_CHANGED_NETWORK_KEY

Klucz sieci został zmieniony.

OT_CHANGED_PENDING_DATASET

Zmieniono 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

Obsługiwana maska kanału została zmieniona.

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

Zmieniono konfigurację lokalnego 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 rozszerzony identyfikator PAN sieci z wątkami.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

Zmieniono sekwencję klucza wątku.

OT_CHANGED_THREAD_LL_ADDR

Zmieniono lokalny adres linku.

OT_CHANGED_THREAD_ML_ADDR

Zmienił się lokalny adres typu mesh.

OT_CHANGED_THREAD_NETDATA

Dane sieci dotyczące wątków zostały zmienione.

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

Zmieniono identyfikator PAN sieci wątków.

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

Zmieniła się rola (wyłączona, odłączona, podrzędne, router, lider).

Typy

Flagi zmian

uint32_t otChangedFlags

Ten typ reprezentuje pole bita, które wskazuje zmieniony stan/konfigurację.

Zobacz definicje: OT_CHANGED_*.

Instancja ot

struct otInstance otInstance

Ta struktura reprezentuje strukturę instancji OpenThread.

Wywołanie wywołania zwrotnego

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

Ten wskaźnik funkcji jest wywoływany w celu powiadamiania o pewnych zmianach konfiguracji lub stanu w OpenThread.

Szczegóły
Parametry
[in] aFlags
Pole bitowe wskazujące określony stan, który uległ zmianie. Zobacz definicje: OT_CHANGED_*.
[in] aContext
Wskaźnik kontekstu aplikacji.

Funkcje

Ciąg pobierania wersji radiowej

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Ta funkcja pobiera ciąg wersji wersji OpenThread.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik wersji radia OpenThread.

OkGetGetVersionString

const char * otGetVersionString(
  void
)

Ta funkcja pobiera ciąg wersji OpenThread.

Szczegóły
Zwroty
Wskaźnik wersji OpenThread.

otInstanceDELETEPersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Ta funkcja usuwa wszystkie trwałe informacje z OpenThread (ustawienia sieci) przechowywane w pamięci ulotnej.

Wykasowanie danych działa tylko wtedy, gdy urządzenie znajduje się w stanie disabled lub roli.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwracane wartości
OT_ERROR_NONE
Usunięto wszystkie trwałe informacje/stan.
OT_ERROR_INVALID_STATE
Stan urządzenia/roli użytkownika disabled jest inny.

Parametr otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Ta metoda usuwa wszystkie ustawienia przechowywane w pamięci ulotnej, a następnie uruchamia resetowanie platformy.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.

Kończenie instancji otInstance

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.

Czas otwarcia instancji otInstance

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

Ta funkcja zwraca aktualną 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).

Parametr dalszego pobierania

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

Ta funkcja zwraca bieżący czas działania instancji jako ciąg zrozumiały dla człowieka.

Ta funkcja wymaga włączenia funkcji OPENTHREAD_CONFIG_UPTIME_ENABLE.

Ciąg jest zgodny z formatem &"::." 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ż jeden dzień).

Jeśli wynikowy ciąg nie zmieści się w polu aBuffer (w znakach aSize), zostanie on obcięty, ale przesyłany ciąg znaków będzie zawsze zakończony pustym ciągiem.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aBuffer
Wskaźnik tablicy tablicowej, który wskazuje ciąg.
[in] aSize
Rozmiar obiektu aBuffer (w bajtach). Zalecamy korzystanie z OT_UPTIME_STRING_SIZE.

IntInstance Init

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. Ta funkcja musi zostać wywołana 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 w OpenThread, który służy do przydzielenia struktury otInstance.
[in,out] aInstanceBufferSize
Rozmiar danych wejściowych: rozmiar bufora instancji. Przy wartości wyjściowej, jeśli jest za mało miejsca na instancję otInstance, liczba bajtów wymagana na potrzeby instancji otInstance.
Zwroty
Wskaźnik nowej instancji OpenThread.
Zobacz też:
otInstanceFinalize

Pojedyncza instancjaOtO

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. Ta funkcja musi zostać wywołana 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.

Instancja ot Inicjowana

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Ta funkcja wskazuje, czy instancja jest prawidłowa czy inicjowana.

Instancja jest uznawana za prawidłową, jeśli została pozyskana i zainicjowana przy użyciu metody otInstanceInitSingle() (w pojedynczej instancji) lub otInstanceInit() (w wielu przypadkach). Kolejne wywołanie otInstanceFinalize() spowoduje, że instancja zostanie uznana za niezainicjowaną.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
TRUE, jeśli dana instancja jest prawidłowa/zainicjowana. W przeciwnym razie ma wartość FALSE.

Zresetuj instancję

void otInstanceReset(
  otInstance *aInstance
)

Ta metoda powoduje zresetowanie platformy.

Proces resetowania gwarantuje, że wszystkie dane o stanie/wątku OpenThread (przechowywane w pamięci ulotnej) zostaną usunięte. otPlatformReset nie usuwa żadnych trwałych stanów ani informacji zapisanych w pamięci ulotnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.

Zresetowanie stosu radia

void otInstanceResetRadioStack(
  otInstance *aInstance
)

Ta metoda resetuje wewnętrzne stany stosu radiowego 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 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 wywoływanej z określoną zmianą konfiguracji lub stanu.
[in] aContext
Wskaźnik 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 wywoływanej z określoną zmianą konfiguracji lub stanu.
[in] aContext
Wskaźnik 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.

Zasoby

Tematy referencyjne interfejsu API OpenThread pochodzą z kodu źródłowego i są dostępne w GitHub. Więcej informacji oraz dodatkowe informacje znajdziesz w materiałach.