Ogólne

Ten moduł zawiera funkcje związane ze wszystkimi rolami w Thread.

Podsumowanie

Wydawca danych sieciowych udostępnia mechanizmy ograniczające liczbę podobnych wpisów dotyczących usługi lub prefiksu (prefiks sieci typu mesh lub trasy zewnętrznej) w danych sieci typu Thread, monitorując dane sieciowe i zarządzając tym, czy oraz kiedy dodać lub usunąć wpisy.

Wszystkie funkcje w tym module wymagają włączenia klasy 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 Thread.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
enum | typ wyliczeniowy
Reprezentuje zdarzenia zgłoszone w wywołaniach 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 dla pola mPreference w otExternalRouteConfig i otBorderRouterConfig.

Definicje typów

otBorderRouterConfig typedef
Reprezentuje konfigurację routera granicznego.
otDetachGracefullyCallback)(void *aContext) typedef
void(*
To wywołanie zwrotne informuje aplikację o zakończeniu procesu odłączania.
otExternalRouteConfig typedef
Reprezentuje konfigurację trasy zewnętrznej.
otIpCounters typedef
struct otIpCounters
Reprezentuje liczniki poziomu adresu IP.
otLeaderData typedef
struct otLeaderData
Reprezentuje dane lidera wątku.
otLinkModeConfig typedef
Reprezentuje konfigurację trybu linku MLE.
otLowpanContextInfo typedef
Reprezentuje informacje o identyfikatorze kontekstu 6LoWPAN powiązane z prefiksem w danych sieci.
otMleCounters typedef
struct otMleCounters
Reprezentuje liczniki MLE Thread.
otNeighborInfoIterator typedef
int16_t
Służy do iteracji z użyciem tabeli sąsiadów.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Typ wskaźnika określa wywołanie zwrotne używane do powiadamiania o dodaniu pozycji „Usługa DNS/SRP” do danych sieci Thread lub ich usunięciu.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
Typ wskaźnika określa wywołanie zwrotne używane do powiadamiania o dodaniu prefiksu (na siatce lub trasie zewnętrznej) do danych sieci typu Thread lub ich usunięcia.
otNetDataPublisherEvent typedef
Reprezentuje zdarzenia zgłoszone w wywołaniach zwrotnych wydawcy.
otNetworkDataIterator typedef
uint32_t
Służy do iteracji z wykorzystaniem informacji dotyczących danych sieci.
otNetworkDiagChildEntry typedef
Reprezentuje wpis tabeli podrzędnej diagnostyki sieci.
otNetworkDiagConnectivity typedef
Reprezentuje wartość diagnostyki połączeń sieci.
otNetworkDiagIterator typedef
uint16_t
Służy do iteracji za pomocą TLV diagnostyki sieci.
otNetworkDiagMacCounters typedef
Reprezentuje wartość liczników diagnostyki sieci na Macu.
otNetworkDiagMleCounters typedef
Reprezentuje wartość liczników MLE diagnostyki sieci.
otNetworkDiagRoute typedef
Reprezentuje wartość TLV trasy diagnostyki sieci.
otNetworkDiagRouteData typedef
Reprezentuje dane trasy diagnostycznej sieci.
otNetworkDiagTlv typedef
Reprezentuje TLV diagnostyki sieci.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
Wskaźnik jest wywoływany po otrzymaniu odpowiedzi na żądanie diagnostyki sieci.
otRoutePreference typedef
Określa prawidłowe wartości dla pola mPreference w otExternalRouteConfig i otBorderRouterConfig.
otServerConfig typedef
Reprezentuje konfigurację serwera.
otServiceConfig typedef
Reprezentuje konfigurację usługi.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
Typ wskaźnika określa wywołanie zwrotne powiadamiające o wyniku żądania otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Wskaźnik jest wywoływany za każdym razem, gdy otrzymasz wiadomość żądania wykrywania MLE.
otThreadDiscoveryRequestInfo typedef
Reprezentuje dane żądania wykrywania Thread.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Wskaźnik jest wywoływany za każdym razem, gdy otrzymana jest wiadomość nadrzędna MLE.
otThreadParentResponseInfo typedef
Reprezentuje dane odpowiedzi nadrzędnej MLE.

Funkcje

otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)
void
Konwertuje czas trwania uint32_t (w sekundach) na ciąg znaków zrozumiały dla człowieka.
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Sprawdź, czy dany prefiks może działać jako prawidłowy prefiks OMR i czy zawiera go dane sieciowe repliki wiodącej.
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Udostępnij pełną lub stabilną kopię danych sieci typu Thread partycji.
otNetDataGetCommissioningDataset(otInstance *aInstance, otCommissioningDataset *aDataset)
void
Pobiera zbiór danych na zlecenie z danych sieci partycji.
otNetDataGetLength(otInstance *aInstance)
uint8_t
Pobierz bieżącą długość (liczbę bajtów) danych sieci w łańcuchu partycji.
otNetDataGetMaxLength(otInstance *aInstance)
uint8_t
Uzyskaj maksymalną zaobserwowaną długość danych sieci typu Thread od zainicjowania stosu OT lub od ostatniego wywołania otNetDataResetMaxLength().
otNetDataGetNextLowpanContextInfo(otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
Pobierz następne informacje o identyfikatorze kontekstu 6LoWPAN z danych sieci partycji.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Znajdź następny prefiks sieci typu mesh w danych sieciowych partycji.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Pobierz następną trasę zewnętrzną w danych sieciowych partycji.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Pobierz następną usługę z danych sieci partycji.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
Pobierz stabilną wersję danych sieciowych.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Pobierz wersję danych sieciowych
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Wskazuje, czy obecnie wpis „Usługa DNS/SRP” jest dodany do danych sieci typu Thread.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Wskazuje, czy do danych sieci typu Thread jest obecnie dodawany opublikowany prefiks (trasa w siatce lub trasa zewnętrzna).
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Wysyła prośbę o opublikowanie „Adres Anycast usługi DNS/SRP” w danych sieci Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Wysyła prośbę o opublikowanie adresu Unicast usługi DNS/SRP w danych sieci Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Wysyła prośbę o opublikowanie adresu Unicast usługi DNS/SRP w danych sieci Thread.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Żąda prefiksu trasy zewnętrznej, który zostanie opublikowany w danych sieci typu Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Żąda prefiksu on-mesh, który zostanie opublikowany w danych sieci typu Thread.
otNetDataReplacePublishedExternalRoute(otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
Zastępuje wcześniej opublikowaną trasę zewnętrzną w danych sieci Thread.
otNetDataResetMaxLength(otInstance *aInstance)
void
Zresetuj śledzoną maksymalną długość danych sieci typu Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Ustawia wywołanie zwrotne informujące o tym, że opublikowana usługa DNS/SRP została faktycznie dodana do danych sieci typu Thread lub z nich usunięta.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Ustawia wywołanie zwrotne informujące, że opublikowany wpis prefiksu został faktycznie dodany do danych sieci typu Thread lub z niego usunięty.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Sprawdź, czy dane sterowania obejmują łącznik.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Sprawdź, czy dane kierowania obejmują łącznik o danej wartości wyróżniającej.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Cofa publikację dowolnego dodanego wcześniej wpisu usługi DNS/SRP (Anycast lub Unicast) w danych sieci Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Cofa opublikowane wcześniej prefiksy trasy On-Mesh lub zewnętrznej.
otThreadBecomeChild(otInstance *aInstance)
Spróbuj ponownie dołączyć plik jako podrzędny.
otThreadBecomeDetached(otInstance *aInstance)
Odłącz się od sieci Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Informuje o innych węzłach w sieci (jeśli istnieją), a następnie zatrzymuje działanie protokołu Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Przekonwertuj rolę urządzenia na ciąg znaków zrozumiały dla człowieka.
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Uruchamia skanowanie wykrywania Thread.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Pobiera czas oczekiwania elementu podrzędnego Thread (w sekundach) używany podczas wykonywania operacji w roli podrzędnej.
otThreadGetDeviceRole(otInstance *aInstance)
Pobierz rolę urządzenia.
otThreadGetDomainName(otInstance *aInstance)
const char *
Pobiera nazwę domeny wątku.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Pobiera rozszerzony identyfikator PAN IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Pobiera identyfikator interfejsu określony ręcznie dla adresu Unicast domeny Thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Pobiera liczniki IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Pobiera thrKeySequenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Pobiera wartość thrKeySwitchGuardTime (w godzinach).
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Pobierz dane Thread Leader.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Zwraca wskaźnik do RLOC lidera.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Pobierz identyfikator routera lidera.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Waga lidera.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Pobiera adres multiemisji połączenia wątku – lokalnego folderu wszystkich węzłów.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Pobiera lokalny adres IPv6 linku Thread.
otThreadGetLinkMode(otInstance *aInstance)
Pobierz konfigurację trybu linku MLE.
otThreadGetMaxTimeInQueue(otInstance *aInstance)
uint32_t
Pobiera maksymalny czas w kolejce dla wiadomości w kolejce TX.
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 Thread.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Pobierz klucz sieciowy Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Pobierz otNetworkKeyRef dla klucza sieciowego Thread.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Uzyskiwanie nazwy sieci Thread.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Pobiera w wiadomości następny ciąg TLV diagnostyki sieci.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Pobiera następne informacje o sąsiadach.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
Funkcja pobiera średnią wartość RSSI dla elementu nadrzędnego wątku.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
Funkcja pobiera informacje diagnostyczne dotyczące routera Thread Router jako elementu nadrzędnego.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
Funkcja pobiera RSSI ostatniego pakietu z elementu nadrzędnego wątku.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Pobierz identyfikator partycji.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Pobiera adres multiemisji wszystkich węzłów w Thread Realm.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Pobiera adres lokalizatora routingu wątków (Thread Routing Locator, RLOC).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Pobierz RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Pobiera ALOC usługi dla podanego identyfikatora usługi.
otThreadGetTimeInQueueHistogram(otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)
const uint32_t *
Pobiera histogram czasu w kolejce dla wiadomości w kolejce TX.
otThreadGetVendorModel(otInstance *aInstance)
const char *
Pobierz ciąg znaków modelu dostawcy.
otThreadGetVendorName(otInstance *aInstance)
const char *
Pobierz ciąg z nazwą dostawcy.
otThreadGetVendorSwVersion(otInstance *aInstance)
const char *
Pobierz ciąg znaków wersji dostawcy sw.
otThreadGetVersion(void)
uint16_t
Pobiera wersję protokołu Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Wskazuje, czy jest obecnie przetwarzane żądanie lokalizacji lokalnej.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Określa, czy trwa obecnie wykrywanie wątków MLE.
otThreadIsSingleton(otInstance *aInstance)
bool
Wskazuje, czy węzeł jest jedynym routerem w sieci.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Zgłasza najbliższe miejsce docelowe danego adresu dowolnego typu.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Rejestruje wywołanie zwrotne w celu odebrania danych odpowiedzi rodzica MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Resetuje liczniki IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Resetuje liczniki MLE Thread.
otThreadResetTimeInQueueStat(otInstance *aInstance)
void
Resetuje statystyki czasu w kolejce TX.
otThreadSearchForBetterParent(otInstance *aInstance)
Rozpoczyna proces wyszukiwania przez dziecko lepszego elementu nadrzędnego, pozostawiając przy sobie bieżący element nadrzędny.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Wysyła wiadomość proaktywne powiadomienie adresowe (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 diagnostyki sieci.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Wysyła wiadomość Proactive Backbone Notification (PRO_BB.ntf) przez link Backbone.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Określa czas oczekiwania elementu podrzędnego wątku (w sekundach) używany podczas wykonywania działań w roli podrzędnej.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Ustawia wywołanie zwrotne odbierające dane żądania wykrywania MLE.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
Ustawia nazwę domeny wątku.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Uruchamia operację protokołu Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Ustawia rozszerzony identyfikator PAN IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Ustawia lub usuwa identyfikator interfejsu określony ręcznie dla adresu Unicast domeny Thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Konfiguruje reklamę typu Thread Joiner podczas wykrywania sieci Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Ustawia parametr thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Ustawia wartość 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 Thread.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Ustaw klucz sieci Thread jako otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Ustaw nazwę sieci typu Thread.
otThreadSetVendorModel(otInstance *aInstance, const char *aVendorModel)
Ustaw ciąg znaków modelu dostawcy.
otThreadSetVendorName(otInstance *aInstance, const char *aVendorName)
Ustaw ciąg znaków z nazwą dostawcy.
otThreadSetVendorSwVersion(otInstance *aInstance, const char *aVendorSwVersion)
Ustaw ciąg znaków wersji oprogramowania dostawcy.

Konstrukcja

otBorderRouterConfig

Reprezentuje konfigurację routera granicznego.

otExternalRouteConfig

Reprezentuje konfigurację trasy zewnętrznej.

otIpCounters

Reprezentuje liczniki poziomu adresu IP.

otLeaderData

Reprezentuje dane lidera wątku.

otLinkModeConfig

Reprezentuje konfigurację trybu linku MLE.

otLowpanContextInfo

Reprezentuje informacje o identyfikatorze kontekstu 6LoWPAN powiązane z prefiksem w danych sieci.

otMleCounters

Reprezentuje liczniki MLE Thread.

otNeighborInfo

Przechowuje informacje diagnostyczne o sąsiednim węźle Thread.

otNetworkDiagChildEntry

Reprezentuje wpis tabeli podrzędnej diagnostyki sieci.

otNetworkDiagConnectivity

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

otNetworkDiagMacCounters

Reprezentuje wartość liczników diagnostyki sieci na Macu.

otNetworkDiagMleCounters

Reprezentuje wartość liczników MLE diagnostyki sieci.

otNetworkDiagRoute

Reprezentuje wartość TLV trasy diagnostyki sieci.

otNetworkDiagRouteData

Reprezentuje dane trasy diagnostycznej sieci.

otNetworkDiagTlv

Reprezentuje TLV diagnostyki sieci.

otRouterInfo

Przechowuje informacje diagnostyczne dotyczące routera Thread.

otServerConfig

Reprezentuje konfigurację serwera.

otServiceConfig

Reprezentuje konfigurację usługi.

otThreadDiscoveryRequestInfo

Reprezentuje dane żądania wykrywania Thread.

otThreadParentResponseInfo

Reprezentuje dane odpowiedzi nadrzędnej MLE.

Wyliczenia

anonimowe wyliczenie

 anonymous enum
Właściwości
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER

Odpowiedz: TLV.

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

TLV poziomu baterii.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV stron kanału.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

Podrzędny zespół pomocy.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

TLV listy podrzędnych adresów IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

TLV tabeli podrzędnej.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV związane z łącznością.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV rozszerzonego adresu MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV listy adresów IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

Leader Data TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

TLV adresów MAC.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

Maksymalny czas oczekiwania elementu podrzędnego na serwer.

OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS

Liczniki MLE TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Tryb TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV danych dotyczących sieci.

OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID

Identyfikator zapytania TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR

TLV sąsiada routera.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Adres16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Napięcie TLV.

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

TLV wersji stosu wątków.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Przekroczony limit czasu TLV (maksymalny czas odpytywania dla SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Wpisz listę TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL

TLV modelu dostawcy.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME

Nazwa dostawcy TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION

Wersja TLV dostawcy oprogramowania.

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

Wersja TLV.

otDeviceRole

 otDeviceRole

Reprezentuje rolę urządzenia Thread.

Właściwości
OT_DEVICE_ROLE_CHILD

Rola podrzędna wątku.

OT_DEVICE_ROLE_DETACHED

Nie uczestniczy obecnie w sieci/partycji Thread.

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ątków.

otNetDataPublisherEvent

 otNetDataPublisherEvent

Reprezentuje zdarzenia zgłoszone w wywołaniach 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.

otRoutePreference

 otRoutePreference

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

Właściwości
OT_ROUTE_PREFERENCE_HIGH

Preferowana trasa.

OT_ROUTE_PREFERENCE_LOW

Niski preferowany wybór trasy.

OT_ROUTE_PREFERENCE_MED

Preferowana średnia trasa.

Definicje typów

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Reprezentuje konfigurację routera granicznego.

otDetachGracefullyCallback

void(* otDetachGracefullyCallback)(void *aContext)

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

Szczegóły
Parametry
[in] aContext
Wskaźnik do kontekstu aplikacji.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Reprezentuje konfigurację trasy zewnętrznej.

otIpCounters

struct otIpCounters otIpCounters

Reprezentuje liczniki poziomu adresu IP.

otLeaderData

struct otLeaderData otLeaderData

Reprezentuje dane lidera wątku.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Reprezentuje konfigurację trybu linku MLE.

otLowpanContextInfo

struct otLowpanContextInfo otLowpanContextInfo

Reprezentuje informacje o identyfikatorze kontekstu 6LoWPAN powiązane z prefiksem w danych sieci.

otMleCounters

struct otMleCounters otMleCounters

Reprezentuje liczniki MLE Thread.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Służy do iteracji z użyciem tabeli sąsiadów.

otNetDataDnsSrpServicePublisherCallback

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

Typ wskaźnika określa wywołanie zwrotne używane do powiadamiania o dodaniu pozycji „Usługa DNS/SRP” do danych sieci Thread lub ich usunięciu.

Przy usuwaniu wywołanie zwrotne jest wywoływane niezależnie od tego, czy wpis został usunięty przez Publisher (np. gdy w danych dotyczących sieci jest już zbyt wiele podobnych wpisów) czy przez bezpośrednie wywołanie w celu cofnięcia publikacji wpisu (np. wywołanie otNetDataUnpublishDnsSrpService()).

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

otNetDataPrefixPublisherCallback

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

Typ wskaźnika określa wywołanie zwrotne używane do powiadamiania o dodaniu prefiksu (na siatce lub trasie zewnętrznej) do danych sieci typu Thread lub ich usunięcia.

W momencie usunięcia wywołanie zwrotne jest wywoływane niezależnie od tego, czy wpis został usunięty przez Publisher (np. gdy w danych dotyczących sieci jest już zbyt wiele podobnych wpisów), czy też przez bezpośrednie wywołanie w celu cofnięcia publikacji wpisu.

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

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Reprezentuje zdarzenia zgłoszone w wywołaniach zwrotnych wydawcy.

otNetworkDataIterator

uint32_t otNetworkDataIterator

Służy do iteracji z wykorzystaniem informacji dotyczących danych sieci.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Reprezentuje wpis tabeli podrzędnej diagnostyki sieci.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

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

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

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

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Reprezentuje wartość liczników diagnostyki sieci na Macu.

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

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

Reprezentuje wartość liczników MLE diagnostyki sieci.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Reprezentuje wartość TLV trasy diagnostyki sieci.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Reprezentuje dane trasy diagnostycznej sieci.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Reprezentuje TLV diagnostyki sieci.

otReceiveDiagnosticGetCallback

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

Wskaźnik jest wywoływany po otrzymaniu odpowiedzi na żądanie diagnostyki sieci.

Szczegóły
Parametry
[in] aError
Błąd, który wystąpił, gdy nie udało się uzyskać odpowiedzi.
[in] aMessage
Wskaźnik do bufora wiadomości zawierającego odebrany ładunek odpowiedzi na potrzeby diagnostyki sieci. Funkcja dostępna tylko wtedy, gdy aError ma wartość OT_ERROR_NONE.
[in] aMessageInfo
Wskaźnik do informacji o wiadomości dla adresu aMessage. Funkcja dostępna tylko wtedy, gdy aError ma wartość OT_ERROR_NONE.
[in] aContext
Wskaźnik do kontekstu aplikacji.

otRoutePreference

enum otRoutePreference otRoutePreference

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

otServerConfig

struct otServerConfig otServerConfig

Reprezentuje konfigurację serwera.

otServiceConfig

struct otServiceConfig otServiceConfig

Reprezentuje konfigurację usługi.

otThreadAnycastLocatorCallback

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

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

Szczegóły
Parametry
[in] aContext
Wskaźnik do dowolnego kontekstu (podanego, gdy zarejestrowane jest wywołanie zwrotne).
[in] aError
Błąd podczas obsługi żądania. OT_ERROR_NONE oznacza, że wystąpiły. OT_ERROR_odpowiedź_TIMEOUT oznacza, że nie udało się znaleźć miejsca docelowego. OT_ERROR_ABORT wskazuje, że żądanie zostało przerwane.
[in] aMeshLocalAddress
Wskaźnik do lokalnego identyfikatora EID najbliższego miejsca docelowego adresu Anycast, gdy aError ma wartość OT_ERROR_NONE. W przeciwnym razie ma wartość NULL.
[in] aRloc16
Znaleziono RLOC16 miejsca docelowego, jeśli jest inny, nieprawidłowy RLOC16 (0xfffe).

otThreadDiscoveryRequestCallback

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

Wskaźnik jest wywoływany za każdym razem, gdy otrzymasz wiadomość żądania wykrywania MLE.

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

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Reprezentuje dane żądania wykrywania Thread.

otThreadParentResponseCallback

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

Wskaźnik jest wywoływany za każdym razem, gdy otrzymana jest wiadomość nadrzędna MLE.

Jest ona używana w aplikacji otThreadRegisterParentResponseCallback().

Szczegóły
Parametry
[in] aInfo
Wskaźnik do lokalizacji na stosie zawierającym dane statystyk.
[in] aContext
Wskaźnik odwołujący się do kontekstu klienta dotyczącego wywołania zwrotnego.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Reprezentuje dane odpowiedzi nadrzędnej MLE.

Funkcje

otConvertDurationInSecondsToString

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

Konwertuje czas trwania uint32_t (w sekundach) na ciąg znaków zrozumiały dla człowieka.

Wymaga włączenia zasady OPENTHREAD_CONFIG_UPTIME_ENABLE.

Ciąg ma format „::” oznaczający godziny, minuty i sekundy (jeśli czas trwania jest krótszy niż jeden dzień) lub „”.

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

Jeśli powstały ciąg znaków nie mieści się w polu aBuffer (łącznie ze znakami aSize), zostanie on obcięty, ale wyjściowy ciąg będzie zawsze miał wartość null.

Przeznaczona do stosowania z zasadą mAge lub mConnectionTime w domach otNeighborInfo lub otChildInfo.

Szczegóły
Parametry
[in] aDuration
Odstęp czasu trwania w sekundach.
[out] aBuffer
Wskaźnik do tablicy znaków generujący ciąg znaków.
[in] aSize
Rozmiar elementu aBuffer (w bajtach). Zalecane użycie: OT_DURATION_STRING_SIZE.

otNetDataContainsOmrPrefix

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

Sprawdź, czy dany prefiks może działać jako prawidłowy prefiks OMR i czy zawiera go dane sieciowe repliki wiodącej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPrefix
Wskaźnik do prefiksu IPv6.
Zwroty
Określa, czy aPrefix jest prawidłowym prefiksem OMR, a dane sieci repliki wiodącej zawierają prefiks OMR aPrefix.

otNetDataGet

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

Udostępnij pełną lub stabilną kopię danych sieci typu Thread partycji.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aStable
Wartość TRUE (prawda) w przypadku kopiowania wersji stabilnej, wartość FALSE (FAŁSZ) podczas kopiowania pełnej wersji.
[out] aData
Wskaźnik do bufora danych.
[in,out] aDataLength
Przy wprowadzaniu rozmiar bufora danych wskazywany przez wartość aData. Przy zamykaniu, liczba skopiowanych bajtów.
Zwracane wartości
OT_ERROR_NONE
Dane sieciowe Thread zostały skopiowane do folderu aData i zaktualizowane aDataLength.
OT_ERROR_NO_BUFS
Za mało miejsca w usłudze aData, aby skopiować w pełni dane sieci typu Thread.

otNetDataGetCommissioningDataset

void otNetDataGetCommissioningDataset(
  otInstance *aInstance,
  otCommissioningDataset *aDataset
)

Pobiera zbiór danych na zlecenie z danych sieci partycji.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aDataset
Wskaźnik do wypełnienia: otCommissioningDataset.

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

Pobierz bieżącą długość (liczbę bajtów) danych sieci w łańcuchu partycji.

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

otNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

Uzyskaj maksymalną zaobserwowaną długość danych sieci typu Thread od 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 (duży znak wody przy długości danych sieciowych).

otNetDataGetNextLowpanContextInfo

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

Pobierz następne informacje o identyfikatorze kontekstu 6LoWPAN z danych sieci partycji.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in,out] aIterator
Wskaźnik do iteratora danych sieci. Aby można było uzyskać pierwszy wpis usługi, powinien on mieć wartość OT_NETWORK_DATA_ITERATOR_INIT.
[out] aContextInfo
Wskaźnik, w którym zostaną umieszczone pobrane informacje o identyfikatorze kontekstu 6LoWPAN.
Zwracane wartości
OT_ERROR_NONE
Udało się znaleźć następne informacje o identyfikatorze kontekstu 6LoWPAN.
OT_ERROR_NOT_FOUND
W danych sieci partycji nie ma kolejnych informacji o kontekście 6LoWPAN.

otNetDataGetNextOnMeshPrefix

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

Znajdź następny prefiks sieci typu mesh w danych sieciowych partycji.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in,out] aIterator
Wskaźnik kontekstu iteratora danych sieciowych. Aby uzyskać pierwszy wpis w siatce, powinien on mieć wartość OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Wskaźnik miejsca, w którym zostaną umieszczone informacje o prefiksie On mesh.
Zwracane wartości
OT_ERROR_NONE
Udało się znaleźć następny prefiks On Mesh.
OT_ERROR_NOT_FOUND
W danych sieci typu Thread nie ma kolejnego prefiksu On Mesh.

otNetDataGetNextRoute

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

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

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in,out] aIterator
Wskaźnik kontekstu iteratora danych sieciowych. Aby można było uzyskać pierwszy wpis trasy zewnętrznej, powinien on mieć wartość OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Wskaźnik, w którym zostaną umieszczone informacje o trasie zewnętrznej.
Zwracane wartości
OT_ERROR_NONE
Udało się znaleźć następną trasę zewnętrzną.
OT_ERROR_NOT_FOUND
W danych sieci typu Thread nie ma kolejnego wpisu trasy zewnętrznej.

otNetDataGetNextService

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

Pobierz następną usługę z danych sieci partycji.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in,out] aIterator
Wskaźnik kontekstu iteratora danych sieciowych. Aby można było uzyskać pierwszy wpis usługi, powinien on mieć wartość OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Wskaźnik, w którym zostaną umieszczone informacje o usłudze.
Zwracane wartości
OT_ERROR_NONE
Udało się znaleźć następną usługę.
OT_ERROR_NOT_FOUND
W danych sieci partycji nie ma kolejnej usługi.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Pobierz stabilną wersję danych sieciowych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Stabilna wersja danych sieci.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Pobierz wersję danych sieciowych

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

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Wskazuje, czy obecnie wpis „Usługa DNS/SRP” jest dodany do danych sieci typu Thread.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwracane wartości
TRUE
Opublikowany wpis usługi DNS/SRP zostanie dodany do danych sieci Thread.
FALSE
Wpis nie zostanie dodany do danych sieci typu Thread lub nie ma wpisu do opublikowania.

