Router/lider

Ten moduł zawiera funkcje związane z routerami do gwintu i liderami.

Podsumowanie

Wyliczenia
otCacheEntryState enum | typ wyliczeniowy
Definiuje 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
Definiuje stałe używane w funkcji otNeighborTableCallback do wskazywania zmian w tabeli sąsiadów.
otPowerSupply{
  OT_POWER_SUPPLY_BATTERY = 0,
  OT_POWER_SUPPLY_EXTERNAL = 1,
  OT_POWER_SUPPLY_EXTERNAL_STABLE = 2,
  OT_POWER_SUPPLY_EXTERNAL_UNSTABLE = 3
} 		enum | typ wyliczeniowy
Reprezentuje właściwość zasilacza na urządzeniu.

Definicje typów
otCacheEntryInfo typedef
Reprezentuje wpis w pamięci podręcznej EID.
otCacheEntryIterator typedef
Reprezentuje iterator używany do iteracji z użyciem wpisów tabeli pamięci podręcznej EID.
otCacheEntryState typedef
Definiuje stan wpisu pamięci podręcznej EID.
otChildIp6AddressIterator typedef
uint16_t
Służy do iteracji z użyciem adresów IPv6 wpisu podrzędnego Thread.
otDeviceProperties typedef
Reprezentuje właściwości urządzenia, które są używane do obliczania wagi lokalnego lidera na danym urządzeniu.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
Wskaźnik jest wywoływany, aby powiadomić o zmianie w tabeli sąsiadów.

