Joiner

Modul ini mencakup fungsi untuk peran Thread Joiner.

Ringkasan

Enumerasi
otJoinerState enum
Mendefinisikan Status Joiner.

Typedef
otJoinerCallback)(otError aError, void *aContext) typedef
void(*
Pointer dipanggil untuk memberi tahu penyelesaian operasi join.
otJoinerDiscerner typedef
Merepresentasikan Joiner Discerner.
otJoinerState typedef
Mendefinisikan Status Joiner.

Fungsi
otJoinerGetDiscerner(otInstance *aInstance)
Mendapatkan Joiner Discerner.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
Mendapatkan ID Penyambung.
otJoinerGetState(otInstance *aInstance)
Mendapatkan Status Joiner.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
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)
Mengaktifkan peran Penggabungan Thread.
otJoinerStateToString(otJoinerState aState)
const char *
Mengonversi nilai enumerasi status joiner tertentu menjadi string yang dapat dibaca manusia.
otJoinerStop(otInstance *aInstance)
void
Menonaktifkan peran Thread Joiner.

Struct
otJoinerDiscerner

Merepresentasikan Joiner Discerner.

Enumerasi

otJoinerState

 otJoinerState

Mendefinisikan Status Joiner.

Typedef

otJoinerCallback

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

Pointer dipanggil untuk memberi tahu penyelesaian operasi join.

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

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

Merepresentasikan Joiner Discerner.

otJoinerState

enum otJoinerState otJoinerState

Mendefinisikan Status Joiner.

Fungsi

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Mendapatkan Joiner Discerner.

Untuk informasi selengkapnya, lihat otJoinerSetDiscerner.

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
)

Mendapatkan ID Penyambung.

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

Joiner ID juga digunakan sebagai alamat IEEE 802.15.4 Extended Address perangkat selama proses commissioning.

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

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Mendapatkan Status Joiner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Status joiner.

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Menetapkan Joiner Discerner.

Joiner Discerner digunakan untuk menghitung ID Joiner selama proses Thread Commissioning. Untuk informasi selengkapnya, lihat otJoinerGetId.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDiscerner
Pointer ke Joiner Discerner. Jika NULL menghapus dicerner yang ditetapkan sebelumnya.
Nilai Pengembalian
OT_ERROR_NONE
Joiner Discerner berhasil diperbarui.
OT_ERROR_INVALID_ARGS
aDiscerner tidak valid (panjang yang ditentukan tidak dalam kisaran yang valid).
OT_ERROR_INVALID_STATE
Ada proses Bergabung yang sedang berlangsung sehingga Joiner Discerner tidak dapat diubah.

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
)

Mengaktifkan peran Penggabungan Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPskd
Pointer ke PSKd.
[in] aProvisioningUrl
Pointer ke URL Penyediaan (mungkin NULL).
[in] aVendorName
Pointer ke Nama Vendor (mungkin NULL).
[in] aVendorModel
Pointer ke Model Vendor (mungkin NULL).
[in] aVendorSwVersion
Pointer ke Vendor Versi SW (mungkin NULL).
[in] aVendorData
Pointer ke Data Vendor (mungkin NULL).
[in] aCallback
Pointer ke fungsi yang dipanggil saat operasi join selesai.
[in] aContext
Pointer ke konteks khusus aplikasi.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil memulai peran Penggabung.
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 stack Thread diaktifkan sepenuhnya.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

Mengonversi nilai enumerasi status joiner tertentu menjadi string yang dapat dibaca manusia.

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

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Menonaktifkan peran Thread Joiner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

Makro

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Panjang maksimum Diskerner Penyambung dalam bit.

Referensi

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