Komisaris

Modul ini mencakup fungsi untuk peran Thread Commissioner.

Ringkasan

Enumerasi
otCommissionerJoinerEvent enum
Mendefinisikan Peristiwa Penggabungan di Commissioner.
otCommissionerState{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
} 		enum
Mendefinisikan Negara Komisaris.
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
} 		enum
Mendefinisikan Jenis Info Penyambung.

Typedef
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
Pointer dipanggil saat Komisaris menerima Laporan Energi.
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
Pointer dipanggil setiap kali status joiner berubah.
otCommissionerJoinerEvent typedef
Mendefinisikan Peristiwa Penggabungan di Commissioner.
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
Pointer dipanggil saat Commissioner menerima pesan Konflik ID PAN.
otCommissionerState typedef
Mendefinisikan Negara Komisaris.
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) typedef
void(*
Pointer dipanggil setiap kali status komisioner berubah.
otCommissioningDataset typedef
Merepresentasikan Set Data Commissioning.
otJoinerInfo typedef
struct otJoinerInfo
Merepresentasikan Info Penggabungan.
otJoinerInfoType typedef
Mendefinisikan Jenis Info Penyambung.
otJoinerPskd typedef
struct otJoinerPskd
Merepresentasikan Joiner PSKd.
otSteeringData typedef
Menampilkan data pengarahan.

Fungsi
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
Menambahkan entri Penyambung.
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
Menambahkan entri Joiner dengan nilai Joiner Discerner tertentu.
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
Mengirim pesan Mulai Diumumkan.
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
Mengirim pesan Kueri Pemindaian Energi.
otCommissionerGetId(otInstance *aInstance)
const char *
Menampilkan ID Commissioner.
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Dapatkan info joiner di posisi aIterator.
otCommissionerGetProvisioningUrl(otInstance *aInstance)
const char *
Mendapatkan URL Penyediaan.
otCommissionerGetSessionId(otInstance *aInstance)
uint16_t
Menampilkan ID Sesi Komisaris.
otCommissionerGetState(otInstance *aInstance)
Menampilkan Status Komisaris.
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
Mengirim pesan Kueri ID PAN.
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Menghapus entri Penyambung.
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
Menghapus entri Penyambung.
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
Mengirim MGMT_COMMISSIONER_GET.
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
Mengirim MGMT_COMMISSIONER_SET.
otCommissionerSetId(otInstance *aInstance, const char *aId)
Menetapkan ID Commissioner.
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
Menetapkan URL Penyediaan.
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
Mengaktifkan peran Komisaris Thread.
otCommissionerStop(otInstance *aInstance)
Menonaktifkan peran Thread Commissioner.

Struct
otCommissioningDataset

Merepresentasikan Set Data Commissioning.

otJoinerInfo

Merepresentasikan Info Penggabungan.

otJoinerPskd

Merepresentasikan Joiner PSKd.

otSteeringData

Menampilkan data pengarahan.

Enumerasi

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

Mendefinisikan Peristiwa Penggabungan di Commissioner.

otCommissionerState

 otCommissionerState

Mendefinisikan Negara Komisaris.

Properti
OT_COMMISSIONER_STATE_ACTIVE

Peran komisaris aktif.

OT_COMMISSIONER_STATE_DISABLED

Peran Komisaris dinonaktifkan.

OT_COMMISSIONER_STATE_PETITION

Saat ini mengajukan petisi untuk menjadi Komisaris.

otJoinerInfoType

 otJoinerInfoType

Mendefinisikan Jenis Info Penyambung.

Properti
OT_JOINER_INFO_TYPE_ANY

Terima Joiner apa pun (tidak ada EUI64 atau Discerner yang ditentukan).

OT_JOINER_INFO_TYPE_DISCERNER

Joiner Discerner ditentukan (mSharedId.mDiscerner di otJoinerInfo).

OT_JOINER_INFO_TYPE_EUI64

Penyambung EUI-64 ditentukan (mSharedId.mEui64 dalam otJoinerInfo).

Typedef

otCommissionerEnergyReportCallback

void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)

Pointer dipanggil saat Komisaris menerima Laporan Energi.

Detail
Parameter
[in] aChannelMask
Nilai mask saluran.
[in] aEnergyList
Penunjuk ke daftar pengukuran energi.
[in] aEnergyListLength
Jumlah entri dalam aEnergyListLength.
[in] aContext
Pointer ke konteks khusus aplikasi.

otCommissionerJoinerCallback

void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)

Pointer dipanggil setiap kali status joiner berubah.

Detail
Parameter
[in] aEvent
Jenis peristiwa joiner.
[in] aJoinerInfo
Pointer ke Joiner Info.
[in] aJoinerId
Pointer ke Joiner ID (jika tidak diketahui, akan menjadi NULL).
[in] aContext
Pointer ke konteks khusus aplikasi.

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

Mendefinisikan Peristiwa Penggabungan di Commissioner.