Funkcje
otThreadBecomeLeader(otInstance *aInstance)
Zostań liderem i rozpocznij nowy podział.
otThreadBecomeRouter(otInstance *aInstance)
Spróbuj zostać routerem.
otThreadGetAdvertisementTrickleIntervalMax(otInstance *aInstance)
uint32_t
Pobiera bieżącą wartość maks. interwału używaną przez licznik czasu przepływu reklamy.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
Pobiera informacje diagnostyczne dotyczące dołączonego podmiotu podrzędnego na podstawie jego identyfikatora podrzędnego lub RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
Funkcja zachowuje informacje diagnostyczne o dołączonym elemencie podrzędnym przez indeks tabeli wewnętrznej.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Pobiera następny adres IPv6 (przy użyciu iteratora) dla danego elementu podrzędnego.
otThreadGetChildRouterLinks(otInstance *aInstance)
uint8_t
Pobierz parametr MLE_CHILD_ROUTER_LINKS używany w roli REED.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
Pobierz parametr CONTEXT_ID_REUSE_dłuż używany w roli lidera.
otThreadGetDeviceProperties(otInstance *aInstance)
Pobierz bieżące właściwości urządzenia.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
Pobiera port UDP Joiner.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
Pobiera wagę lidera wątku używaną w przypadku działania w roli lidera.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
Pobiera maksymalną dozwoloną obecnie liczbę elementów podrzędnych.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
Pobiera maksymalną liczbę adresów IP, które każde podrzędne konto MTD może zarejestrować jako urządzenie nadrzędne na tym urządzeniu.
otThreadGetMaxRouterId(otInstance *aInstance)
uint8_t
Funkcja zwraca maksymalny dozwolony identyfikator routera.
otThreadGetNetworkIdTimeout(otInstance *aInstance)
uint8_t
Pobierz parametr NETWORK_ID_TIMEOUT.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Pobiera następny wpis w pamięci podręcznej EID (przy użyciu iteratora).
otThreadGetNextHopAndPathCost(otInstance *aInstance, uint16_t aDestRloc16, uint16_t *aNextHopRloc16, uint8_t *aPathCost)
void
Pobiera koszt następnego przeskoku i ścieżki w kierunku danego miejsca docelowego RLOC16.
otThreadGetParentPriority(otInstance *aInstance)
int8_t
Pobierz przypisany priorytet nadrzędny.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
Uzyskaj preferowany identyfikator partycji Thread Leader używany podczas pracy w roli lidera
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
Zdobądź klucz PSKc Thread.
otThreadGetPskcRef(otInstance *aInstance)
Pobranie odniesienia klucza do zapisanego klucza PSKc wątku.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
Pobierz parametr ROUTER_DOWNGRADE_THRESHOLD używany w roli Router.
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
Pobiera 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)
Funkcja przechowuje informacje diagnostyczne o danym routerze Thread.
otThreadGetRouterSelectionJitter(otInstance *aInstance)
uint8_t
Pobierz parametr ROUTER_SELECTION_JITTER używany w roli REED lub routera.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
uint8_t
Pobierz parametr ROUTER_UPGRADE_THRESHOLD używany w roli REED.
otThreadIsRouterEligible(otInstance *aInstance)
bool
Wskazuje, czy urządzenie obsługuje router.
otThreadIsRouterIdAllocated(otInstance *aInstance, uint8_t aRouterId)
bool
Wskazuje, czy identyfikator routera jest obecnie przydzielony.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
Rejestruje funkcję wywołania zwrotnego tabeli sąsiadów.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
Zwolnij identyfikator routera przydzielony przez urządzenie w roli lidera.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
Określa, czy urządzenie zostało zamówione przy użyciu CCM.
otThreadSetChildRouterLinks(otInstance *aInstance, uint8_t aChildRouterLinks)
Ustaw parametr MLE_CHILD_ROUTER_LINKS używany w roli REED.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
Ustaw parametr CONTEXT_ID_REUSE_dłuż używany w roli lidera.
otThreadSetDeviceProperties(otInstance *aInstance, const otDeviceProperties *aDeviceProperties)
void
Ustaw właściwości urządzenia, które będą następnie używane do określania i ustawiania wagi repliki wiodącej.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
Ustawia port UDP Joiner.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
Określa wagę lidera wątku, używaną podczas pracy w roli lidera.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
Określa maksymalną obecnie dozwoloną liczbę dzieci.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
Ustawia lub przywraca maksymalną liczbę adresów IP, które każde podrzędne konto MTD może zarejestrować się na tym urządzeniu jako rodzic.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
Ustaw parametr NETWORK_ID_TIMEOUT.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
Ustaw priorytet nadrzędny.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
Ustaw preferowany identyfikator partycji Thread Leader używany podczas pracy w roli lidera.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
Ustaw preferowany identyfikator routera.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
Ustaw klucz PSKc wątku.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
Ustaw odwołanie klucza na klucz PSKc wątku.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Ustaw parametr ROUTER_DOWNGRADE_THRESHOLD używany w roli repliki wiodącej.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
Określa, czy urządzenie obsługuje router.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Ustawia zakres identyfikatorów routerów, które mogą być przypisywane do węzłów w sieci wątków.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
Ustaw parametr ROUTER_SELECTION_JITTER używany w roli REED lub routera.
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 sterowania poza zakresem.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
Określa, czy próg wersji TLV zasady zabezpieczeń jest włączony na potrzeby routingu (pole VR).

Konstrukcja
otCacheEntryInfo

Reprezentuje wpis w pamięci podręcznej EID.

otCacheEntryIterator

Reprezentuje iterator używany do iteracji z użyciem wpisów tabeli pamięci podręcznej EID.

otChildInfo

Przechowuje informacje diagnostyczne o elemencie podrzędnym Thread.

otDeviceProperties

Reprezentuje właściwości urządzenia, które są używane do obliczania wagi lokalnego lidera na danym urządzeniu.

otNeighborTableEntryInfo

Reprezentują informacje o wpisie tabeli sąsiadów (podrzędne lub router) i są używane jako parametr w wywołaniu zwrotnym otNeighborTableCallback tabeli sąsiadów.

Wyliczenia

otCacheEntryState

 otCacheEntryState

Definiuje stan wpisu pamięci podręcznej EID.

otNeighborTableEvent

 otNeighborTableEvent

Definiuje stałe używane w funkcji otNeighborTableCallback do wskazywania zmian w tabeli sąsiadów.

Właściwości
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

Dodajemy dziecko.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

Tryb istniejącego dziecka zostanie zmieniony.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Dziecko jest usuwane.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Dodaję router.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Usuwam router.

otPowerSupply

 otPowerSupply

Reprezentuje właściwość zasilacza na urządzeniu.

Ta wartość jest używana jako właściwość w otDeviceProperties do obliczania wagi repliki wiodącej.

Właściwości
OT_POWER_SUPPLY_BATTERY

