Router/lider

Ten moduł zawiera funkcje dla routerów i liderów.

Podsumowanie

Wyliczenia
otCacheEntryState enum | typ wyliczeniowy
To wyliczenie określa stan wpisu pamięci podręcznej EID.
otNeighborTableEvent{
  OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
} 		enum | typ wyliczeniowy
Te wyliczenie określa stałe używane w otNeighborTableCallback do wskazywania zmian w tabeli sąsiadów.

Typy
otCacheEntryInfo typedef
Ta struktura reprezentuje wpis pamięci podręcznej EID.
otCacheEntryIterator typedef
Ten typ reprezentuje iterację używaną do iteracji przez wpisy tabeli pamięci podręcznej EID.
otCacheEntryState typedef
To wyliczenie określa stan wpisu pamięci podręcznej EID.
otChildIp6AddressIterator typedef
uint16_t
Służy do iterowania przez adresy IPv6 wpisu podrzędnego wątku.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
Ten wskaźnik funkcji służy do powiadamiania o zmianach w tabeli sąsiadów.

Funkcje
otThreadBecomeLeader(otInstance *aInstance)
Zostań liderem i utwórz nową partycję.
otThreadBecomeRouter(otInstance *aInstance)
Spróbuj zostać routerem.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
Funkcja przechowuje informacje diagnostyczne dotyczące dołączonego podmiotu podrzędnego na podstawie jego identyfikatora podrzędnego lub listy RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
Ta funkcja przechowuje informacje diagnostyczne o dołączonym elemencie podrzędnym według wewnętrznego indeksu tabeli.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Ta funkcja pobiera następny adres IPv6 (przy użyciu iteratora) dla danego elementu podrzędnego.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
Pobierz parametr CONTEXT_ID_REUSE_DELAY używany w roli lidera.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
Pobierz port UDP SSH.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
Waga lidera wątku jest wykorzystywana podczas pracy w roli lidera.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
Uzyskaj maksymalną dozwoloną liczbę dzieci.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
Ta funkcja uzyskuje maksymalną liczbę adresów IP, które każde dziecko MDM może zarejestrować w tym urządzeniu jako rodzic.
otThreadGetMaxRouterId(otInstance *aInstance)
uint8_t
Ta funkcja zwraca maksymalny dozwolony identyfikator routera.
otThreadGetNetworkIdTimeout(otInstance *aInstance)
uint8_t
Pobierz parametr NETWORK_ID_TIMEOUT używany w roli routera.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Ta funkcja pobiera następny wpis pamięci podręcznej EID (przy użyciu iteratora).
otThreadGetParentPriority(otInstance *aInstance)
int8_t
Pobierz przypisany priorytet nadrzędny.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
Pobierz preferowany identyfikator partycji lidera wątku używany podczas pracy w roli lidera.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
Pobierz PSKc wątku.
otThreadGetPskcRef(otInstance *aInstance)
Pobierz odniesienie do klucza PSKc wątku.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
Pobierz parametr ROUTER_DOWNGRADE_THRESHOLD pełniący rolę roli routera.
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
Ta funkcja uzyskuje zakres identyfikatorów routerów, które mogą przypisywać do węzłów w sieci wątków.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
Pobierz bieżącą sekwencję identyfikatorów routera.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
Ta funkcja przechowuje informacje diagnostyczne o danym routerze z wątkiem.
otThreadGetRouterSelectionJitter(otInstance *aInstance)
uint8_t
Pobierz parametr ROUTER_SELECTION_JITTER używany w roli REED/Router.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
uint8_t
Pobierz parametr ROUTER_UPGRADE_THRESHOLD używany w roli REED.
otThreadIsRouterEligible(otInstance *aInstance)
bool
Ta metoda wskazuje, czy urządzenie kwalifikuje się do włączenia routera.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
Ta funkcja rejestruje funkcję wywołania zwrotnego tabeli sąsiada.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
Zwolnij identyfikator routera przydzielony przez urządzenie w roli lidera.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
Ta funkcja określa, czy urządzenie zostało zlecone za pomocą CCM.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
Ustaw parametr CONTEXT_ID_REUSE_DELAY używany w roli lidera.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
Ustaw port UDP usługi Connector.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
Ustaw wagę lidera wątku, który jest używany podczas pracy w roli lidera.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
Ustaw maksymalną dozwoloną liczbę dzieci.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
Ta funkcja ustawia/przywraca maksymalną liczbę adresów IP, które każde dziecko MTD może zarejestrować na tym urządzeniu jako rodzic.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
Ustaw parametr NETWORK_ID_TIMEOUT używany w roli lidera.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
Ustaw priorytet elementu nadrzędnego.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
Ustaw preferowany identyfikator partycji lidera, który jest używany podczas pracy w roli lidera.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
Ustaw preferowany identyfikator routera.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
Ustaw kod PSKc wątku.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
Ustaw kod PSKc wątku.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Ustaw parametr ROUTER_DOWNGRADE_THRESHOLD pełniący rolę lidera.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
Ta funkcja określa, czy urządzenie spełnia wymagania routera.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Ta funkcja ustawia zakres identyfikatorów routerów, które można przypisywać do węzłów w sieci wątków.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
Ustaw parametr ROUTER_SELECTION_JITTER w roli REED/Router.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Ustaw parametr ROUTER_UPGRADE_THRESHOLD używany w roli lidera.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Ustaw dane kierownicy poza zakresem.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
Ta funkcja określa, czy włączony jest próg aktualizacji dla wersji zabezpieczeń TLV w polu Zasad zabezpieczeń.

