Zbiór danych operacyjnych

Obejmuje funkcje Operational Dataset API.

Podsumowanie

Tylko w przypadku kompilacji FTD zawiera funkcje do zarządzania aktualizacjami zbioru danych.

W przypadku kompilacji FTD i MTD Operational Dataset API zawiera funkcje do zarządzania aktywnymi i oczekującymi zbiorami danych oraz TLV zbiorów danych.

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
Reprezentuje typy TLV meshcop.

Definicje typów
otChannelMask typedef
uint32_t
Reprezentuje maskę kanału.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
Wskaźnik 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 po zakończeniu żądania aktualizacji zbioru danych i zgłoszeniu stanu udanego lub niepowodzenia żądania aktualizacji zbioru danych.
otExtendedPanId typedef
Reprezentuje rozszerzony identyfikator PAN.
otMeshLocalPrefix typedef
Reprezentuje lokalny prefiks sieci typu mesh.
otMeshcopTlvType typedef
Reprezentuje typy TLV meshcop.
otNetworkKey typedef
struct otNetworkKey
Reprezentuje klucz sieciowy Thread.
otNetworkKeyRef typedef
Ten typ danych reprezentuje odwołanie do klucza NetworkKey.
otNetworkName typedef
struct otNetworkName
Reprezentuje nazwę sieci.
otOperationalDataset typedef
Reprezentuje aktywny lub oczekujący zbiór danych operacyjnych.
otOperationalDatasetComponents typedef
Reprezentuje obecność różnych komponentów w aktywnym lub oczekującym zbiorze danych operacyjnych.
otOperationalDatasetTlvs typedef
Reprezentuje aktywny lub oczekujący zbiór danych operacyjnych.
otPskc typedef
struct otPskc
Reprezentuje klucz PSKc.
otPskcRef typedef
Ten typ danych reprezentuje odwołanie do klucza PSKc.
otSecurityPolicy typedef
Reprezentowanie zasad zabezpieczeń.
otTimestamp typedef
struct otTimestamp
Reprezentuje komponent sygnatury czasowej zbioru danych wątku.

Zmienne
OT_TOOL_PACKED_END

Funkcje
otDatasetConvertToTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Konwertuje dane operacyjne na otOperationalDatasetTlvs.
otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Tylko w przypadku FTD tworzy nowy zbiór danych operacyjnych do użycia podczas tworzenia nowej sieci.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Generuje klucz PSKc na podstawie podanego hasła, nazwy sieci i rozszerzonego identyfikatora PAN.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Pobiera aktywny zbiór danych operacyjnych.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Pobiera aktywny zbiór danych operacyjnych.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
Tylko FTD powoduje minimalne opóźnienie.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Pobiera oczekujący zbiór danych operacyjnych.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Pobiera oczekujący zbiór danych operacyjnych.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Wskazuje, czy w aktywnym zbiorze danych operacyjnych znajduje się prawidłowa sieć.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Analizuje zbiór danych operacyjnych z określonego otOperationalDatasetTlvs.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Wysyła MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Wysyła MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Wysyła MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Wysyła MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
Ustawia aktywny zbiór danych operacyjnych.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Ustawia aktywny zbiór danych operacyjnych.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
Tylko FTD ustawia minimalny czas oczekiwania.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Ustawia oczekujący zbiór danych operacyjnych.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Ustawia oczekujący zbiór danych operacyjnych.
otDatasetUpdateTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Aktualizuje dany zbiór danych operacyjnych.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Anuluje trwające (jeśli trwa) żądanie aktualizacji zbioru danych operacyjnych.
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Wskazuje, czy istnieje aktualne żądanie aktualizacji zbioru danych operacji.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Prosi o aktualizację zbioru danych operacyjnych.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Konfiguruje instancję otNetworkName z danego ciągu znaków C zakończonego wartością null.

Konstrukcja
otExtendedPanId

Reprezentuje rozszerzony identyfikator PAN.

otNetworkKey

Reprezentuje klucz sieciowy Thread.

otNetworkName