otCommissionerPanIdConflictCallback

void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)

Pointer dipanggil saat Commissioner menerima pesan Konflik ID PAN.

Detail
Parameter
[in] aPanId
Nilai ID PAN.
[in] aChannelMask
Nilai mask saluran.
[in] aContext
Pointer ke konteks khusus aplikasi.

otCommissionerState

enum otCommissionerState otCommissionerState

Mendefinisikan Negara Komisaris.

otCommissionerStateCallback

void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)

Pointer dipanggil setiap kali status komisioner berubah.

Detail
Parameter
[in] aState
Komisaris.
[in] aContext
Pointer ke konteks khusus aplikasi.

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

Merepresentasikan Set Data Commissioning.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

Merepresentasikan Info Penggabungan.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Mendefinisikan Jenis Info Penyambung.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Merepresentasikan Joiner PSKd.

otSteeringData

struct otSteeringData otSteeringData

Menampilkan data pengarahan.

Fungsi

otCommissionerAddJoiner

otError otCommissionerAddJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64,
  const char *aPskd,
  uint32_t aTimeout
)

Menambahkan entri Penyambung.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEui64
Pointer ke IEEE EUI-64 atau NULL dari Joiner untuk Joiner apa pun.
[in] aPskd
Pointer ke PSKd.
[in] aTimeout
Waktu setelah Joiner dihapus secara otomatis, dalam detik.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menambahkan Penyambung.
OT_ERROR_NO_BUFS
Tidak ada buffer yang tersedia untuk menambahkan Joiner.
OT_ERROR_INVALID_ARGS
aEui64 atau aPskd tidak valid.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommissionerAddJoinerWithDiscerner

otError otCommissionerAddJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner,
  const char *aPskd,
  uint32_t aTimeout
)

Menambahkan entri Joiner dengan nilai Joiner Discerner tertentu.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDiscerner
Pointer ke Joiner Discerner.
[in] aPskd
Pointer ke PSKd.
[in] aTimeout
Waktu setelah Joiner dihapus secara otomatis, dalam detik.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menambahkan Penyambung.
OT_ERROR_NO_BUFS
Tidak ada buffer yang tersedia untuk menambahkan Joiner.
OT_ERROR_INVALID_ARGS
aDiscerner atau aPskd tidak valid.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommissionerAnnounceBegin

otError otCommissionerAnnounceBegin(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  const otIp6Address *aAddress
)

Mengirim pesan Mulai Diumumkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aChannelMask
Nilai mask saluran.
[in] aCount
Jumlah pesan Pengumuman per channel.
[in] aPeriod
Waktu antara dua transmisi Pengumuman MLE berturut-turut (dalam milidetik).
[in] aAddress
Sebuah pointer ke tujuan IPv6.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengantrekan pesan Umumkan Mulai.
OT_ERROR_NO_BUFS
Buffering tidak cukup untuk menghasilkan pesan Pemberitahuan Mulai.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommissionerEnergyScan

otError otCommissionerEnergyScan(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  uint16_t aScanDuration,
  const otIp6Address *aAddress,
  otCommissionerEnergyReportCallback aCallback,
  void *aContext
)

Mengirim pesan Kueri Pemindaian Energi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aChannelMask
Nilai mask saluran.
[in] aCount
Jumlah pengukuran energi per saluran.
[in] aPeriod
Waktu antara pengukuran energi (milidetik).
[in] aScanDuration
Durasi pemindaian untuk setiap pengukuran energi (milidetik).
[in] aAddress
Sebuah pointer ke tujuan IPv6.
[in] aCallback
Pointer ke fungsi yang dipanggil saat menerima pesan Laporan Energi.
[in] aContext
Pointer ke konteks khusus aplikasi.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengantrekan pesan Energy Scan Query.
OT_ERROR_NO_BUFS
Buffering tidak cukup untuk menghasilkan pesan Kueri Pemindaian Energi.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

Menampilkan ID Commissioner.

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

otCommissionerGetNextJoinerInfo

otError otCommissionerGetNextJoinerInfo(
  otInstance *aInstance,
  uint16_t *aIterator,
  otJoinerInfo *aJoiner
)

Dapatkan info joiner di posisi aIterator.

Detail
Parameter
[in] aInstance
Pointer ke instance.
[in,out] aIterator
Pointer ke konteks iterator Info Joiner.
[out] aJoiner
Referensi ke info Penggabungan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mendapatkan info Penggabung.
OT_ERROR_NOT_FOUND
Tidak ditemukan Penyambung berikutnya.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Mendapatkan URL Penyediaan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke string URL.

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Menampilkan ID Sesi Komisaris.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
ID sesi komisioner saat ini.

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Menampilkan Status Komisaris.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
OT_COMMISSIONER_STATE_DISABLED
Komisaris dinonaktifkan.
OT_COMMISSIONER_STATE_PETITION
Menjadi komisioner.
OT_COMMISSIONER_STATE_ACTIVE
Komisaris diaktifkan.