Struktury
otCacheEntryInfo

Ta struktura reprezentuje wpis pamięci podręcznej EID.

otCacheEntryIterator

Ten typ reprezentuje iterację używaną do iteracji przez wpisy tabeli pamięci podręcznej EID.

otChildInfo

Ta struktura zawiera informacje diagnostyczne dotyczące elementu podrzędnego wątku.

otNeighborTableEntryInfo

Ten typ reprezentuje informacje o tabeli sąsiedniej (podrzędne lub router) i jest używany jako parametr w wywołaniu zwrotnym tabeli sąsiedniej otNeighborTableCallback.

Wyliczenia

otCacheEntryState

 otCacheEntryState

To wyliczenie określa stan wpisu pamięci podręcznej EID.

Zdarzenie otNeighborTable

 otNeighborTableEvent

Te wyliczenie określa stałe używane w otNeighborTableCallback do wskazywania zmian w tabeli sąsiadów.

Właściwości
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

Dodaję dziecko.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

Istniejący tryb podrzędny zostanie zmieniony.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Dziecko jest usuwane.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Trwa dodawanie routera.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Usuwam router.

Typy

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Ta struktura reprezentuje wpis pamięci podręcznej EID.

otCacheEntryIterator,

struct otCacheEntryIterator otCacheEntryIterator

Ten typ reprezentuje iterację używaną do iteracji przez wpisy tabeli pamięci podręcznej EID.

Aby zainicjować iterację i zacząć od pierwszego wpisu w tabeli pamięci podręcznej, ustaw wszystkie jego pola w strukturze na zero (np. memset iteracji do zera).

otCacheEntryState

enum otCacheEntryState otCacheEntryState

To wyliczenie określa stan wpisu pamięci podręcznej EID.

Oszacowanie_wielkości_ adresów

uint16_t otChildIp6AddressIterator

Służy do iterowania przez adresy IPv6 wpisu podrzędnego wątku.

Wywołanie zwrotne tabeli otNeighborTable

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

Ten wskaźnik funkcji służy do powiadamiania o zmianach w tabeli sąsiadów.

Szczegóły
Parametry
[in] aEvent
Flaga zdarzenia.
[in] aEntryInfo
Wskaźnik prowadzący do wpisu w tabeli.

Funkcje

OTThreadZostań liderem

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Zostań liderem i utwórz nową partycję.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwracane wartości
OT_ERROR_NONE
Udało Ci się zostać liderem i utworzyć nową partycję.
OT_ERROR_INVALID_STATE
Wątek jest wyłączony.

TrasaPotokuNagłówka

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Spróbuj zostać routerem.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwracane wartości
OT_ERROR_NONE
Podjęto próbę zostania routerem.
OT_ERROR_INVALID_STATE
Wątek jest wyłączony.

OknoGetGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