otNetDataIsPrefixAdded

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

Wskazuje, czy do danych sieci typu Thread jest obecnie dodawany opublikowany prefiks (trasa w siatce lub trasa zewnętrzna).

Wymaga włączenia funkcji OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPrefix
Wskaźnik do prefiksu (NIE MOŻE zawierać wartości NULL).
Zwracane wartości
TRUE
Opublikowany prefiks zostanie dodany do danych sieci typu Thread.
FALSE
Wpis nie zostanie dodany do danych sieci typu Thread lub nie ma wpisu do opublikowania.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Wysyła prośbę o opublikowanie „Adres Anycast usługi DNS/SRP” w danych sieci Thread.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Wywołanie tej funkcji spowoduje usunięcie i zastąpienie wszelkiego poprzedniego wpisu „DNS/SRP Service” (Usługi DNS/SRP), który był publikowany (z wcześniejszego wywołania dowolnej z funkcji otNetDataPublishDnsSrpService{Type}()).

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

otNetDataPublishDnsSrpServiceUnicast

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

Wysyła prośbę o opublikowanie adresu Unicast usługi DNS/SRP w danych sieci Thread.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Wywołanie tej funkcji spowoduje usunięcie i zastąpienie wszelkiego poprzedniego wpisu „DNS/SRP Service” (Usługi DNS/SRP), który był publikowany (z wcześniejszego wywołania dowolnej z funkcji otNetDataPublishDnsSrpService{Type}()).