Reprezentuje nazwę sieci.

otOperationalDataset

Reprezentuje aktywny lub oczekujący zbiór danych operacyjnych.

otOperationalDatasetComponents

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

otOperationalDatasetTlvs

Reprezentuje aktywny lub oczekujący zbiór danych operacyjnych.

otPskc

Reprezentuje klucz PSKc.

otSecurityPolicy

Reprezentowanie zasad zabezpieczeń.

otTimestamp

Reprezentuje komponent sygnatury czasowej zbioru danych wątku.

Wyliczenia

otMeshcopTlvType

 otMeshcopTlvType

Reprezentuje typy TLV meshcop.

Właściwości
OT_MESHCOP_TLV_ACTIVETIMESTAMP

meshcop Aktywna sygnatura czasowa TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

meshcop Border Agent Locator TLV

OT_MESHCOP_TLV_CHANNEL

TLV kanału Meshcop

OT_MESHCOP_TLV_CHANNELMASK

Maska kanału Meshcop – TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

meshcop ID komisarza TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

TLV portu UDP komisarza meshcop

OT_MESHCOP_TLV_COMM_SESSION_ID

meshcop – identyfikator sesji komisarza – TLV

OT_MESHCOP_TLV_COUNT

Liczba TLV w meshcop

OT_MESHCOP_TLV_DELAYTIMER

meshcop Opóźnienie Timer TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

meshcop Discovery – żądanie TLV

OT_MESHCOP_TLV_DISCOVERYRESPONSE

Odpowiedź TLV firmy meshcop Discovery

OT_MESHCOP_TLV_ENERGY_LIST

Lista energetyczna meshcop

OT_MESHCOP_TLV_EXTPANID

meshcop Rozszerzony identyfikator przesuwania TLV

OT_MESHCOP_TLV_GET

meshcop – zespół pomocy technicznej

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

TLV adresu IPv6 mehcop

OT_MESHCOP_TLV_JOINERADVERTISEMENT

meshcop – łącznik – reklama TLV

OT_MESHCOP_TLV_JOINER_DTLS

TLV encapsulation DTLS do meshcop

OT_MESHCOP_TLV_JOINER_IID

meshcop Joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

Lokalizator frezarek meshcop TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Frezarka mechaniczna meshcop KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

meshcop Joiner – port UDP – TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

Lokalny prefiks sieci meshcop Mesh TLV

OT_MESHCOP_TLV_NETWORKKEY

Klucz sieciowy meshcop

OT_MESHCOP_TLV_NETWORKNAME

Nazwa sieci meshcop TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

Ciąg znaków TLV sekwencji kluczy sieci meshcop

OT_MESHCOP_TLV_PANID

Identyfikator przesuwania meshcop TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

meshcop Oczekiwanie na sygnaturę czasową TLV

OT_MESHCOP_TLV_PERIOD

TLV z okresu Meshcop

OT_MESHCOP_TLV_PROVISIONING_URL

TLV adresu URL udostępniania meshcop

OT_MESHCOP_TLV_PSKC

Meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

Czas trwania skanowania meshcop

OT_MESHCOP_TLV_SECURITYPOLICY

Zespół ds. zasad zabezpieczeń meshcop

OT_MESHCOP_TLV_STATE

TLV stanu Meshcop

OT_MESHCOP_TLV_STEERING_DATA

TLV danych sterowania meshcop

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV hermetycznego protokołu UDP Mehcop

OT_MESHCOP_TLV_VENDOR_DATA_TLV

TLV danych dostawcy w meshcop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Model dostawcy meshcop TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Nazwa dostawcy meshcop, TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

meshcop Vendor Stos wersji TLV

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

meshcop Vendor SW wersja TLV

Definicje typów

otChannelMask

uint32_t otChannelMask

Reprezentuje maskę kanału.

otDatasetMgmtSetCallback

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

Wskaźnik 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.
Zwracane wartości
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
W okresie oczekiwania nie otrzymano odpowiedzi ani potwierdzenia.

otDatasetUpdaterCallback

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

