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{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
} 		enum
Komiser Eyaleti'ni tanımlar.
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
} 		enum
Doğramacı Bilgi Türünü tanımlar.

Türdefler
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
Yetkili, Enerji Raporu aldığında işaretçi çağrılır.
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
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) typedef
void(*
Yetkili, PAN kimliği anlaşmazlığı mesajı aldığında işaretçi çağrılır.
otCommissionerState typedef
Komiser Eyaleti'ni tanımlar.
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) typedef
void(*
Komisyoncu durumu her değiştiğinde işaretçi çağrılır.
otCommissioningDataset typedef
Devreye Alma Veri Kümesini temsil eder.
otJoinerInfo typedef
struct otJoinerInfo
Birleştirici Bilgilerini temsil eder.
otJoinerInfoType typedef
Doğramacı Bilgi Türünü tanımlar.
otJoinerPskd typedef
struct otJoinerPskd
Birleştirici PSKd'yi temsil eder.
otSteeringData typedef
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 (otJoinerInfo içinde mSharedId.mDiscerner).

OT_JOINER_INFO_TYPE_EUI64

Birleştirici EUI-64 belirtilmiş (otJoinerInfo içinde mSharedId.mEui64).

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
[in] aChannelMask
Kanal maskesi değeri.
[in] aEnergyList
Enerji ölçüm listesinin işaretçisi.
[in] aEnergyListLength
aEnergyListLength alanındaki giriş sayısı.
[in] aContext
Uygulamaya özel bağlama işaret eden bir işaretçi.

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
[in] aEvent
Birleştirme etkinliğinin türü.
[in] aJoinerInfo
Birleştirici Bilgisi için işaretçi.
[in] aJoinerId
Birleştirici kimliği için işaretçi (bilinmiyorsa NULL olacaktır).
[in] aContext
Uygulamaya özel bağlama işaret eden bir işaretçi.

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
[in] aPanId
PAN kimliği değeri.
[in] aChannelMask
Kanal maskesi değeri.
[in] aContext
Uygulamaya özel bağlama işaret eden bir işaretçi.

otCommissionerState

enum otCommissionerState otCommissionerState

Komiser Eyaleti'ni tanımlar.

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
[in] aState
Komiser eyaleti.
[in] aContext
Uygulamaya özel bağlama işaret eden bir işaretçi.

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

Devreye Alma Veri Kümesini temsil eder.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

Birleştirici Bilgilerini temsil eder.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

Doğramacı Bilgi Türünü tanımlar.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

Birleştirici PSKd'yi temsil eder.

otSteeringData

struct otSteeringData otSteeringData

Yönlendirme verilerini 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
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aEui64
Herhangi bir üye için, birleştiricinin IEEE EUI-64 veya NULL işaretçisi.
[in] aPskd
PSKd'ye işaret eden bir işaretçi.
[in] aTimeout
Birleştiricinin otomatik olarak kaldırılması için saniye cinsinden süre.
Döndürülen Değerler
OT_ERROR_NONE
Birleştirici başarıyla eklendi.
OT_ERROR_NO_BUFS
Birleştiriciyi eklemek için tampon yok.
OT_ERROR_INVALID_ARGS
aEui64 veya aPskd geçersiz.
OT_ERROR_INVALID_STATE
Temsilci aktif değil.

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
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDiscerner
Birleştirici Ayırıcı'ya işaret eden işaretçi.
[in] aPskd
PSKd'ye işaret eden bir işaretçi.
[in] aTimeout
Birleştiricinin otomatik olarak kaldırılması için saniye cinsinden süre.
Döndürülen Değerler
OT_ERROR_NONE
Birleştirici başarıyla eklendi.
OT_ERROR_NO_BUFS
Birleştiriciyi eklemek için tampon yok.
OT_ERROR_INVALID_ARGS
aDiscerner veya aPskd geçersiz.
OT_ERROR_INVALID_STATE
Temsilci aktif değil.

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
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aChannelMask
Kanal maskesi değeri.
[in] aCount
Kanal başına Duyuru mesajı sayısı.
[in] aPeriod
Birbirini izleyen iki MLE Duyuru yayını arasındaki süre (milisaniye cinsinden).
[in] aAddress
IPv6 hedefine işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
Duyuru Başlangıcı mesajı başarıyla sıraya alındı.
OT_ERROR_NO_BUFS
Duyuru Başlangıcı mesajı oluşturmak için yeterli arabellek yok.
OT_ERROR_INVALID_STATE
Temsilci aktif değil.

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
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aChannelMask
Kanal maskesi değeri.
[in] aCount
Kanal başına enerji ölçümü sayısı.
[in] aPeriod
Enerji ölçümleri arasındaki süre (milisaniye).
[in] aScanDuration
Her enerji ölçümü için tarama süresi (milisaniye).
[in] aAddress
IPv6 hedefine işaretçi.
[in] aCallback
Enerji Raporu mesajı alındığında çağrıda bulunan bir işlevin işaretçisi.
[in] aContext
Uygulamaya özel bağlama işaret eden bir işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
Energy Scan Query mesajı başarıyla sıraya alındı.
OT_ERROR_NO_BUFS
Energy Scan Query mesajı oluşturmak için yetersiz arabellek.
OT_ERROR_INVALID_STATE
Temsilci aktif değil.

otCommissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

Commissioner kimliğini döndürür.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
İ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
[in] aInstance
Örneğe işaret eden bir işaretçi.
[in,out] aIterator
Birleştirici Bilgi yineleyici bağlamına işaret eden bir işaretçi.
[out] aJoiner
Birleştirici bilgisi için referans.
Döndürülen Değerler
OT_ERROR_NONE
Birleştirici bilgisi başarıyla alındı.
OT_ERROR_NOT_FOUND
Sonraki Birleştirici bulunamadı.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

Temel Hazırlık URL'sini alır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
İ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
[in] aInstance
OpenThread örneğinin işaretçisi.
İadeler
Mevcut komisyon üyesi oturum kimliği.

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

Komiser Eyaleti'ni döndürür.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
Döndürülen Değerler
OT_COMMISSIONER_STATE_DISABLED
Komiser devre dışı bırakıldı.
OT_COMMISSIONER_STATE_PETITION
Komisyoncu olmak.
OT_COMMISSIONER_STATE_ACTIVE
Komiser etkinleştirildi.

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
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aPanId
Sorgulanacak PAN kimliği.
[in] aChannelMask
Kanal maskesi değeri.
[in] aAddress
IPv6 hedefine işaretçi.
[in] aCallback
PAN Kimliği Çakışması mesajı alındığında çağrıda bulunan bir işlevin işaretçisi.
[in] aContext
Uygulamaya özel bağlama işaret eden bir işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
PAN kimliği sorgusu mesajı başarıyla sıraya alındı.
OT_ERROR_NO_BUFS
PAN kimliği sorgusu mesajı oluşturmak için yeterli arabellek yok.
OT_ERROR_INVALID_STATE
Temsilci aktif değil.

otCommissionerRemoveJoiner

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

Birleştirici girişini kaldırır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aEui64
Herhangi bir üye için, birleştiricinin IEEE EUI-64 veya NULL işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
Birleştirici başarıyla kaldırıldı.
OT_ERROR_NOT_FOUND
aEui64 tarafından belirtilen birleştirici bulunamadı.
OT_ERROR_INVALID_ARGS
aEui64 numaralı telefon geçersiz.
OT_ERROR_INVALID_STATE
Temsilci aktif değil.

otCommissionerRemoveJoinerWithDiscerner

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

Birleştirici girişini kaldırır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDiscerner
Birleştirici Ayırıcı'ya işaret eden işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
Birleştirici başarıyla kaldırıldı.
OT_ERROR_NOT_FOUND
aEui64 tarafından belirtilen birleştirici bulunamadı.
OT_ERROR_INVALID_ARGS
aDiscerner numaralı telefon geçersiz.
OT_ERROR_INVALID_STATE
Temsilci aktif değil.

otCommissionerSendMgmtGet

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

MGMT_COMMISSIONER_GET gönderir.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aTlvs
TLV'lere işaret eden bir işaretçi.
[in] aLength
TLV'lerin uzunluğu.
Döndürülen Değerler
OT_ERROR_NONE
meshcop veri kümesi komutu başarıyla gönderildi.
OT_ERROR_NO_BUFS
Göndermek için yeterli arabellek alanı yok.
OT_ERROR_INVALID_STATE
Temsilci aktif değil.

otCommissionerSendMgmtSet

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

MGMT_COMMISSIONER_SET gönderir.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDataset
Devreye alma veri kümesi için işaretçi.
[in] aTlvs
TLV'lere işaret eden bir işaretçi.
[in] aLength
TLV'lerin uzunluğu.
Döndürülen Değerler
OT_ERROR_NONE
meshcop veri kümesi komutu başarıyla gönderildi.
OT_ERROR_NO_BUFS
Göndermek için yeterli arabellek alanı yok.
OT_ERROR_INVALID_STATE
Temsilci aktif değil.

otCommissionerSetId

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

Müdür kimliğini belirler.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aId
Bir dize karakter dizisine işaret eden öğe. Boş değer sonlandırılmalıdır.
Döndürülen Değerler
OT_ERROR_NONE
Müdür kimliği başarıyla ayarlandı.
OT_ERROR_INVALID_ARGS
Ad çok uzun.
OT_ERROR_INVALID_STATE
Temsilci aktif ve kimlik değiştirilemez.

otCommissionerSetProvisioningUrl

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

Temel Hazırlık URL'sini ayarlar.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aProvisioningUrl
Temel Hazırlık URL'sine yönelik işaretçi (boş dize olarak ayarlamak için NULL değeri olabilir).
Döndürülen Değerler
OT_ERROR_NONE
Temel Hazırlık URL'si başarıyla ayarlandı.
OT_ERROR_INVALID_ARGS
aProvisioningUrl geçersiz (çok uzun).

otCommissionerStart

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

İleti Dizisi Yetkilisi rolünü etkinleştirir.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aStateCallback
Görevlinin durumu değiştiğinde çağrılan bir işlevin işaretçisi.
[in] aJoinerCallback
Bir birleştirme etkinliğiyle çağrılan işlevin işaretçisi oluşur.
[in] aCallbackContext
Uygulamaya özel bağlama işaret eden bir işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
Yetkili hizmeti başarıyla başlatıldı.
OT_ERROR_ALREADY
Delege zaten başlatıldı.
OT_ERROR_INVALID_STATE
Cihaz şu anda bir ağa bağlı değil.

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

İleti Dizisi Yetkilisi rolünü devre dışı bırakır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
Yetkili hizmeti başarıyla durduruldu.
OT_ERROR_ALREADY
Komisyon yöneticisi zaten durduruldu.

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.