Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.

Joiner

Modul ini mencakup fungsi untuk peran Thread Joiner.

Ringkasan

Enumerasi

otJoinerState enum
Enumerasi ini menentukan Status Joiner.

Typedef

otJoinerCallback)(otError aError, void *aContext) typedef
void(*
Pointer fungsi ini dipanggil untuk memberi tahu penyelesaian operasi bergabung.
otJoinerDiscerner typedef
Struktur ini mewakili Pembeda Joiner.
otJoinerState typedef
Enumerasi ini menentukan Status Joiner.

Fungsi

otJoinerGetDiscerner(otInstance *aInstance)
Fungsi ini mendapatkan Joiner Discerner.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
Fungsi ini akan mendapatkan ID Joiner.
otJoinerGetState(otInstance *aInstance)
Fungsi ini akan menampilkan Status Joiner.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Fungsi ini menetapkan Joiner Discerner.
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)
Fungsi ini mengaktifkan peran Thread Joiner.
otJoinerStateToString(otJoinerState aState)
const char *
Fungsi ini mengonversi nilai enumerasi status gabungan yang diberikan menjadi string yang dapat dibaca manusia.
otJoinerStop(otInstance *aInstance)
void
Fungsi ini menonaktifkan peran Thread Joiner.

Struct

otJoinerDiscerner

Struktur ini mewakili Pembeda Joiner.

Enumerasi

Negara bagian lain

 otJoinerState

Enumerasi ini menentukan Status Joiner.

Typedef

otJoinerCallback

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

Pointer fungsi ini dipanggil untuk memberi tahu penyelesaian operasi bergabung.

Detail
Parameter
[in] aError
OT_ERROR_NONE jika proses bergabung berhasil. OT_ERROR_Keamanan jika proses bergabung gagal karena kredensial keamanan. OT_ERROR_NOT_FOUND jika tidak ada jaringan yang dapat ditemukan yang ditemukan. OT_ERROR_RESPONSE_TIMEOUT jika waktu tunggu respons habis.
[in] aContext
Pointer ke konteks khusus aplikasi.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Struktur ini mewakili Pembeda Joiner.

Negara bagian lain

enum otJoinerState otJoinerState

Enumerasi ini menentukan Status Joiner.

Fungsi

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Fungsi ini mendapatkan Joiner Discerner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke Joiner Discerner atau NULL jika tidak ada yang ditetapkan.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Fungsi ini akan mendapatkan ID Joiner.

Jika Joiner Discerner tidak disetel, ID Joiner adalah 64 bit pertama dari hasil komputasi SHA-256 di atas IEEE EUI-64 yang ditetapkan pabrik. Jika tidak, ID Joiner dihitung dari nilai Discerner Gabungan.

ID Joiner juga digunakan sebagai Alamat Extended IEEE 802.15.4 perangkat selama proses komisioning.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke ID Joiner.

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Fungsi ini akan menampilkan Status Joiner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Fungsi ini menetapkan Joiner Discerner.

Joiner Discerner digunakan untuk menghitung ID Joiner yang digunakan selama proses komisioning/penggabungan.

Secara default (bila beragam tidak disediakan atau disetel ke NULL), ID Joiner diperoleh sebagai 64 bit pertama dari hasil komputasi SHA-256 melalui IEEE EUI-64 yang ditetapkan pabrik. Perlu diperhatikan bahwa ini adalah perilaku utama yang diharapkan oleh spesifikasi Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDiscerner
Pointer ke Joiner Discerner. Jika NULL menghapus setiap pemroses yang ditetapkan sebelumnya.
Nilai yang Ditampilkan
OT_ERROR_NONE
Joiner Discerner berhasil diperbarui.
OT_ERROR_INVALID_ARGS
aDiscerner tidak valid (panjang yang ditentukan tidak berada dalam rentang yang valid).
OT_ERROR_INVALID_STATE
Ada proses Bergabung yang berkelanjutan sehingga Joiner Discerner tidak dapat diubah.

otJoiner Mulai

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
)

Fungsi ini mengaktifkan peran Thread Joiner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPskd
Pointer ke PSK.
[in] aProvisioningUrl
Pointer ke URL Penyediaan (mungkin NULL).
[in] aVendorName
Pointer ke Vendor Name (mungkin NULL).
[in] aVendorModel
Pointer ke Model Vendor (mungkin NULL).
[in] aVendorSwVersion
Pointer ke Versi SW Vendor (bisa NULL).
[in] aVendorData
Pointer ke Data Vendor (mungkin NULL).
[in] aCallback
Pointer ke fungsi yang dipanggil ketika operasi bergabung selesai.
[in] aContext
Pointer ke konteks khusus aplikasi.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil memulai peran Joiner.
OT_ERROR_BUSY
Upaya sebelumnya masih berlangsung.
OT_ERROR_INVALID_ARGS
aPskd atau aProvisioningUrl tidak valid.
OT_ERROR_INVALID_STATE
Stack IPv6 tidak diaktifkan atau Thread thread sepenuhnya diaktifkan.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

Fungsi ini mengonversi nilai enumerasi status gabungan yang diberikan menjadi string yang dapat dibaca manusia.

Detail
Parameter
[in] aState
Status bergabung.
Hasil
Representasi string aState yang dapat dibaca manusia.

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Fungsi ini menonaktifkan peran Thread Joiner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

Makro

OT_pedoman_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Panjang maksimum Joiner Discerner dalam bit.

Resource

Topik Referensi OpenThread API berasal dari kode sumber, yang tersedia di GitHub. Untuk informasi selengkapnya, atau untuk memberikan kontribusi pada dokumentasi kami, lihat Referensi.