Ten wskaźnik funkcji wywołania zwrotnego jest wywoływany po zakończeniu żądania aktualizacji zbioru danych i zgłoszeniu stanu udanego lub niepowodzenia żądania aktualizacji zbioru danych.

Dostępne, gdy włączono OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

Szczegóły
Parametry
[in] aError
Stan błędu. OT_ERROR_NONE oznacza, że aktualizacja zbioru danych się powiodła. OT_ERROR_FAILED_STATE oznacza niepowodzenie z powodu nieprawidłowego stanu (MLE jest wyłączony). OT_ERROR_ALREADY oznacza, że wystąpił błąd spowodowany przez inne urządzenie w sieci wysyłające żądanie aktualizacji zbioru danych powodujące konflikt.
[in] aContext
Wskaźnik do dowolnego kontekstu (udostępnionego przez użytkownika w zasadzie otDatasetUpdaterRequestUpdate()).

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Reprezentuje rozszerzony identyfikator PAN.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Reprezentuje lokalny prefiks sieci typu mesh.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Reprezentuje typy TLV meshcop.

otNetworkKey

struct otNetworkKey otNetworkKey

Reprezentuje klucz sieciowy Thread.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Ten typ danych reprezentuje odwołanie do klucza NetworkKey.

Odwołanie do klucza

otNetworkName

struct otNetworkName otNetworkName

Reprezentuje nazwę sieci.

otNetworkName to ciąg znaków C zakończony wartością null (np. Tablica znaków m8 MUSI kończyć się znakiem null \0).

otOperationalDataset

struct otOperationalDataset otOperationalDataset

Reprezentuje aktywny lub oczekujący zbiór danych operacyjnych.

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

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

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

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Reprezentuje aktywny lub oczekujący zbiór danych operacyjnych.

Zbiór danych operacyjnych jest zakodowany w TLV zgodnie z określonym przez Thread.

otPskc

struct otPskc otPskc

Reprezentuje klucz PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

Ten typ danych reprezentuje odwołanie do klucza PSKc.

Odwołanie do klucza

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Reprezentowanie zasad zabezpieczeń.

otTimestamp

struct otTimestamp otTimestamp

Reprezentuje komponent sygnatury czasowej zbioru danych wątku.

Zmienne

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Funkcje

otDatasetConvertToTlvs

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

Konwertuje dane operacyjne na otOperationalDatasetTlvs.

Szczegóły
Parametry
[in] aDataset
Operacyjny zbiór danych do przekonwertowania na środowiska TLV.
[out] aDatasetTlvs
Wskaźnik do TLV zbioru danych, który zwraca wynik.
Zwracane wartości
OT_ERROR_NONE
Przekonwertowano plik aDataset i zaktualizowano aDatasetTlvs.
OT_ERROR_INVALID_ARGS
Wartość aDataset jest nieprawidłowa – nie zawiera aktywnych ani oczekujących sygnatur czasowych.

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Tylko w przypadku FTD tworzy nowy zbiór danych operacyjnych do użycia podczas tworzenia nowej sieci.

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

otDatasetGeneratePskc

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

Generuje klucz PSKc na podstawie podanego hasła, nazwy sieci i rozszerzonego identyfikatora PAN.

PSKc służy do organizowania sesji komisarza.