Publikuje „Adres Unicast usługi DNS/SRP”, dołączając adres i informacje o porcie 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 zawierać wartości NULL).
[in] aPort
Numer portu serwera SRP do opublikowania.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Wysyła prośbę o opublikowanie adresu Unicast usługi DNS/SRP w danych sieci Thread.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

Wywołanie tej funkcji spowoduje usunięcie i zastąpienie wszelkiego poprzedniego wpisu „DNS/SRP Service” (Usługi DNS/SRP), który był publikowany (z wcześniejszego wywołania dowolnej z funkcji otNetDataPublishDnsSrpService{Type}()).

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

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

otNetDataPublishExternalRoute

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

Żąda prefiksu trasy zewnętrznej, który zostanie opublikowany w danych sieci typu Thread.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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

Kolejne wywołanie tej metody spowoduje zastąpienie poprzedniego żądania dotyczącego tego samego prefiksu. W szczególności, jeśli w nowym wywołaniu zmieni się tylko flagi (np. na poziomie preferencji), a prefiks został już dodany w danych dotyczących sieci, zmiana flag jest natychmiast odzwierciedlana w danych sieci. Dzięki temu istniejące wpisy w danych sieci nie są nagle usuwane. Pamiętaj, że zmiana poziomu preferencji może później spowodować usunięcie wpisu z danych sieci po określeniu, że inne węzły publikują ten sam prefiks z takimi samymi lub wyższymi preferencjami.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aConfig
Konfiguracja trasy zewnętrznej do opublikowania (NIE MOŻE zawierać wartości NULL).
Zwracane wartości
OT_ERROR_NONE
Trasa zewnętrzna została opublikowana.
OT_ERROR_INVALID_ARGS
aConfig jest nieprawidłowy (zły prefiks, nieprawidłowe kombinacje flag lub niestabilne).
OT_ERROR_NO_BUFS
Nie udało się przydzielić wpisu dla nowego żądania. Wydawca obsługuje ograniczoną liczbę wpisów (współdzielonych między prefiksem sieci typu mesh i trasą zewnętrzną) zgodnie z konfiguracją OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataPublishOnMeshPrefix

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

