Ogólne

Ten moduł zawiera funkcje przeznaczone dla wszystkich ról w wątku.

Podsumowanie

Wydawca danych sieciowych udostępnia mechanizmy ograniczające liczbę podobnych wpisów dotyczących usług i prefiksów (w prefiksie sieci mesh lub trasy zewnętrznej) w danych sieci związanych z wątkami, monitorując dane sieciowe i określając, czy i kiedy dodawać lub usuwać wpisy.

Wszystkie funkcje w tym module wymagają włączenia funkcji OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE.

Wyliczenia
anonymous enum{
  OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
  OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
  OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
  OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
  OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
  OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
  OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
  OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
  OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
  OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
  OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
  OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
  OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
  OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19,
  OT_NETWORK_DIAGNOSTIC_TLV_VERSION = 24,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME = 25,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL = 26,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION = 27,
  OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION = 28,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD = 29,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST = 30,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR = 31,
  OT_NETWORK_DIAGNOSTIC_TLV_ANSWER = 32,
  OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID = 33,
  OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS = 34
} 		enum | typ wyliczeniowy
otDeviceRole{
  OT_DEVICE_ROLE_DISABLED = 0,
  OT_DEVICE_ROLE_DETACHED = 1,
  OT_DEVICE_ROLE_CHILD = 2,
  OT_DEVICE_ROLE_ROUTER = 3,
  OT_DEVICE_ROLE_LEADER = 4
} 		enum | typ wyliczeniowy
Reprezentuje rolę urządzenia w wątku.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
} 		enum | typ wyliczeniowy
Odnosi się do zdarzeń zgłoszonych z wywołań zwrotnych wydawcy.
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
} 		enum | typ wyliczeniowy
Określa prawidłowe wartości mPreference w otExternalRouteConfig i otBorderRouterConfig.

