Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Zbiór danych operacyjnych

Zawiera funkcje interfejsu Operational Dataset API.

Podsumowanie

Tylko w przypadku kompilacji FTD Aktualizator zbiorów danych zawiera funkcje zarządzania aktualizacjami zbiorów danych.

W przypadku kompilacji FTD i MTD interfejs Operational Dataset API zawiera funkcje do zarządzania aktywnymi zbiorami danych i aktywnymi zbiorami danych oraz TLV.

Wyliczenia

otMeshcopTlvType{
  OT_MESHCOP_TLV_CHANNEL = 0,
  OT_MESHCOP_TLV_PANID = 1,
  OT_MESHCOP_TLV_EXTPANID = 2,
  OT_MESHCOP_TLV_NETWORKNAME = 3,
  OT_MESHCOP_TLV_PSKC = 4,
  OT_MESHCOP_TLV_NETWORKKEY = 5,
  OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6,
  OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,
  OT_MESHCOP_TLV_STEERING_DATA = 8,
  OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9,
  OT_MESHCOP_TLV_COMMISSIONER_ID = 10,
  OT_MESHCOP_TLV_COMM_SESSION_ID = 11,
  OT_MESHCOP_TLV_SECURITYPOLICY = 12,
  OT_MESHCOP_TLV_GET = 13,
  OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14,
  OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,
  OT_MESHCOP_TLV_STATE = 16,
  OT_MESHCOP_TLV_JOINER_DTLS = 17,
  OT_MESHCOP_TLV_JOINER_UDP_PORT = 18,
  OT_MESHCOP_TLV_JOINER_IID = 19,
  OT_MESHCOP_TLV_JOINER_RLOC = 20,
  OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21,
  OT_MESHCOP_TLV_PROVISIONING_URL = 32,
  OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,
  OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,
  OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35,
  OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36,
  OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,
  OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48,
  OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49,
  OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,
  OT_MESHCOP_TLV_DELAYTIMER = 52,
  OT_MESHCOP_TLV_CHANNELMASK = 53,
  OT_MESHCOP_TLV_COUNT = 54,
  OT_MESHCOP_TLV_PERIOD = 55,
  OT_MESHCOP_TLV_SCAN_DURATION = 56,
  OT_MESHCOP_TLV_ENERGY_LIST = 57,
  OT_MESHCOP_TLV_DISCOVERYREQUEST = 128,
  OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129,
  OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241
}
enum | typ wyliczeniowy
Te wyliczenia reprezentują typy TLV meshcop.

Typy

