Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.
Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Komisaris

Modul ini mencakup fungsi untuk peran Komisioner Thread.

Ringkasan

Enumerasi

otCommissionerJoinerEvent enum
Enumerasi ini menentukan Peristiwa Joiner pada Komisaris.
otCommissionerState{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
}
enum
Enumerasi ini menentukan Negara Bagian Komisaris.
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
}
enum
Enumerasi ini menentukan Jenis Info Penggabung.

Typedef

otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
Pointer fungsi ini dipanggil saat Komisaris menerima Laporan Energi.
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
Pointer fungsi ini dipanggil setiap kali status penggabung berubah.
otCommissionerJoinerEvent typedef
Enumerasi ini menentukan Peristiwa Joiner pada Komisaris.
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
Pointer fungsi ini dipanggil saat Komisaris menerima pesan Konflik ID PAN.
otCommissionerState typedef
Enumerasi ini menentukan Negara Bagian Komisaris.
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) typedef
void(*
Pointer fungsi ini dipanggil setiap kali status komisioner berubah.
otCommissioningDataset typedef
Struktur ini mewakili Set Data Komisi.
otJoinerInfo typedef
struct otJoinerInfo
Struktur ini mewakili Info Joiner.
otJoinerInfoType typedef
Enumerasi ini menentukan Jenis Info Penggabung.
otJoinerPskd typedef
struct otJoinerPskd
Struktur ini mewakili PSKd Joiner.
otSteeringData typedef
Struktur ini mewakili data kemudi.

Fungsi

otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
Fungsi ini menambahkan entri Joiner.
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
Fungsi ini menambahkan entri Joiner dengan nilai Joiner Discerner yang diberikan.
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
Fungsi ini mengirimkan pesan Umumkan Memulai.
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
Fungsi ini mengirim pesan Kueri Pemindaian Energi.
otCommissionerGetId(otInstance *aInstance)
const char *
Fungsi ini menampilkan ID Komisaris.
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Metode ini mendapatkan info penggabung di posisi aterator.
otCommissionerGetProvisioningUrl(otInstance *aInstance)
const char *
Fungsi ini mendapatkan URL Penyediaan.
otCommissionerGetSessionId(otInstance *aInstance)
uint16_t
Fungsi ini menampilkan ID Sesi Komisioner.
otCommissionerGetState(otInstance *aInstance)
Fungsi ini menampilkan Status Komisaris.
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
Fungsi ini mengirimkan pesan Kueri ID PAN.
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Fungsi ini menghapus entri Joiner.
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
Fungsi ini menghapus entri Joiner.
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
Fungsi ini mengirim MGMT_COMMISSIONER_GET.
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
Fungsi ini mengirim MGMT_COMMISSIONER_SET.
otCommissionerSetId(otInstance *aInstance, const char *aId)
Fungsi ini menetapkan ID Komisaris.
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
Fungsi ini menetapkan URL Penyediaan.
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
Fungsi ini mengaktifkan peran Komisioner Thread.
otCommissionerStop(otInstance *aInstance)
Fungsi ini menonaktifkan peran Komisioner Thread.

Struct

otCommissioningDataset

Struktur ini mewakili Set Data Komisi.

otJoinerInfo

Struktur ini mewakili Info Joiner.

otJoinerPskd

Struktur ini mewakili PSKd Joiner.

otSteeringData

Struktur ini mewakili data kemudi.

Enumerasi

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

Enumerasi ini menentukan Peristiwa Joiner pada Komisaris.

otCommissionerState

 otCommissionerState

Enumerasi ini menentukan Negara Bagian 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

Enumerasi ini menentukan Jenis Info Penggabung.

Properti
OT_JOINER_INFO_TYPE_ANY

Menerima Joiner (tidak ada EUI64 atau Discerner yang ditentukan).

OT_JOINER_INFO_TYPE_DISCERNER

Perbedaan Joiner ditetapkan (mSharedId.mDiscerner dalam otJoinerInfo).

OT_JOINER_INFO_TYPE_EUI64

Joiner EUI-64 ditetapkan (mSharedId.mEui64 dalam otJoinerInfo).

Typedef

otCommissionerEnergyReportCallback

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

Pointer fungsi ini dipanggil saat Komisaris menerima Laporan Energi.

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

otCommissionerGabungerCallback

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

Pointer fungsi ini dipanggil setiap kali status penggabung berubah.

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

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

Enumerasi ini menentukan Peristiwa Joiner pada Komisaris.

otCommissionerPanIdKonflikCallback

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

Pointer fungsi ini dipanggil saat Komisaris 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

Enumerasi ini menentukan Negara Bagian Komisaris.

otCommissionerStateCallback

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

Pointer fungsi ini dipanggil setiap kali status komisioner berubah.

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

otCom data

struct otCommissioningDataset otCommissioningDataset

Struktur ini mewakili Set Data Komisi.

InfoGabung

struct otJoinerInfo otJoinerInfo

Struktur ini mewakili Info Joiner.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Enumerasi ini menentukan Jenis Info Penggabung.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Struktur ini mewakili PSKd Joiner.

data OTSteeringData

struct otSteeringData otSteeringData

Struktur ini mewakili data kemudi.

Fungsi

otCommissionerTambahkanGabung

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

Fungsi ini menambahkan entri Joiner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEui64
Pointer ke IEEE EUI-64 atau NULL dari Joiner untuk setiap Joiner.
[in] aPskd
Pointer ke PSKd.
[in] aTimeout
Waktu saat Joiner dihapus secara otomatis, dalam detik.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menambahkan Joiner.
OT_ERROR_NO_BUFS
Tidak tersedia buffer 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
)

