کمیسیونر، رئیس پلیس
این ماژول شامل توابعی برای نقش Thread Commissioner است.
خلاصه
شمارش ها | |
---|---|
otCommissionerJoinerEvent | enum یک رویداد Joiner را در کمیسیونر تعریف می کند. |
otCommissionerState { | enum دولت کمیسر را تعریف می کند. |
otJoinerInfoType { | enum نوع اطلاعات Joiner را تعریف می کند. |
Typedefs | |
---|---|
otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) | typedefvoid(* زمانی که کمیسیونر گزارش انرژی دریافت می کند، اشاره گر فراخوانی می شود. |
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) | typedefvoid(* هر زمان که وضعیت اتصال دهنده تغییر کند، اشاره گر فراخوانی می شود. |
otCommissionerJoinerEvent | typedef یک رویداد Joiner را در کمیسیونر تعریف می کند. |
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) | typedefvoid(* هنگامی که کمیسیونر پیام تضاد PAN ID را دریافت می کند، اشاره گر فراخوانی می شود. |
otCommissionerState | typedefenum otCommissionerState دولت کمیسر را تعریف می کند. |
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) | typedefvoid(* هر زمان که وضعیت کمیسیون تغییر کند، اشاره گر فراخوانی می شود. |
otCommissioningDataset | typedefstruct otCommissioningDataset یک مجموعه داده راه اندازی را نشان می دهد. |
otJoinerInfo | typedefstruct otJoinerInfo نشان دهنده اطلاعات وصال است. |
otJoinerInfoType | typedefenum otJoinerInfoType نوع اطلاعات Joiner را تعریف می کند. |
otJoinerPskd | typedefstruct otJoinerPskd یک Joiner PSKd را نشان می دهد. |
otSteeringData | typedefstruct otSteeringData نشان دهنده داده های فرمان است. |
کارکرد | |
---|---|
otCommissionerAddJoiner ( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout) | یک ورودی Joiner اضافه می کند. |
otCommissionerAddJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout) | یک ورودی Joiner با مقدار Joiner Discerner داده شده اضافه می کند. |
otCommissionerAnnounceBegin ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress) | یک پیام اعلام شروع ارسال می کند. |
otCommissionerEnergyScan ( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext) | یک پیام پرسش اسکن انرژی ارسال می کند. |
otCommissionerGetId ( otInstance *aInstance) | const char * شناسه کمیسیونر را برمی گرداند. |
otCommissionerGetNextJoinerInfo ( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner) | اطلاعات وصال را در موقعیت aIterator دریافت کنید. |
otCommissionerGetProvisioningUrl ( otInstance *aInstance) | const char * URL تدارکات را دریافت می کند. |
otCommissionerGetSessionId ( otInstance *aInstance) | uint16_t شناسه جلسه کمیسیون را برمی گرداند. |
otCommissionerGetState ( otInstance *aInstance) | ایالت کمیسر را برمی گرداند. |
otCommissionerPanIdQuery ( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext) | یک پیام پرس و جو PAN ID ارسال می کند. |
otCommissionerRemoveJoiner ( otInstance *aInstance, const otExtAddress *aEui64) | ورودی Joiner را حذف می کند. |
otCommissionerRemoveJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner) | ورودی Joiner را حذف می کند. |
otCommissionerSendMgmtGet ( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength) | MGMT_COMMISSIONER_GET را ارسال می کند. |
otCommissionerSendMgmtSet ( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength) | MGMT_COMMISSIONER_SET را ارسال می کند. |
otCommissionerSetId ( otInstance *aInstance, const char *aId) | شناسه کمیسیونر را تنظیم می کند. |
otCommissionerSetProvisioningUrl ( otInstance *aInstance, const char *aProvisioningUrl) | URL تامین را تنظیم می کند. |
otCommissionerStart ( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext) | نقش Thread Commissioner را فعال می کند. |
otCommissionerStop ( otInstance *aInstance) | نقش Thread Commissioner را غیرفعال می کند. |
سازه ها | |
---|---|
otCommissioningDataset | یک مجموعه داده راه اندازی را نشان می دهد. |
otJoinerInfo | نشان دهنده اطلاعات وصال است. |
otJoinerPskd | یک Joiner PSKd را نشان می دهد. |
otSteeringData | نشان دهنده داده های فرمان است. |
شمارش ها
otCommissionerJoinerEvent
otCommissionerJoinerEvent
یک رویداد Joiner را در کمیسیونر تعریف می کند.
OCommissioner State
otCommissionerState
otJoinerInfoType
otJoinerInfoType
نوع اطلاعات Joiner را تعریف می کند.
خواص | |
---|---|
OT_JOINER_INFO_TYPE_ANY | هر Joiner را بپذیرید (هیچ EUI64 یا Discerner مشخص نشده است). |
OT_JOINER_INFO_TYPE_DISCERNER | Joiner Discerner مشخص شده است ( |
OT_JOINER_INFO_TYPE_EUI64 | Joiner EUI-64 مشخص شده است ( |
Typedefs
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
زمانی که کمیسیونر گزارش انرژی دریافت می کند، اشاره گر فراخوانی می شود.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
|
otCommissionerJoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
هر زمان که وضعیت اتصال دهنده تغییر کند، اشاره گر فراخوانی می شود.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
|
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
یک رویداد Joiner را در کمیسیونر تعریف می کند.
otCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
هنگامی که کمیسیونر پیام تضاد PAN ID را دریافت می کند، اشاره گر فراخوانی می شود.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
|
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
هر زمان که وضعیت کمیسیون تغییر کند، اشاره گر فراخوانی می شود.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
یک مجموعه داده راه اندازی را نشان می دهد.
کارکرد
otCommissionerAddJoiner
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
یک ورودی Joiner اضافه می کند.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
ارزش های بازگشتی |
|
otCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
یک ورودی Joiner با مقدار Joiner Discerner داده شده اضافه می کند.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
ارزش های بازگشتی |
|
otCommissionerAnnounceBegin
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
یک پیام اعلام شروع ارسال می کند.
جزئیات | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||||
ارزش های بازگشتی |
|
otCommissionerEnergyScan
otError otCommissionerEnergyScan( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext )
یک پیام پرسش اسکن انرژی ارسال می کند.
جزئیات | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||||||||||
ارزش های بازگشتی |
|
otCommissionerGetId
const char * otCommissionerGetId( otInstance *aInstance )
شناسه کمیسیونر را برمی گرداند.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه کمیسر |
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
اطلاعات وصال را در موقعیت aIterator دریافت کنید.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
| ||||||
ارزش های بازگشتی |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
URL تدارکات را دریافت می کند.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | اشاره گر به رشته URL. |
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
شناسه جلسه کمیسیون را برمی گرداند.
جزئیات | |||
---|---|---|---|
مولفه های |
| ||
برمی گرداند | شناسه جلسه کمیسیون فعلی |
otCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
ایالت کمیسر را برمی گرداند.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
| ||||||
ارزش های بازگشتی |
|
otCommissionerPanIdQuery
otError otCommissionerPanIdQuery( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext )
یک پیام پرس و جو PAN ID ارسال می کند.
جزئیات | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||||||
ارزش های بازگشتی |
|
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
ورودی Joiner را حذف می کند.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
ارزش های بازگشتی |
|
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
ورودی Joiner را حذف می کند.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
ارزش های بازگشتی |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
MGMT_COMMISSIONER_GET را ارسال می کند.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
| ||||||
ارزش های بازگشتی |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
MGMT_COMMISSIONER_SET را ارسال می کند.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
ارزش های بازگشتی |
|
otCommissionerSetId
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
شناسه کمیسیونر را تنظیم می کند.
جزئیات | |||||||
---|---|---|---|---|---|---|---|
مولفه های |
| ||||||
ارزش های بازگشتی |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
URL تامین را تنظیم می کند.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
ارزش های بازگشتی |
|
otCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
نقش Thread Commissioner را فعال می کند.
جزئیات | |||||||||
---|---|---|---|---|---|---|---|---|---|
مولفه های |
| ||||||||
ارزش های بازگشتی |
|
otCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
نقش Thread Commissioner را غیرفعال می کند.
جزئیات | |||||
---|---|---|---|---|---|
مولفه های |
| ||||
ارزش های بازگشتی |
|
ماکروها
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255
حداکثر اندازه عبارت عبور راه اندازی.
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6
حداقل اندازه کلمه عبور راه اندازی.
OT_JOINER_MAX_PSKD_LENGTH
OT_JOINER_MAX_PSKD_LENGTH 32
حداکثر طول رشته یک Joiner PSKd (شامل کاراکتر تهی نمی شود).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
حداکثر اندازه (تعداد کاراکترها) در رشته URL تهیه (به استثنای کاراکتر تهی).
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
حداکثر طول داده فرمان (بایت)
منابع
موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.