Funkcja przechowuje informacje diagnostyczne dotyczące dołączonego podmiotu podrzędnego na podstawie jego identyfikatora podrzędnego lub listy RLOC16.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aChildId
Identyfikator podrzędny lub lista RLOC16 dołączonego elementu podrzędnego.
[out] aChildInfo
Wskaźnik określający, gdzie znajdują się informacje podrzędne.
Zwracane wartości
OT_ERROR_NONE
Informacje o miejscu aChildInfo zostały zaktualizowane na podstawie podanego identyfikatora.
OT_ERROR_NOT_FOUND
Brak prawidłowego podmiotu podrzędnego o tym identyfikatorze podrzędnym.
OT_ERROR_INVALID_ARGS
Jeśli aChildInfo ma wartość NULL.

OknoGetGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

Ta funkcja przechowuje informacje diagnostyczne o dołączonym elemencie podrzędnym według wewnętrznego indeksu tabeli.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aChildIndex
Indeks tabeli.
[out] aChildInfo
Wskaźnik określający, gdzie znajdują się informacje podrzędne.
Zwracane wartości
OT_ERROR_NONE
Informacje o indeksie aChildInfo zostały zaktualizowane.
OT_ERROR_NOT_FOUND
Brak prawidłowego elementu podrzędnego w tym indeksie.
OT_ERROR_INVALID_ARGS
aChildInfo ma wartość NULL albo aChildIndex jest poza zakresem (wyższym od maksymalnego indeksu tabeli).
Zobacz również:
otGetMaxAllowedChild

OTThreadGetChildNextIp6Address

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

Ta funkcja pobiera następny adres IPv6 (przy użyciu iteratora) dla danego elementu podrzędnego.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aChildIndex
Indeks podrzędny.
[in,out] aIterator
Wskaźnik do iteratora. W przypadku udanego iteratora zostanie zaktualizowany, aby wskazywał na następny wpis na liście. Aby uzyskać pierwszy adres IPv6, ustaw iterator na OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Wskaźnik adresu IPv6, w którym znajduje się następny adres podrzędny (sukces).
Zwracane wartości
OT_ERROR_NONE
Następny adres IPv6 (aAddress) został zaktualizowany.
OT_ERROR_NOT_FOUND
W elemencie podrzędnym nie ma podanego adresu IPv6.
OT_ERROR_INVALID_ARGS
aIterator lub aAddress mają wartość NULL, a element podrzędny w kolumnie aChildIndex jest nieprawidłowy.
Zobacz też:
otThreadGetChildInfoByIndex

Opóźnione ponowne użycie identyfikatora OTThreadGet

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Pobierz parametr CONTEXT_ID_REUSE_DELAY używany w roli lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość CONTEXT_ID_REUSE_DELAY.
Zobacz też:
otThreadSetContextIdReuseDelay

otThreadGetDołączerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Pobierz port UDP SSH.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Numer portu łącznika UDP.
Zobacz też:
otThreadSetDołączerUdpPort

OTThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Waga lidera wątku jest wykorzystywana podczas pracy w roli lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość wagi lidera wątku.
Zobacz też:
otThreadSetLeaderWeight

OTThreadGetMaxAllowedChild

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Uzyskaj maksymalną dozwoloną liczbę dzieci.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Obecnie maksymalna dozwolona liczba dzieci.
Zobacz też:
otThreadSetMaxAllowedChild

OTThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Ta funkcja uzyskuje maksymalną liczbę adresów IP, które każde dziecko MDM może zarejestrować w tym urządzeniu jako rodzic.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Maksymalna liczba adresów IP, które każde dziecko MTD może zarejestrować na tym urządzeniu jako rodzic.
Zobacz też:
otThreadSetMaxChildIpAddresses

Identyfikator otThreadGetMaxRouter

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

Ta funkcja zwraca maksymalny dozwolony identyfikator routera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Maksymalny dozwolony identyfikator routera.

Czas oczekiwania

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Pobierz parametr NETWORK_ID_TIMEOUT używany w roli routera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość NETWORK_ID_TIMEOUT.
Zobacz też:
otThreadSetNetworkIdTimeout

OkThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