Szczegóły
Parametry
[in] aPassPhrase
Hasło służące do zlecania zadania.
[in] aNetworkName
Nazwa sieci na potrzeby obliczeń PSKc.
[in] aExtPanId
Rozszerzony identyfikator PAN do obliczeń PSKc.
[out] aPskc
Wskaźnik do zmiennej generującej wygenerowany klucz PSKc.
Zwracane wartości
OT_ERROR_NONE
Wygenerowano klucz PSKc.
OT_ERROR_INVALID_ARGS
Jeśli dowolny z argumentów wejściowych jest nieprawidłowy.

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.
Zwracane wartości
OT_ERROR_NONE
Aktywny zbiór danych operacyjnych został pobrany.
OT_ERROR_NOT_FOUND
Brak odpowiadającej mu wartości w magazynie ustawień.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *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.
Zwracane wartości
OT_ERROR_NONE
Aktywny zbiór danych operacyjnych został pobrany.
OT_ERROR_NOT_FOUND
Brak odpowiadającej mu wartości w magazynie ustawień.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Tylko FTD powoduje minimalne opóźnienie.

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

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Pobiera oczekujący zbiór danych operacyjnych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aDataset
Wskaźnik, gdzie zostanie umieszczony oczekujący zbiór danych operacyjnych.
Zwracane wartości
OT_ERROR_NONE
Pobrano oczekujący zbiór danych operacyjnych.
OT_ERROR_NOT_FOUND
Brak odpowiadającej mu wartości w magazynie ustawień.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Pobiera oczekujący zbiór danych operacyjnych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aDataset
Wskaźnik, gdzie zostanie umieszczony oczekujący zbiór danych operacyjnych.
Zwracane wartości
OT_ERROR_NONE
Pobrano oczekujący zbiór danych operacyjnych.
OT_ERROR_NOT_FOUND
Brak odpowiadającej mu wartości w magazynie ustawień.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Wskazuje, czy w aktywnym zbiorze danych operacyjnych znajduje się prawidłowa sieć.

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

otDatasetParseTlvs

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

Analizuje zbiór danych operacyjnych z określonego otOperationalDatasetTlvs.

Szczegóły
Parametry
[in] aDatasetTlvs
Wskaźnik do ciągów TLV zbioru danych.
[out] aDataset
Wskaźnik, w którym zostanie umieszczony zbiór danych.
Zwracane wartości
OT_ERROR_NONE
Ustawiono aDataset z aDatasetTlvs.
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 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órych komponentów zażądać.
[in] aTlvTypes
Wskaźnik do tablicy zawierającej dodatkowe nieprzetworzone typy TLV, które mają być żądane.
[in] aLength
Długość aTlvTypes.
[in] aAddress
Wskaźnik do miejsca docelowego IPv6, jeśli ma wartość NULL, będzie domyślnie używać ALOC repliki wiodącej.
Zwracane wartości
OT_ERROR_NONE
Polecenie zbioru danych meshcop zostało wysłane.
OT_ERROR_NO_BUFS
Za mało miejsca, aby wysłać wiadomość.

otDatasetSendMgmtActiveSet

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

Wysyła MGMT_ACTIVE_SET.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskaźnik do operacyjnego zbioru danych.
[in] aTlvs
Wskaźnik do zespołów TLV.
[in] aLength
Długość TLV.
[in] aCallback
Wskaźnik do funkcji, która jest wywoływana po odebraniu odpowiedzi lub po upływie czasu oczekiwania.
[in] aContext
Wskaźnik do kontekstu aplikacji dla elementu aCallback.
Zwracane wartości
OT_ERROR_NONE
Polecenie zbioru danych meshcop zostało wysłane.
OT_ERROR_NO_BUFS
Za mało miejsca, aby wysłać wiadomość.
OT_ERROR_BUSY
Poprzednie żądanie jest w toku.

otDatasetSendMgmtPendingGet

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

Wysyła 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órych komponentów zażądać.
[in] aTlvTypes
Wskaźnik do tablicy zawierającej dodatkowe nieprzetworzone typy TLV, które mają być żądane.
[in] aLength
Długość aTlvTypes.
[in] aAddress
Wskaźnik do miejsca docelowego IPv6, jeśli ma wartość NULL, będzie domyślnie używać ALOC repliki wiodącej.
Zwracane wartości
OT_ERROR_NONE
Polecenie zbioru danych meshcop zostało wysłane.
OT_ERROR_NO_BUFS
Za mało miejsca, aby wysłać wiadomość.

otDatasetSendMgmtPendingSet

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