Na baterie.

OT_POWER_SUPPLY_EXTERNAL

Zasilanie z zewnątrz (zasilanie z sieci).

OT_POWER_SUPPLY_EXTERNAL_STABLE

Stabilne zasilanie zewnętrzne z baterią lub zasilaczem UPS.

OT_POWER_SUPPLY_EXTERNAL_UNSTABLE

Potencjalnie niestabilne zasilanie zewnętrzne (np. żarówka zasilana za pomocą przełącznika).

Definicje typów

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Reprezentuje wpis w pamięci podręcznej EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

Reprezentuje iterator używany do iteracji z użyciem wpisów tabeli pamięci podręcznej EID.

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

otCacheEntryState

enum otCacheEntryState otCacheEntryState

Definiuje stan wpisu pamięci podręcznej EID.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Służy do iteracji z użyciem adresów IPv6 wpisu podrzędnego Thread.

otDeviceProperties

struct otDeviceProperties otDeviceProperties

Reprezentuje właściwości urządzenia, które są używane do obliczania wagi lokalnego lidera na danym urządzeniu.

Parametry są ustawiane na podstawie możliwości urządzenia, np. routera granicznego, konfiguracji zasilacza itp.

mIsUnstable oznacza stabilność operacyjną urządzenia i jest określana przez mechanizm odpowiedni dla danego dostawcy. Mogą one obejmować następujące przypadki:

  • Urządzenie wewnętrznie wykrywa, że traci ono zewnętrzny zasilacz częściej niż zwykle. Standardowe zasady są określane przez dostawcę.
  • Urządzenie wewnętrznie wykryło, że uruchamia się ponownie częściej niż zwykle. Standardowe zasady są określane przez dostawcę.

otNeighborTableCallback

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

Wskaźnik jest wywoływany, aby powiadomić o zmianie w tabeli sąsiadów.

Szczegóły
Parametry
[in] aEvent
Flaga zdarzenia.
[in] aEntryInfo
Wskaźnik do informacji o wpisie w tabeli.

Funkcje

otThreadBecomeLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Zostań liderem i rozpocznij nowy podział.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwracane wartości
OT_ERROR_NONE
Użytkownik został liderem i uruchomił nową partycję.
OT_ERROR_INVALID_STATE
Wątek jest wyłączony.

otThreadBecomeRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Spróbuj zostać routerem.

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

otThreadGetAdvertisementTrickleIntervalMax

uint32_t otThreadGetAdvertisementTrickleIntervalMax(
  otInstance *aInstance
)

Pobiera bieżącą wartość maks. interwału używaną przez licznik czasu przepływu reklamy.

Ten interfejs API wymaga OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE i jest przeznaczony wyłącznie do testów.

Szczegóły
Zwroty
Licznik licznika interwałowego maksymalnej liczby reklam w milisekundach.

otThreadGetChildInfoById

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

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

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aChildId
Identyfikator podmiotu podrzędnego lub RLOC16 powiązanego z nim podmiotu podrzędnego.
[out] aChildInfo
Wskaźnik miejsca, w którym znajdują się dane dziecka.
Zwracane wartości
OT_ERROR_NONE
Element aChildInfo został zaktualizowany o informacje dotyczące podanego identyfikatora.
OT_ERROR_NOT_FOUND
Brak prawidłowego konta podrzędnego o tym identyfikatorze.
OT_ERROR_INVALID_ARGS
Jeśli aChildInfo ma wartość NULL.

otThreadGetChildInfoByIndex

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