Ta funkcja pobiera następny wpis pamięci podręcznej EID (przy użyciu iteratora).

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aEntryInfo
Wskaźnik miejsca, w którym umieszczane są dane EID pamięci podręcznej.
[in,out] aIterator
Wskaźnik do iteratora. Zostanie ona zaktualizowana, tak aby wskazywała kolejny element, który odniesie sukces. Aby otrzymać pierwszy wpis, zainicjuj iterator, ustawiając wszystkie jego pola na zero (np. memset strukturę iteracji do zera).
Zwracane wartości
OT_ERROR_NONE
Pole aEntryInfo dla pamięci podręcznej EID zostało wypełnione.
OT_ERROR_NOT_FOUND
Nie ma więcej wpisów w tabeli pamięci podręcznej adresu.

OknoGetGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Pobierz przypisany priorytet nadrzędny.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Przypisana wartość nadrzędna ma wartość -2, która nie jest przypisana.
Zobacz też:
otThreadSetParentPriority

otThreadGetPrefererPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Pobierz preferowany identyfikator partycji lidera wątku używany podczas pracy w roli lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość identyfikatora partycji wiodącej wątku.

OTThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Pobierz PSKc wątku.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aPskc
Wskaźnik do otPskc, który zwraca pobrany PSKc wątku.
Zobacz też:
otThreadSetPskc

OTThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Pobierz odniesienie do klucza PSKc wątku.

Ta funkcja wymaga włączenia funkcji kompilacji w czasie OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Odniesienie do klucza PSKc
Zobacz też:
otThreadSetPskcRef

Przejście na niższy poziom narzędzia otThreadGetRouter

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Pobierz parametr ROUTER_DOWNGRADE_THRESHOLD pełniący rolę roli routera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość ROUTER_DOWNGRADE_THRESHOLD.
Zobacz też:
otThreadSetRouterLowerThreshold

Parametr otThreadGetRouterId

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

Ta funkcja uzyskuje zakres identyfikatorów routerów, które mogą przypisywać do węzłów w sieci wątków.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aMinRouterId
Minimalny identyfikator routera.
[out] aMaxRouterId
Maksymalny identyfikator routera.
Zobacz też:
otThreadSetRouterIdRange

OTThreadGetRouterIdSekwencja

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Pobierz bieżącą sekwencję identyfikatorów routera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Sekwencja identyfikatorów routera.

Informacje o pliku OTThreadGetRouter

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

Ta funkcja przechowuje informacje diagnostyczne o danym routerze z wątkiem.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aRouterId
Identyfikator routera lub RLOC16 dla danego routera.
[out] aRouterInfo
Wskaźnik miejsca, w którym umieszczane są informacje o routerze.
Zwracane wartości
OT_ERROR_NONE
Udało się pobrać informacje o routerze dla podanego identyfikatora.
OT_ERROR_NOT_FOUND
Brak wpisu routera o podanym identyfikatorze.
OT_ERROR_INVALID_ARGS
aRouterInfo ma wartość NULL.

TrasaNawigacjiWyciąguTotów

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Pobierz parametr ROUTER_SELECTION_JITTER używany w roli REED/Router.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość ROUTER_SELECTION_JITTER.
Zobacz też:
otThreadSetRouterSelectionJitter

Parametr otThreadGetRouterUpgradePróg

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Pobierz parametr ROUTER_UPGRADE_THRESHOLD używany w roli REED.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość ROUTER_UPGRADE_THRESHOLD.
Zobacz też:
otThreadSetRouterUpgradeThreshold

Parametr otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Ta metoda wskazuje, czy urządzenie kwalifikuje się do włączenia routera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwracane wartości
TRUE
Jeśli urządzenie spełnia warunki routera.
FALSE
Jeśli urządzenie nie spełnia wymagań.

Wywołanie zwrotne tabeli otThreadRegisterNeighborTable

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Ta funkcja rejestruje funkcję wywołania zwrotnego tabeli sąsiada.

Wywołanie zwrotne (jeśli nie ma wartości NULL) zostanie wywołane w przypadku zmiany w tabeli sąsiedniej (np. dodanie lub usunięcie elementu podrzędnego lub sąsiada routera albo zmiana dotychczasowego trybu podrzędnego).

Kolejne wywołania tej metody zastąpią poprzednie wywołanie zwrotne. Pamiętaj, że to wywołanie zwrotne jest wywoływane podczas aktualizowania tabeli sąsiadów/podrzędnych i zawsze przed otStateChangedCallback.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aCallback
Wskaźnik do funkcji obsługi wywołania zwrotnego.

