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

Komisaris

Modul ini mencakup fungsi untuk peran Komisaris Utas.

Ringkasan

Pencacahan

otCommissionerJoinerEvent enum
Pencacahan ini mendefinisikan Acara Penggabung pada Komisaris.
otCommissionerState {
OT_COMMISSIONER_STATE_DISABLED = 0,
OT_COMMISSIONER_STATE_PETITION = 1,
OT_COMMISSIONER_STATE_ACTIVE = 2
}
enum
Pencacahan ini mendefinisikan Negara Komisaris.
otJoinerInfoType {
OT_JOINER_INFO_TYPE_ANY = 0,
OT_JOINER_INFO_TYPE_EUI64 = 1,
OT_JOINER_INFO_TYPE_DISCERNER = 2
}
enum
Penghitungan ini mendefinisikan Joiner Info Typer.

Typedefs

otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
Penunjuk fungsi ini dipanggil ketika Komisaris menerima Laporan Energi.
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
Penunjuk fungsi ini dipanggil setiap kali status joiner berubah.
otCommissionerJoinerEvent typedef
Pencacahan ini mendefinisikan Acara Penggabung pada Komisaris.
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
Penunjuk fungsi ini dipanggil ketika Komisaris menerima pesan Konflik ID PAN.
otCommissionerState typedef
Pencacahan ini mendefinisikan Negara Komisaris.
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) typedef
void(*
Penunjuk fungsi ini dipanggil setiap kali status komisaris berubah.
otCommissioningDataset typedef
Struktur ini mewakili Set Data Komisioning.
otJoinerInfo typedef
struct otJoinerInfo
Struktur ini mewakili Info Joiner.
otJoinerInfoType typedef
Penghitungan ini mendefinisikan Joiner Info Typer.
otJoinerPskd typedef
struct otJoinerPskd
Struktur ini mewakili PSKd Joiner.
otSteeringData typedef
Struktur ini merepresentasikan 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 Mulai.
otCommissionerEnergyScan ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
Fungsi ini mengirimkan pesan Energy Scan Query.
otCommissionerGetNextJoinerInfo ( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
Metode ini mendapatkan info joiner di posisi aIterator.
otCommissionerGetProvisioningUrl ( otInstance *aInstance)
const char *
Fungsi ini mendapatkan URL Penyediaan.
otCommissionerGetSessionId ( otInstance *aInstance)
uint16_t
Fungsi ini mengembalikan ID Sesi Komisaris.
otCommissionerGetState ( otInstance *aInstance)
Fungsi ini mengembalikan Negara Komisaris.
otCommissionerPanIdQuery ( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
Fungsi ini mengirimkan pesan PAN ID Query.
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.
otCommissionerSetProvisioningUrl ( otInstance *aInstance, const char *aProvisioningUrl)
Fungsi ini menyetel URL Penyediaan.
otCommissionerStart ( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
Fungsi ini memungkinkan peran Komisaris Utas.
otCommissionerStop ( otInstance *aInstance)
Fungsi ini menonaktifkan peran Komisaris Utas.

Structs

otCommissioningDataset

Struktur ini mewakili Set Data Komisioning.

otJoinerInfo

Struktur ini mewakili Info Joiner.

otJoinerPskd

Struktur ini mewakili PSKd Joiner.

otSteeringData

Struktur ini merepresentasikan data kemudi.

Pencacahan

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

Pencacahan ini mendefinisikan Acara Penggabung pada Komisaris.

otCommissionerState

 otCommissionerState

Pencacahan ini 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

Penghitungan ini mendefinisikan Joiner Info Typer.

Properti
OT_JOINER_INFO_TYPE_ANY

Terima Penggabung apa pun (EUI64 atau Discerner tidak ditentukan).

OT_JOINER_INFO_TYPE_DISCERNER

Joiner Discerner ditentukan ( mSharedId.mDiscerner di otJoinerInfo ).

OT_JOINER_INFO_TYPE_EUI64

EUI-64 Joiner ditentukan ( mSharedId.mEui64 di otJoinerInfo ).

Typedefs

otCommissionerEnergyReportCallback

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

Penunjuk fungsi ini dipanggil ketika Komisaris menerima Laporan Energi.

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

otCommissionerJoinerCallback

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

Penunjuk fungsi ini dipanggil setiap kali status joiner berubah.

Detail
Parameter
[in] aEvent
Jenis acara joiner.
[in] aJoinerInfo
Penunjuk ke Info Penggabung.
[in] aJoinerId
Sebuah pointer ke Joiner ID (jika tidak diketahui, itu akan menjadi NULL).
[in] aContext
Penunjuk ke konteks khusus aplikasi.

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

Pencacahan ini mendefinisikan Acara Penggabung pada Komisaris.

otCommissionerPanIdConflictCallback

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

Penunjuk fungsi ini dipanggil ketika Komisaris menerima pesan Konflik ID PAN.

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

otCommissionerState

enum otCommissionerState otCommissionerState

Pencacahan ini mendefinisikan Negara Komisaris.

otCommissionerStateCallback

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

Penunjuk fungsi ini dipanggil setiap kali status komisaris berubah.

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

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

Struktur ini mewakili Set Data Komisioning.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

Struktur ini mewakili Info Joiner.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Penghitungan ini mendefinisikan Joiner Info Typer.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Struktur ini mewakili PSKd Joiner.

otSteeringData

struct otSteeringData otSteeringData

Struktur ini merepresentasikan data kemudi.

Fungsi

otCommissionerAddJoiner

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

Fungsi ini menambahkan entri Joiner.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aEui64
Sebuah pointer ke IEEE EUI-64 atau NULL Joiner untuk Joiner manapun.
[in] aPskd
Penunjuk ke PSKd.
[in] aTimeout
Waktu setelah Penggabung secara otomatis dihapus, dalam hitungan detik.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menambahkan Joiner.
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
)

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

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aDiscerner
Sebuah penunjuk ke Joiner Discerner.
[in] aPskd
Penunjuk ke PSKd.
[in] aTimeout
Waktu setelah Penggabung secara otomatis dihapus, dalam hitungan detik.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menambahkan Joiner.
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
)

Fungsi ini mengirimkan pesan Umumkan Mulai.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aChannelMask
Nilai topeng saluran.
[in] aCount
Jumlah pesan Pengumuman per saluran.
[in] aPeriod
Waktu antara dua transmisi Umumkan MLE berturut-turut (dalam milidetik).
[in] aAddress
Penunjuk ke tujuan IPv6.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mengantrekan pesan Announce Begin.
OT_ERROR_NO_BUFS
Buffer tidak mencukupi untuk menghasilkan pesan Announce Begin.
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 mengirimkan pesan Energy Scan Query.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aChannelMask
Nilai topeng 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
Penunjuk ke tujuan IPv6.
[in] aCallback
Penunjuk ke fungsi yang dipanggil saat menerima pesan Laporan Energi.
[in] aContext
Penunjuk ke konteks khusus aplikasi.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mengantrekan pesan Energy Scan Query.
OT_ERROR_NO_BUFS
Buffer tidak cukup untuk menghasilkan pesan Energy Scan Query.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommissionerGetNextJoinerInfo

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

Metode ini mendapatkan info joiner di posisi aIterator.

Detail
Parameter
[in] aInstance
Sebuah pointer ke instance.
[in,out] aIterator
Penunjuk ke konteks iterator Info Joiner.
[out] aJoiner
Referensi ke info Joiner.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mendapatkan info Bergabung.
OT_ERROR_NOT_FOUND
Tidak ditemukan Joiner berikutnya.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Fungsi ini mendapatkan URL Penyediaan.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
Kembali
Penunjuk ke string URL.

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

Fungsi ini mengembalikan ID Sesi Komisaris.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
Kembali
ID sesi komisaris saat ini.

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)
.dll

Fungsi ini mengembalikan Negara Komisaris.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
Kembalikan Nilai
OT_COMMISSIONER_STATE_DISABLED
Komisaris dinonaktifkan.
OT_COMMISSIONER_STATE_PETITION
Menjadi komisaris.
OT_COMMISSIONER_STATE_ACTIVE
Komisaris diaktifkan.

otCommissionerPanIdQuery

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

Fungsi ini mengirimkan pesan PAN ID Query.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aPanId
ID PAN untuk membuat kueri.
[in] aChannelMask
Nilai topeng saluran.
[in] aAddress
Penunjuk ke tujuan IPv6.
[in] aCallback
Penunjuk ke fungsi yang dipanggil saat menerima pesan Konflik ID PAN.
[in] aContext
Penunjuk ke konteks khusus aplikasi.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mengantrekan pesan Permintaan ID PAN.
OT_ERROR_NO_BUFS
Buffer tidak cukup untuk menghasilkan pesan Kueri ID PAN.
OT_ERROR_INVALID_STATE
Komisaris tidak aktif.

otCommissionerRemoveJoiner

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

Fungsi ini menghapus entri Joiner.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aEui64
Sebuah pointer ke IEEE EUI-64 atau NULL Joiner untuk Joiner manapun.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menghapus Joiner.
OT_ERROR_NOT_FOUND
Joiner 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
)