Fungsi ini menambahkan entri Joiner dengan nilai Joiner Discerner yang diberikan.

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

otCommmissionerAnnounceBegin

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

Fungsi ini mengirimkan pesan Umumkan Memulai.

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
Pointer ke tujuan IPv6.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengantrekan pesan Mengumumkan Mulai.
OT_ERROR_NO_BUFS
Buffering tidak cukup untuk menghasilkan pesan Mengumumkan 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
)

Fungsi ini 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
Pointer ke tujuan IPv6.
[in] aCallback
Pointer ke fungsi yang dipanggil saat menerima pesan Laporan Energi.
[in] aContext
Pointer ke konteks khusus aplikasi.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengantrekan pesan Kueri Pemindaian Energi.
OT_ERROR_NO_BUFS
Buffering tidak cukup untuk menghasilkan pesan Kueri Pemindaian Energi.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommmissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

Fungsi ini menampilkan ID Komisaris.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Menampilkan
ID Komisioner

otCommmissionerGetNextJoinerInfo

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

Metode ini mendapatkan info penggabung di posisi aterator.

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

otCommmissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Fungsi ini mendapatkan URL Penyediaan.

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

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Fungsi ini menampilkan ID Sesi Komisioner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Menampilkan
ID sesi komisaris saat ini.

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Fungsi ini menampilkan Status Komisaris.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
OT_COMMISSIONER_STATE_DISABLED
Komisaris dinonaktifkan.
OT_COMMISSIONER_STATE_PETITION
Menjadi komisaris.
OT_COMMISSIONER_STATE_ACTIVE
Komisaris diaktifkan.

otCommmissionerPanIdQuery

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

Fungsi ini mengirimkan pesan Kueri ID PAN.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPanId
ID PAN untuk kueri.
[in] aChannelMask
Nilai mask saluran.
[in] aAddress
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 yang Ditampilkan
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.

otCommmissionerRemoveJoiner

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

Fungsi ini menghapus entri Joiner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEui64
Pointer ke IEEE EUI-64 atau NULL dari Joiner untuk setiap Joiner.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menghapus Joiner.
OT_ERROR_NOT_FOUND
Joiner yang ditetapkan oleh aEui64 tidak ditemukan.
OT_ERROR_INVALID_ARGS
aEui64 tidak valid.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommmissionerRemoveJoinerWithDiscerner

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

Fungsi ini menghapus entri Joiner.

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

otCommmissionerSendMgmtGet

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

Fungsi ini mengirim MGMT_COMMISSIONER_GET.

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

otCommmissionerSendMgmtSet

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

Fungsi ini mengirim MGMT_COMMISSIONER_SET.

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

otCommmissionerSetId

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

Fungsi ini menetapkan ID Komisaris.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aId
Pointer ke array karakter string. Harus diakhiri dengan null.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menyetel ID Komisaris.
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
)

Fungsi ini 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 yang Ditampilkan
OT_ERROR_NONE
Berhasil menetapkan URL Penyediaan.
OT_ERROR_INVALID_ARGS
aProvisioningUrl tidak valid (terlalu panjang).

otcommissionerMulai

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

Fungsi ini mengaktifkan peran Komisioner Thread.

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

otCommmissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

Fungsi ini menonaktifkan peran Komisioner Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
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 Komisi.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

Ukuran minimum Frasa Sandi Komisioner.

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 maks (jumlah karakter) dalam string URL Penyediaan (tidak termasuk karakter null).

OT_STEERING_DATA_MAX_PANJANG

 OT_STEERING_DATA_MAX_LENGTH 16

Panjang data kemudi maksimum (byte)

Resource

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