Başkan
Bu modül, İleti Dizisi Yetkilisi rolüne yönelik işlevleri içerir.
Özet
Sıralamalar |
|
---|---|
otCommissionerJoinerEvent
|
enum Yetkilide bir birleştirme etkinliği tanımlar. |
otCommissionerState{
|
enum Komiser Eyaleti'ni tanımlar. |
otJoinerInfoType{
|
enum Doğramacı Bilgi Türünü tanımlar. |
Türdefler |
|
---|---|
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
|
typedefvoid(*
Yetkili, Enerji Raporu aldığında işaretçi çağrılır. |
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
|
typedefvoid(*
Birleştirici durumu her değiştiğinde işaretçi çağrılır. |
otCommissionerJoinerEvent
|
typedef Yetkilide bir birleştirme etkinliği tanımlar. |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
typedefvoid(*
Yetkili, PAN kimliği anlaşmazlığı mesajı aldığında işaretçi çağrılır. |
otCommissionerState
|
typedefenum otCommissionerState
Komiser Eyaleti'ni tanımlar. |
otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
|
typedefvoid(*
Komisyoncu durumu her değiştiğinde işaretçi çağrılır. |
otCommissioningDataset
|
typedefstruct otCommissioningDataset
Devreye Alma Veri Kümesini temsil eder. |
otJoinerInfo
|
typedefstruct otJoinerInfo
Birleştirici Bilgilerini temsil eder. |
otJoinerInfoType
|
typedefenum otJoinerInfoType
Doğramacı Bilgi Türünü tanımlar. |
otJoinerPskd
|
typedefstruct otJoinerPskd
Birleştirici PSKd'yi temsil eder. |
otSteeringData
|
typedefstruct otSteeringData
Yönlendirme verilerini temsil eder. |
İşlevler |
|
---|---|
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
|
Birleştirici girişi ekler.
|
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
|
Belirli bir Joiner Ayırıcı değerine sahip bir Birleştirme girişi ekler.
|
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
|
Duyuru başlangıcı mesajı gönderir.
|
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
|
Energy Scan Query mesajı gönderir.
|
otCommissionerGetId(otInstance *aInstance)
|
const char *
Commissioner kimliğini döndürür.
|
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
|
İterasyon pozisyonunda bir katılımcıyla ilgili bilgi alın.
|
otCommissionerGetProvisioningUrl(otInstance *aInstance)
|
const char *
Temel Hazırlık URL'sini alır.
|
otCommissionerGetSessionId(otInstance *aInstance)
|
uint16_t
Yetkili Oturum Kimliği'ni döndürür.
|
otCommissionerGetState(otInstance *aInstance)
|
Komiser Eyaleti'ni döndürür.
|
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
|
PAN kimliği sorgusu mesajı gönderir.
|
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
Birleştirici girişini kaldırır.
|
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
|
Birleştirici girişini kaldırır.
|
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
|
MGMT_COMMISSIONER_GET gönderir.
|
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
|
MGMT_COMMISSIONER_SET gönderir.
|
otCommissionerSetId(otInstance *aInstance, const char *aId)
|
Müdür kimliğini belirler.
|
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
|
Temel Hazırlık URL'sini ayarlar.
|
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
|
İleti Dizisi Yetkilisi rolünü etkinleştirir.
|
otCommissionerStop(otInstance *aInstance)
|
İleti Dizisi Yetkilisi rolünü devre dışı bırakır.
|
Yapılar |
|
---|---|
otCommissioningDataset |
Devreye Alma Veri Kümesini temsil eder. |
otJoinerInfo |
Birleştirici Bilgilerini temsil eder. |
otJoinerPskd |
Birleştirici PSKd'yi temsil eder. |
otSteeringData |
Yönlendirme verilerini temsil eder. |
Sıralamalar
otCommissionerJoinerEvent
otCommissionerJoinerEvent
Yetkilide bir birleştirme etkinliği tanımlar.
otCommissionerState
otCommissionerState
Komiser Eyaleti'ni tanımlar.
Özellikler | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
Temsilci rolü etkin. |
OT_COMMISSIONER_STATE_DISABLED
|
Temsilci rolü devre dışı bırakıldı. |
OT_COMMISSIONER_STATE_PETITION
|
Şu anda Temsilci olmak için başvuruda bulunuyorsunuz. |
otJoinerInfoType
otJoinerInfoType
Doğramacı Bilgi Türünü tanımlar.
Özellikler | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
Herhangi bir Birleştirici kabul edin (EUI64 veya Discerner belirtilmemiş). |
OT_JOINER_INFO_TYPE_DISCERNER
|
Birleştirici Ayırıcı belirtildi ( |
OT_JOINER_INFO_TYPE_EUI64
|
Birleştirici EUI-64 belirtilmiş ( |
Türdefler
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
Yetkili, Enerji Raporu aldığında işaretçi çağrılır.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
otCommissionerJoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
Birleştirici durumu her değiştiğinde işaretçi çağrılır.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
Yetkilide bir birleştirme etkinliği tanımlar.
otCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
Yetkili, PAN kimliği anlaşmazlığı mesajı aldığında işaretçi çağrılır.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
Komisyoncu durumu her değiştiğinde işaretçi çağrılır.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
Devreye Alma Veri Kümesini temsil eder.
İşlevler
otCommissionerAddJoiner
otError otCommissionerAddJoiner(
otInstance *aInstance,
const otExtAddress *aEui64,
const char *aPskd,
uint32_t aTimeout
)
Birleştirici girişi ekler.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
otCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner(
otInstance *aInstance,
const otJoinerDiscerner *aDiscerner,
const char *aPskd,
uint32_t aTimeout
)
Belirli bir Joiner Ayırıcı değerine sahip bir Birleştirme girişi ekler.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
otCommissionerAnnounceBegin
otError otCommissionerAnnounceBegin(
otInstance *aInstance,
uint32_t aChannelMask,
uint8_t aCount,
uint16_t aPeriod,
const otIp6Address *aAddress
)
Duyuru başlangıcı mesajı gönderir.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||
Döndürülen Değerler |
|
otCommissionerEnergyScan
otError otCommissionerEnergyScan(
otInstance *aInstance,
uint32_t aChannelMask,
uint8_t aCount,
uint16_t aPeriod,
uint16_t aScanDuration,
const otIp6Address *aAddress,
otCommissionerEnergyReportCallback aCallback,
void *aContext
)
Energy Scan Query mesajı gönderir.
Ayrıntılar | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||||||||
Döndürülen Değerler |
|
otCommissionerGetId
const char * otCommissionerGetId(
otInstance *aInstance
)
Commissioner kimliğini döndürür.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Müdür Kimliği
|
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo(
otInstance *aInstance,
uint16_t *aIterator,
otJoinerInfo *aJoiner
)
İterasyon pozisyonunda bir katılımcıyla ilgili bilgi alın.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl(
otInstance *aInstance
)
Temel Hazırlık URL'sini alır.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
URL dizesine yönlendiren bir işaretçi.
|
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId(
otInstance *aInstance
)
Yetkili Oturum Kimliği'ni döndürür.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
Mevcut komisyon üyesi oturum kimliği.
|
otCommissionerGetState
otCommissionerState otCommissionerGetState(
otInstance *aInstance
)
Komiser Eyaleti'ni döndürür.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCommissionerPanIdQuery
otError otCommissionerPanIdQuery(
otInstance *aInstance,
uint16_t aPanId,
uint32_t aChannelMask,
const otIp6Address *aAddress,
otCommissionerPanIdConflictCallback aCallback,
void *aContext
)
PAN kimliği sorgusu mesajı gönderir.
Ayrıntılar | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||||||
Döndürülen Değerler |
|
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner(
otInstance *aInstance,
const otExtAddress *aEui64
)
Birleştirici girişini kaldırır.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner(
otInstance *aInstance,
const otJoinerDiscerner *aDiscerner
)
Birleştirici girişini kaldırır.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet(
otInstance *aInstance,
const uint8_t *aTlvs,
uint8_t aLength
)
MGMT_COMMISSIONER_GET gönderir.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet(
otInstance *aInstance,
const otCommissioningDataset *aDataset,
const uint8_t *aTlvs,
uint8_t aLength
)
MGMT_COMMISSIONER_SET gönderir.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
otCommissionerSetId
otError otCommissionerSetId(
otInstance *aInstance,
const char *aId
)
Müdür kimliğini belirler.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Döndürülen Değerler |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl(
otInstance *aInstance,
const char *aProvisioningUrl
)
Temel Hazırlık URL'sini ayarlar.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
Döndürülen Değerler |
|
otCommissionerStart
otError otCommissionerStart(
otInstance *aInstance,
otCommissionerStateCallback aStateCallback,
otCommissionerJoinerCallback aJoinerCallback,
void *aCallbackContext
)
İleti Dizisi Yetkilisi rolünü etkinleştirir.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
Döndürülen Değerler |
|
otCommissionerStop
otError otCommissionerStop(
otInstance *aInstance
)
İleti Dizisi Yetkilisi rolünü devre dışı bırakır.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
Döndürülen Değerler |
|
Makrolar
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255
Maksimum Devreye Alma Parolası boyutu.
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6
Devreye Alma Parolasının minimum boyutu.
OT_JOINER_MAX_PSKD_LENGTH
OT_JOINER_MAX_PSKD_LENGTH 32
Birleştirici PSKd'sinin maksimum dize uzunluğu (boş karakter içermez).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
Temel Hazırlık URL'si dizesinde maksimum boyut (karakter sayısı) (boş karakter hariç).
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
Maksimum yönlendirme verisi uzunluğu (bayt)
Kaynaklar
OpenThread API Referans konuları, GitHub'da bulunan kaynak koddan gelir. Daha fazla bilgi edinmek veya dokümanlarımıza katkıda bulunmak için Kaynaklar bölümüne bakın.