Funkcja zachowuje informacje diagnostyczne o dołączonym elemencie podrzędnym przez indeks tabeli wewnętrznej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aChildIndex
Indeks tabeli.
[out] aChildInfo
Wskaźnik miejsca, w którym znajdują się dane dziecka.
Zwracane wartości
OT_ERROR_NONE
Element aChildInfo został zaktualizowany o informacje dla danego indeksu.
OT_ERROR_NOT_FOUND
Brak prawidłowego elementu podrzędnego w tym indeksie.
OT_ERROR_INVALID_ARGS
aChildInfo ma wartość NULL lub aChildIndex jest poza zakresem (wyższy niż maksymalny indeks tabeli).
Zobacz też:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Address

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

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. Po pomyślnym zakończeniu iterator zostanie zaktualizowany tak, aby wskazywał następną pozycję na liście. Aby uzyskać pierwszy adres IPv6, iterator powinien mieć wartość OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Wskaźnik do adresu IPv6, pod którym jest umieszczony następny adres wydawcy (jeśli uda się).
Zwracane wartości
OT_ERROR_NONE
Znaleziono następny adres IPv6 (zaktualizowano aAddress).
OT_ERROR_NOT_FOUND
Element podrzędny nie ma kolejnego adresu IPv6.
OT_ERROR_INVALID_ARGS
aIterator lub aAddress mają wartość NULL lub element podrzędny w aChildIndex jest nieprawidłowy.
Zobacz też:
otThreadGetChildInfoByIndex 

uint8_t otThreadGetChildRouterLinks(
  otInstance *aInstance
)

Pobierz parametr MLE_CHILD_ROUTER_LINKS używany w roli REED.

Ten parametr określa maksymalną liczbę sąsiadujących routerów, z którymi urządzenie (jako FED) będzie próbowało nawiązać połączenie.

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

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Pobierz parametr CONTEXT_ID_REUSE_dłuż używany w roli lidera.

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

otThreadGetDeviceProperties

const otDeviceProperties * otThreadGetDeviceProperties(
  otInstance *aInstance
)

Pobierz bieżące właściwości urządzenia.

Wymagana jest subskrypcja OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE.

Szczegóły
Zwroty
Właściwości urządzenia: otDeviceProperties.

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Pobiera port UDP Joiner.

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

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Pobiera wagę lidera wątku używaną w przypadku działania w roli lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość wagi wiodącej nici.
Zobacz też:
otThreadSetLeaderWeight
otThreadSetDeviceProperties

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Pobiera maksymalną dozwoloną obecnie liczbę elementów podrzędnych.

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

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Pobiera maksymalną liczbę adresów IP, które każde podrzędne konto MTD może zarejestrować jako urządzenie nadrzędne na tym urządzeniu.

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

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

Funkcja zwraca maksymalny dozwolony identyfikator routera.

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

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Pobierz parametr NETWORK_ID_TIMEOUT.

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

otThreadGetNextCacheEntry

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

Pobiera następny wpis w 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 znajdują się informacje o wpisie z pamięci podręcznej EID.
[in,out] aIterator
Wskaźnik do iteratora. Zostanie zaktualizowany tak, aby wskazywał następne wystąpienie błędu. Aby uzyskać pierwszy wpis, zainicjuj iterator, ustawiając wszystkie jego pola na zero (np. memset ustaw strukturę iteratora na zero).
Zwracane wartości
OT_ERROR_NONE
Pole aEntryInfo dla następnego wpisu pamięci podręcznej EID zostało wypełnione.
OT_ERROR_NOT_FOUND
Brak kolejnych wpisów w tabeli pamięci podręcznej adresów.

otThreadGetNextHopAndPathCost

void otThreadGetNextHopAndPathCost(
  otInstance *aInstance,
  uint16_t aDestRloc16,
  uint16_t *aNextHopRloc16,
  uint8_t *aPathCost
)

Pobiera koszt następnego przeskoku i ścieżki w kierunku danego miejsca docelowego RLOC16.

Można jej używać, w którym aNextHopRloc16 lub aPathCost ma wartość NULL, co oznacza, że element wywołujący nie chce otrzymywać wartości.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDestRloc16
RLOC16 miejsca docelowego.
[out] aNextHopRloc16
Wskaźnik zwracający RLOC16 następnego przeskoku lub 0xfffe, jeśli nie ma następnego przeskoku.
[out] aPathCost
Wskaźnik zwracający koszt ścieżki w kierunku miejsca docelowego.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Pobierz przypisany priorytet nadrzędny.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Przypisana wartość priorytetu nadrzędnego (-2) oznacza, że nie przypisano.
Zobacz też:
otThreadSetParentPriority

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Uzyskaj preferowany identyfikator partycji Thread Leader używany podczas pracy w roli lidera

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość identyfikatora partycji Thread Leader.

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Zdobądź klucz PSKc Thread.

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

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Pobranie odniesienia klucza do zapisanego klucza PSKc wątku.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE w czasie kompilacji.

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

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Pobierz parametr ROUTER_DOWNGRADE_THRESHOLD używany w roli Router.

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

