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
.
Definicje typów |
|
---|---|
otBorderRouterConfig
|
typedefstruct otBorderRouterConfig
Reprezentuje konfigurację routera granicznego. |
otDetachGracefullyCallback)(void *aContext)
|
typedefvoid(*
To wywołanie zwrotne informuje aplikację o zakończeniu procesu odłączania. |
otExternalRouteConfig
|
typedefstruct otExternalRouteConfig
Reprezentuje konfigurację trasy zewnętrznej. |
otIpCounters
|
typedefstruct otIpCounters
Reprezentuje liczniki poziomu adresu IP. |
otLeaderData
|
typedefstruct otLeaderData
Reprezentuje dane lidera wątku. |
otLinkModeConfig
|
typedefstruct otLinkModeConfig
Reprezentuje konfigurację trybu linku MLE. |
otLowpanContextInfo
|
typedefstruct otLowpanContextInfo
Reprezentuje informacje o identyfikatorze kontekstu 6LoWPAN powiązane z prefiksem w danych sieci. |
otMleCounters
|
typedefstruct otMleCounters
Reprezentuje liczniki MLE Thread. |
otNeighborInfoIterator
|
typedefint16_t
Służy do iteracji z użyciem tabeli sąsiadów. |
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)
|
typedefvoid(*
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)
|
typedefvoid(*
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
|
typedefuint32_t
Służy do iteracji z wykorzystaniem informacji dotyczących danych sieci. |
otNetworkDiagChildEntry
|
typedefstruct otNetworkDiagChildEntry
Reprezentuje wpis tabeli podrzędnej diagnostyki sieci. |
otNetworkDiagConnectivity
|
typedefstruct otNetworkDiagConnectivity
Reprezentuje wartość diagnostyki połączeń sieci. |
otNetworkDiagIterator
|
typedefuint16_t
Służy do iteracji za pomocą TLV diagnostyki sieci. |
otNetworkDiagMacCounters
|
typedefstruct otNetworkDiagMacCounters
Reprezentuje wartość liczników diagnostyki sieci na Macu. |
otNetworkDiagMleCounters
|
typedefstruct otNetworkDiagMleCounters
Reprezentuje wartość liczników MLE diagnostyki sieci. |
otNetworkDiagRoute
|
typedefstruct otNetworkDiagRoute
Reprezentuje wartość TLV trasy diagnostyki sieci. |
otNetworkDiagRouteData
|
typedefstruct otNetworkDiagRouteData
Reprezentuje dane trasy diagnostycznej sieci. |
otNetworkDiagTlv
|
typedefstruct otNetworkDiagTlv
Reprezentuje TLV diagnostyki sieci. |
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)
|
typedefvoid(*
Wskaźnik jest wywoływany po otrzymaniu odpowiedzi na żądanie diagnostyki sieci. |
otRoutePreference
|
typedefenum otRoutePreference
|
otServerConfig
|
typedefstruct otServerConfig
Reprezentuje konfigurację serwera. |
otServiceConfig
|
typedefstruct otServiceConfig
Reprezentuje konfigurację usługi. |
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)
|
typedefvoid(*
Typ wskaźnika określa wywołanie zwrotne powiadamiające o wyniku żądania otThreadLocateAnycastDestination() . |
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)
|
typedefvoid(*
Wskaźnik jest wywoływany za każdym razem, gdy otrzymasz wiadomość żądania wykrywania MLE. |
otThreadDiscoveryRequestInfo
|
typedefstruct otThreadDiscoveryRequestInfo
Reprezentuje dane żądania wykrywania Thread. |
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)
|
typedefvoid(*
Wskaźnik jest wywoływany za każdym razem, gdy otrzymana jest wiadomość nadrzędna MLE. |
otThreadParentResponseInfo
|
typedefstruct otThreadParentResponseInfo
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)
|
const otIp6InterfaceIdentifier *
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)
|
const otMeshLocalPrefix *
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
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 |
|
otExternalRouteConfig
struct otExternalRouteConfig otExternalRouteConfig
Reprezentuje konfigurację trasy zewnętrznej.
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.
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 |
|
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 |
|
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.
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 |
|
otRoutePreference
enum otRoutePreference otRoutePreference
Określa prawidłowe wartości dla pola mPreference
w otExternalRouteConfig
i otBorderRouterConfig
.
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 |
|
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 |
|
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 |
|
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 „
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 |
|
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 |
|
||||
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 |
|
||||||||
Zwracane wartości |
|
otNetDataGetCommissioningDataset
void otNetDataGetCommissioningDataset( otInstance *aInstance, otCommissioningDataset *aDataset )
Pobiera zbiór danych na zlecenie z danych sieci partycji.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
otNetDataGetLength
uint8_t otNetDataGetLength( otInstance *aInstance )
Pobierz bieżącą długość (liczbę bajtów) danych sieci w łańcuchu partycji.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
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 |
|
||
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 |
|
||||||
Zwracane wartości |
|
otNetDataGetNextOnMeshPrefix
otError otNetDataGetNextOnMeshPrefix( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig )
Znajdź następny prefiks sieci typu mesh w danych sieciowych partycji.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otNetDataGetNextRoute
otError otNetDataGetNextRoute( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig )
Pobierz następną trasę zewnętrzną w danych sieciowych partycji.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otNetDataGetNextService
otError otNetDataGetNextService( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig )
Pobierz następną usługę z danych sieci partycji.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otNetDataGetStableVersion
uint8_t otNetDataGetStableVersion( otInstance *aInstance )
Pobierz stabilną wersję danych sieciowych.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Stabilna wersja danych sieci.
|
otNetDataGetVersion
uint8_t otNetDataGetVersion( otInstance *aInstance )
Pobierz wersję danych sieciowych
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
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 |
|
||||
Zwracane wartości |
|
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 |
|
||||
Zwracane wartości |
|
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 |
|
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 |
|
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 |
|
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 |
|
||||||
Zwracane wartości |
|
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 |
|
||||||
Zwracane wartości |
|
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 waConfig
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 prefiksemaConfig
, 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 |
|
||||||
Zwracane wartości |
|
otNetDataResetMaxLength
void otNetDataResetMaxLength( otInstance *aInstance )
Zresetuj śledzoną maksymalną długość danych sieci typu Thread.
Szczegóły | |||
---|---|---|---|
Parametry |
|
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 |
|
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 |
|
otNetDataSteeringDataCheckJoiner
otError otNetDataSteeringDataCheckJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Sprawdź, czy dane sterowania obejmują łącznik.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
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 |
|
||||||
Zwracane wartości |
|
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 |
|
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 |
|
||||
Zwracane wartości |
|
otThreadBecomeChild
otError otThreadBecomeChild( otInstance *aInstance )
Spróbuj ponownie dołączyć plik jako podrzędny.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
otThreadBecomeDetached
otError otThreadBecomeDetached( otInstance *aInstance )
Odłącz się od sieci Thread.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
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 |
|
||||||
Zwracane wartości |
|
otThreadDeviceRoleToString
const char * otThreadDeviceRoleToString( otDeviceRole aRole )
Przekonwertuj rolę urządzenia na ciąg znaków zrozumiały dla człowieka.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
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 |
|
||||||||||||||
Zwracane wartości |
|
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 |
|
||
Zwroty |
Wartość limitu czasu podmiotu podrzędnego Thread (w sekundach).
|
otThreadSetChildTimeout
otThreadGetDeviceRole
otDeviceRole otThreadGetDeviceRole( otInstance *aInstance )
Pobierz rolę urządzenia.
Szczegóły | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||
Zwracane wartości |
|
otThreadGetDomainName
const char * otThreadGetDomainName( otInstance *aInstance )
Pobiera nazwę domeny wątku.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wskaźnik nazwy domeny Thread.
|
otThreadSetDomainName
otThreadGetExtendedPanId
const otExtendedPanId * otThreadGetExtendedPanId( otInstance *aInstance )
Pobiera rozszerzony identyfikator PAN IEEE 802.15.4.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wskaźnik do rozszerzonego identyfikatora PAN IEEE 802.15.4.
|
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 |
|
||
Zwroty |
Wskaźnik do identyfikatora interfejsu ustawiony ręcznie lub wartość NULL, jeśli nie ustawiono żadnej wartości.
|
otThreadSetFixedDuaInterfaceIdentifier
otThreadGetIp6Counters
const otIpCounters * otThreadGetIp6Counters( otInstance *aInstance )
Pobiera liczniki IPv6.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wskaźnik do liczników IPv6.
|
otThreadGetKeySequenceCounter
uint32_t otThreadGetKeySequenceCounter( otInstance *aInstance )
Pobiera thrKeySequenceCounter.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wartość thrKeySequenceCounter.
|
otThreadSetKeySequenceCounter
otThreadGetKeySwitchGuardTime
uint32_t otThreadGetKeySwitchGuardTime( otInstance *aInstance )
Pobiera wartość thrKeySwitchGuardTime (w godzinach).
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wartość thrKeySwitchGuardTime (w godzinach).
|
otThreadSetKeySwitchGuardTime
otThreadGetLeaderData
otError otThreadGetLeaderData( otInstance *aInstance, otLeaderData *aLeaderData )
Pobierz dane Thread Leader.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
otThreadGetLeaderRloc
otError otThreadGetLeaderRloc( otInstance *aInstance, otIp6Address *aLeaderRloc )
Zwraca wskaźnik do RLOC lidera.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otThreadGetLeaderRouterId
uint8_t otThreadGetLeaderRouterId( otInstance *aInstance )
Pobierz identyfikator routera lidera.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Identyfikator routera lidera.
|
otThreadGetLeaderWeight
uint8_t otThreadGetLeaderWeight( otInstance *aInstance )
Waga lidera.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
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 |
|
||
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 |
|
||
Zwroty |
Wskaźnik do lokalnego adresu IPv6 linku Thread.
|
otThreadGetLinkMode
otLinkModeConfig otThreadGetLinkMode( otInstance *aInstance )
Pobierz konfigurację trybu linku MLE.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Konfiguracja trybu linku MLE.
|
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 |
|
||
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 |
|
||
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 |
|
||
Zwroty |
Wskaźnik do lokalnego prefiksu sieci typu mesh.
|
otThreadGetMleCounters
const otMleCounters * otThreadGetMleCounters( otInstance *aInstance )
Pobiera liczniki MLE Thread.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wskaźnik do liczników MLE Thread.
|
otThreadGetNetworkKey
void otThreadGetNetworkKey( otInstance *aInstance, otNetworkKey *aNetworkKey )
Pobierz klucz sieciowy Thread.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
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 |
|
||
Zwroty |
Odniesienie do klucza sieciowego Thread zapisanego w pamięci.
|
otThreadSetNetworkKeyRef
otThreadGetNetworkName
const char * otThreadGetNetworkName( otInstance *aInstance )
Uzyskiwanie nazwy sieci Thread.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Wskaźnik nazwy sieci Thread.
|
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 |
|
||||||
Zwracane wartości |
|
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 |
|
||||||
Zwracane wartości |
|
otThreadGetParentAverageRssi
otError otThreadGetParentAverageRssi( otInstance *aInstance, int8_t *aParentRssi )
Funkcja pobiera średnią wartość RSSI dla elementu nadrzędnego wątku.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
otThreadGetParentInfo
otError otThreadGetParentInfo( otInstance *aInstance, otRouterInfo *aParentInfo )
Funkcja pobiera informacje diagnostyczne dotyczące routera Thread Router jako elementu nadrzędnego.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
otThreadGetParentLastRssi
otError otThreadGetParentLastRssi( otInstance *aInstance, int8_t *aLastRssi )
Funkcja pobiera RSSI ostatniego pakietu z elementu nadrzędnego wątku.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
otThreadGetPartitionId
uint32_t otThreadGetPartitionId( otInstance *aInstance )
Pobierz identyfikator partycji.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
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 |
|
||
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 |
|
||
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 |
|
||
Zwroty |
RLOC16.
|
otThreadGetServiceAloc
otError otThreadGetServiceAloc( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc )
Pobiera ALOC usługi dla podanego identyfikatora usługi.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
||||||
Zwracane wartości |
|
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 |
|
||||||
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 |
|
||
Zwroty |
Ciąg znaków modelu dostawcy.
|
otThreadGetVendorName
const char * otThreadGetVendorName( otInstance *aInstance )
Pobierz ciąg z nazwą dostawcy.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
Zwroty |
Ciąg tekstowy nazwy dostawcy.
|
otThreadGetVendorSwVersion
const char * otThreadGetVendorSwVersion( otInstance *aInstance )
Pobierz ciąg znaków wersji dostawcy sw.
Szczegóły | |||
---|---|---|---|
Parametry |
|
||
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 |
|
||
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 |
|
otThreadIsSingleton
bool otThreadIsSingleton( otInstance *aInstance )
Wskazuje, czy węzeł jest jedynym routerem w sieci.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
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 |
|
||||||||
Zwracane wartości |
|
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 |
|
otThreadResetIp6Counters
void otThreadResetIp6Counters( otInstance *aInstance )
Resetuje liczniki IPv6.
Szczegóły | |||
---|---|---|---|
Parametry |
|
otThreadResetMleCounters
void otThreadResetMleCounters( otInstance *aInstance )
Resetuje liczniki MLE Thread.
Szczegóły | |||
---|---|---|---|
Parametry |
|
otThreadResetTimeInQueueStat
void otThreadResetTimeInQueueStat( otInstance *aInstance )
Resetuje statystyki czasu w kolejce TX.
Wymagana jest subskrypcja OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE
.
Szczegóły | |||
---|---|---|---|
Parametry |
|
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 |
|
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 |
|
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 |
|
||||||||||||
Zwracane wartości |
|
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 |
|
||||||||
Zwracane wartości |
|
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 |
|
||||||||
Zwracane wartoś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 |
|
otThreadGetChildTimeout
otThreadSetDiscoveryRequestCallback
void otThreadSetDiscoveryRequestCallback( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext )
Ustawia wywołanie zwrotne odbierające dane żądania wykrywania MLE.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
Parametry |
|
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 |
|
||||
Zwracane wartości |
|
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 |
|
||||
Zwracane wartości |
|
otThreadSetExtendedPanId
otError otThreadSetExtendedPanId( otInstance *aInstance, const otExtendedPanId *aExtendedPanId )
Ustawia rozszerzony identyfikator PAN IEEE 802.15.4.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
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 |
|
||||
Zwracane wartości |
|
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 |
|
||||||||
Zwracane wartości |
|
otThreadSetKeySequenceCounter
void otThreadSetKeySequenceCounter( otInstance *aInstance, uint32_t aKeySequenceCounter )
Ustawia parametr thrKeySequenceCounter.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
otThreadGetKeySequenceCounter
otThreadSetKeySwitchGuardTime
void otThreadSetKeySwitchGuardTime( otInstance *aInstance, uint32_t aKeySwitchGuardTime )
Ustawia wartość thrKeySwitchGuardTime (w godzinach).
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
otThreadGetKeySwitchGuardTime
otThreadSetLinkMode
otError otThreadSetLinkMode( otInstance *aInstance, otLinkModeConfig aConfig )
Ustaw konfigurację trybu linku MLE.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwracane wartości |
|
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 |
|
||||
Zwracane wartości |
|
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 |
|
||||
Zwracane wartości |
|
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 |
|
||||
Zwracane wartości |
|
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 |
|
||||
Zwracane wartości |
|
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 |
|
||||
Zwracane wartości |
|
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 |
|
||||
Zwracane wartości |
|
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 |
|
||||
Zwracane wartości |
|
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.