Definicja typów
otBorderRouterConfig definicja typu
Reprezentuje konfigurację routera granicznego.
otDetachGracefullyCallback)(void *aContext) definicja typu
void(*
To wywołanie zwrotne informuje aplikację o zakończeniu procesu odłączenia.
otExternalRouteConfig definicja typu
Reprezentuje konfigurację trasy zewnętrznej.
otIpCounters definicja typu
struct otIpCounters
Reprezentuje liczniki adresów IP.
otLeaderData definicja typu
struct otLeaderData
Reprezentuje dane osoby odpowiedzialnej za wątki.
otLinkModeConfig definicja typu
Reprezentuje konfigurację trybu linku MLE.
otLowpanContextInfo definicja typu
Reprezentuje informacje identyfikatora kontekstu 6LoWPAN powiązanego z prefiksem w danych sieciowych.
otMleCounters definicja typu
struct otMleCounters
Reprezentuje liczniki MLE wątku.
otNeighborInfoIterator definicja typu
int16_t
Służy do iterowania przez tabelę sąsiadów.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) definicja typu
void(*
Wskaźnik wskaźnika definiuje wywołanie zwrotne powiadamiające o dodaniu pozycji „Usługa DNS/SRP” do danych sieci dotyczących wątków lub z niej usunięte.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) definicja typu
void(*
Wskaźnik wskaźnika definiuje wywołanie zwrotne używane do powiadamiania o dodaniu prefiksu (trasa typu mesh lub trasa zewnętrzna) do danych sieci dotyczących wątków lub z nich usunięty.
otNetDataPublisherEvent definicja typu
Odnosi się do zdarzeń zgłoszonych z wywołań zwrotnych wydawcy.
otNetworkDataIterator definicja typu
uint32_t
Służy do iterowania przez informacje o sieci.
otNetworkDiagChildEntry definicja typu
Odzwierciedla wpis wpisu dotyczącego diagnostyki sieci.
otNetworkDiagConnectivity definicja typu
Reprezentuje wartość połączeń diagnostycznych sieci.
otNetworkDiagIterator definicja typu
uint16_t
Służy do iterowania za pomocą TLV sieci.
otNetworkDiagMacCounters definicja typu
Reprezentuje wartość diagnostyki sieci Mac.
otNetworkDiagMleCounters definicja typu
Reprezentuje wartość diagnostyki sieci MLE.
otNetworkDiagRoute definicja typu
Reprezentuje wartość TLV ścieżki diagnostycznej sieci.
otNetworkDiagRouteData definicja typu
Reprezentuje dane trasy diagnostycznej sieci.
otNetworkDiagTlv definicja typu
Reprezentuje rejestrator diagnostyki sieci.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) definicja typu
void(*
Wskaźnik jest wywoływany po otrzymaniu odpowiedzi dotyczącej diagnostyki sieci.
otRoutePreference definicja typu
Określa prawidłowe wartości mPreference w otExternalRouteConfig i otBorderRouterConfig.
otServerConfig definicja typu
Reprezentuje konfigurację serwera.
otServiceConfig definicja typu
Reprezentuje konfigurację usługi.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) definicja typu
void(*
Typ wskaźnika definiuje wywołanie zwrotne powiadamiające o wyniku żądania otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) definicja typu
void(*
Wskaźnik jest wywoływany za każdym razem, gdy zostanie odebrana wiadomość z żądaniem MLE Discovery.
otThreadDiscoveryRequestInfo definicja typu
Odnosi się do danych żądania wykrywania wątków.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) definicja typu
void(*
Wskaźnik jest wywoływany za każdym razem, gdy zostanie odebrana odpowiedź rodziców z funkcją MLE.
otThreadParentResponseInfo definicja typu
Reprezentuje dane odpowiedzi nadrzędnej MLE.

Funkcje
otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)
void
Konwertuje czas trwania polecenia uint32_t (w sekundach) na ciąg czytelny dla człowieka.
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Sprawdź, czy dany prefiks może działać jako prawidłowy prefiks OMR, oraz czy dane sieci lidera zawierają ten prefiks.
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Udostępnij pełną lub stabilną kopię danych sieci dotyczących wątku.
otNetDataGetLength(otInstance *aInstance)
uint8_t
pobrać bieżącą długość (liczbę bajtów) danych z sieci dotyczących wątków;
otNetDataGetMaxLength(otInstance *aInstance)
uint8_t
Uzyskaj maksymalną zaobserwowaną długość danych z wątków od momentu zainicjowania stosu OT lub od ostatniego wywołania otNetDataResetMaxLength().
otNetDataGetNextLowpanContextInfo(otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
Uzyskaj następne informacje o identyfikatorze kontekstu 6LoWPAN w danych sieci partycji.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Pobierz następny prefiks On Mesh w danych sieci partycji.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Pobierz następną trasę zewnętrzną w danych sieci partycji.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Pobranie następnej usługi w danych sieci partycji.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
Pobierz stabilną wersję danych.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Pobieranie wersji danych sieci.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Wskazuje, czy pozycja „Usługa DNS/SRP” jest obecnie dodawana do danych sieci dotyczących wątków.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Wskazuje, czy opublikowany już prefiks prefiksu (trasa typu mesh lub zewnętrzna) jest dodawany do danych sieci dotyczących wątków.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Wysyła zapytanie o adres „Cast” dowolnego adresu usługi DNS/SRP w celu opublikowania jego danych w sieci.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Wysyła żądanie „Adresu Unicast DNS/SRP” w celu opublikowania w danych sieci dotyczących wątków.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Wysyła żądanie „Adresu Unicast DNS/SRP” w celu opublikowania w danych sieci dotyczących wątków.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Wysyła żądanie zewnętrznego prefiksu trasy do opublikowania w danych sieci dotyczących wątków.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Wysyła żądanie udostępnienia prefiksu siatki typu mesh w danych sieci dotyczących wątków.
otNetDataReplacePublishedExternalRoute(otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
Zastępuje wcześniej opublikowaną trasę zewnętrzną w danych sieci dotyczących wątków.
otNetDataResetMaxLength(otInstance *aInstance)
void
Zresetuj maksymalną długość danych z sieci dotyczących wątków.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Konfiguruje wywołanie zwrotne informujące, kiedy opublikowana „usługa DNS/SRP” została dodana do danych sieci lub z nich usunięta.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Ustawia wywołanie zwrotne z powiadomieniem o dodaniu lub usunięciu opublikowanego prefiksu w danych sieci dotyczących wątków.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Sprawdź, czy dane dotyczące kierownicy zawierają złącze.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Sprawdź, czy dane układu kierowniczego zawierają złącze o określonej wartości dystrybutora.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Cofnięcie publikacji dowolnego dodanego wcześniej wpisu DNS/SRP (anycast lub Unicast) z danych sieci dotyczących wątków.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Cofnięcie publikacji wcześniej opublikowanego prefiksu trasy w sieci typu mesh lub zewnętrznej.
otThreadBecomeChild(otInstance *aInstance)
Spróbuj ponownie dołączyć jako dziecko.
otThreadBecomeDetached(otInstance *aInstance)
Odłącz od sieci Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Powiadamia inne węzły w sieci (jeśli takie istnieją), a następnie zatrzymuje działanie protokołu Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Zmień rolę urządzenia na ciąg zrozumiały dla człowieka.
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Rozpoczyna skanowanie wątków.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Pobiera podrzędny limit czasu wątku (w sekundach) używany podczas pracy w roli podmiotu podrzędnego.
otThreadGetDeviceRole(otInstance *aInstance)
Poznaj rolę urządzenia.
otThreadGetDomainName(otInstance *aInstance)
const char *
Pobiera nazwę domeny wątku.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Pobiera identyfikator IEEE 802.15.4 PAN.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Pobiera ręcznie identyfikator interfejsu określony dla adresu Unicast domeny domeny.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Pobiera liczniki IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Pobiera thrKeySessionCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Pobiera parametr thrKeySwitchGuardTime (w godzinach).
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Pobieranie danych osoby odpowiedzialnej za wątki.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Zwraca wskaźnik do RLOC lidera.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Uzyskaj identyfikator routera lidera.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Sprawdź wagę lidera.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Pobiera adres multicast wszystkich wątków wątków.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Pobiera lokalny adres IPv6 linku Thread.
otThreadGetLinkMode(otInstance *aInstance)
Pobieranie konfiguracji trybu linku MLE.
otThreadGetMaxTimeInQueue(otInstance *aInstance)
uint32_t
Pobiera maksymalny czas przechowywania wiadomości w kolejce TX w kolejce.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Pobiera lokalny adres EID sieci typu mesh.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Zwraca wskaźnik do lokalnego prefiksu sieci typu mesh.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Pobiera liczniki MLE w wątkach.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Pobierz klucz sieciowy z wątku.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Pobierz otNetworkKeyRef klucza klucza sieciowego.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Pobieranie nazwy sieci wątku.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Pobiera następną wiadomość dialektyczną sieci w wiadomości.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Pobiera informacje o następnym sąsiadzie.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
Funkcja pobiera średnią wartość RSSI dla elementu nadrzędnego wątku.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
Funkcja pobiera jako dane nadrzędne informacje o routerze Thread Router.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
Funkcja pobiera RSSI ostatniego pakietu z wątku nadrzędnego.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Pobieranie identyfikatora partycji.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Pobiera adres multicast węzłów Rzeczny-lokalny wątek.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Pobiera adres RLOC (Locator Routing Locator).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Uzyskaj listę RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Pobiera ALOC usługi dla danego identyfikatora usługi.
otThreadGetTimeInQueueHistogram(otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)
const uint32_t *
Pobiera histogram czasu wstawania wiadomości w kolejce.
otThreadGetVendorModel(otInstance *aInstance)
const char *
Pobierz ciąg modelu dostawcy.
otThreadGetVendorName(otInstance *aInstance)
const char *
Pobierz ciąg nazwy dostawcy.
otThreadGetVendorSwVersion(otInstance *aInstance)
const char *
Pobierz ciąg znaków wersji dostawcy sw dostawcy.
otThreadGetVersion(void)
uint16_t
Pobiera wersję protokołu Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Wskazuje, czy żądanie lokalizacji dowolnego typu jest obecnie przetwarzane.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Określa, czy usługa MLE Thread Discovery jest obecnie w toku.
otThreadIsSingleton(otInstance *aInstance)
bool
Wskazuje, czy węzeł jest jedynym routerem w sieci.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Zwraca najbliższe miejsce docelowe danego adresu nadawcy.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Rejestruje wywołanie zwrotne, które będzie otrzymywać dane odpowiedzi nadrzędnej MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Resetuje liczniki IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Resetuje liczniki MLE wątku.
otThreadResetTimeInQueueStat(otInstance *aInstance)
void
Resetuje statystyki dotyczące kolejki kolejki TX.
otThreadSearchForBetterParent(otInstance *aInstance)
Rozpoczyna proces znajdowania przez dziecko lepszego rodzica, zachowując jego zgodność z obecnym rodzicem.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Wysyła powiadomienie o aktywnym adresie (ADDR_NTF.ntf).
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Wyślij żądanie diagnostyki sieci.
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Wyślij żądanie resetowania sieci.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Wysyła wiadomość proaktywną powiadomienia o szkieletie (PRO_BB.ntf) w linku szkieletowym.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Ustawia w sekundach podrzędny limit czasu wątku używany podczas pracy w roli podrzędnej.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Konfiguruje wywołanie zwrotne, które odbiera dane MLE Discovery Request.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
Ustawia nazwę domeny wątku.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Rozpoczyna operację protokołu Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Ustawia identyfikator IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Ustawia lub usuwa identyfikator interfejsu ręczny określony dla adresu Unicast domeny wątku.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Ustawia reklamę Łącznika wątków podczas wykrywania sieci Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Ustawia thrKeySessionLicznik.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Ustawia thrKeySwitchGuardTime (w godzinach).
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Ustaw konfigurację trybu linku MLE.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Ustawia lokalny prefiks sieci typu mesh.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Ustaw klucz sieciowy dla wątków.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Ustaw klucz sieci wątku jako otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Ustaw nazwę sieci wątku.
otThreadSetVendorModel(otInstance *aInstance, const char *aVendorModel)
Ustaw ciąg modelu dostawcy.
otThreadSetVendorName(otInstance *aInstance, const char *aVendorName)
Ustaw ciąg nazwy dostawcy.
otThreadSetVendorSwVersion(otInstance *aInstance, const char *aVendorSwVersion)
Ustaw ciąg wersji oprogramowania dostawcy.

Struktury
Konfiguracja konfiguracji routingu

Reprezentuje konfigurację routera granicznego.

otExternalRouteConfig.

Reprezentuje konfigurację trasy zewnętrznej.

OTIpLiczniks

Reprezentuje liczniki adresów IP.

otLeaderData

Reprezentuje dane osoby odpowiedzialnej za wątki.

otLinkModeConfig.

Reprezentuje konfigurację trybu linku MLE.

ototpanContextInfo

Reprezentuje informacje identyfikatora kontekstu 6LoWPAN powiązanego z prefiksem w danych sieciowych.

OTMleCounters

Reprezentuje liczniki MLE wątku.

InformacjeNeighborInfo

Zawiera informacje diagnostyczne dotyczące sąsiadującego węzła Thread.

OTNetworkDiagChildEntry

Odzwierciedla wpis wpisu dotyczącego diagnostyki sieci.

otNetworkDiagConnectivity,

Reprezentuje wartość połączeń diagnostycznych sieci.

OTNetworkDiagMacLiczniki

Reprezentuje wartość diagnostyki sieci Mac.

LicznikiOtNetworkDiagMleLicznik

Reprezentuje wartość diagnostyki sieci MLE.

TrasaDogSieci

Reprezentuje wartość TLV ścieżki diagnostycznej sieci.

DanesieciDiagRoute

Reprezentuje dane trasy diagnostycznej sieci.

otNetworkDiagTlv

Reprezentuje rejestrator diagnostyki sieci.

otRouterInfo

Zawiera informacje diagnostyczne dotyczące routera Thread.

otServerConfig

Reprezentuje konfigurację serwera.

otServiceConfig

Reprezentuje konfigurację usługi.

otThreadDiscoveryRequestInfo

Odnosi się do danych żądania wykrywania wątków.

otThreadParentResponseInfo,

Reprezentuje dane odpowiedzi nadrzędnej MLE.

Wyliczenia

anonimowy enum

 anonymous enum
Właściwości
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER

Odpowiedz.

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Poziom naładowania baterii.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TL strony kanału.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

Telewizja dziecięca

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

Podrzędna lista adresów IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

Podrzędna tabela TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

Połączenia z telewizorem.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

Rozszerzony adres MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV adres IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

Lider danych (TLV)

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

MAC liczników TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

Maksymalny czas oczekiwania dla dzieci podrzędnych.

OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS

MLE Counters TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Tryb TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TL sieci danych.

OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID

Identyfikator TLV zapytania.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR

Router sąsiada (TLV).

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Address16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Napięcie TLV.

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

Wersja stosu TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Limit czasu TLV (maksymalny czas odpytywania SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Typ listy TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL

TLV dostawcy.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME

Nazwa dostawcy usługi.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION

Dostawca oprogramowania w wersji TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

Wersja TLV.

Rolaurządzenie

 otDeviceRole

Reprezentuje rolę urządzenia w wątku.

Właściwości
OT_DEVICE_ROLE_CHILD

Rola elementu podrzędnego wątku.

OT_DEVICE_ROLE_DETACHED

Obecnie nie uczestniczym w sieci/partycji wątku.

OT_DEVICE_ROLE_DISABLED

Stos wątków jest wyłączony.

OT_DEVICE_ROLE_LEADER

Rola lidera wątku.

OT_DEVICE_ROLE_ROUTER

Rola Router wątku.

Zdarzeniewydarzeniadanych_giełdowych

 otNetDataPublisherEvent

Odnosi się do zdarzeń zgłoszonych z wywołań zwrotnych wydawcy.

Właściwości
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

Opublikowany wpis jest dodawany do danych sieci Thread.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

Opublikowany wpis jest usuwany z danych sieci Thread.

Preferowana trasa

 otRoutePreference

Określa prawidłowe wartości mPreference w otExternalRouteConfig i otBorderRouterConfig.

Właściwości
OT_ROUTE_PREFERENCE_HIGH

Preferowana trasa jest wysoka.

OT_ROUTE_PREFERENCE_LOW

Niskie preferencje trasy.

OT_ROUTE_PREFERENCE_MED

Preferowana średnia trasa.

Definicja typów

Konfiguracja otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Reprezentuje konfigurację routera granicznego.

otDetachGracelyCallback

void(* otDetachGracefullyCallback)(void *aContext)

To wywołanie zwrotne informuje aplikację o zakończeniu procesu odłączenia.

Szczegóły
Parametry
[in] aContext
Wskazanie kontekstu aplikacji.

Konfiguracja trasy alternatywnej

struct otExternalRouteConfig otExternalRouteConfig

Reprezentuje konfigurację trasy zewnętrznej.

Liczniki IoT

struct otIpCounters otIpCounters

Reprezentuje liczniki adresów IP.

dane kontaktowe

struct otLeaderData otLeaderData

Reprezentuje dane osoby odpowiedzialnej za wątki.

Konfiguracja trybu jednorazowego

struct otLinkModeConfig otLinkModeConfig

Reprezentuje konfigurację trybu linku MLE.

Informacje kontekstowe

struct otLowpanContextInfo otLowpanContextInfo

Reprezentuje informacje identyfikatora kontekstu 6LoWPAN powiązanego z prefiksem w danych sieciowych.

OTMleLiczniki

struct otMleCounters otMleCounters

Reprezentuje liczniki MLE wątku.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Służy do iterowania przez tabelę sąsiadów.

Funkcja wywołania zwrotnego wywołania otNetDataDnsSrpServicePublisherCallback

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

Wskaźnik wskaźnika definiuje wywołanie zwrotne powiadamiające o dodaniu pozycji „Usługa DNS/SRP” do danych sieci dotyczących wątków lub z niej usunięte.

W przypadku usunięcia wywołanie zwrotne jest wywoływane niezależnie od tego, czy wpis jest usuwany przez Publisher (np. gdy w danych sieci jest już zbyt wiele podobnych wpisów), czy poprzez jawne wywołanie w celu cofnięcia publikacji (np. wywołanie metody otNetDataUnpublishDnsSrpService()).

Szczegóły
Parametry
[in] aEvent
Wskazuje zdarzenie (niezależnie od tego, czy wpis został dodany czy usunięty).
[in] aContext
Wskazanie kontekstu aplikacji.

wywołanie zwrotne wydawcy otNetDataPrefix

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

Wskaźnik wskaźnika definiuje wywołanie zwrotne używane do powiadamiania o dodaniu prefiksu (trasa typu mesh lub trasa zewnętrzna) do danych sieci dotyczących wątków lub z nich usunięty.

W przypadku usunięcia wywołanie zwrotne jest wywoływane niezależnie od tego, czy wpis zostanie usunięty przez zasadę Publisher (np. gdy w danych sieciowych istnieje już zbyt wiele podobnych wpisów), czy przez bezpośrednie wywołanie w celu cofnięcia publikacji.

Szczegóły
Parametry
[in] aEvent
Wskazuje zdarzenie (niezależnie od tego, czy wpis został dodany czy usunięty).
[in] aPrefix
Wskaźnik do pozycji prefiksu.
[in] aContext
Wskazanie kontekstu aplikacji.

Zdarzeniewydarzeniadanych_giełdowych

enum otNetDataPublisherEvent otNetDataPublisherEvent

Odnosi się do zdarzeń zgłoszonych z wywołań zwrotnych wydawcy.

Węzeł danych sieciowych

uint32_t otNetworkDataIterator

Służy do iterowania przez informacje o sieci.

Temat

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Odzwierciedla wpis wpisu dotyczącego diagnostyki sieci.

Połączenie międzysieciowe

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Reprezentuje wartość połączeń diagnostycznych sieci.

Szybki dostęp

uint16_t otNetworkDiagIterator

Służy do iterowania za pomocą TLV sieci.

LicznikiNaDiagMac

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Reprezentuje wartość diagnostyki sieci Mac.

Definicje pól członków znajdziesz w RFC 2863.

LicznikiOTA

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

Reprezentuje wartość diagnostyki sieci MLE.

TrasaOtNetwork

struct otNetworkDiagRoute otNetworkDiagRoute

Reprezentuje wartość TLV ścieżki diagnostycznej sieci.

Dane dotyczące tras sieciowych

struct otNetworkDiagRouteData otNetworkDiagRouteData

Reprezentuje dane trasy diagnostycznej sieci.

OtNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Reprezentuje rejestrator diagnostyki sieci.

Uzyskanie wywołania zwrotnego

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

Wskaźnik jest wywoływany po otrzymaniu odpowiedzi dotyczącej diagnostyki sieci.

Szczegóły
Parametry
[in] aError
Podczas pobierania odpowiedzi wystąpił błąd.
[in] aMessage
Wskaźnik do bufora wiadomości zawierający odbierany ładunek odpowiedzi diagnostycznych sieci. Dostępne tylko wtedy, gdy aError ma wartość OT_ERROR_NONE.
[in] aMessageInfo
Wskaźnik do informacji o wiadomości aMessage. Dostępne tylko wtedy, gdy aError ma wartość OT_ERROR_NONE.
[in] aContext
Wskazanie kontekstu aplikacji.

Preferowana trasa

enum otRoutePreference otRoutePreference

Określa prawidłowe wartości mPreference w otExternalRouteConfig i otBorderRouterConfig.

Konfiguracja serwera operacyjnego

struct otServerConfig otServerConfig

Reprezentuje konfigurację serwera.

Konfiguracja usługi otService

struct otServiceConfig otServiceConfig

Reprezentuje konfigurację usługi.

Funkcja otThread AnycastLocatorCallback

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

Typ wskaźnika definiuje wywołanie zwrotne powiadamiające o wyniku żądania otThreadLocateAnycastDestination().

Szczegóły
Parametry
[in] aContext
Wskaźnik do dowolnego kontekstu (podawanego podczas rejestrowania wywołania zwrotnego).
[in] aError
Błąd podczas obsługi żądania. OT_ERROR_NONE oznacza powodzenie. OT_ERROR_RESPONSE_TIMEOUT oznacza, że nie znaleziono miejsca docelowego. OT_ERROR_ABORT oznacza, że żądanie zostało przerwane.
[in] aMeshLocalAddress
Wskazuje lokalny identyfikator EID sieci najbliższego miejsca docelowego dowolnego adresu, gdy aError ma wartość OT_ERROR_NONE. W przeciwnym razie przyjmuje wartość NULL.
[in] aRloc16
RLOC16 miejsca docelowego, jeśli zostanie znaleziony, w przeciwnym razie nieprawidłowy RLOC16 (0xfffe).

Wywołanie zwrotne żądania otThreadDiscoveryRequest

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

Wskaźnik jest wywoływany za każdym razem, gdy zostanie odebrana wiadomość z żądaniem MLE Discovery.

Szczegóły
Parametry
[in] aInfo
Wskaźnik do danych z żądania wykrywania.
[in] aContext
Wskaźnik do kontekstu wywołania zwrotnego aplikacji.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Odnosi się do danych żądania wykrywania wątków.

Wywołanie zwrotne otThreadParentResponse

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

Wskaźnik jest wywoływany za każdym razem, gdy zostanie odebrana odpowiedź rodziców z funkcją MLE.

(otThreadRegisterParentResponseCallback()).

Szczegóły
Parametry
[in] aInfo
Wskaźnik do lokalizacji na stosie zawierający dane statystyczne.
[in] aContext
Wskazanie kontekstu kontekstowego klienta.

OTThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Reprezentuje dane odpowiedzi nadrzędnej MLE.

Funkcje

OTKonwertujCzas trwaniawsekundachw_ciągu

void otConvertDurationInSecondsToString(
  uint32_t aDuration,
  char *aBuffer,
  uint16_t aSize
)

Konwertuje czas trwania polecenia uint32_t (w sekundach) na ciąg czytelny dla człowieka.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_UPTIME_ENABLE.

Ciąg ma format „::” (w godzinach, minutach lub sekundach (jeśli czas trwania jest krótszy niż 1 dzień) lub „.

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

Jeśli wynikowy ciąg nie zmieści się w zakresie aBuffer (znajduje się w jego aSize znakach), zostanie skrócony, ale zawsze będzie zwracany pusty ciąg.

Należy używać w przypadku obiektów mAge lub mConnectionTime w strukturach otNeighborInfo lub otChildInfo.

Szczegóły
Parametry
[in] aDuration
Czas trwania w sekundach.
[out] aBuffer
Wskaźnik do tablicy znaków, aby uzyskać ciąg znaków.
[in] aSize
Rozmiar pliku aBuffer (w bajtach). Zalecane użycie: OT_DURATION_STRING_SIZE.

OTNetDataContainsOmrPrefiks

bool otNetDataContainsOmrPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Sprawdź, czy dany prefiks może działać jako prawidłowy prefiks OMR, oraz czy dane sieci lidera zawierają ten prefiks.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPrefix
Wskaźnik określający prefiks IPv6.
Zwroty
Określa, czy aPrefix to prawidłowy prefiks OMR, a dane sieci lidera zawierają prefiks aPrefix OMR.

Pobranie danych z sieci

otError otNetDataGet(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

Udostępnij pełną lub stabilną kopię danych sieci dotyczących wątku.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aStable
TRUE podczas kopiowania wersji stabilnej, a FALSE w przypadku kopiowania pełnej wersji.
[out] aData
Wskaźnik do bufora danych.
[in,out] aDataLength
Rozmiar bufora danych podany przez aData. Przy wyjściu wyświetlana jest liczba skopiowanych bajtów.
Wartości zwracane
OT_ERROR_NONE
Dane dotyczące sieci typu Thread zostały skopiowane do aData i zaktualizowane aDataLength.
OT_ERROR_NO_BUFS
Za mało miejsca na liście aData w celu pełnego skopiowania danych z sieci typu Thread.

Długość_otwartejDane netto

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

pobrać bieżącą długość (liczbę bajtów) danych z sieci dotyczących wątków;

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Długość danych sieci.

Długość_sieci_obejrzeń

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

Uzyskaj maksymalną zaobserwowaną długość danych z wątków od momentu zainicjowania stosu OT lub od ostatniego wywołania otNetDataResetMaxLength().

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Maksymalna długość danych sieciowych (wysoki znak wodny dotyczący długości danych sieciowych).

otNetDataGetNextLowpanContextInfo

otError otNetDataGetNextLowpanContextInfo(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otLowpanContextInfo *aContextInfo
)

Uzyskaj następne informacje o identyfikatorze kontekstu 6LoWPAN w danych sieci partycji.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in,out] aIterator
Wskaźnik do iteratora danych sieci. Aby uzyskać pierwszy wpis usługi, ustaw go na OT_NETWORK_DATA_ITERATOR_INIT.
[out] aContextInfo
Wskaźnik, w którym zostanie umieszczony pobrany identyfikator identyfikatora kontekstu 6LoWPAN.
Wartości zwracane
OT_ERROR_NONE
Udało się znaleźć kolejne informacje o identyfikatorze kontekstu 6LoWPAN.
OT_ERROR_NOT_FOUND
W danych sieciowych partycji nie ma dalszych informacji kontekstowych dotyczących 6LoWPAN.

OTNetDataGetNextOnMeshPrefiks

otError otNetDataGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

Pobierz następny prefiks On Mesh w danych sieci partycji.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in,out] aIterator
Wskazanie kontekstu iteratora danych sieci. Aby uzyskać pierwszy wpis w sieci typu mesh, ustaw go na OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Wskaźnik określający, gdzie zostaną umieszczone informacje dotyczące prefiksu On Mesh.
Wartości zwracane
OT_ERROR_NONE
Następny prefiks w sieci typu mesh został znaleziony.
OT_ERROR_NOT_FOUND
W danych sieci dotyczących wątków nie ma takiego prefiksu.

Trasa OTNetDataGetNext

otError otNetDataGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

Pobierz następną trasę zewnętrzną w danych sieci partycji.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in,out] aIterator
Wskazanie kontekstu iteratora danych sieci. Aby uzyskać pierwszy wpis z trasą zewnętrzną, ustaw go na OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Wskaźnik określający, gdzie zostaną umieszczone informacje o trasie zewnętrznej.
Wartości zwracane
OT_ERROR_NONE
Udało się znaleźć następną trasę zewnętrzną.
OT_ERROR_NOT_FOUND
Brak danych dotyczących dalszych tras zewnętrznych w danych sieci dotyczących wątków.

UsługaOtNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

Pobranie następnej usługi w danych sieci partycji.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in,out] aIterator
Wskazanie kontekstu iteratora danych sieci. Aby uzyskać pierwszy wpis usługi, ustaw go na OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Wskaźnik określający, gdzie zostaną umieszczone informacje o usłudze.
Wartości zwracane
OT_ERROR_NONE
Udało się znaleźć następną usługę.
OT_ERROR_NOT_FOUND
W danych sieciowych partycji nie ma kolejnych usług.

WersjaOotNetGetGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Pobierz stabilną wersję danych.

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

WersjaOtNetDataGet

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Pobieranie wersji danych sieci.

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

UsługaOotNetDataIsDnsSrpService została dodana

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Wskazuje, czy pozycja „Usługa DNS/SRP” jest obecnie dodawana do danych sieci dotyczących wątków.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Wartości zwracane
TRUE
Opublikowany wpis usługi DNS/SRP jest dodawany do danych sieci dotyczących wątków.
FALSE
Wpis nie zostanie dodany do danych z sieci typu Thread lub nie będzie można go opublikować.

Dodano OTNetDataIsPrefiks

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Wskazuje, czy opublikowany już prefiks prefiksu (trasa typu mesh lub zewnętrzna) jest dodawany do danych sieci dotyczących wątków.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPrefix
Wskaźnik prefiksu (NIE MOŻE być NULL).
Wartości zwracane
TRUE
Opublikowany wpis z prefiksem jest dodawany do danych sieci dotyczących wątków.
FALSE
Wpis nie zostanie dodany do danych z sieci typu Thread lub nie będzie można go opublikować.

otNetDataOpublikujDnsSrpServiceanycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Wysyła zapytanie o adres „Cast” dowolnego adresu usługi DNS/SRP w celu opublikowania jego danych w sieci.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Wywołanie tej funkcji spowoduje usunięcie i zastąpienie wcześniejszego wpisu „Usługa DNS/SRP” (wcześniejszy wywołanie dowolnej funkcji otNetDataPublishDnsSrpService{Type}()).

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aSequenceNUmber
Numer sekwencyjny usługi DNS/SRP w dowolnej usłudze.

UsługaOotNetDataOpublikujDnsSrpService

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

Wysyła żądanie „Adresu Unicast DNS/SRP” w celu opublikowania w danych sieci dotyczących wątków.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Wywołanie tej funkcji spowoduje usunięcie i zastąpienie wcześniejszego wpisu „Usługa DNS/SRP” (wcześniejszy wywołanie dowolnej funkcji otNetDataPublishDnsSrpService{Type}()).

Publikuje „Adres Unicast DNS/SRP”, podając adres i numer portu w danych TLV usługi.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aAddress
Adres serwera DNS/SRP do opublikowania (NIE MOŻE być NULL).
[in] aPort
Numer portu serwera SRP do opublikowania.

otNetDataOpublikujDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Wysyła żądanie „Adresu Unicast DNS/SRP” w celu opublikowania w danych sieci dotyczących wątków.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Wywołanie tej funkcji spowoduje usunięcie i zastąpienie wcześniejszego wpisu „Usługa DNS/SRP” (wcześniejszy wywołanie dowolnej funkcji otNetDataPublishDnsSrpService{Type}()).

W odróżnieniu od zasady otNetDataPublishDnsSrpServiceUnicast(), która wymaga podania opublikowanego adresu i uwzględnia informacje w danych TLV usługi, funkcja ta używa lokalnego identyfikatora EID urządzenia i uwzględnia informacje w danych TLV serwera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPort
Numer portu serwera SRP do opublikowania.

TrasaOtNetDataOpublikuj

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

Wysyła żądanie zewnętrznego prefiksu trasy do opublikowania w danych sieci dotyczących wątków.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Można publikować tylko stabilne wpisy (np.aConfig.mStable MUSI mieć wartość TRUE).

Następne wywołanie tej metody zastąpi poprzednie żądanie tego samego prefiksu. W szczególności, jeśli nowe wywołanie spowoduje tylko zmianę flag (np. poziom preferencji), a prefiks został już dodany w danych sieci, zmiana flag zostanie natychmiast odzwierciedlona w danych sieci. Dzięki temu utworzone wpisy w danych sieciowych nie zostaną nagle usunięte. Pamiętaj, że zmiana poziomu preferencji może później spowodować usunięcie wpisu z danych sieci po określeniu, że istnieją inne węzły publikujące ten sam prefiks o takim samym lub wyższym priorytecie.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aConfig
Zewnętrzna konfiguracja trasy do opublikowania (NIE MOŻE być NULL).
Wartości zwracane
OT_ERROR_NONE
Trasa zewnętrzna została opublikowana.
OT_ERROR_INVALID_ARGS
aConfig jest nieprawidłowy (nieprawidłowy prefiks, nieprawidłowe kombinacje flagi lub niestabilne).
OT_ERROR_NO_BUFS
Nie udało się przydzielić wpisu do nowego żądania. Wydawca obsługuje ograniczoną liczbę pozycji (udostępnianych między prefiksem on-sh a ruchem zewnętrznym) określonym w konfiguracji OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

OTNetDataOpublikujOnMeshPrefiks

otError otNetDataPublishOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

Wysyła żądanie udostępnienia prefiksu siatki typu mesh w danych sieci dotyczących wątków.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Można publikować tylko stabilne wpisy (np.aConfig.mStable MUSI mieć wartość TRUE).

Następne wywołanie tej metody zastąpi poprzednie żądanie tego samego prefiksu. W szczególności, jeśli nowe wywołanie spowoduje tylko zmianę flag (np. poziom preferencji), a prefiks został już dodany w danych sieci, zmiana flag zostanie natychmiast odzwierciedlona w danych sieci. Dzięki temu utworzone wpisy w danych sieciowych nie zostaną nagle usunięte. Pamiętaj, że zmiana poziomu preferencji może później spowodować usunięcie wpisu z danych sieci po określeniu, że istnieją inne węzły publikujące ten sam prefiks o takim samym lub wyższym priorytecie.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aConfig
Konfiguracja prefiksu w sieci typu mesh, która ma zostać opublikowana (NIE MOŻE to być wartość NULL).
Wartości zwracane
OT_ERROR_NONE
Prefiks on-mesh został opublikowany.
OT_ERROR_INVALID_ARGS
aConfig jest nieprawidłowy (nieprawidłowy prefiks, nieprawidłowe kombinacje flagi lub niestabilne).
OT_ERROR_NO_BUFS
Nie udało się przydzielić wpisu do nowego żądania. Wydawca obsługuje ograniczoną liczbę pozycji (udostępnianych między prefiksem on-sh a ruchem zewnętrznym) określonym w konfiguracji OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

OTNetDataReplaceReleaseExternalRoute

otError otNetDataReplacePublishedExternalRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix,
  const otExternalRouteConfig *aConfig
)