Identyfikator_otwątku_trasy

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Zwolnij identyfikator routera przydzielony przez urządzenie w roli lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aRouterId
Identyfikator routera do zwolnienia. Prawidłowy zakres to [0, 62].
Zwracane wartości
OT_ERROR_NONE
Identyfikator routera został zwolniony.
OT_ERROR_INVALID_ARGS
aRouterId nie mieści się w zakresie [0, 62].
OT_ERROR_INVALID_STATE
To urządzenie nie jest obecnie liderem.
OT_ERROR_NOT_FOUND
Identyfikator routera nie jest aktualnie przypisany.

OTThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Ta funkcja określa, czy urządzenie zostało zlecone za pomocą CCM.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aEnabled
TRUE, jeśli urządzenie zostało zlecone za pomocą CCM, w przeciwnym razie ma wartość FALSE.

Opóźnienie ponownego użycia elementu otThreadSetContext

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Ustaw parametr CONTEXT_ID_REUSE_DELAY używany w roli lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDelay
Wartość CONTEXT_ID_REUSE_DELAY.
Zobacz też:
otThreadGetContextIdReuseDelay

otThreadSetConnecterUdpPort.

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Ustaw port UDP usługi Connector.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aJoinerUdpPort
Numer portu łącznika UDP.
Zwracane wartości
OT_ERROR_NONE
Udało się ustawić port UDP usługi Connector.
Zobacz też:
otThreadGetDołączerUdpPort

0ThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Ustaw wagę lidera wątku, który jest używany podczas pracy w roli lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aWeight
Wartość wagi lidera wątku.
Zobacz też:
otThreadGetLeaderWeight

OTThreadSetMaxAllowedChild

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Ustaw maksymalną dozwoloną liczbę dzieci.

Ten parametr można ustawić tylko wtedy, gdy obsługa protokołu Thread została zatrzymana.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aMaxChildren
Maksymalna dozwolona liczba dzieci.
Zwracane wartości
OT_ERROR_NONE
Maks.
OT_ERROR_INVALID_ARGS
Jeśli aMaxChildren nie mieści się w zakresie [1, OPENthread_CONFIG_MLE_MAX_CHILDREN].
OT_ERROR_INVALID_STATE
Jeśli wątek nie został zatrzymany,
Zobacz też:
otThreadGetMaxAllowedChild

OTThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Ta funkcja ustawia/przywraca maksymalną liczbę adresów IP, które każde dziecko MTD może zarejestrować na tym urządzeniu jako rodzic.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aMaxIpAddresses
Maksymalna liczba adresów IP, które każde dziecko MTD może zarejestrować na tym urządzeniu jako rodzic. 0, aby wyczyścić to ustawienie i przywrócić je.
Zwracane wartości
OT_ERROR_NONE
Ustawiono/wyczyszczono numer.
OT_ERROR_INVALID_ARGS
Wartość przekracza dopuszczalne maksimum.
Zobacz też:
otThreadGetMaxChildIpAddresses

Limit czasu sieci

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Ustaw parametr NETWORK_ID_TIMEOUT używany w roli lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aTimeout
Wartość NETWORK_ID_TIMEOUT.
Zobacz też:
otThreadGetNetworkIdTimeout

Parametr OTThreadSetParent

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Ustaw priorytet elementu nadrzędnego.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aParentPriority
Wartość priorytetu elementu nadrzędnego.
Zwracane wartości
OT_ERROR_NONE
Priorytet został ustawiony.
OT_ERROR_INVALID_ARGS
Jeśli wartość nadrzędna jest inna niż 1, 0, -1 lub -2.
Zobacz też:
otThreadGetParentPriority

Identyfikator otThreadSetPreferowanyLeaderPartition

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Ustaw preferowany identyfikator partycji lidera, który jest używany podczas pracy w roli lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPartitionId
Wartość identyfikatora partycji wiodącej wątku.

Identyfikator otThreadSetPreferRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Ustaw preferowany identyfikator routera.