Żąda prefiksu on-mesh, który zostanie opublikowany w danych sieci typu Thread.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

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

Kolejne wywołanie tej metody spowoduje zastąpienie poprzedniego żądania dotyczącego tego samego prefiksu. W szczególności, jeśli w nowym wywołaniu zmieni się tylko flagi (np. na poziomie preferencji), a prefiks został już dodany w danych dotyczących sieci, zmiana flag jest natychmiast odzwierciedlana w danych sieci. Dzięki temu istniejące wpisy w danych sieci nie są nagle usuwane. Pamiętaj, że zmiana poziomu preferencji może później spowodować usunięcie wpisu z danych sieci po określeniu, że inne węzły publikują ten sam prefiks z takimi samymi lub wyższymi preferencjami.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aConfig
Konfiguracja prefiksu on-siatki do opublikowania (NIE MOŻE zawierać wartości NULL).
Zwracane wartości
OT_ERROR_NONE
Prefiks on-mesh został opublikowany.
OT_ERROR_INVALID_ARGS
aConfig jest nieprawidłowy (zły prefiks, nieprawidłowe kombinacje flag lub niestabilne).
OT_ERROR_NO_BUFS
Nie udało się przydzielić wpisu dla nowego żądania. Wydawca obsługuje ograniczoną liczbę wpisów (współdzielonych między prefiksem sieci typu mesh i trasą zewnętrzną) zgodnie z konfiguracją OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataReplacePublishedExternalRoute

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