Zastępuje wcześniej opublikowaną trasę zewnętrzną w danych sieci dotyczących wątków.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Jeśli nie ma żadnej opublikowanej trasy zewnętrznej pasującej do aPrefix, ta funkcja działa podobnie jak otNetDataPublishExternalRoute(), czyli rozpoczyna proces publikowania aConfig jako trasy zewnętrznej w danych sieci dotyczących wątków.

Jeśli opublikowany jest już wpis trasy pasujący do: aPrefix, zostanie on zastąpiony nowym prefiksem z tabeli aConfig.

  • Jeśli parametr aPrefix został już dodany w danych sieci, zmiana nowego prefiksu w aConfig zostanie natychmiast odzwierciedlona w danych sieciowych. Dzięki temu wpisy tras w danych sieci nie zostaną nagle usunięte, a przejście z aPrefiksa na nowy prefiks będzie przebiegało bezproblemowo.
  • Jeśli stara publikowana aPrefix nie została dodana do danych sieci, zostanie ona zastąpiona nowym prefiksem aConfig, ale nie zostanie dodana natychmiast. Zamiast tego rozpocznie proces publikowania danych sieciowych (monitorowanie danych sieciowych w celu określenia, kiedy lub czy dodać prefiks) w zależności od liczby podobnych prefiksów dostępnych w danych sieci.