otCommissionerPanIdQuery

otError otCommissionerPanIdQuery(
  otInstance *aInstance,
  uint16_t aPanId,
  uint32_t aChannelMask,
  const otIp6Address *aAddress,
  otCommissionerPanIdConflictCallback aCallback,
  void *aContext
)

Mengirim pesan Kueri ID PAN.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPanId
ID PAN untuk dikueri.
[in] aChannelMask
Nilai mask saluran.
[in] aAddress
Sebuah pointer ke tujuan IPv6.
[in] aCallback
Pointer ke fungsi yang dipanggil saat menerima pesan Konflik ID PAN.
[in] aContext
Pointer ke konteks khusus aplikasi.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengantrekan pesan Kueri ID PAN.
OT_ERROR_NO_BUFS
Buffering tidak cukup untuk menghasilkan pesan Kueri ID PAN.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommissionerRemoveJoiner

otError otCommissionerRemoveJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

Menghapus entri Penyambung.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEui64
Pointer ke IEEE EUI-64 atau NULL dari Joiner untuk Joiner apa pun.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menghapus Penyambung.
OT_ERROR_NOT_FOUND
Penggabungan yang ditentukan oleh aEui64 tidak ditemukan.
OT_ERROR_INVALID_ARGS
aEui64 tidak valid.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommissionerRemoveJoinerWithDiscerner

otError otCommissionerRemoveJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner
)

Menghapus entri Penyambung.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDiscerner
Pointer ke Joiner Discerner.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menghapus Penyambung.
OT_ERROR_NOT_FOUND
Penggabungan yang ditentukan oleh aEui64 tidak ditemukan.
OT_ERROR_INVALID_ARGS
aDiscerner tidak valid.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommissionerSendMgmtGet

otError otCommissionerSendMgmtGet(
  otInstance *aInstance,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Mengirim MGMT_COMMISSIONER_GET.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aTlvs
Pointer ke TLV.
[in] aLength
Panjang TLV.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengirim perintah set data meshcop.
OT_ERROR_NO_BUFS
Ruang buffer tidak cukup untuk mengirim.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommissionerSendMgmtSet

otError otCommissionerSendMgmtSet(
  otInstance *aInstance,
  const otCommissioningDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

Mengirim MGMT_COMMISSIONER_SET.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDataset
Pointer ke commissioning set data.
[in] aTlvs
Pointer ke TLV.
[in] aLength
Panjang TLV.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengirim perintah set data meshcop.
OT_ERROR_NO_BUFS
Ruang buffer tidak cukup untuk mengirim.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommissionerSetId

otError otCommissionerSetId(
  otInstance *aInstance,
  const char *aId
)

Menetapkan ID Commissioner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aId
Pointer ke array karakter string. Harus diakhiri null.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan ID Commissioner.
OT_ERROR_INVALID_ARGS
Nama depan terlalu panjang.
OT_ERROR_INVALID_STATE
Komisaris aktif dan ID tidak dapat diubah.

otCommissionerSetProvisioningUrl

otError otCommissionerSetProvisioningUrl(
  otInstance *aInstance,
  const char *aProvisioningUrl
)

Menetapkan URL Penyediaan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aProvisioningUrl
Pointer ke URL Penyediaan (mungkin NULL untuk ditetapkan sebagai string kosong).
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan URL Penyediaan.
OT_ERROR_INVALID_ARGS
aProvisioningUrl tidak valid (terlalu panjang).

otCommissionerStart

otError otCommissionerStart(
  otInstance *aInstance,
  otCommissionerStateCallback aStateCallback,
  otCommissionerJoinerCallback aJoinerCallback,
  void *aCallbackContext
)

Mengaktifkan peran Komisaris Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aStateCallback
Pointer ke fungsi yang dipanggil saat status komisioner berubah.
[in] aJoinerCallback
Pointer ke fungsi yang dipanggil dengan peristiwa joiner terjadi.
[in] aCallbackContext
Pointer ke konteks khusus aplikasi.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil memulai layanan Commissioner.
OT_ERROR_ALREADY
Komisaris sudah dimulai.
OT_ERROR_INVALID_STATE
Saat ini perangkat tidak terhubung ke jaringan.

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

Menonaktifkan peran Thread Commissioner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menghentikan layanan Commissioner.
OT_ERROR_ALREADY
Komisaris sudah dihentikan.

Makro

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

 OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255

Ukuran maksimum Frasa Sandi Commissioning.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

Ukuran minimum Frasa Sandi Commissioning.

OT_JOINER_MAX_PSKD_LENGTH

 OT_JOINER_MAX_PSKD_LENGTH 32

Panjang string maksimum PSKd Joiner (tidak termasuk karakter null).

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

Ukuran maksimum (jumlah karakter) dalam string URL Penyediaan (tidak termasuk karakter null).

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

Panjang data pengarah maksimum (byte)

Referensi

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