Zastępuje wcześniej opublikowaną trasę zewnętrzną w danych sieci Thread.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

Jeśli nie ma wcześniej opublikowanych tras zewnętrznych pasujących do aPrefix, ta funkcja działa podobnie do funkcji otNetDataPublishExternalRoute(), tj. rozpoczyna proces publikowania obiektu aConfig jako trasy zewnętrznej w danych sieci typu Thread.

Jeśli istnieje wcześniej opublikowany wpis trasy pasujący do zapytania aPrefix, zostanie on zastąpiony nowym prefiksem z adresu aConfig.

  • Jeśli element aPrefix został już dodany w danych sieci, zmiana nowego prefiksu w aConfig zostanie natychmiast odzwierciedlona w danych sieci. Dzięki temu wpisy trasy w danych sieci nie są nagle usuwane, a przejście od prefiksu do nowego prefiksu będzie przebiegać płynnie.
  • Jeśli stara opublikowana wersja aPrefix nie została dodana do danych sieci, zostanie zastąpiona nowym prefiksem aConfig, ale nie zostanie od razu dodany. Zamiast tego rozpocznie proces publikowania go w danych sieci (monitorowanie danych sieci w celu określenia, kiedy lub czy dodać prefiks w zależności od liczby podobnych prefiksów obecnych w danych sieci).

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPrefix
Wcześniej opublikowany prefiks trasy zewnętrznej do zastąpienia.
[in] aConfig
Konfiguracja trasy zewnętrznej do opublikowania.
Zwracane wartości
OT_ERROR_NONE
Trasa zewnętrzna została opublikowana.
OT_ERROR_INVALID_ARGS
aConfig jest nieprawidłowy (zły prefiks, nieprawidłowe kombinacje flag lub niestabilne).
OT_ERROR_NO_BUFS
Nie udało się przydzielić wpisu dla nowego żądania. Wydawca obsługuje ograniczoną liczbę wpisów (współdzielonych między prefiksem sieci typu mesh i trasą zewnętrzną) zgodnie z konfiguracją OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

Zresetuj śledzoną maksymalną długość danych sieci typu Thread.

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

otNetDataSetDnsSrpServicePublisherCallback

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

Ustawia wywołanie zwrotne informujące o tym, że opublikowana usługa DNS/SRP została faktycznie dodana do danych sieci typu Thread lub z nich usunięta.

Kolejne wywołanie tej funkcji zastępuje dowolną 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 funkcji wywołania zwrotnego (może mieć wartość NULL, jeśli nie jest potrzebny).
[in] aContext
Wskaźnik do kontekstu aplikacji (używany po wywołaniu funkcji aCallback).

otNetDataSetPrefixPublisherCallback

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

Ustawia wywołanie zwrotne informujące, że opublikowany wpis prefiksu został faktycznie dodany do danych sieci typu Thread lub z niego usunięty.

Kolejne wywołanie tej funkcji zastępuje dowolną 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 funkcji wywołania zwrotnego (może mieć wartość NULL, jeśli nie jest potrzebny).
[in] aContext
Wskaźnik do kontekstu aplikacji (używany po wywołaniu funkcji aCallback).

otNetDataSteeringDataCheckJoiner

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

Sprawdź, czy dane sterowania obejmują łącznik.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aEui64
Wskaźnik IEEE EUI-64 łącznika.
Zwracane wartości
OT_ERROR_NONE
Dane kierowania obejmują: aEui64.
OT_ERROR_INVALID_STATE
Brak danych dotyczących kierowania.
OT_ERROR_NOT_FOUND
aEui64 nie jest uwzględniony w danych kierowania.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

Sprawdź, czy dane kierowania obejmują łącznik o danej wartości wyróżniającej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDiscerner
Wskaźnik do łączenia elementów.
Zwracane wartości
OT_ERROR_NONE
Dane kierowania obejmują: aDiscerner.
OT_ERROR_INVALID_STATE
Brak danych dotyczących kierowania.
OT_ERROR_NOT_FOUND
aDiscerner nie jest uwzględniony w danych kierowania.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Cofa publikację dowolnego dodanego wcześniej wpisu usługi DNS/SRP (Anycast lub Unicast) w danych sieci Thread.

Aplikacja OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE musi być włączona.

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

otNetDataUnpublishPrefix

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

Cofa opublikowane wcześniej prefiksy trasy On-Mesh lub zewnętrznej.

Aplikacja OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE musi być włączona.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPrefix
Prefiks do cofnięcia publikacji (NIE MOŻE zawierać wartości NULL).
Zwracane wartości
OT_ERROR_NONE
Publikacja prefiksu została cofnięta.
OT_ERROR_NOT_FOUND
Nie udało się znaleźć prefiksu na opublikowanej liście.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Spróbuj ponownie dołączyć plik jako podrzędny.

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

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Odłącz się od sieci Thread.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwracane wartości
OT_ERROR_NONE
Udało się odłączyć od sieci Thread.
OT_ERROR_INVALID_STATE
Wątek jest wyłączony.