Szczegóły
Parametry
[in] aPrefix
Poprzedni opublikowany prefiks trasy zewnętrznej do zastąpienia.
[in] aConfig
Zewnętrzna konfiguracja trasy do opublikowania.
[in] aRequester
Zgłaszający (kFromUser lub moduł kFromRoutingManager).
Wartości zwracane
OT_ERROR_NONE
Trasa zewnętrzna została opublikowana.
OT_ERROR_INVALID_ARGS
aConfig jest nieprawidłowy (nieprawidłowy prefiks, nieprawidłowe kombinacje flagi lub niestabilne).
OT_ERROR_NO_BUFS
Nie udało się przydzielić wpisu do nowego żądania. Wydawca obsługuje ograniczoną liczbę pozycji (udostępnianych między prefiksem on-sh a ruchem zewnętrznym) określonym w konfiguracji OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

OTNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

Zresetuj maksymalną długość danych z sieci dotyczących wątków.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zobacz też:
otNetDataGetMaxLength

Funkcja wywołania zwrotnego wywołania OTNetDataSetDnsSrpServicePublisherCallback

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

Konfiguruje wywołanie zwrotne informujące, kiedy opublikowana „usługa DNS/SRP” została dodana do danych sieci lub z nich usunięta.

Kolejne wywołanie tej funkcji zastępuje każdą ustawioną wcześniej funkcję wywołania zwrotnego.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aCallback
Wskaźnik wywołania zwrotnego (może być wartością NULL, jeśli nie jest potrzebny).
[in] aContext
Wskaźnik do kontekstu aplikacji (używany po wywołaniu elementu aCallback).