otChannelMask typedef,
uint32_t
Ten typ reprezentuje maskę kanału.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef,
void(*
Ten wskaźnik funkcji jest wywoływany po otrzymaniu odpowiedzi na żądanie MGMT_SET lub po przekroczeniu limitu czasu.
otDatasetUpdaterCallback)(otError aError, void *aContext) typedef,
void(*
Ten wskaźnik funkcji wywołania zwrotnego jest wywoływany, gdy żądanie aktualizacji zbioru danych zakończy się, a raport lub jego stan zakończą się powodzeniem.
otExtendedPanId typedef,
Ta struktura reprezentuje rozszerzony identyfikator PAN.
otMeshLocalPrefix typedef,
Ta struktura reprezentuje lokalny prefiks sieci typu mesh.
otMeshcopTlvType typedef,
Te wyliczenia reprezentują typy TLV meshcop.
otNetworkKey typedef,
struct otNetworkKey
Ta struktura reprezentuje klucz sieci typu Thread.
otNetworkKeyRef typedef,
Ten typ danych odpowiada kluczowi KeyRef sieci.
otNetworkName typedef,
struct otNetworkName
Taka struktura reprezentuje nazwę sieci.
otOperationalDataset typedef,
Ta struktura reprezentuje aktywny lub oczekujący zbiór danych operacyjnych.
otOperationalDatasetComponents typedef,
Ta struktura przedstawia obecność różnych komponentów w aktywnym lub oczekującym zbiorze danych operacyjnych.
otOperationalDatasetTlvs typedef,
Ta struktura reprezentuje aktywny lub oczekujący zbiór danych operacyjnych.
otPskc typedef,
struct otPskc
Taka struktura reprezentuje kod PSKC.
otPskcRef typedef,
Ten typ danych reprezentuje klucz PSKc klucza.
otSecurityPolicy typedef,
Ta struktura reprezentuje zasadę zabezpieczeń.
otTimestamp typedef,
struct otTimestamp
Ta struktura reprezentuje komponent sygnatury czasowej zbioru danych w wątkach.

Zmienne

OT_TOOL_PACKED_END

Funkcje

otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Tylko w przypadku FTD tworzy nowy operacyjny zbiór danych, który będzie wykorzystywany podczas tworzenia nowej sieci.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Ta funkcja generuje PSKc z danego hasła, nazwy sieci i rozszerzonego identyfikatora PAN.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Pobiera aktywny zbiór danych operacyjnych.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Ta funkcja pobiera aktywny zbiór danych operacyjnych.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
Tylko w przypadku FTD: urządzenie z minimalnym opóźnieniem.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Ta funkcja pobiera oczekujący zbiór danych operacyjnych.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Ta funkcja pobiera oczekujący zbiór danych operacyjnych.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Ta funkcja wskazuje, czy w aktywnym zbiorze danych operacyjnych znajdują się prawidłowe sieci.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Ta funkcja analizuje operacyjny zbiór danych z typu otOperationalDatasetTlvs.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Wysyła wiadomość do MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Wysyła wiadomość do MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Wysyła wiadomość do MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Wysyła wiadomość do MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
Ustawia aktywny zbiór danych operacyjnych.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Ta funkcja ustawia aktywny zbiór danych operacyjnych.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
Tylko w przypadku FTD ustawia minimalny minutnik.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Ustawia oczekujący zbiór danych operacyjnych.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Ta funkcja ustawia oczekujący zbiór danych operacyjnych.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Ta funkcja anuluje trwającą prośbę o aktualizację zbioru danych operacyjnych.
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Ta funkcja wskazuje, czy istnieje żądanie aktualizacji zbioru danych operacji.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Ta funkcja prosi o aktualizację zbioru danych operacyjnych.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Ustawia instancję otNetworkName z określonego zakończonego ciągu C.

Dane strukturalne

OTExtensionedPanId

Ta struktura reprezentuje rozszerzony identyfikator PAN.

kluczsieciowy

Ta struktura reprezentuje klucz sieci typu Thread.

nazwaSieci.nazwa_firmy

Taka struktura reprezentuje nazwę sieci.

OTOperationalDataset

Ta struktura reprezentuje aktywny lub oczekujący zbiór danych operacyjnych.

OTOperationalDatasetComponents

Ta struktura przedstawia obecność różnych komponentów w aktywnym lub oczekującym zbiorze danych operacyjnych.

otOperationalDatasetTlvs

Ta struktura reprezentuje aktywny lub oczekujący zbiór danych operacyjnych.

OTPskc

Ta struktura reprezentuje kod PSKc.

OTPolicyPolicy

Ta struktura reprezentuje zasadę zabezpieczeń.

Sygnatura czasowa

Ta struktura reprezentuje komponent sygnatury czasowej zbioru danych w wątkach.

Wyliczenia

Typ OtMeshcopTlv

 otMeshcopTlvType

Te wyliczenia reprezentują typy TLV meshcop.

Właściwości
OT_MESHCOP_TLV_ACTIVETIMESTAMP

Meshcop Active sygnatura czasowa TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

Lokalizator agentów meshcop, lokalizator, TLV

OT_MESHCOP_TLV_CHANNEL

Meshcop Channel TLV

OT_MESHCOP_TLV_CHANNELMASK

Maska kanału Meshcop TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

Meshcop ID Commissioner TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

Meshcop Commissioner – port UDP TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

Meshcop Commissioner ID ID TLV

OT_MESHCOP_TLV_COUNT

Meshcop Count TLV

OT_MESHCOP_TLV_DELAYTIMER

Minutnik opóźnienia meshcop, TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

Meshcop Discovery Request (TLV)

OT_MESHCOP_TLV_DISCOVERYRESPONSE

Wiadomość Discovery w odpowiedzi na meshcop

OT_MESHCOP_TLV_ENERGY_LIST

Meshcop Energy List TLV,

OT_MESHCOP_TLV_EXTPANID

Meshcop Extended ID ID TLV

OT_MESHCOP_TLV_GET

Meshcop Get TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

Adres IPv6 protokołu meshcop TLV

OT_MESHCOP_TLV_JOINERADVERTISEMENT

Reklama Meshcop Dołączająca (TLV)

OT_MESHCOP_TLV_JOINER_DTLS

Połączenie DTLS w Meshcop Connector

OT_MESHCOP_TLV_JOINER_IID

MeshcopDołączer IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

Lokalizator routerów Meshcop TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Router Meshcop, KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

Port UDP TLV meshcop

OT_MESHCOP_TLV_MESHLOCALPREFIX

Meshcop Mesh – lokalny prefiks TLV

OT_MESHCOP_TLV_NETWORKKEY

Meshcop Network Key TLV

OT_MESHCOP_TLV_NETWORKNAME

Meshcop Network Name TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

Sekwencja kluczy sieciowych meshcop TLV

OT_MESHCOP_TLV_PANID

Meshcop Pan ID TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

Meshcop Pending sygnatura czasowa TLV

OT_MESHCOP_TLV_PERIOD

Meshcop – okres TLV

OT_MESHCOP_TLV_PROVISIONING_URL

Adres URL do obsługi administracyjnej meshcop TLV

OT_MESHCOP_TLV_PSKC

Meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

Czas trwania skanowania meshcop, TLV

OT_MESHCOP_TLV_SECURITYPOLICY

Zasada zabezpieczeń meshcop TLV

OT_MESHCOP_TLV_STATE

Meshcop State, TLV

OT_MESHCOP_TLV_STEERING_DATA

Meshcop Steering Data TLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV meshcop UDP

OT_MESHCOP_TLV_VENDOR_DATA_TLV

Meshcop Vendor Data TLV (Dane dostawcy usługi TLV)

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Meshcop Vendor model TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Nazwa dostawcy meshcop TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

Wersja stosu usług meshcop dostawcy TLV

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

meshcop Vendor SW Version TLV

Typy

Maska kanału

uint32_t otChannelMask

Ten typ reprezentuje maskę kanału.

OTDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

Ten wskaźnik funkcji jest wywoływany po otrzymaniu odpowiedzi na żądanie MGMT_SET lub po przekroczeniu limitu czasu.

Szczegóły
Parametry
[in] aResult
Wynik operacji.
[in] aContext
Wskaźnik do kontekstu aplikacji.
Wartości zwracane
OT_ERROR_NONE
Żądanie zostało zaakceptowane przez lidera.
OT_ERROR_REJECTED
Żądanie zostało odrzucone przez lidera.
OT_ERROR_PARSE
Podczas analizowania odpowiedzi wystąpił błąd.
OT_ERROR_ABORT
Żądanie zostało zresetowane przez połączenie równorzędne.
OT_ERROR_RESPONSE_TIMEOUT
Nie otrzymano odpowiedzi ani potwierdzenia w okresie oczekiwania.

Wywołanie zwrotne otDatasetUpdater

void(* otDatasetUpdaterCallback)(otError aError, void *aContext)

Ten wskaźnik funkcji wywołania zwrotnego jest wywoływany, gdy żądanie aktualizacji zbioru danych zakończy się, a raport lub jego stan zakończą się powodzeniem.

Dostępne, gdy włączona jest zasada OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

Szczegóły
Parametry
[in] aError
Stan błędu. Błąd OT_ERROR_NONE oznacza aktualizację zbioru danych. OT_ERROR_INVALID_STATE oznacza, że błąd wystąpił z powodu nieprawidłowego stanu (wyłączanie MLE). Błąd OT_ERROR_ALREADY wskazuje na awarię z powodu innego urządzenia w sieci, które zażądało aktualizacji aktualizacji zbioru danych.
[in] aContext
Wskaźnik określający dowolny kontekst (dostarczany przez użytkownika w języku: otDatasetUpdaterRequestUpdate()).

Identyfikator OTRozszerzony

struct otExtendedPanId otExtendedPanId

Ta struktura reprezentuje rozszerzony identyfikator PAN.

OTMeshLocalPrefiks

otIp6NetworkPrefix otMeshLocalPrefix

Ta struktura reprezentuje lokalny prefiks sieci typu mesh.

Typ OtMeshcopTlv

enum otMeshcopTlvType otMeshcopTlvType

Te wyliczenia reprezentują typy TLV meshcop.

Klucz otNetwork

struct otNetworkKey otNetworkKey

Ta struktura reprezentuje klucz sieci typu Thread.

Klucz połączenia sieciowego

otCryptoKeyRef otNetworkKeyRef

Ten typ danych odpowiada kluczowi KeyRef sieci.

Odniesienie do klucza

Nazwa sieci OTNetwork

struct otNetworkName otNetworkName

Taka struktura reprezentuje nazwę sieci.

otNetworkName to pusty ciąg C (np. Tablica znaków m8 musi kończyć się pustym znakiem \0.

OTOpsalDataset,

struct otOperationalDataset otOperationalDataset

Ta struktura reprezentuje aktywny lub oczekujący zbiór danych operacyjnych.

Komponenty w zbiorze danych są opcjonalne. Struktura mComponets określa, które komponenty znajdują się w zbiorze danych.

Komponenty zbioru danych operacyjnych

struct otOperationalDatasetComponents otOperationalDatasetComponents

Ta struktura przedstawia obecność różnych komponentów w aktywnym lub oczekującym zbiorze danych operacyjnych.

otOperationalDatasetTlvs,

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Ta struktura reprezentuje aktywny lub oczekujący zbiór danych operacyjnych.

Działający zbiór danych jest zakodowany w formacie TLV zgodnie z wątkiem.

OTPskc

struct otPskc otPskc

Taka struktura reprezentuje kod PSKC.

Numer OTPskcref

otCryptoKeyRef otPskcRef

Ten typ danych reprezentuje klucz PSKc klucza.

Odniesienie do klucza

Zasada zabezpieczeń

struct otSecurityPolicy otSecurityPolicy

Ta struktura reprezentuje zasadę zabezpieczeń.

Znacznik czasu

struct otTimestamp otTimestamp

Ta struktura reprezentuje komponent sygnatury czasowej zbioru danych w wątkach.

Zmienne

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Funkcje

Utworzenie zbioru danych przez funkcję OTDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Tylko w przypadku FTD tworzy nowy operacyjny zbiór danych, który będzie wykorzystywany podczas tworzenia nowej sieci.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aDataset
Zbiór danych operacyjnych.
Wartości zwracane
OT_ERROR_NONE
Nowy zbiór danych operacyjnych został utworzony.
OT_ERROR_FAILED
Nie udało się wygenerować losowych wartości dla nowych parametrów.

OtDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

Ta funkcja generuje PSKc z danego hasła, nazwy sieci i rozszerzonego identyfikatora PAN.

Klucz PSKc służy do utworzenia sesji Komisarza.

Szczegóły
Parametry
[in] aPassPhrase
Hasło-przekazywania.
[in] aNetworkName
Nazwa sieci obliczeniowej PSKc.
[in] aExtPanId
Rozszerzony identyfikator PAN do obliczeń PSKc.
[out] aPskc
Wskaźnik do zmiennej wyjściowej generowanego PSKc.
Wartości zwracane
OT_ERROR_NONE
Wygenerowano PSKc.
OT_ERROR_INVALID_ARGS
Jeśli którykolwiek z argumentów wejściowych jest nieprawidłowy.

Pakiet OTDataSetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Pobiera aktywny zbiór danych operacyjnych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aDataset
Wskaźnik, w którym zostanie umieszczony aktywny zbiór danych operacyjnych.
Wartości zwracane
OT_ERROR_NONE
Aktywny zbiór danych operacyjnych został pobrany.
OT_ERROR_NOT_FOUND
Brak odpowiadającej mu wartości w magazynie ustawień.

Pakiet danych OTDataGetActiveTlv

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Ta funkcja pobiera aktywny zbiór danych operacyjnych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aDataset
Wskaźnik, w którym zostanie umieszczony aktywny zbiór danych operacyjnych.
Wartości zwracane
OT_ERROR_NONE
Aktywny zbiór danych operacyjnych został pobrany.
OT_ERROR_NOT_FOUND
Brak odpowiadającej mu wartości w magazynie ustawień.

OTDatasetGetOpóźnienieTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Tylko w przypadku FTD: urządzenie z minimalnym opóźnieniem.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Wartości zwracane
the
wartość minimalnego opóźnienia (w ms).

OTDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Ta funkcja pobiera oczekujący zbiór danych operacyjnych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aDataset
Wskaźnik, w którym zostanie umieszczony oczekujący zbiór danych operacyjnych.
Wartości zwracane
OT_ERROR_NONE
Zbiór danych operacyjnych oczekuje na realizację.
OT_ERROR_NOT_FOUND
Brak odpowiadającej mu wartości w magazynie ustawień.

Funkcja OTDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Ta funkcja pobiera oczekujący zbiór danych operacyjnych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aDataset
Wskaźnik, w którym zostanie umieszczony oczekujący zbiór danych operacyjnych.
Wartości zwracane
OT_ERROR_NONE
Zbiór danych operacyjnych oczekuje na realizację.
OT_ERROR_NOT_FOUND
Brak odpowiadającej mu wartości w magazynie ustawień.

Zezwolenie na przesyłanie danych

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Ta funkcja wskazuje, czy w aktywnym zbiorze danych operacyjnych znajdują się prawidłowe sieci.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wartość TRUE (prawda), jeśli w aktywnym zbiorze danych operacyjnych znajduje się prawidłowa sieć. W przeciwnym razie ma wartość FALSE (fałsz).

Pakiet OTDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

Ta funkcja analizuje operacyjny zbiór danych z typu otOperationalDatasetTlvs.

Szczegóły
Parametry
[in] aDatasetTlvs
Wskaźnik do TLV zbioru danych.
[out] aDataset
Wskaźnik określający, gdzie zostanie umieszczony zbiór danych.
Wartości zwracane
OT_ERROR_NONE
Ustawiono aDatasetTlvs (aDataset).
OT_ERROR_INVALID_ARGS
Element aDatasetTlvs jest nieprawidłowy.

OTDatasetSendMgmtActiveGet,

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Wysyła wiadomość do MGMT_ACTIVE_GET.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDatasetComponents
Wskaźnik do struktury komponentów zbioru danych określający, które komponenty mają być żądane.
[in] aTlvTypes
Wskaźnik do tablicy zawierającej dodatkowe typy nieprzetworzonych plików TLV.
[in] aLength
Długość: aTlvTypes.
[in] aAddress
Wskaźnik do miejsca docelowego IPv6, jeśli ma wartość NULL, będzie domyślnie używać lidera ALOC.
Wartości zwracane
OT_ERROR_NONE
Udało się wysłać polecenie zbioru danych meshcop.
OT_ERROR_NO_BUFS
Za mało miejsca, aby wysłać dane.

OTDatasetSendMgmtActiveSet.

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Wysyła wiadomość do MGMT_ACTIVE_SET.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskaźnik do działającego zbioru danych.
[in] aTlvs
Wskaźnik do kierowców samochodów na sprzedaż.
[in] aLength
Długość kierowców.
[in] aCallback
Wskaźnik do funkcji wywoływanej podczas odbierania odpowiedzi lub przekraczania limitu czasu.
[in] aContext
Wskaźnik do konkretnej aplikacji aCallback.
Wartości zwracane
OT_ERROR_NONE
Udało się wysłać polecenie zbioru danych meshcop.
OT_ERROR_NO_BUFS
Za mało miejsca, aby wysłać dane.
OT_ERROR_BUSY
Poprzednia prośba jest rozpatrywana.

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

Wysyła wiadomość do MGMT_PENDING_GET.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDatasetComponents
Wskaźnik do struktury komponentów zbioru danych określający, które komponenty mają być żądane.
[in] aTlvTypes
Wskaźnik do tablicy zawierającej dodatkowe typy nieprzetworzonych plików TLV.
[in] aLength
Długość: aTlvTypes.
[in] aAddress
Wskaźnik do miejsca docelowego IPv6, jeśli ma wartość NULL, będzie domyślnie używać lidera ALOC.
Wartości zwracane
OT_ERROR_NONE
Udało się wysłać polecenie zbioru danych meshcop.
OT_ERROR_NO_BUFS
Za mało miejsca, aby wysłać dane.

OTDatasetSendMgmtPendingSet,

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

Wysyła wiadomość do MGMT_PENDING_SET.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskaźnik do działającego zbioru danych.
[in] aTlvs
Wskaźnik do kierowców samochodów na sprzedaż.
[in] aLength
Długość kierowców.
[in] aCallback
Wskaźnik do funkcji wywoływanej podczas odbierania odpowiedzi lub przekraczania limitu czasu.
[in] aContext
Wskaźnik do konkretnej aplikacji aCallback.
Wartości zwracane
OT_ERROR_NONE
Udało się wysłać polecenie zbioru danych meshcop.
OT_ERROR_NO_BUFS
Za mało miejsca, aby wysłać dane.
OT_ERROR_BUSY
Poprzednia prośba jest rozpatrywana.

Pakiet OTDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Ustawia aktywny zbiór danych operacyjnych.

Jeśli zbiór danych nie zawiera aktywnej sygnatury czasowej, jest tylko częściowo kompletny.

Jeśli wątek jest włączony na urządzeniu, które ma częściowo pełny aktywny zbiór danych, spróbuje dołączyć je do istniejącej sieci za pomocą istniejących informacji w zbiorze danych. Do połączenia z siecią potrzebny jest tylko klucz sieci typu Thread.

Jeśli kanał nie został uwzględniony w zbiorze danych, urządzenie będzie wysyłać wiadomości MLE do osób w pobliżu, które przekazują informacje o sąsiednich kanałach.

Jeśli urządzenie uda się dołączyć do sieci typu Thread, urządzenie pobierze pełny aktywny zbiór danych z jednostki nadrzędnej. Pamiętaj, że urządzenie obsługujące router nie przejdzie na router lub lidera, dopóki nie będzie mieć pełnego zbioru danych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskaźnik do aktywnego zbioru danych operacyjnych.
Wartości zwracane
OT_ERROR_NONE
Aktywny zbiór danych operacyjnych jest ustawiony.
OT_ERROR_NO_BUFS
Niewystarczająca ilość miejsca w buforze do ustawienia aktywnego zbioru danych operacyjnych.
OT_ERROR_NOT_IMPLEMENTED
Platforma nie udostępnia funkcji ustawień.

OTDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Ta funkcja ustawia aktywny zbiór danych operacyjnych.

Jeśli zbiór danych nie zawiera aktywnej sygnatury czasowej, jest tylko częściowo kompletny.

Jeśli wątek jest włączony na urządzeniu, które ma częściowo pełny aktywny zbiór danych, spróbuje dołączyć je do istniejącej sieci za pomocą istniejących informacji w zbiorze danych. Do połączenia z siecią potrzebny jest tylko klucz sieci typu Thread.

Jeśli kanał nie został uwzględniony w zbiorze danych, urządzenie będzie wysyłać wiadomości MLE do osób w pobliżu, które przekazują informacje o sąsiednich kanałach.

Jeśli urządzenie uda się dołączyć do sieci typu Thread, urządzenie pobierze pełny aktywny zbiór danych z jednostki nadrzędnej. Pamiętaj, że urządzenie obsługujące router nie przejdzie na router lub lidera, dopóki nie będzie mieć pełnego zbioru danych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskaźnik do aktywnego zbioru danych operacyjnych.
Wartości zwracane
OT_ERROR_NONE
Aktywny zbiór danych operacyjnych jest ustawiony.
OT_ERROR_NO_BUFS
Niewystarczająca ilość miejsca w buforze do ustawienia aktywnego zbioru danych operacyjnych.
OT_ERROR_NOT_IMPLEMENTED
Platforma nie udostępnia funkcji ustawień.

OTDatasetSetOpóźnienieTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Tylko w przypadku FTD ustawia minimalny minutnik.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDelayTimerMinimal
Wartość minimalnego opóźnienia opóźnienia (w ms).
Wartości zwracane
OT_ERROR_NONE
Minutnik z minimalnym opóźnieniem został ustawiony.
OT_ERROR_INVALID_ARGS
Jeśli wartość aDelayTimerMinimal jest nieprawidłowa.

OTDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Ustawia oczekujący zbiór danych operacyjnych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskaźnik oczekującego zbioru danych operacyjnych.
Wartości zwracane
OT_ERROR_NONE
Zbiór danych operacyjnych oczekuje na utworzenie.
OT_ERROR_NO_BUFS
Niewystarczająca ilość miejsca w buforze do ustawienia oczekującego zbioru danych operacyjnych.
OT_ERROR_NOT_IMPLEMENTED
Platforma nie udostępnia funkcji ustawień.

OTDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Ta funkcja ustawia oczekujący zbiór danych operacyjnych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskaźnik oczekującego zbioru danych operacyjnych.
Wartości zwracane
OT_ERROR_NONE
Zbiór danych operacyjnych oczekuje na utworzenie.
OT_ERROR_NO_BUFS
Niewystarczająca ilość miejsca w buforze do ustawienia oczekującego zbioru danych operacyjnych.
OT_ERROR_NOT_IMPLEMENTED
Platforma nie udostępnia funkcji ustawień.

Aktualizacja pakietu OTDatasetUpdaterCancel

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Ta funkcja anuluje trwającą prośbę o aktualizację zbioru danych operacyjnych.

Dostępne, gdy włączona jest zasada OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

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

Trwa aktualizacja zbioru danych OTData

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Ta funkcja wskazuje, czy istnieje żądanie aktualizacji zbioru danych operacji.

Dostępne, gdy włączona jest zasada OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Wartości zwracane
TRUE
Trwa aktualizacja.
FALSE
Nie ma bieżących aktualizacji.

Aktualizacja żądania OTDatasetUpdater

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

Ta funkcja prosi o aktualizację zbioru danych operacyjnych.

Dostępne, gdy włączona jest zasada OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

Pole aDataset powinno zawierać pola do zaktualizowania i nową wartość. Nie może zawierać pól Aktywna ani Znacznik czasu oczekiwania. Pole Opóźnienie jest opcjonalne, jeśli nie zostanie podane wartość domyślna (1000 ms).

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskazuje na zbiór danych zawierający pola, które chcesz zmienić.
[in] aCallback
Wywołanie zwrotne wskazujące, kiedy żądanie aktualizacji zbioru danych dobiegnie końca.
[in] aContext
Dowolny kontekst przekazany do wywołania zwrotnego.
Wartości zwracane
OT_ERROR_NONE
Zaktualizowano zbiór danych (po wywołaniu funkcja aCallback zostanie wywołana).
OT_ERROR_INVALID_STATE
Urządzenie jest wyłączone (MLE jest wyłączone).
OT_ERROR_INVALID_ARGS
Element aDataset jest nieprawidłowy (zawiera sygnaturę czasową aktywnego lub oczekującego).
OT_ERROR_BUSY
Nie można rozpocząć aktualizacji. Trwa poprzednia.
OT_ERROR_NO_BUFS
Nie udało się przypisać bufora do zapisania zbioru danych.

Nazwa_sieci

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

Ustawia instancję otNetworkName z określonego zakończonego ciągu C.

Dyrektywa aNameString musi być kodowana w formacie UTF-8. Długość nazwy sieci nie może być większa niż OT_NETWORK_NAME_MAX_SIZE.

Szczegóły
Parametry
[out] aNetworkName
Wskaźnik do ustawienia otNetworkName.
[in] aNameString
Ciąg nazwy C.
Wartości zwracane
OT_ERROR_NONE
Ustawiono aNameString (aNetworkName).
OT_ERROR_INVALID_ARGS
Wartość aNameStrng jest nieprawidłowa (za długa lub niezgodna z kodowaniem UTF-8).

Makra

OTW._KANAŁU10

 OT_CHANNEL_10_MASK (1 << 10)

Kanał 10.

OTW._KANAŁU11

 OT_CHANNEL_11_MASK (1 << 11)

Kanał 11.

OT_Kanał_12_OT_KANAŁU

 OT_CHANNEL_12_MASK (1 << 12)

Kanał 12.

OT_kanał_13_MAKS

 OT_CHANNEL_13_MASK (1 << 13)

Kanał 13.

OTW_KANAŁU_14

 OT_CHANNEL_14_MASK (1 << 14)

Kanał 14.

OT_kanał_15_MAKS

 OT_CHANNEL_15_MASK (1 << 15)

Kanał 15.

OTW_KANAŁU_16

 OT_CHANNEL_16_MASK (1 << 16)

Kanał 16.

KANAŁ_17_OTW_KANAŁU

 OT_CHANNEL_17_MASK (1 << 17)

Kanał 17.

MAKSYMALNA_KANAŁ_18_OTW

 OT_CHANNEL_18_MASK (1 << 18)

Kanał 18.

OT_kanał_19_OTW

 OT_CHANNEL_19_MASK (1 << 19)

Kanał 19.

OTWÓRZ_KANAŁ_1_KANAŁU

 OT_CHANNEL_1_MASK (1 << 1)

Kanał 1.

OT_KANAŁ_20_MAKS

 OT_CHANNEL_20_MASK (1 << 20)

Kanał 20.

OTWÓRZ_KANAŁ_21_MAKS

 OT_CHANNEL_21_MASK (1 << 21)

Kanał 21.

OTW_KANAŁ_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Kanał 22.

OTW_KANAŁ_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Kanał 23.

OTW_KANAŁ_24_MAKS

 OT_CHANNEL_24_MASK (1 << 24)

Kanał 24.

OTW_KANAŁ_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Kanał 25.

OTW._KANAŁU_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Kanał 26.

OTW._KANAŁU_2

 OT_CHANNEL_2_MASK (1 << 2)

Kanał 2.

OTWÓRZ_KANAŁ_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Kanał 3.

OTWÓRZ_KANAŁ_4_KANAŁU

 OT_CHANNEL_4_MASK (1 << 4)

Kanał 4.

OTW._KANAŁU_5

 OT_CHANNEL_5_MASK (1 << 5)

Kanał 5.

OTWÓRZ_KANAŁU_6

 OT_CHANNEL_6_MASK (1 << 6)

Kanał 6.

OTWÓRZ_KANAŁ_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Kanał 7.

OTW._KANAŁU_8

 OT_CHANNEL_8_MASK (1 << 8)

Kanał 8.

OTWÓRZ_KANAŁ_9_KANAŁU

 OT_CHANNEL_9_MASK (1 << 9)

Kanał 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Rozmiar identyfikatora PAN wątku (bajty)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Rozmiar lokalnego prefiksu sieci typu mesh (bajty)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Rozmiar klucza sieci typu Thread (bajty)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Maksymalny rozmiar pola nazwy sieci typu Thread (bajty)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Maksymalna długość zbioru danych operacyjnych w bajtach.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Maksymalny rozmiar pliku PSKc (bajty)

Zasoby

Tematy referencyjne interfejsu API OpenThread pochodzą z kodu źródłowego, który jest dostępny w GitHub. Więcej informacji oraz linki do dokumentacji znajdziesz w zasobach.