Wysyła MGMT_PENDING_SET.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskaźnik do operacyjnego zbioru danych.
[in] aTlvs
Wskaźnik do zespołów TLV.
[in] aLength
Długość TLV.
[in] aCallback
Wskaźnik do funkcji, która jest wywoływana po odebraniu odpowiedzi lub po upływie czasu oczekiwania.
[in] aContext
Wskaźnik do kontekstu aplikacji dla elementu aCallback.
Zwracane wartości
OT_ERROR_NONE
Polecenie zbioru danych meshcop zostało wysłane.
OT_ERROR_NO_BUFS
Za mało miejsca, aby wysłać wiadomość.
OT_ERROR_BUSY
Poprzednie żądanie jest w toku.

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 on tylko częściowo kompletny.

Jeśli funkcja Thread jest włączona na urządzeniu, które ma częściowo kompletny aktywny zbiór danych, urządzenie spróbuje połączyć się z istniejącą siecią Thread, korzystając z wszelkich informacji znajdujących się w zbiorze danych. Do podłączenia do sieci potrzebny jest tylko klucz sieciowy Thread.

Jeśli kanału nie ma w zbiorze danych, urządzenie będzie wysyłać komunikaty MLE Announce między różnymi kanałami, aby znaleźć sąsiadów w innych kanałach.

Jeśli urządzenie połączy się z siecią typu Thread, pobierze pełny aktywny zbiór danych z podmiotu nadrzędnego. Pamiętaj, że urządzenie obsługujące router nie zostanie przeniesione do roli routera lub lidera, dopóki nie będzie miało pełnego aktywnego zbioru danych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskaźnik do aktywnego zbioru danych operacyjnych.
Zwracane wartości
OT_ERROR_NONE
Aktywny zbiór danych operacyjnych został ustawiony.
OT_ERROR_NO_BUFS
Niewystarczająca ilość miejsca w buforze, aby ustawić aktywny zbiór danych operacyjnych.
OT_ERROR_NOT_IMPLEMENTED
Platforma nie implementuje funkcji ustawień.

otDatasetSetActiveTlvs

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

Ustawia aktywny zbiór danych operacyjnych.

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

Jeśli funkcja Thread jest włączona na urządzeniu, które ma częściowo kompletny aktywny zbiór danych, urządzenie spróbuje połączyć się z istniejącą siecią Thread, korzystając z wszelkich informacji znajdujących się w zbiorze danych. Do podłączenia do sieci potrzebny jest tylko klucz sieciowy Thread.

Jeśli kanału nie ma w zbiorze danych, urządzenie będzie wysyłać komunikaty MLE Announce między różnymi kanałami, aby znaleźć sąsiadów w innych kanałach.

Jeśli urządzenie połączy się z siecią typu Thread, pobierze pełny aktywny zbiór danych z podmiotu nadrzędnego. Pamiętaj, że urządzenie obsługujące router nie zostanie przeniesione do roli routera lub lidera, dopóki nie będzie miało pełnego aktywnego zbioru danych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskaźnik do aktywnego zbioru danych operacyjnych.
Zwracane wartości
OT_ERROR_NONE
Aktywny zbiór danych operacyjnych został ustawiony.
OT_ERROR_NO_BUFS
Niewystarczająca ilość miejsca w buforze, aby ustawić aktywny zbiór danych operacyjnych.
OT_ERROR_NOT_IMPLEMENTED
Platforma nie implementuje funkcji ustawień.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Tylko FTD ustawia minimalny czas oczekiwania.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDelayTimerMinimal
Wartość minimalnego opóźnienia (w ms).
Zwracane wartości
OT_ERROR_NONE
Minimalny czas oczekiwania został ustawiony.
OT_ERROR_INVALID_ARGS
Jeśli aDelayTimerMinimal jest nieprawidłowy.

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 do oczekującego zbioru danych operacyjnych.
Zwracane wartości
OT_ERROR_NONE
Ustawiono oczekujący zbiór danych operacyjnych.
OT_ERROR_NO_BUFS
Niewystarczająca ilość miejsca w buforze, aby ustawić oczekujący zbiór danych operacyjnych.
OT_ERROR_NOT_IMPLEMENTED
Platforma nie implementuje funkcji ustawień.

otDatasetSetPendingTlvs

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