OTNetDataSetPrefiksWydawcyWywołania

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

Ustawia wywołanie zwrotne z powiadomieniem o dodaniu lub usunięciu opublikowanego prefiksu w danych sieci dotyczących wątków.

Kolejne wywołanie tej funkcji zastępuje każdą ustawioną wcześniej funkcję wywołania zwrotnego.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aCallback
Wskaźnik wywołania zwrotnego (może być wartością NULL, jeśli nie jest potrzebny).
[in] aContext
Wskaźnik do kontekstu aplikacji (używany po wywołaniu elementu aCallback).

Łącznik otNetDataSteeringDataCheck

otError otNetDataSteeringDataCheckJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

Sprawdź, czy dane dotyczące kierownicy zawierają złącze.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aEui64
Wskaźnik wskaźnika IEEE EUI-64 łącznika.
Wartości zwracane
OT_ERROR_NONE
Dane dotyczące układu kierowniczego są uwzględnione w danych aEui64.
OT_ERROR_INVALID_STATE
Brak danych dla kierownicy.
OT_ERROR_NOT_FOUND
Dane dotyczące układu kierowniczego nie są uwzględnione w parametrze aEui64.

Połączenie danych kontrolnych danych online

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

Sprawdź, czy dane układu kierowniczego zawierają złącze o określonej wartości dystrybutora.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDiscerner
Wskaźnik do konwertera.
Wartości zwracane
OT_ERROR_NONE
Dane dotyczące układu kierowniczego są uwzględnione w danych aDiscerner.
OT_ERROR_INVALID_STATE
Brak danych dla kierownicy.
OT_ERROR_NOT_FOUND
Dane dotyczące układu kierowniczego nie są uwzględnione w parametrze aDiscerner.

UsługaOotNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Cofnięcie publikacji dowolnego dodanego wcześniej wpisu DNS/SRP (anycast lub Unicast) z danych sieci dotyczących wątków.

Musisz włączyć OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

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

OTNetDataUnpublishPrefiks

otError otNetDataUnpublishPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Cofnięcie publikacji wcześniej opublikowanego prefiksu trasy w sieci typu mesh lub zewnętrznej.

Musisz włączyć OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPrefix
Prefiks do cofnięcia publikacji (NIE MOŻE być NULL).
Wartości zwracane
OT_ERROR_NONE
Cofnięto publikację prefiksu.
OT_ERROR_NOT_FOUND
Nie udało się znaleźć prefiksu na opublikowanej liście.

otTi

otError otThreadBecomeChild(
  otInstance *aInstance
)

Spróbuj ponownie dołączyć jako dziecko.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Wartości zwracane
OT_ERROR_NONE
Podjęto próbę podjęcia statusu dziecka.
OT_ERROR_INVALID_STATE
Wątek jest wyłączony.

TematPowolnyWątek

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Odłącz od sieci Thread.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Wartości zwracane
OT_ERROR_NONE
Odłączono od sieci Thread.
OT_ERROR_INVALID_STATE
Wątek jest wyłączony.

ottA Bezpłatnie

otError otThreadDetachGracefully(
  otInstance *aInstance,
  otDetachGracefullyCallback aCallback,
  void *aContext
)

Powiadamia inne węzły w sieci (jeśli takie istnieją), a następnie zatrzymuje działanie protokołu Thread.

W przypadku routera adres jest wysyłany przy użyciu funkcji Zwolnij adres lub ustawia wartość limitu czasu podrzędnego na 0, jeśli jest urządzeniem podrzędnym.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aCallback
Wskaźnik do funkcji wywoływanej po zakończeniu odłączenia.
[in] aContext
Wskaźnik do kontekstu wywołania zwrotnego aplikacji.
Wartości zwracane
OT_ERROR_NONE
Odłączono.
OT_ERROR_BUSY
Odłączanie jest już w toku.

TematWątkuNaUrządzenia

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Zmień rolę urządzenia na ciąg zrozumiały dla człowieka.

Szczegóły
Parametry
[in] aRole
Rola urządzenia do przekonwertowania.
Zwroty
Ciąg reprezentujący aRole.

otThreadDiscover

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

Rozpoczyna skanowanie wątków.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aScanChannels
Wektor wskazujący, które kanały mają być skanowane (np. OT_CHANNEL_11_MASK).
[in] aPanId
Filtr ID numeru PAN (ustawiony na potrzeby przesyłania numeru PAN, aby go wyłączyć).
[in] aJoiner
Wartość flagi towarzyszącej w żądaniu wykrywania treści.
[in] aEnableEui64Filtering
TRUE (prawda) w celu filtrowania odpowiedzi w EUI-64. W przeciwnym razie ma wartość FALSE (fałsz).
[in] aCallback
Wskaźnik określający funkcję otrzymywaną po otrzymaniu odpowiedzi MLE Discovery lub przeskanowaniu.
[in] aCallbackContext
Wskazanie kontekstu aplikacji.
Wartości zwracane
OT_ERROR_NONE
Skanowanie na wątki zostało rozpoczęte.
OT_ERROR_INVALID_STATE
Interfejs IPv6 nie jest włączony (netif nie jest włączony).
OT_ERROR_NO_BUFS
Nie udało się przydzielić wiadomości na potrzeby żądania wykrywania.
OT_ERROR_BUSY
Trwa skanowanie wątków.