Fungsi ini menghapus entri Joiner.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aEui64
Sebuah penunjuk ke Joiner Discerner.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menghapus Joiner.
OT_ERROR_NOT_FOUND
Joiner 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
)

Fungsi ini mengirim MGMT_COMMISSIONER_GET.

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

otCommissionerSendMgmtSet

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

Fungsi ini mengirim MGMT_COMMISSIONER_SET.

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

otCommissionerSetProvisioningUrl

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

Fungsi ini menyetel URL Penyediaan.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aProvisioningUrl
Sebuah pointer ke Provisioning URL (mungkin NULL untuk disetel sebagai string kosong).
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menyetel URL Penyediaan.
OT_ERROR_INVALID_ARGS
aProvisioningUrl tidak valid (terlalu panjang).

otCommissionerStart

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

Fungsi ini memungkinkan peran Komisaris Utas.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aStateCallback
Penunjuk ke fungsi yang dipanggil saat status komisaris berubah.
[in] aJoinerCallback
Sebuah pointer ke fungsi yang dipanggil dengan event joiner terjadi.
[in] aCallbackContext
Penunjuk ke konteks khusus aplikasi.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil memulai layanan Komisaris.
OT_ERROR_ALREADY
Komisaris sudah dimulai.
OT_ERROR_INVALID_STATE
Perangkat saat ini tidak terhubung ke jaringan.

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

Fungsi ini menonaktifkan peran Komisaris Utas.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menghentikan layanan Komisaris.
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 Penggabung (tidak termasuk karakter nol).

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

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

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

Panjang data kemudi maks (byte)