otThreadGetRouterIdRange

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

Pobiera 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

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

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

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

otThreadGetRouterInfo

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

Funkcja przechowuje informacje diagnostyczne o danym routerze Thread.

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

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Pobierz parametr ROUTER_SELECTION_JITTER używany w roli REED lub routera.

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

otThreadGetRouterUpgradeThreshold

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

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Wskazuje, czy urządzenie obsługuje router.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwracane wartości
TRUE
Jeśli urządzenie obsługuje router.
FALSE
Jeśli urządzenie nie obsługuje routera.

otThreadIsRouterIdAllocated

bool otThreadIsRouterIdAllocated(
  otInstance *aInstance,
  uint8_t aRouterId
)

Wskazuje, czy identyfikator routera jest obecnie przydzielony.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aRouterId
Identyfikator routera do sprawdzenia.
Zwracane wartości
TRUE
aRouterId jest przydzielony.
FALSE
aRouterId nie jest przydzielony.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Rejestruje funkcję wywołania zwrotnego tabeli sąsiadów.

Podane wywołanie zwrotne (jeśli nie ma wartości NULL) zostanie wywołane w przypadku zmiany w tabeli sąsiadów (np. w wyniku dodania/usunięcia wpisu sąsiada routera albo zmiany trybu podrzędnego).

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

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

otThreadReleaseRouterId

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
Urządzenie nie jest obecnie liderem.
OT_ERROR_NOT_FOUND
Obecnie identyfikator routera nie jest przydzielony.

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Określa, czy urządzenie zostało zamówione przy użyciu CCM.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aEnabled
Wartość TRUE, jeśli urządzenie zostało zamówione z użyciem CCM, lub wartość FALSE w przeciwnym razie. 
otError otThreadSetChildRouterLinks(
  otInstance *aInstance,
  uint8_t aChildRouterLinks
)

Ustaw parametr MLE_CHILD_ROUTER_LINKS używany w roli REED.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aChildRouterLinks
Wartość MLE_CHILD_ROUTER_LINKS.
Zwracane wartości
OT_ERROR_NONE
Wartość została ustawiona.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.
Zobacz też:
otThreadGetChildRouterLinks

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Ustaw parametr CONTEXT_ID_REUSE_dłuż używany w roli lidera.

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

otThreadSetDeviceProperties

void otThreadSetDeviceProperties(
  otInstance *aInstance,
  const otDeviceProperties *aDeviceProperties
)

Ustaw właściwości urządzenia, które będą następnie używane do określania i ustawiania wagi repliki wiodącej.

Wymagana jest subskrypcja OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDeviceProperties
Właściwości urządzenia.

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Ustawia port UDP Joiner.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aJoinerUdpPort
Numer portu UDP Joiner.
Zwracane wartości
OT_ERROR_NONE
Port UDP sprzętu został ustawiony.
Zobacz też:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Określa wagę lidera wątku, używaną podczas pracy w roli lidera.

Bezpośrednio ustawia nową wartość wagi repliki wiodącej, zastępując jej poprzednią wartość (która mogła zostać określona na podstawie bieżącej wartości otDeviceProperties).

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

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Określa maksymalną obecnie dozwoloną liczbę dzieci.

Ten parametr można ustawić tylko po zatrzymaniu operacji protokołu Thread.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aMaxChildren
Maksymalna dozwolona liczba elementów podrzędnych.
Zwracane wartości
OT_ERROR_NONE
Udało się ustawić 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 aplikacja Thread nie jest zatrzymana
Zobacz też:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Ustawia lub przywraca maksymalną liczbę adresów IP, które każde podrzędne konto MTD może zarejestrować się na tym urządzeniu jako rodzic.

Przekaż 0, aby wyczyścić ustawienie i przywrócić domyślne.