Czas oczekiwania podręczny

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Pobiera podrzędny limit czasu wątku (w sekundach) używany podczas pracy w roli podmiotu podrzędnego.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość czasu oczekiwania wątku podrzędnego w sekundach.
Zobacz też:
otThreadSetChildTimeout

RolaPobieraniaWtyczek

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Poznaj rolę urządzenia.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Wartości zwracane
OT_DEVICE_ROLE_DISABLED
Stos wątków jest wyłączony.
OT_DEVICE_ROLE_DETACHED
Urządzenie nie należy obecnie do sieci/partycji wątku.
OT_DEVICE_ROLE_CHILD
Urządzenie działa obecnie jako wątek podrzędny.
OT_DEVICE_ROLE_ROUTER
Urządzenie działa obecnie jako router z wątkami.
OT_DEVICE_ROLE_LEADER
Urządzenie działa obecnie jako osoba odpowiedzialna za wątki.

Domena_OTT

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Pobiera nazwę domeny wątku.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do nazwy domeny wątku.
Zobacz też:
otThreadSetDOMAIN

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Pobiera identyfikator IEEE 802.15.4 PAN.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do rozszerzonego numeru PAN karty IEEE 802.15.4.
Zobacz też:
otThreadSetExtendedPanId

OTThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Pobiera ręcznie identyfikator interfejsu określony dla adresu Unicast domeny domeny.

Dostępne po włączeniu funkcji OPENTHREAD_CONFIG_DUA_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik ustawiony na identyfikator interfejsu ustawiony ręcznie lub NULL, jeśli nie został ustawiony.
Zobacz też:
otThreadSetFixedDuaInterfaceIdentifier

Liczniki OTThreadGetIp6

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Pobiera liczniki IPv6.

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

Licznik wątków

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Pobiera thrKeySessionCounter.

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

Przełącz

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Pobiera parametr thrKeySwitchGuardTime (w godzinach).

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość thrKeySwitchGuardTime (w godzinach).
Zobacz też:
otThreadSetKeySwitchGuardTime

DaneOotGetGeterData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Pobieranie danych osoby odpowiedzialnej za wątki.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aLeaderData
Wskaźnik określający, gdzie znajdują się dane lidera.
Wartości zwracane
OT_ERROR_NONE
Dane lidera zostały pobrane.
OT_ERROR_DETACHED
Obecnie nie podłączono.

ototGetLeaderRloc,

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Zwraca wskaźnik do RLOC lidera.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aLeaderRloc
Wskaźnik do RLOC przywódcy.
Wartości zwracane
OT_ERROR_NONE
Lista RLOC dla lidera została zapisana w: aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc miał wartość NULL.
OT_ERROR_DETACHED
Obecnie nie jest podłączony do partycji wątku.

Identyfikator OTThreadGetLeaderRouter

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Uzyskaj identyfikator routera lidera.

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

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Sprawdź wagę lidera.

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

OTThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Pobiera adres multicast wszystkich wątków wątków.

Adres to lokalny adres Multicast oparty na prefiksie [RFC 3306], który zawiera:

  • fryty ustawione na 3 (P = 1 i T = 1)
  • Scop ustawiony na 2
  • plener ustawiony na 64
  • Prefiks sieciowy ustawiony na lokalny prefiks sieci typu mesh
  • Identyfikator grupy ustawiony na 1

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do adresu multicast węzłów linków lokalnych.

OTThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Pobiera lokalny adres IPv6 linku Thread.

Adres lokalny linku w wątku jest określany na podstawie rozszerzonego adresu IEEE802.15.4.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik wskazujący lokalny adres IPv6 linku Thread.

Tryb pobierania wątków

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Pobieranie konfiguracji trybu linku MLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Konfiguracja trybu połączenia MLE.
Zobacz też:
otThreadSetLinkMode

Maksymalizowanie_czasu_wyszukiwania

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

Pobiera maksymalny czas przechowywania wiadomości w kolejce TX w kolejce.

Wymagane: OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Czas w kolejce jest śledzony tylko w przypadku transmisji bezpośrednich. Czas jest mierzony od momentu dodania wiadomości do kolejki przesyłania do momentu przekazania jej do warstwy MAC w celu jej przesłania lub usunięcia.

Zebrane statystyki można zresetować przez wywołanie otThreadResetTimeInQueueStat().

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Maksymalny czas oczekiwania w milisekundach w przypadku wszystkich wiadomości w kolejce TX.

Identyfikator_OTT

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Pobiera lokalny adres EID sieci typu mesh.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do lokalnego adresu EID sieci.

Prefiks wątku

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Zwraca wskaźnik do lokalnego prefiksu sieci typu mesh.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do lokalnego prefiksu sieci typu mesh.

Licznik_OTT

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Pobiera liczniki MLE w wątkach.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do liczników MLE wątku.

KluczPozyskiwaniaSieci

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Pobierz klucz sieciowy z wątku.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aNetworkKey
Wskaźnik otNetworkKey, który zwraca klucz sieciowy z wątkami.
Zobacz też:
otThreadSetNetworkKey

ototGetGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Pobierz otNetworkKeyRef klucza klucza sieciowego.

Wymaga włączenia funkcji czasu kompilacji OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Odwołanie do klucza sieciowego wątku zapisanego w pamięci.
Zobacz też:
otThreadSetNetworkKeyRef

Nazwa sieci_wątkowej

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Pobieranie nazwy sieci wątku.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do nazwy sieci typu Thread.
Zobacz też:
otThreadSetNetworkName

OTThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

Pobiera następną wiadomość dialektyczną sieci w wiadomości.

Wymagane: OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Następne wywołanie tej funkcji jest dozwolone tylko wtedy, gdy obecna wartość zwrotu to OT_ERROR_NONE.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do wiadomości.
[in,out] aIterator
Wskazanie kontekstu iteratora sieci. Aby uzyskać pierwszą TLV sieci diagnostycznej, ustaw wartość OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Wskaźnik określający, gdzie należy umieścić informacje dotyczące diagnostyki sieci.
Wartości zwracane
OT_ERROR_NONE
Udało się znaleźć kolejny diagnostyk sieci.
OT_ERROR_NOT_FOUND
Wiadomość nie zawiera kolejnego komunikatu diagnostycznego dotyczącego sieci.
OT_ERROR_PARSE
Nie udało się przeanalizować kolejnej diagnostyki.

otThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

Pobiera informacje o następnym sąsiadzie.

Służy do przechodzenia między tabelami sąsiadów.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in,out] aIterator
Wskazanie kontekstu iteratora. Aby uzyskać pierwszy wpis sąsiada, ustaw go na OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Wskaźnik do informacji sąsiadów.
Wartości zwracane
OT_ERROR_NONE
Następny wpis sąsiada został znaleziony w tabeli.
OT_ERROR_NOT_FOUND
Brak kolejnych wpisów sąsiadujących w tabeli.
OT_ERROR_INVALID_ARGS
aIterator lub aInfo miało wartość NULL.

OTThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

Funkcja pobiera średnią wartość RSSI dla elementu nadrzędnego wątku.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aParentRssi
Wskaźnik określający, gdzie znajduje się nadrzędny plik RSSI.

Temat

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

Funkcja pobiera jako dane nadrzędne informacje o routerze Thread Router.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aParentInfo
Wskaźnik określający, gdzie znajdują się informacje o routerze nadrzędnym.

Wątek

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

Funkcja pobiera RSSI ostatniego pakietu z wątku nadrzędnego.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aLastRssi
Wskaźnik określający, gdzie powinien się znaleźć ostatni RSSI.
Wartości zwracane
OT_ERROR_NONE
Dane RSSI zostały pobrane.
OT_ERROR_FAILED
Nie udało się pobrać danych RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi ma wartość NULL.

Identyfikator_w_dziele_wątku

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Pobieranie identyfikatora partycji.

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

OTThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Pobiera adres multicast węzłów Rzeczny-lokalny wątek.

Adres ten to lokalny adres multicast oparty na prefiksie Unicast [RFC 3306], który zawiera:

  • fryty ustawione na 3 (P = 1 i T = 1)
  • Scop ustawiony na 3
  • plener ustawiony na 64
  • Prefiks sieciowy ustawiony na lokalny prefiks sieci typu mesh
  • Identyfikator grupy ustawiony na 1

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do adresu multiemisji węzłów wszystkich wątków lokalnych.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Pobiera adres RLOC (Locator Routing Locator).

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do adresu RLOC (Location Routing Locator).

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Uzyskaj listę RLOC16.

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

UsługaOTOTGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