Po tym, jak zostanie routerem/liderem, węzeł spróbuje użyć tego identyfikatora routera. Jeśli preferowany identyfikator routera nie jest ustawiony lub nie można go użyć, wybierany jest losowo generowany identyfikator routera. Tę właściwość można ustawić tylko wtedy, gdy rola urządzenia jest odłączona lub wyłączona.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aRouterId
Preferowany identyfikator routera.
Zwracane wartości
OT_ERROR_NONE
Udało się ustawić preferowany identyfikator routera.
OT_ERROR_INVALID_STATE
Nie udało się ustawić (rola nie jest odłączona ani wyłączona)

OTThreadSetPskc 

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

Ustaw kod PSKc wątku.

Ta funkcja działa tylko wtedy, gdy wyłączone są protokoły Thread. Udane wywołanie tej funkcji spowoduje też unieważnienie aktywnych i oczekujących zbiorów danych w pamięci ulotnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPskc
Wskaźnik do nowego PSKc wątku.
Zwracane wartości
OT_ERROR_NONE
Udało się ustawić PSKc wątku.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.
Zobacz też:
otThreadGetPskc

OTThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Ustaw kod PSKc wątku.

Ta funkcja wymaga włączenia funkcji kompilacji w czasie OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Ta funkcja działa tylko wtedy, gdy wyłączone są protokoły Thread. Udane wywołanie tej funkcji spowoduje też unieważnienie aktywnych i oczekujących zbiorów danych w pamięci ulotnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aKeyRef
Odniesienie do nowego klucza PSK Thread.
Zwracane wartości
OT_ERROR_NONE
Udało się ustawić PSKc wątku.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.
Zobacz też:
otThreadGetPskcRef

Parametr otThreadSetRouterzmniejszania progu

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Ustaw parametr ROUTER_DOWNGRADE_THRESHOLD pełniący rolę lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aThreshold
Wartość ROUTER_DOWNGRADE_THRESHOLD.
Zobacz też:
otThreadGetRouterLowerThreshold

Parametr otthreadSetRouter

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Ta funkcja określa, czy urządzenie spełnia wymagania routera.

Jeśli aEligible ma wartość Fałsz i urządzenie aktualnie działa jako router, to połączenie spowoduje odłączenie urządzenia i próbę ponownego dołączenia go jako dziecka.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aEligible
Wartość TRUE powoduje skonfigurowanie urządzenia jako routera. W przeciwnym razie ma wartość FALSE.
Zwracane wartości
OT_ERROR_NONE
Skonfiguruj odpowiednią konfigurację routera.
OT_ERROR_NOT_CAPABLE
Urządzenie nie może być routerem.

OTThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

Ta funkcja ustawia zakres identyfikatorów routerów, które można przypisywać do węzłów w sieci wątków.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aMinRouterId
Minimalny identyfikator routera.
[in] aMaxRouterId
Maksymalny identyfikator routera.
Zwracane wartości
OT_ERROR_NONE
Udało się ustawić zakres.
OT_ERROR_INVALID_ARGS
aMinRouterId > aMaxRouterId lub zakres nie jest objęty zakresem [0, 62].
Zobacz też:
otThreadGetRouterIdRange

ZagnieżdżonyJoś

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Ustaw parametr ROUTER_SELECTION_JITTER w roli REED/Router.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aRouterJitter
Wartość ROUTER_SELECTION_JITTER.
Zobacz też:
otThreadGetRouterSelectionJitter

Parametr otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Ustaw parametr ROUTER_UPGRADE_THRESHOLD używany w roli lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aThreshold
Wartość ROUTER_UPGRADE_THRESHOLD.
Zobacz też:
otThreadGetRouterUpgradeThreshold

Dane_zestawu_danych

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Ustaw dane kierownicy poza zakresem.

Opcja konfiguracji OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE powinna być ustawiona, by umożliwić ustawienie danych sterowania poza zakresem.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aExtAddress
Adres używany do aktualizowania danych układu sterowania. Wszystkie zera powodują usunięcie danych układu sterowania. Wszystkie wartości 0xFF do ustawiania i zezwalania na wszystkie dane dotyczące układu sterowania. Określony EUI64, który jest następnie dodawany do bieżącego filtra danych/kwiatów układu sterowania.

OTThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Ta funkcja określa, czy włączony jest próg aktualizacji dla wersji zabezpieczeń TLV w polu Zasad zabezpieczeń.

Makra

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inicjator pliku otChildIP6AddressIterator.

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.