Komisaris
Modul ini mencakup fungsi untuk peran Komisaris Utas.
Ringkasan
Pencacahan | |
---|---|
otCommissionerJoinerEvent | enum Pencacahan ini mendefinisikan Acara Penggabung pada Komisaris. |
otCommissionerState { | enum Pencacahan ini mendefinisikan Negara Komisaris. |
otJoinerInfoType { | enum Penghitungan ini mendefinisikan Joiner Info Typer. |
Typedefs | |
---|---|
otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) | typedefvoid(* Penunjuk fungsi ini dipanggil ketika Komisaris menerima Laporan Energi. |
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) | typedefvoid(* 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) | typedefvoid(* Penunjuk fungsi ini dipanggil ketika Komisaris menerima pesan Konflik ID PAN. |
otCommissionerState | typedefenum otCommissionerState Pencacahan ini mendefinisikan Negara Komisaris. |
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) | typedefvoid(* Penunjuk fungsi ini dipanggil setiap kali status komisaris berubah. |
otCommissioningDataset | typedefstruct otCommissioningDataset Struktur ini mewakili Set Data Komisioning. |
otJoinerInfo | typedefstruct otJoinerInfo Struktur ini mewakili Info Joiner. |
otJoinerInfoType | typedefenum otJoinerInfoType Penghitungan ini mendefinisikan Joiner Info Typer. |
otJoinerPskd | typedefstruct otJoinerPskd Struktur ini merepresentasikan PSKd Joiner. |
otSteeringData | typedefstruct otSteeringData 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 Announce Begin. |
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 Benang. |
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 merepresentasikan PSKd Joiner. |
otSteeringData | Struktur ini merepresentasikan data kemudi. |
Pencacahan
otCommissionerJoinerEvent
otCommissionerJoinerEvent
Pencacahan ini mendefinisikan Acara Penggabung pada Komisaris.
otCommissionerState
otCommissionerState
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 ( |
OT_JOINER_INFO_TYPE_EUI64 | Joiner EUI-64 ditentukan ( |
Typedefs
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
Penunjuk fungsi ini dipanggil saat Komisaris menerima Laporan Energi.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
otCommissionerJoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
Penunjuk fungsi ini dipanggil setiap kali status joiner berubah.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
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 |
|
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 |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
Struktur ini mewakili Set Data Komisioning.
otJoinerInfoType
enum otJoinerInfoType otJoinerInfoType
Penghitungan ini mendefinisikan Joiner Info Typer.
Fungsi
otCommissionerAddJoiner
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
Fungsi ini menambahkan entri Joiner.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||
Kembalikan Nilai |
|
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 |
| ||||||||
Kembalikan Nilai |
|
otCommissionerAnnounceBegin
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
Fungsi ini mengirimkan pesan Announce Begin.
Detail | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||||
Kembalikan Nilai |
|
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 |
| ||||||||||||||||
Kembalikan Nilai |
|
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
Metode ini mendapatkan info joiner di posisi aIterator.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembalikan Nilai |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
Fungsi ini mendapatkan URL Penyediaan.
Detail | |||
---|---|---|---|
Parameter |
| ||
Kembali | Penunjuk ke string URL. |
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
Fungsi ini mengembalikan ID Sesi Komisaris.
Detail | |||
---|---|---|---|
Parameter |
| ||
Kembali | ID sesi komisaris saat ini. |
otCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance ).dll
Fungsi ini mengembalikan Negara Komisaris.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembalikan Nilai |
|
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 |
| ||||||||||||
Kembalikan Nilai |
|
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
Fungsi ini menghapus entri Joiner.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||
Kembalikan Nilai |
|
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
Fungsi ini menghapus entri Joiner.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||
Kembalikan Nilai |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
Fungsi ini mengirim MGMT_COMMISSIONER_GET.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembalikan Nilai |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
Fungsi ini mengirim MGMT_COMMISSIONER_SET.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||
Kembalikan Nilai |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
Fungsi ini menyetel URL Penyediaan.
Detail | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembalikan Nilai |
|
otCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
Fungsi ini memungkinkan peran Komisaris Benang.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||
Kembalikan Nilai |
|
otCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
Fungsi ini menonaktifkan peran Komisaris Utas.
Detail | |||||
---|---|---|---|---|---|
Parameter |
| ||||
Kembalikan Nilai |
|
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)