Pobiera ALOC usługi dla danego identyfikatora usługi.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aServiceId
Identyfikator usługi, dla której chcesz uzyskać dostęp do ALOC.
[out] aServiceAloc
Wskaźnik wyjściowy ALOC usługi. NIE MOŻE BYĆ NULL.
Wartości zwracane
OT_ERROR_NONE
Usługa ALOC została pobrana.
OT_ERROR_DETACHED
Interfejs wątku nie jest obecnie podłączony do partycji wątku.

Histogram

const uint32_t * otThreadGetTimeInQueueHistogram(
  otInstance *aInstance,
  uint16_t *aNumBins,
  uint32_t *aBinInterval
)

Pobiera histogram czasu wstawania wiadomości w kolejce.

Wymagane: OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Histogram przedstawiający czas przesyłania wiadomości w kolejce przesyłania. Czas w kolejce jest śledzony tylko w przypadku transmisji bezpośrednich. Czas jest mierzony od momentu dodania wiadomości do kolejki przesyłania do momentu przekazania jej do warstwy MAC w celu jej przesłania lub usunięcia.

Histogram jest zwracany jako tablica wartości uint32_t z wpisami aNumBins. Pierwszy wpis w tablicy (indeks 0) reprezentuje liczbę wiadomości w kolejce znajdujących się w kolejce mniejszej niż aBinInterval. Drugi wpis informuje o liczbie wiadomości w kolejce, która wynosi co najmniej aBinInterval, ale nie przekracza 2 * aBinInterval. I tak dalej. Ostatni wpis pokazuje liczbę wiadomości z czasem w kolejności wynoszącym co najmniej (aNumBins - 1) * aBinInterval.

Zebrane statystyki można zresetować przez wywołanie otThreadResetTimeInQueueStat(). Histogram zbiera się od czasu zainicjowania instancji OpenThread lub od ostatniego resetowania statystyk statystyk przez wywołanie otThreadResetTimeInQueueStat().

Wskaźniki aNumBins i aBinInterval NIE MOGĄ mieć wartości NULL.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aNumBins
Wskaźnik zwracający liczbę pojemników na histogramie (długość tablicy).
[out] aBinInterval
Wskaźnik, który zwraca długość histogramu w milisekundach.
Zwroty
Wskaźnik do tablicy aNumBins wpisów reprezentujących zebrane informacje histogramu.

OTThreadGetVendorModel

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

Pobierz ciąg modelu dostawcy.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Ciąg modelu dostawcy.

Nazwa_dostawcy_wątku

const char * otThreadGetVendorName(
  otInstance *aInstance
)

Pobierz ciąg nazwy dostawcy.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Ciąg nazwy dostawcy.

Wersja OTThreadGetVendorSwVersion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

Pobierz ciąg znaków wersji dostawcy sw dostawcy.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Ciąg tekstowy dostawcy w ramach funkcji sw

WersjaOtdzielGet

uint16_t otThreadGetVersion(
  void
)

Pobiera wersję protokołu Thread.

Szczegóły
Zwroty
wersję protokołu Thread.

ot online

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Wskazuje, czy żądanie lokalizacji dowolnego typu jest obecnie przetwarzane.

Jest dostępne tylko wtedy, gdy zasada OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE jest włączona.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
TRUE, jeśli dowolne żądanie lokalizacji przekierowania jest obecnie realizowane. W przeciwnym razie ma wartość FALSE.

otThreadtoDiscover w toku

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Określa, czy usługa MLE Thread Discovery jest obecnie w toku.

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

OTThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Wskazuje, czy węzeł jest jedynym routerem w sieci.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Wartości zwracane
TRUE
To jedyny router w sieci.
FALSE
To urządzenie podrzędne lub nie jest pojedynczym routerem w sieci.

otokLocate AnycastDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

Zwraca najbliższe miejsce docelowe danego adresu nadawcy.

Jest dostępne tylko wtedy, gdy zasada OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE jest włączona.

Jeśli poprzednie żądanie jest nadal przetwarzane, kolejne wywołanie tej funkcji spowoduje anulowanie i zastąpienie poprzedniego żądania.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aAnycastAddress
Dowolny adres do wyszukiwania. NIE MOŻE być NULL.
[in] aCallback
Funkcja wywołania zwrotnego zgłaszająca wynik.
[in] aContext
Dowolny kontekst używany z elementem aCallback.
Wartości zwracane
OT_ERROR_NONE
Żądanie zostało rozpoczęte. W celu zgłoszenia wyniku zostanie wywołana funkcja aCallback.
OT_ERROR_INVALID_ARGS
aAnycastAddress nie jest prawidłowym adresem typucast lub aCallback ma wartość NULL.
OT_ERROR_NO_BUFS
Brak bufora w celu przygotowania i wysłania wiadomości z żądaniem.

OTThreadRegisterParentResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

Rejestruje wywołanie zwrotne, które będzie otrzymywać dane odpowiedzi nadrzędnej MLE.

Wymagane: OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aCallback
Wskaźnik do funkcji, która jest wywoływana po otrzymaniu wiadomości nadrzędnej z odpowiedzi MLE.
[in] aContext
Wskazanie kontekstu kontekstowego klienta.

Liczniki OTThreadresetIp6

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Resetuje liczniki IPv6.

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

Licznik wiadomości

void otThreadResetMleCounters(
  otInstance *aInstance
)

Resetuje liczniki MLE wątku.

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

ZresetujBiegalnośćWątków

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

Resetuje statystyki dotyczące kolejki kolejki TX.

Wymagane: OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

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

TematPotokuWyszukiwania

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

Rozpoczyna proces znajdowania przez dziecko lepszego rodzica, zachowując jego zgodność z obecnym rodzicem.

Należy go używać, gdy urządzenie jest podłączone jako dziecko.

Szczegóły
Wartości zwracane
OT_ERROR_NONE
Rozpoczął się proces wyszukiwania lepszego rodzica.
OT_ERROR_INVALID_STATE
Rola urządzenia nie jest podrzędną.

OTThreadSendAddressNotification

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

Wysyła powiadomienie o aktywnym adresie (ADDR_NTF.ntf).

Jest dostępne tylko wtedy, gdy zasada OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE jest włączona.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDestination
Miejsce docelowe, do którego ma zostać wysłana wiadomość ADDR_NTF.ntf.
[in] aTarget
Adres docelowy wiadomości ADDR_NTF.ntf.
[in] aMlIid
Identyfikator ML-IID wiadomości ADDR_NTF.ntf.

OTThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

Wyślij żądanie diagnostyki sieci.

Wymagane: OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDestination
Wskaźnik do adresu miejsca docelowego.
[in] aTlvTypes
Tablica typów informacji diagnostycznych dotyczących sieci.
[in] aCount
Liczba typów w aTlvType.
[in] aCallback
Wskaźnik do funkcji, która jest wywoływana w chwili otrzymania odpowiedzi dotyczącej diagnostyki sieci lub wartości NULL, aby wyłączyć wywołanie zwrotne.
[in] aCallbackContext
Wskazanie kontekstu aplikacji.
Wartości zwracane
OT_ERROR_NONE
Plik DIAG_GET.req został dodany do kolejki.
OT_ERROR_NO_BUFS
Niewystarczająca ilość buforów wiadomości do wysłania pliku DIAG_GET.req.

OTThreadSendDiagnosticReset,

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

Wyślij żądanie resetowania sieci.

Wymagane: OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDestination
Wskaźnik do adresu miejsca docelowego.
[in] aTlvTypes
Tablica typów informacji diagnostycznych dotyczących sieci. Obecnie dozwolony jest tylko typ 9.
[in] aCount
Liczba typów w aTlvType
Wartości zwracane
OT_ERROR_NONE
Plik DIAG_RST.ntf został dodany do kolejki.
OT_ERROR_NO_BUFS
Niewystarczająca ilość buforów wiadomości do wysłania DIAG_RST.ntf.

OTThreadSendProactiveBackbonePowiadomienia

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

Wysyła wiadomość proaktywną powiadomienia o szkieletie (PRO_BB.ntf) w linku szkieletowym.

Jest dostępne tylko wtedy, gdy zasada OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE jest włączona.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aTarget
Adres docelowy wiadomości PRO_BB.ntf.
[in] aMlIid
Identyfikator ML-I komunikatu PRO_BB.ntf.
[in] aTimeSinceLastTransaction
Czas od ostatniej transakcji (w sekundach).
Wartości zwracane
OT_ERROR_NONE
E-mail PRO_BB.ntf dotyczący połączenia szkieletowego został wysłany.
OT_ERROR_NO_BUFS
Jeśli dostępnych jest za mało buforów wiadomości.

OTThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Ustawia w sekundach podrzędny limit czasu wątku używany podczas pracy w roli podrzędnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aTimeout
Czas oczekiwania (w sekundach).
Zobacz też:
otThreadGetChildTimeout

Wywołanie zwrotne otThreadSetDiscovery

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

Konfiguruje wywołanie zwrotne, które odbiera dane MLE Discovery Request.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aCallback
Wskaźnik do funkcji wywoływanej po otrzymaniu żądania żądania MLE Discovery.
[in] aContext
Wskaźnik do kontekstu wywołania zwrotnego aplikacji.

OTT

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

Ustawia nazwę domeny wątku.