Dostępne, gdy włączono OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aMaxIpAddresses
Maksymalna liczba adresów IP, które każde podrzędne konto MTD może zarejestrować się na tym urządzeniu jako konto nadrzędne. 0, aby wyczyścić ustawienie i przywrócić domyślne.
Zwracane wartości
OT_ERROR_NONE
Udało się ustawić/usunąć numer.
OT_ERROR_INVALID_ARGS
Jeśli liczba przekracza dozwolony limit.
Zobacz też:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Ustaw parametr NETWORK_ID_TIMEOUT.

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

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Ustaw priorytet nadrzędny.

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

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Ustaw preferowany identyfikator partycji Thread Leader używany podczas pracy w roli lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPartitionId
Wartość identyfikatora partycji Thread Leader.

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Ustaw preferowany identyfikator routera.

Gdy węzeł jest routerem/liderem, próbuje użyć tego identyfikatora routera. Jeśli preferowany identyfikator routera nie jest ustawiony lub nie można go użyć, wybierany jest losowo wygenerowany identyfikator routera. Tę właściwość można ustawić tylko wtedy, gdy rola urządzenia została 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
Preferowany identyfikator routera został ustawiony.
OT_ERROR_INVALID_STATE
Nie udało się ustawić (rola nie została odłączona ani wyłączona)

otThreadSetPskc

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

Ustaw klucz PSKc wątku.

Odniesie sukces tylko wtedy, gdy protokoły Thread są wyłączone. Udane wywołanie tej funkcji spowoduje też unieważnienie aktywnych i oczekujących zbiorów danych operacyjnych w pamięci nieulotnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPskc
Wskaźnik do nowego klucza PSKc typu Thread.
Zwracane wartości
OT_ERROR_NONE
PSKc wątku został ustawiony.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.
Zobacz też:
otThreadGetPskc

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Ustaw odwołanie klucza na klucz PSKc wątku.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE w czasie kompilacji.

Odniesie sukces tylko wtedy, gdy protokoły Thread są wyłączone. Po pomyślnym zakończeniu unieważnienie aktywnych i oczekujących zbiorów danych operacyjnych w pamięci nieulotnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aKeyRef
Odniesienie klucza do nowego klucza PSKc dla wątku.
Zwracane wartości
OT_ERROR_NONE
PSKc wątku został ustawiony.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.
Zobacz też:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Ustaw parametr ROUTER_DOWNGRADE_THRESHOLD używany w roli repliki wiodącej.

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

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Określa, czy urządzenie obsługuje router.

Jeśli zasada aEligible ma wartość Fałsz, a urządzenie działa obecnie jako router, to wywołanie spowoduje odłączenie urządzenia i podłączenie go jako podrzędnego.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aEligible
TRUE (prawda), aby skonfigurować urządzenie jako zgodne z routerem; w przeciwnym razie ma wartość FALSE (FAŁSZ).
Zwracane wartości
OT_ERROR_NONE
Konfiguracja odpowiednia do zastosowania routera została ustawiona.
OT_ERROR_NOT_CAPABLE
Urządzenie nie może zostać routerem.

otThreadSetRouterIdRange

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

Ustawia zakres identyfikatorów routerów, które mogą być przypisywane 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
Zakres został ustawiony.
OT_ERROR_INVALID_ARGS
aMinRouterId > aMaxRouterId lub zakres nie jest objęty wartością [0, 62].
Zobacz też:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Ustaw parametr ROUTER_SELECTION_JITTER używany w roli REED lub routera.

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

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

otThreadSetSteeringData

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

Ustaw dane sterowania poza zakresem.

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

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aExtAddress
Adres używany do aktualizacji danych kierowania. Wszystkie zera, aby wyczyścić dane kierowania (brak danych kierowania). Wszystkie wartości 0xFF, aby ustawić filtr danych sterowania/kwiatów i akceptował/akceptował wszystkie. Konkretny kod EUI64, który jest następnie dodawany do bieżącego filtra danych sterowania/kwiatu.

otThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Określa, czy próg wersji TLV zasady zabezpieczeń jest włączony na potrzeby routingu (pole VR).

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aEnabled
Wartość TRUE (prawda), aby włączyć próg wersji TLV zasady zabezpieczeń na potrzeby routingu, lub wartość FALSE w przeciwnym razie.

Makra

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inicjator dla otChildIP6AddressIterator.

Zasoby

Tematy referencyjne interfejsu OpenThread API pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dołączyć do naszej dokumentacji, skorzystaj z sekcji Zasoby.