otThreadDetachGracefully

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

Informuje o innych węzłach w sieci (jeśli istnieją), a następnie zatrzymuje działanie protokołu Thread.

Wysyła zwolnienie z adresu, jeśli jest routerem, lub ustawia limit czasu podrzędnego na 0, jeśli jest elementem podrzędnym.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aCallback
Wskaźnik do funkcji, która jest wywoływana po odłączeniu.
[in] aContext
Wskaźnik do wywołania zwrotnego w konkretnej aplikacji.
Zwracane wartości
OT_ERROR_NONE
Rozpoczęto odłączanie.
OT_ERROR_BUSY
Odłączam już coś.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Przekonwertuj rolę urządzenia na ciąg znaków zrozumiały dla człowieka.

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

otThreadDiscover

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

Uruchamia skanowanie wykrywania Thread.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aScanChannels
Wektor bitowy wskazujący kanały do przeskanowania (np. OT_CHANNEL_11_MASK).
[in] aPanId
Filtr identyfikatora PAN (aby wyłączyć filtr, ustaw „Transmituj numer PAN”).
[in] aJoiner
Wartość flagi złącza w TLV żądania wykrywania.
[in] aEnableEui64Filtering
Wartość TRUE (prawda) pozwala filtrować odpowiedzi według UEI-64; w przeciwnym razie ma wartość FALSE (FAŁSZ).
[in] aCallback
Wskaźnik do funkcji wywoływanej po otrzymaniu odpowiedzi MLE Discovery lub zakończeniu skanowania.
[in] aCallbackContext
Wskaźnik do kontekstu aplikacji.
Zwracane wartości
OT_ERROR_NONE
Rozpoczęto skanowanie wykrywania wątków.
OT_ERROR_INVALID_STATE
Interfejs IPv6 nie jest włączony (jeśli nie działa).
OT_ERROR_NO_BUFS
Nie udało się przydzielić wiadomości do żądania wykrywania.
OT_ERROR_BUSY
Skanowanie wykrywania wątków jest już w toku.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Pobiera czas oczekiwania elementu podrzędnego Thread (w sekundach) używany podczas wykonywania operacji w roli podrzędnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość limitu czasu podmiotu podrzędnego Thread (w sekundach).
Zobacz też:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Pobierz rolę urządzenia.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwracane wartości
OT_DEVICE_ROLE_DISABLED
Stos wątków jest wyłączony.
OT_DEVICE_ROLE_DETACHED
Urządzenie nie należy obecnie do sieci/partycji Thread.
OT_DEVICE_ROLE_CHILD
Urządzenie działa obecnie jako element podrzędny Thread.
OT_DEVICE_ROLE_ROUTER
Urządzenie działa obecnie jako router typu Thread.
OT_DEVICE_ROLE_LEADER
Urządzenie działa obecnie jako Thread Leader.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Pobiera nazwę domeny wątku.

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

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Pobiera rozszerzony identyfikator PAN IEEE 802.15.4.

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

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

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

Dostępne, gdy włączono OPENTHREAD_CONFIG_DUA_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do identyfikatora interfejsu ustawiony ręcznie lub wartość NULL, jeśli nie ustawiono żadnej wartości.
Zobacz też:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

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.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Pobiera thrKeySequenceCounter.

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

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Pobiera wartość thrKeySwitchGuardTime (w godzinach).

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

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Pobierz dane Thread Leader.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aLeaderData
Wskaźnik miejsca, w którym znajdują się dane repliki wiodącej.
Zwracane wartości
OT_ERROR_NONE
Dane repliki wiodącej zostały pobrane.
OT_ERROR_DETACHED
Obecnie nie podłączono.

otThreadGetLeaderRloc

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 RLOC lidera.
Zwracane wartości
OT_ERROR_NONE
Wynik RLOC lidera został wysłany na adres aLeaderRloc.
OT_ERROR_INVALID_ARGS
Pole aLeaderRloc zawiera wartość NULL.
OT_ERROR_DETACHED
Obecnie nie jest ona podłączona do partycji wątków.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Pobierz identyfikator routera lidera.

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

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Waga lidera.

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

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Pobiera adres multiemisji połączenia wątku – lokalnego folderu wszystkich węzłów.

Adres jest adresem multicast opartym na prefiksie Unicast [RFC 3306], który zawiera:

  • flgs ustaw na 3 (P = 1 i T = 1)
  • scop ustawiony na 2
  • Ustawiona wartość to 64
  • prefiks sieci jest 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 połączeń lokalnych w wątku.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Pobiera lokalny adres IPv6 linku Thread.

Adres lokalny linku wątku jest uzyskiwany przy użyciu adresu rozszerzonego IEEE802.15.4 jako identyfikatora interfejsu.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do lokalnego adresu IPv6 linku Thread.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Pobierz konfigurację trybu linku MLE.

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

otThreadGetMaxTimeInQueue

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

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

Wymagana jest subskrypcja OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

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

Zebrane statystyki można zresetować, dzwoniąc pod numer otThreadResetTimeInQueueStat().

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Maksymalny (do tej pory) maksymalny czas oczekiwania w kolejce (w milisekundach) na wszystkie wiadomości w kolejce TX.

otThreadGetMeshLocalEid

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 typu mesh.

otThreadGetMeshLocalPrefix

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.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Pobiera liczniki MLE Thread.

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

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Pobierz klucz sieciowy Thread.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aNetworkKey
Wskaźnik do otNetworkKey zwracający klucz sieciowy Thread.
Zobacz też:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Pobierz otNetworkKeyRef dla klucza sieciowego Thread.

Wymaga włączenia funkcji OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE w czasie kompilacji.

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

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Uzyskiwanie nazwy sieci Thread.

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

otThreadGetNextDiagnosticTlv

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

Pobiera w wiadomości następny ciąg TLV diagnostyki sieci.

Wymagana jest subskrypcja OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Kolejne wywołanie tej funkcji jest dozwolone tylko wtedy, gdy obecna wartość zwracana to OT_ERROR_NONE.

Szczegóły
Parametry
[in] aMessage
Wskaźnik wiadomości.
[in,out] aIterator
Wskaźnik do kontekstu iteratora diagnostyki sieci. Aby uzyskać pierwszy TLV diagnostyki sieci, należy ustawić wartość OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Wskaźnik, gdzie zostaną umieszczone informacje TLV diagnostyki sieci.
Zwracane wartości
OT_ERROR_NONE
Znaleziono następny TLV diagnostyki sieci.
OT_ERROR_NOT_FOUND
W komunikacie nie ma kolejnego TLV diagnostyki sieci.
OT_ERROR_PARSE
Analizowanie następnej diagnostyki sieci nie powiodło się.

otThreadGetNextNeighborInfo

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

Pobiera następne informacje o sąsiadach.

Służy do przeglądania wpisów do tabeli sąsiadów.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in,out] aIterator
Wskaźnik kontekstu iteratora. Aby można było pobrać pierwszy wpis sąsiada, powinien on mieć wartość OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Wskaźnik do informacji o sąsiednim sąsiedztwie.
Zwracane wartości
OT_ERROR_NONE
Udało się znaleźć następny wpis sąsiada w tabeli.
OT_ERROR_NOT_FOUND
W tabeli nie ma kolejnego wpisu sąsiada.
OT_ERROR_INVALID_ARGS
aIterator lub aInfo ma 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, w którym należy umieścić nadrzędny RSSI.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

