Stolarz

Ten moduł zawiera funkcje związane z rolą „łącznik wątków”.

Podsumowanie

Wyliczenia
otJoinerState enum | typ wyliczeniowy
Definiuje stan złącza.

Definicje typów
otJoinerCallback)(otError aError, void *aContext) typedef
void(*
Wskaźnik jest wywoływany w celu powiadomienia o zakończeniu operacji złączenia.
otJoinerDiscerner typedef
Reprezentuje dodatek zbierającego dane.
otJoinerState typedef
Definiuje stan złącza.

Funkcje
otJoinerGetDiscerner(otInstance *aInstance)
Pobieram narzędzie do rozpoznawania złączeń.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
Pobiera identyfikator złączającego.
otJoinerGetState(otInstance *aInstance)
Pobiera stan złącza.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Konfiguruje narzędzie zbierające dane.
otJoinerStart(otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
Włącza rolę złączającego wątki.
otJoinerStateToString(otJoinerState aState)
const char *
Konwertuje wartość wyliczeniową danego stanu łączenia na ciąg zrozumiały dla człowieka.
otJoinerStop(otInstance *aInstance)
void
Wyłącza rolę złączającego wątki.

Konstrukcja
otJoinerDiscerner

Reprezentuje dodatek zbierającego dane.

Wyliczenia

otJoinerState

 otJoinerState

Definiuje stan złącza.

Definicje typów

otJoinerCallback

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

Wskaźnik jest wywoływany w celu powiadomienia o zakończeniu operacji złączenia.

Szczegóły
Parametry
[in] aError
OT_ERROR_NONE, jeśli proces dołączania się powiódł. OT_ERROR_Security, jeśli proces dołączania nie powiedzie się z powodu bezpieczeństwa danych uwierzytelniających. OT_ERROR_NOT_FOUND, jeśli nie wykryto sieci, z którą można się połączyć. Jeśli przekroczono limit czasu odpowiedzi, zwracany jest błąd OT_ERROR_ANSWER_TIMEOUT.
[in] aContext
Wskaźnik do kontekstu aplikacji.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Reprezentuje dodatek zbierającego dane.

otJoinerState

enum otJoinerState otJoinerState

Definiuje stan złącza.

Funkcje

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Pobieram narzędzie do rozpoznawania złączeń.

Więcej informacji znajdziesz tutaj: otJoinerSetDiscerner.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do wyróżnienia złączania lub wartość NULL, jeśli nie ustawiono żadnej wartości.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Pobiera identyfikator złączającego.

Jeśli funkcja rozpoznawania złączeń nie jest skonfigurowana, identyfikator złącza to pierwsze 64 bity wyniku obliczenia SHA-256 względem IEEE EUI-64 przypisanego do ustawień fabrycznych. W przeciwnym razie wartość złącza jest obliczana na podstawie wartości złączającego.

Ten identyfikator jest też używany jako rozszerzony adres IEEE 802.15.4 urządzenia podczas procesu uruchamiania.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Wskaźnik do identyfikatora złączającego.

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Pobiera stan złącza.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
Zwroty
Stan złączania.

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Konfiguruje narzędzie zbierające dane.

Narzędzie do rozpoznawania łączników służy do obliczania identyfikatora złącza podczas procesu przekazywania gwintu. Więcej informacji znajdziesz tutaj: otJoinerGetId.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aDiscerner
Wskaźnik do łączenia metod łączenia. Jeśli wartość NULL wyczyści wcześniej ustawiony element wyróżniający.
Zwracane wartości
OT_ERROR_NONE
Łącznik został zaktualizowany.
OT_ERROR_INVALID_ARGS
Wartość aDiscerner jest nieprawidłowa (określona długość jest poza dozwolonym zakresem).
OT_ERROR_INVALID_STATE
W toku trwa proces dołączania, więc nie można zmienić narzędzia rozpoznawania osób.

otJoinerStart

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

Włącza rolę złączającego wątki.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[in] aPskd
Wskaźnik do klucza PSKd.
[in] aProvisioningUrl
Wskaźnik do adresu URL do obsługi administracyjnej (może mieć wartość NULL).
[in] aVendorName
Wskaźnik do nazwy dostawcy (może zawierać wartość NULL).
[in] aVendorModel
Wskaźnik modelu dostawcy (może mieć wartość NULL).
[in] aVendorSwVersion
Wskaźnik do wersji SW dostawcy (może mieć wartość NULL).
[in] aVendorData
Wskaźnik do danych dostawcy (może mieć wartość NULL).
[in] aCallback
Wskaźnik do funkcji, która jest wywoływana po zakończeniu operacji łączenia.
[in] aContext
Wskaźnik do kontekstu aplikacji.
Zwracane wartości
OT_ERROR_NONE
Przypisano rolę Joiner.
OT_ERROR_BUSY
Poprzednia próba jest nadal w toku.
OT_ERROR_INVALID_ARGS
Wartość aPskd lub aProvisioningUrl jest nieprawidłowa.
OT_ERROR_INVALID_STATE
Stos IPv6 nie jest włączony lub stos wątków jest w pełni włączony.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

Konwertuje wartość wyliczeniową danego stanu łączenia na ciąg zrozumiały dla człowieka.

Szczegóły
Parametry
[in] aState
Stan złączania.
Zwroty
Zrozumiały dla człowieka ciąg tekstowy z reprezentacją aState.

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Wyłącza rolę złączającego wątki.

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

Makra

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Maksymalna długość elementu rozpoznającego łącza (w bitach).

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.