Ustawia oczekujący zbiór danych operacyjnych.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskaźnik do oczekującego zbioru danych operacyjnych.
Zwracane wartości
OT_ERROR_NONE
Ustawiono oczekujący zbiór danych operacyjnych.
OT_ERROR_NO_BUFS
Niewystarczająca ilość miejsca w buforze, aby ustawić oczekujący zbiór danych operacyjnych.
OT_ERROR_NOT_IMPLEMENTED
Platforma nie implementuje funkcji ustawień.

otDatasetUpdateTlvs

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

Aktualizuje dany zbiór danych operacyjnych.

aDataset zawiera pola do zaktualizowania i ich nową wartość.

Szczegóły
Parametry
[in] aDataset
Określa zestaw typów i wartości do zaktualizowania.
[in,out] aDatasetTlvs
Wskaźnik do aktualizacji TLV zbioru danych.
Zwracane wartości
OT_ERROR_NONE
Zaktualizowano aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDataset zawiera nieprawidłowe wartości.
OT_ERROR_NO_BUFS
Za mało miejsca w usłudze aDatasetTlvs, aby zastosować aktualizację.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Anuluje trwające (jeśli trwa) żądanie aktualizacji zbioru danych operacyjnych.

Dostępne, gdy włączono OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

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

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Wskazuje, czy istnieje aktualne żądanie aktualizacji zbioru danych operacji.

Dostępne, gdy włączono OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwracane wartości
TRUE
Trwa aktualizacja.
FALSE
Brak trwającej aktualizacji.

otDatasetUpdaterRequestUpdate

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

Prosi o aktualizację zbioru danych operacyjnych.

Dostępne, gdy włączono OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE.

Pole aDataset powinno zawierać pola do zaktualizowania i ich nową wartość. Nie może zawierać pól Aktywna ani Oczekująca sygnatura czasowa. Pole Opóźnienie jest opcjonalne. Jeśli nie zostanie podane, zostanie użyta wartość domyślna (1000 ms).

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDataset
Wskaźnik do zbioru danych zawierającego pola do zmiany.
[in] aCallback
Wywołanie zwrotne wskazujące, kiedy kończy się żądanie aktualizacji zbioru danych.
[in] aContext
Dowolny kontekst przekazany do wywołania zwrotnego.
Zwracane wartości
OT_ERROR_NONE
Rozpoczęto aktualizację zbioru danych (po zakończeniu zostanie wywołana aplikacja aCallback).
OT_ERROR_INVALID_STATE
Urządzenie jest wyłączone (MLE wyłączone).
OT_ERROR_INVALID_ARGS
Wartość aDataset jest nieprawidłowa (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ę przydzielić bufora do zapisania zbioru danych.

otNetworkNameFromString

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

Konfiguruje instancję otNetworkName z danego ciągu znaków C zakończonego wartością null.

aNameString musi być zgodny z kodowaniem UTF-8, a nazwa sieci nie może być dłuższa niż OT_NETWORK_NAME_MAX_SIZE.

Szczegóły
Parametry
[out] aNetworkName
Wskaźnik do ustawienia (otNetworkName).
[in] aNameString
Ciąg znaków C z nazwą.
Zwracane wartości
OT_ERROR_NONE
Ustawiono aNetworkName z aNameString.
OT_ERROR_INVALID_ARGS
Parametr aNameStrng jest nieprawidłowy (zbyt długi lub nie pasuje do kodowania UTF-8).

Makra

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Kanał 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Kanał 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Kanał 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Kanał 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Kanał 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Kanał 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Kanał 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Kanał 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Kanał 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Kanał 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Kanał 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Kanał 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Kanał 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Kanał 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Kanał 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Kanał 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Kanał 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Kanał 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Kanał 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Kanał 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Kanał 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Kanał 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Kanał 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Kanał 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Kanał 8.

OT_CHANNEL_9_MASK

 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 sieciowego Thread (bajty)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Maksymalny rozmiar pola Nazwa sieci Thread (bajty)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

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

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Maksymalny rozmiar pliku PSKc (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.