Funkcja pobiera informacje diagnostyczne dotyczące routera Thread Router jako elementu nadrzędnego.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aParentInfo
Wskaźnik, w którym znajdują się informacje o routerze nadrzędnym.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

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

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aLastRssi
Wskaźnik, w którym należy umieścić ostatni element RSSI.
Zwracane wartości
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.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Pobierz identyfikator partycji.

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

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Pobiera adres multiemisji wszystkich węzłów w Thread Realm.

Adres jest lokalnym adresem multicast opartym na prefiksie Unicast [RFC 3306], który zawiera:

  • flgs ustaw na 3 (P = 1 i T = 1)
  • spodnie ustawione na 3
  • Ustawiona wartość to 64
  • prefiks sieci jest 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 grupy połączeń lokalnych wszystkich wątków w Thread Realm.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Pobiera adres lokalizatora routingu wątków (Thread Routing Locator, RLOC).

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do adresu lokalizatora routingu wątków (Thread Routing Locator, RLOC).

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Pobierz RLOC16.

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

otThreadGetServiceAloc

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

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

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aServiceId
Identyfikator usługi, dla której zostanie pobrany ALOC.
[out] aServiceAloc
Wskaźnik wyświetlający wartość ALOC usługi. NIE MOŻE BYĆ NULL.
Zwracane wartości
OT_ERROR_NONE
Pobrano ALOC usługi.
OT_ERROR_DETACHED
Interfejs Thread nie jest obecnie podłączony do partycji Thread.

otThreadGetTimeInQueueHistogram

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

Pobiera histogram czasu w kolejce dla wiadomości w kolejce TX.

Wymagana jest subskrypcja OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

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

Histogram jest zwracany w postaci tablicy wartości uint32_t z wpisami aNumBins. Pierwszy wpis w tablicy (o indeksie 0) reprezentuje liczbę wiadomości z czasem w kolejce mniejszą niż aBinInterval. Drugi wpis reprezentuje liczbę wiadomości z czasem w kolejce nie większy niż aBinInterval, ale mniejszy niż 2 * aBinInterval. I tak dalej. Ostatni wpis przedstawia liczbę wiadomości z czasem w kolejce wynoszącym co najmniej (aNumBins - 1) * aBinInterval.

Zebrane statystyki można zresetować, dzwoniąc pod numer otThreadResetTimeInQueueStat(). Informacje dotyczące histogramu są zbierane od czasu zainicjowania instancji OpenThread lub od ostatniego zresetowania zbierania statystyk przez wywołanie otThreadResetTimeInQueueStat().

Wskaźniki aNumBins i aBinInterval NIE MOGĄ BYĆ NULL.

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

otThreadGetVendorModel

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

Pobierz ciąg znaków modelu dostawcy.

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

otThreadGetVendorName

const char * otThreadGetVendorName(
  otInstance *aInstance
)

Pobierz ciąg z nazwą dostawcy.

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

otThreadGetVendorSwVersion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

Pobierz ciąg znaków wersji dostawcy sw.

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

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Pobiera wersję protokołu Thread.

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

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Wskazuje, czy jest obecnie przetwarzane żądanie lokalizacji lokalnej.

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

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość TRUE, jeśli trwa przetwarzanie żądania lokalizowania Anycast; w przeciwnym razie ma wartość FALSE.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Określa, czy trwa obecnie wykrywanie wątków MLE.

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.
Zwracane wartości
TRUE
To jedyny router w sieci.
FALSE
Urządzenie jest podrzędne lub nie jest pojedynczym routerem w sieci.

otThreadLocateAnycastDestination

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

Zgłasza najbliższe miejsce docelowe danego adresu dowolnego typu.

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

Jeśli wcześniejsze żądanie trwa, kolejne wywołanie tej funkcji zostanie anulowane i zastąpione.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aAnycastAddress
Adres Anycast do zlokalizowania. NIE MOŻE zawierać wartości NULL.
[in] aCallback
Funkcja wywołania zwrotnego do zgłoszenia wyniku.
[in] aContext
Dowolny kontekst używany z elementem aCallback.
Zwracane wartości
OT_ERROR_NONE
Żądanie zostało uruchomione. Do zgłoszenia wyniku zostanie wywołana funkcja aCallback.
OT_ERROR_INVALID_ARGS
aAnycastAddress nie jest prawidłowym adresem typu Anycast lub aCallback ma wartość NULL.
OT_ERROR_NO_BUFS
Brak bufora, aby przygotować i wysłać wiadomość z żądaniem.

otThreadRegisterParentResponseCallback

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

Rejestruje wywołanie zwrotne w celu odebrania danych odpowiedzi rodzica MLE.

Wymagana jest subskrypcja 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 z odpowiedzią nadrzędną MLE.
[in] aContext
Wskaźnik odwołujący się do kontekstu klienta dotyczącego wywołania zwrotnego.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Resetuje liczniki IPv6.

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

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Resetuje liczniki MLE Thread.

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

otThreadResetTimeInQueueStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

Resetuje statystyki czasu w kolejce TX.

Wymagana jest subskrypcja OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

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

otThreadSearchForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

Rozpoczyna proces wyszukiwania przez dziecko lepszego elementu nadrzędnego, pozostawiając przy sobie bieżący element nadrzędny.

Musi być używana, gdy urządzenie jest podłączone jako dziecko.

Szczegóły
Zwracane wartości
OT_ERROR_NONE
Rozpoczęto proces wyszukiwania lepszego rodzica.
OT_ERROR_INVALID_STATE
Rola urządzenia nie jest podrzędna.

otThreadSendAddressNotification

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

Wysyła wiadomość proaktywne powiadomienie adresowe (ADDR_NTF.ntf).

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

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.

Wymagana jest subskrypcja OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDestination
Wskaźnik do adresu docelowego.
[in] aTlvTypes
Tablica typów TLV do diagnostyki sieci.
[in] aCount
Liczba typów w aTlvType.
[in] aCallback
Wskaźnik do funkcji, która jest wywoływana po otrzymaniu odpowiedzi diagnostyki sieci, lub wartość NULL, która wyłącza wywołanie zwrotne.
[in] aCallbackContext
Wskaźnik do kontekstu aplikacji.
Zwracane wartości
OT_ERROR_NONE
Żądanie DIAG_GET.req.
OT_ERROR_NO_BUFS
Niewystarczająca ilość buforów wiadomości do wysłania DIAG_GET.req.

otThreadSendDiagnosticReset

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

Wyślij żądanie resetowania diagnostyki sieci.

Wymagana jest subskrypcja OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDestination
Wskaźnik do adresu docelowego.
[in] aTlvTypes
Tablica typów TLV do diagnostyki sieci. Obecnie dozwolony jest tylko typ 9.
[in] aCount
Liczba typów w aTlvType
Zwracane wartości
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.

otThreadSendProactiveBackboneNotification

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

Wysyła wiadomość Proactive Backbone Notification (PRO_BB.ntf) przez link Backbone.

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

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aTarget
Adres docelowy wiadomości PRO_BB.ntf.
[in] aMlIid
Identyfikator ML-IID wiadomości PRO_BB.ntf.
[in] aTimeSinceLastTransaction
Czas od ostatniej transakcji (w sekundach).
Zwracane wartości
OT_ERROR_NONE
Wysłano plik PRO_BB.ntf przez połączenie szkieletowe.
OT_ERROR_NO_BUFS
Jeśli nie ma wystarczającej ilości buforów wiadomości.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Określa czas oczekiwania elementu podrzędnego wątku (w sekundach) używany podczas wykonywania działań w roli podrzędnej.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aTimeout
Wartość limitu czasu w sekundach.
Zobacz też:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

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