Działa tylko wtedy, gdy wyłączone są protokoły Thread.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDomainName
Wskaźnik do nazwy domeny wątku.
Wartości zwracane
OT_ERROR_NONE
Nazwa domeny wątku została ustawiona.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.
Zobacz też:
otThreadGetDOMAIN

OTThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Rozpoczyna operację protokołu Thread.

Podczas wywoływania tej funkcji interfejs musi być aktywny.

Wywołanie tej funkcji z wartością aEnabled to FALSE powoduje zatrzymanie trwających procesów odłączania od funkcji otThreadDetachGraceful(). Jej wywołanie zwrotne.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aEnabled
TRUE, jeśli wątek jest włączony. W przeciwnym razie ma wartość FALSE.
Wartości zwracane
OT_ERROR_NONE
Operacja protokołu Thread została uruchomiona.
OT_ERROR_INVALID_STATE
Interfejs sieci nie był włączony.

OTThreadSetExtendedPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

Ustawia identyfikator IEEE 802.15.4.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aExtendedPanId
Wskaźnik do rozszerzonego numeru PAN karty IEEE 802.15.4.
Wartości zwracane
OT_ERROR_NONE
Identyfikator Rozszerzonego numeru PAN został ustawiony.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.
Zobacz też:
otThreadGetExtendedPanId

OTThreadSetFixedDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Ustawia lub usuwa identyfikator interfejsu ręczny określony dla adresu Unicast domeny wątku.

Dostępne po włączeniu funkcji OPENTHREAD_CONFIG_DUA_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aIid
Wskaźnik do ustawienia identyfikatora interfejsu, który ma zostać ustawiony, lub wartość NULL do wyczyszczenia.
Wartości zwracane
OT_ERROR_NONE
Ustawiono/wyczyszczono identyfikator interfejsu.
OT_ERROR_INVALID_ARGS
Podany identyfikator interfejsu jest zarezerwowany.
Zobacz też:
otThreadGetFixedDuaInterfaceIdentifier

ReklamapołączeniaOotTSet

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

Ustawia reklamę Łącznika wątków podczas wykrywania sieci Thread.

Reklama łącznika wątków jest wykorzystywana do umożliwienia Łącznikowi reklamowania własnych informacji o aplikacji (np. identyfikatora dostawcy, identyfikatora produktu, dystrybutora itp.) za pomocą nowo zaproponowanego łącznika.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aOui
Wartość OUI dostawcy, IEEE, która zostanie uwzględniona w reklamie towarzyszącej. Użyte zostaną tylko 3 najmniej istotne bajty, a największy bajt zostanie zignorowany.
[in] aAdvData
Wskaźnik AdvData, który zostanie uwzględniony w reklamie łączącej.
[in] aAdvDataLength
Długość danych typu AdvData w bajtach.
Wartości zwracane
OT_ERROR_NONE
Reklama łącznika została ustawiona.
OT_ERROR_INVALID_ARGS
Nieprawidłowe dane obiektu AdvData.

OTThreadSetKeySessionLicznik

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Ustawia thrKeySessionLicznik.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aKeySequenceCounter
Wartość thrKeySessionCounter.
Zobacz też:
otThreadGetKeySessionCounter

OTThreadSetKeySwitchGuard

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Ustawia thrKeySwitchGuardTime (w godzinach).

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aKeySwitchGuardTime
Wartość thrKeySwitchGuardTime (w godzinach).
Zobacz też:
otThreadGetKeySwitchGuardTime

TrybOTOTSetLink

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Ustaw konfigurację trybu linku MLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aConfig
Wskaźnik konfiguracji trybu linku.
Wartości zwracane
OT_ERROR_NONE
Konfiguracja trybu MLE połączenia została skonfigurowana.
Zobacz też:
otThreadGetLinkMode

OTThreadSetMeshLocalPrefiks

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

Ustawia lokalny prefiks sieci typu mesh.

Może działać tylko wtedy, gdy wyłączone są protokoły Thread. Udane wywołanie tej funkcji powoduje 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] aMeshLocalPrefix
Wskaźnik do lokalnego prefiksu sieci typu mesh.
Wartości zwracane
OT_ERROR_NONE
Lokalny prefiks sieci typu mesh został ustawiony.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.

KluczOOT

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

Ustaw klucz sieciowy dla wątków.

Może działać tylko wtedy, gdy wyłączone są protokoły Thread. Udane wywołanie tej funkcji powoduje 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] aKey
Wskaźnik do bufora zawierającego klucz sieciowy wątku.
Wartości zwracane
OT_ERROR_NONE
Klucz sieciowy Thread został ustawiony.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.
Zobacz też:
otThreadGetNetworkKey

ototSetSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Ustaw klucz sieci wątku jako otNetworkKeyRef.

Może działać tylko wtedy, gdy wyłączone są protokoły Thread. Udane wywołanie tej funkcji powoduje unieważnienie aktywnych i oczekujących zbiorów danych operacyjnych w pamięci nieulotnej.

Wymaga włączenia funkcji czasu kompilacji OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aKeyRef
Odwołanie do klucza sieciowego wątku.
Wartości zwracane
OT_ERROR_NONE
Klucz sieciowy Thread został ustawiony.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.
Zobacz też:
otThreadGetNetworkKeyRef

Nazwa zestawu wątków

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

Ustaw nazwę sieci wątku.

Może działać tylko wtedy, gdy wyłączone są protokoły Thread. Udane wywołanie tej funkcji powoduje 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] aNetworkName
Wskaźnik do nazwy sieci typu Thread.
Wartości zwracane
OT_ERROR_NONE
Nazwa sieci typu Thread została ustawiona.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.
Zobacz też:
otThreadGetNetworkName

OTThreadSetVendorModel

otError otThreadSetVendorModel(
  otInstance *aInstance,
  const char *aVendorModel
)

Ustaw ciąg modelu dostawcy.

Wymagane: OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorModel powinna mieć kodowanie UTF8 i maksymalnie 32 znaki (MAX_VENDOR_MODEL_TLV_LENGTH). Maksymalna długość nie zawiera pustego znaku \0.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aVendorModel
Ciąg modelu dostawcy.
Wartości zwracane
OT_ERROR_NONE
Model dostawcy został ustawiony.
OT_ERROR_INVALID_ARGS
Pole aVendorModel jest nieprawidłowe (zbyt długie lub nie ma UTF8).

Nazwa dostawcy

otError otThreadSetVendorName(
  otInstance *aInstance,
  const char *aVendorName
)

Ustaw ciąg nazwy dostawcy.

Wymagane: OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorName powinna mieć kodowanie UTF8 i maksymalnie 32 znaki (MAX_VENDOR_NAME_TLV_LENGTH). Maksymalna długość nie zawiera pustego znaku \0.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aVendorName
Ciąg nazwy dostawcy.
Wartości zwracane
OT_ERROR_NONE
Nazwa dostawcy została ustawiona.
OT_ERROR_INVALID_ARGS
Pole aVendorName jest nieprawidłowe (zbyt długie lub nie ma UTF8).

Wersja OTThreadSetVendorSwVersion

otError otThreadSetVendorSwVersion(
  otInstance *aInstance,
  const char *aVendorSwVersion
)

Ustaw ciąg wersji oprogramowania dostawcy.

Wymagane: OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorSwVersion powinna mieć kodowanie UTF8 i maksymalnie 16 znaków(MAX_VENDOR_SW_VERSION_TLV_LENGTH). Maksymalna długość nie zawiera pustego znaku \0.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aVendorSwVersion
Ciąg znaków wersji oprogramowania dostawcy.
Wartości zwracane
OT_ERROR_NONE
Wersja oprogramowania dostawcy została ustawiona.
OT_ERROR_INVALID_ARGS
Pole aVendorSwVersion jest nieprawidłowe (zbyt długie lub nie ma UTF8).

Makra

OT_DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

Zalecany rozmiar reprezentujący czas trwania (uint32_t) (w sekundach).

OT_JOINER_AD_DATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maksymalna długość danych reklamodawcy w reklamach łączących.

_DOGR._INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Inicjator otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maksymalna długość TLV wątku.

OT_SIECI_DO_NAZWY_SIECI

 OT_NETWORK_DATA_ITERATOR_INIT 0

Wartość do zainicjowania otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Rozmiar pozycji tabeli podrzędnej diagnostyki sieci.

OT_SIECI_DIAGNOSTYCZNE_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Inicjator otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_MAX_Thread_STACK_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

Maksymalna długość wersji stosu TLV.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

Maksymalna długość TLV dostawcy.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

Maksymalna długość TL nazwy dostawcy.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

Maksymalna długość wersji oprogramowania SWV dostawcy.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Maksymalna liczba typów TLV do diagnostyki sieci, które można zażądać lub zresetować.

DOGR._MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maksymalny identyfikator routera.

OT_SERWER_DANYCH_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Maksymalny rozmiar danych serwera w bajtach. Teoretycznie limit jest znacznie niższy.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Maksymalny rozmiar danych usługi w bajtach.

Zasoby

Tematy referencyjne interfejsu API OpenThread pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dodać treści do naszej dokumentacji, zapoznaj się z materiałami.