Ustawia wywołanie zwrotne odbierające dane żądania wykrywania MLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aCallback
Wskaźnik do funkcji, która jest wywoływana po otrzymaniu komunikatu żądania wykrywania MLE.
[in] aContext
Wskaźnik do wywołania zwrotnego w konkretnej aplikacji.

otThreadSetDomainName

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

Ustawia nazwę domeny wątku.

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

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

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Uruchamia operację protokołu Thread.

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

Wywołanie tej funkcji z wartością aEnabled ustawioną na FALSE zatrzymuje wszystkie trwające procesy odłączania rozpoczęte przez otThreadDetachGracefully(). Wywołanie tej funkcji zostanie wywołane.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aEnabled
Wartość TRUE, jeśli funkcja Thread jest włączona. W przeciwnym razie ma wartość FALSE.
Zwracane wartości
OT_ERROR_NONE
Rozpoczęto operację protokołu Thread.
OT_ERROR_INVALID_STATE
Interfejs sieci nie działa.

otThreadSetExtendedPanId

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

Ustawia rozszerzony identyfikator PAN IEEE 802.15.4.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aExtendedPanId
Wskaźnik do rozszerzonego identyfikatora PAN IEEE 802.15.4.
Zwracane wartości
OT_ERROR_NONE
Rozszerzony identyfikator 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 określony ręcznie dla adresu Unicast domeny Thread.

Dostępne, gdy włączono OPENTHREAD_CONFIG_DUA_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aIid
Wskaźnik do identyfikatora interfejsu do ustawienia lub wartość NULL do wyczyszczenia.
Zwracane wartości
OT_ERROR_NONE
Udało się ustawić/wyczyścić identyfikator interfejsu.
OT_ERROR_INVALID_ARGS
Podany identyfikator interfejsu jest zarezerwowany.
Zobacz też:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

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

Konfiguruje reklamę typu Thread Joiner podczas wykrywania sieci Thread.

Dzięki reklamie łączącej wątki można reklamować własne informacje dotyczące aplikacji (np. identyfikator dostawcy, identyfikator produktu, dyskryminator itp.) za pomocą nowo proponowanej TLV reklamy łączonej oraz udostępniać te informacje komisarzom lub kandydatom na komisarza.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aOui
Wartość OUI dostawcy IEEE, która zostanie uwzględniona w reklamie połączonej. Zostaną użyte tylko 3 najmniej istotne 3 bajty, a najważniejszy z nich zostanie zignorowany.
[in] aAdvData
Wskaźnik do AdvData, który zostanie włączony w reklamie Joiner.
[in] aAdvDataLength
Długość AdvData w bajtach.
Zwracane wartości
OT_ERROR_NONE
Udało się ustawić reklamę Joiner.
OT_ERROR_INVALID_ARGS
Nieprawidłowe dane AdvData.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Ustawia parametr thrKeySequenceCounter.

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

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Ustawia wartość thrKeySwitchGuardTime (w godzinach).

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

otThreadSetLinkMode

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.
Zwracane wartości
OT_ERROR_NONE
Konfiguracja trybu linku MLE została ustawiona.
Zobacz też:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

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

Ustawia lokalny prefiks sieci typu mesh.

Niepowodzenie tylko wtedy, gdy protokoły Thread są wyłączone. 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.
Zwracane wartości
OT_ERROR_NONE
Lokalny prefiks sieci mesh został ustawiony.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.

otThreadSetNetworkKey

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

Ustaw klucz sieciowy Thread.

Niepowodzenie tylko wtedy, gdy protokoły Thread są wyłączone. 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 Thread.
Zwracane wartości
OT_ERROR_NONE
Klucz sieciowy Thread został ustawiony.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.
Zobacz też:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Ustaw klucz sieci Thread jako otNetworkKeyRef.

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

Wymaga włączenia funkcji OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE w czasie kompilacji.

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

otThreadSetNetworkName

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

Ustaw nazwę sieci typu Thread.

Niepowodzenie tylko wtedy, gdy protokoły Thread są wyłączone. 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 nazwy sieci Thread.
Zwracane wartości
OT_ERROR_NONE
Nazwa sieci 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 znaków modelu dostawcy.

Wymagana jest subskrypcja OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

Parametr aVendorModel powinien być w formacie UTF-8 o maksymalnej długości 32 znaków (MAX_VENDOR_MODEL_TLV_LENGTH). Maksymalna długość nie obejmuje pustego znaku \0.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aVendorModel
Ciąg znaków modelu dostawcy.
Zwracane wartości
OT_ERROR_NONE
Model dostawcy został ustawiony.
OT_ERROR_INVALID_ARGS
Parametr aVendorModel jest nieprawidłowy (zbyt długi lub niezgodny z UTF8).

otThreadSetVendorName

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

Ustaw ciąg znaków z nazwą dostawcy.

Wymagana jest subskrypcja OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

Parametr aVendorName powinien być w formacie UTF-8 o maksymalnej długości 32 znaków (MAX_VENDOR_NAME_TLV_LENGTH). Maksymalna długość nie obejmuje pustego znaku \0.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aVendorName
Ciąg tekstowy nazwy dostawcy.
Zwracane wartości
OT_ERROR_NONE
Nazwa dostawcy została ustawiona.
OT_ERROR_INVALID_ARGS
Parametr aVendorName jest nieprawidłowy (zbyt długi lub niezgodny z UTF8).

otThreadSetVendorSwVersion

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

Ustaw ciąg znaków wersji oprogramowania dostawcy.

Wymagana jest subskrypcja OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

Parametr aVendorSwVersion powinien być w formacie UTF-8 o maksymalnej długości 16 znaków(MAX_VENDOR_SW_VERSION_TLV_LENGTH). Maksymalna długość nie obejmuje pustego znaku \0.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aVendorSwVersion
Ciąg znaków wersji oprogramowania dostawcy.
Zwracane wartości
OT_ERROR_NONE
Wersja oprogramowania dostawcy została ustawiona.
OT_ERROR_INVALID_ARGS
Parametr aVendorSwVersion jest nieprawidłowy (zbyt długi lub niezgodny z UTF8).

Makra

OT_DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

Zalecany rozmiar na potrzeby reprezentacji czasu trwania funkcji uint32_t w sekundach w postaci ciągu znaków.

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maksymalna długość reklamy AdvData w reklamie łączenia.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Inicjator otTerritoryInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maksymalna długość TLV podstawy gwintu.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Wartość do inicjowania otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Rozmiar wpisu w tabeli podrzędnej diagnostyki sieci.

OT_NETWORK_DIAGNOSTIC_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ść TLV wersji stosu wątków.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

Maksymalna długość TLV modelu dostawcy.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

Maksymalna długość TLV nazwy dostawcy.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

Maksymalna długość TLV wersji oprogramowania dostawcy.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Maksymalna liczba typów TLV diagnostyki sieci do zażądania lub zresetowania.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maksymalny identyfikator routera.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Maksymalny rozmiar danych serwera w bajtach. Teoretyczny limit jest praktycznie niższy.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Maksymalny rozmiar danych usługi w bajtach.

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.