Operasyonel Veri Kümesi

Operasyonel Veri Kümesi API'sine yönelik işlevleri içerir.

Özet

Veri Kümesi Güncelleyici, yalnızca FTD derlemeleri için veri kümesi güncellemelerini yönetmeyi sağlayan işlevler içerir.

Operasyonel Veri Kümesi API'si, FTD ve MTD derlemeleri için Etkin ve Beklemedeki veri kümeleri ile veri kümesi TLV'lerini yönetmeyi sağlayan işlevler içerir.

Sıralamalar
otMeshcopTlvType{
  OT_MESHCOP_TLV_CHANNEL = 0,
  OT_MESHCOP_TLV_PANID = 1,
  OT_MESHCOP_TLV_EXTPANID = 2,
  OT_MESHCOP_TLV_NETWORKNAME = 3,
  OT_MESHCOP_TLV_PSKC = 4,
  OT_MESHCOP_TLV_NETWORKKEY = 5,
  OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6,
  OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,
  OT_MESHCOP_TLV_STEERING_DATA = 8,
  OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9,
  OT_MESHCOP_TLV_COMMISSIONER_ID = 10,
  OT_MESHCOP_TLV_COMM_SESSION_ID = 11,
  OT_MESHCOP_TLV_SECURITYPOLICY = 12,
  OT_MESHCOP_TLV_GET = 13,
  OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14,
  OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,
  OT_MESHCOP_TLV_STATE = 16,
  OT_MESHCOP_TLV_JOINER_DTLS = 17,
  OT_MESHCOP_TLV_JOINER_UDP_PORT = 18,
  OT_MESHCOP_TLV_JOINER_IID = 19,
  OT_MESHCOP_TLV_JOINER_RLOC = 20,
  OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21,
  OT_MESHCOP_TLV_PROVISIONING_URL = 32,
  OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,
  OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,
  OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35,
  OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36,
  OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,
  OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48,
  OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49,
  OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,
  OT_MESHCOP_TLV_DELAYTIMER = 52,
  OT_MESHCOP_TLV_CHANNELMASK = 53,
  OT_MESHCOP_TLV_COUNT = 54,
  OT_MESHCOP_TLV_PERIOD = 55,
  OT_MESHCOP_TLV_SCAN_DURATION = 56,
  OT_MESHCOP_TLV_ENERGY_LIST = 57,
  OT_MESHCOP_TLV_DISCOVERYREQUEST = 128,
  OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129,
  OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241
} 		enum
Meshcop TLV türlerini temsil eder.

Türdefler
otChannelMask typedef
uint32_t
Kanal maskesini temsil eder.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
MGMT_SET isteğine yanıt alındığında veya zaman aşımına uğradığında işaretçi çağrılır.
otDatasetUpdaterCallback)(otError aError, void *aContext) typedef
void(*
Bu geri çağırma işlevi işaretçisi, bir Veri Kümesi güncelleme isteği tamamlandığında çağrılır ve Veri Kümesi güncelleme isteğinin başarılı veya hata durumunu bildirir.
otExtendedPanId typedef
Genişletilmiş PAN kimliğini temsil eder.
otMeshLocalPrefix typedef
Örgü Yerel Önekini temsil eder.
otMeshcopTlvType typedef
Meshcop TLV türlerini temsil eder.
otNetworkKey typedef
struct otNetworkKey
Thread ağ anahtarını temsil eder.
otNetworkKeyRef typedef
Bu veri türü, NetworkKey parametresine ait KeyRef'i temsil eder.
otNetworkName typedef
struct otNetworkName
Ağ Adını temsil eder.
otOperationalDataset typedef
Etkin veya Beklemedeki Bir Operasyonel Veri Kümesini temsil ediyor.
otOperationalDatasetComponents typedef
Etkin veya Beklemedeki Operasyonel Veri Kümesinde farklı bileşenlerin varlığını gösterir.
otOperationalDatasetTlvs typedef
Etkin veya Beklemedeki Bir Operasyonel Veri Kümesini temsil ediyor.
otPskc typedef
struct otPskc
PSKc'yi temsil eder.
otPskcRef typedef
Bu veri türü, PSKc'ye ait KeyRef'i temsil eder.
otSecurityPolicy typedef
Güvenlik Politikası'nı temsil etmelidir.
otTimestamp typedef
struct otTimestamp
İş parçacığı veri kümesi zaman damgası bileşenini temsil eder.

Değişkenler
OT_TOOL_PACKED_END

İşlevler
otDatasetConvertToTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Belirli bir operasyonel veri kümesini otOperationalDatasetTlvs türüne dönüştürür.
otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Yalnızca FTD için yeni bir ağ oluştururken kullanılacak yeni bir Operasyonel Veri Kümesi oluşturur.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Belirli bir parola, ağ adı ve genişletilmiş PAN kimliğinden PSKc oluşturur.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Etkin Operasyonel Veri Kümesini alır.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Etkin Operasyonel Veri Kümesini alır.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
Yalnızca FTD için minimum gecikme zamanlayıcısı sağlanır.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Beklemedeki Operasyonel Veri Kümesini alır.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Beklemedeki Operasyonel Veri Kümesini alır.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Etkin Operasyonel Veri Kümesinde geçerli bir ağın mevcut olup olmadığını belirtir.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Belirli bir otOperationalDatasetTlvs öğesinden Operasyonel Veri Kümesini ayrıştırır.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
MGMT_ACTIVE_GET gönderir.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
MGMT_ACTIVE_SET gönderir.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
MGMT_PENDING_GET gönderir.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
MGMT_PENDING_SET gönderir.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
Etkin Operasyonel Veri Kümesini ayarlar.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Etkin Operasyonel Veri Kümesini ayarlar.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
Yalnızca FTD için minimum gecikme süresi ölçer.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Beklemedeki Operasyonel Veri Kümesini ayarlar.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Beklemedeki Operasyonel Veri Kümesini ayarlar.
otDatasetUpdateTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Belirli bir Operasyonel Veri Kümesini günceller.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Devam eden (varsa) bir Operasyonel Veri Kümesi güncelleme isteğini iptal eder.
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Devam eden bir İşlem Veri Kümesi güncelleme isteği olup olmadığını belirtir.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Operasyonel Veri Kümesi için güncelleme isteğinde bulundu.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Boş sonlandırılmış belirli bir C dizesinden otNetworkName örneği ayarlar.

Yapılar
otExtendedPanId

Genişletilmiş PAN kimliğini temsil eder.

otNetworkKey

Thread ağ anahtarını temsil eder.

otNetworkName

Ağ Adını temsil eder.

otOperationalDataset

Etkin veya Beklemedeki Bir Operasyonel Veri Kümesini temsil ediyor.

otOperationalDatasetComponents

Etkin veya Beklemedeki Operasyonel Veri Kümesinde farklı bileşenlerin varlığını gösterir.

otOperationalDatasetTlvs

Etkin veya Beklemedeki Bir Operasyonel Veri Kümesini temsil ediyor.

otPskc

PSKc'yi temsil eder.

otSecurityPolicy

Güvenlik Politikası'nı temsil etmelidir.

otTimestamp

İş parçacığı veri kümesi zaman damgası bileşenini temsil eder.

Sıralamalar

otMeshcopTlvType

 otMeshcopTlvType

Meshcop TLV türlerini temsil eder.

Özellikler
OT_MESHCOP_TLV_ACTIVETIMESTAMP

meshcop Etkin Zaman Damgası TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

meshcop Sınır Acentesi Bulucu TLV

OT_MESHCOP_TLV_CHANNEL

meshcop Kanalı TLV

OT_MESHCOP_TLV_CHANNELMASK

meshcop Kanal Maskesi TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

meshcop Komisyoncu Kimliği TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

meshcop Yetkilisi UDP Bağlantı Noktası TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

meshcop Komisyoncu Oturum Kimliği TLV

OT_MESHCOP_TLV_COUNT

meshcop Sayısı TLV

OT_MESHCOP_TLV_DELAYTIMER

meshcop Gecikme Kronometresi TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

meshcop Keşif İsteği TLV

OT_MESHCOP_TLV_DISCOVERYRESPONSE

meshcop Keşif Yanıtı TLV

OT_MESHCOP_TLV_ENERGY_LIST

meshcop Enerji Listesi TLV

OT_MESHCOP_TLV_EXTPANID

meshcop Genişletilmiş Kaydırma Kimliği TLV

OT_MESHCOP_TLV_GET

meshcop TLV Alın

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

meshcop IPv6 adresi TLV

OT_MESHCOP_TLV_JOINERADVERTISEMENT

meshcop Joiner Reklamı TLV

OT_MESHCOP_TLV_JOINER_DTLS

meshcop Joiner DTLS Kapsülleme TLV

OT_MESHCOP_TLV_JOINER_IID

meshcop Joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

meshcop Birleştirici Yönlendirici Bulucu TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

meshcop Birleştirici Freze KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

meshcop Birleştirici UDP Bağlantı Noktası TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

meshcop Mesh Yerel Önek TLV

OT_MESHCOP_TLV_NETWORKKEY

meshcop Ağ Anahtarı TLV

OT_MESHCOP_TLV_NETWORKNAME

meshcop Ağ Adı TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

meshcop Ağ Anahtar Sırası TLV

OT_MESHCOP_TLV_PANID

meshcop Pan Kimliği TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

meshcop Beklemedeki Zaman Damgası TLV

OT_MESHCOP_TLV_PERIOD

meshcop Dönemi TLV

OT_MESHCOP_TLV_PROVISIONING_URL

meshcop Temel Hazırlık URL'si TLV

OT_MESHCOP_TLV_PSKC

meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

meshcop Tarama Süresi TLV

OT_MESHCOP_TLV_SECURITYPOLICY

meshcop Güvenlik Politikası TLV

OT_MESHCOP_TLV_STATE

meshcop Eyaleti TLV

OT_MESHCOP_TLV_STEERING_DATA

meshcop Yönlendirme Verileri TLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

meshcop UDP kapsülleme TLV

OT_MESHCOP_TLV_VENDOR_DATA_TLV

meshcop Satıcı Verileri TLV

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

meshcop Satıcı Modeli TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

meshcop Satıcı Adı TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

meshcop Satıcı Yığını Sürümü TLV

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

meshcop Satıcı Yazılımı Sürüm TLV

Türdefler

otChannelMask

uint32_t otChannelMask

Kanal maskesini temsil eder.

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

MGMT_SET isteğine yanıt alındığında veya zaman aşımına uğradığında işaretçi çağrılır.

Ayrıntılar
Parametreler
[in] aResult
İşlemin sonucu.
[in] aContext
Uygulamaya özel bağlama işaret eden bir işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
İstek, lider tarafından kabul edildi.
OT_ERROR_REJECTED
İstek, lider tarafından reddedildi.
OT_ERROR_PARSE
Yanıt ayrıştırılırken bir hata oluştu.
OT_ERROR_ABORT
İstek eş tarafından sıfırlandı.
OT_ERROR_RESPONSE_TIMEOUT
Zaman aşımı süresi boyunca hiçbir yanıt veya onay alınmadı.

otDatasetUpdaterCallback

void(* otDatasetUpdaterCallback)(otError aError, void *aContext)

Bu geri çağırma işlevi işaretçisi, bir Veri Kümesi güncelleme isteği tamamlandığında çağrılır ve Veri Kümesi güncelleme isteğinin başarılı veya hata durumunu bildirir.

OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE etkinleştirildiğinde kullanılabilir.

Ayrıntılar
Parametreler
[in] aError
Hata durumu. OT_ERROR_NONE, veri kümesi güncellemesinin başarılı olduğunu gösterir. OT_ERROR_INVALID_STATE, geçersiz durumdan kaynaklanan hatayı belirtir (MLE devre dışı bırakılır). OT_ERROR_ALREADY, ağdaki başka bir cihazın çakışan veri kümesi güncellemesi istemesinden kaynaklanan hata olduğunu gösterir.
[in] aContext
Rastgele bağlama işaret eden bir işaret (otDatasetUpdaterRequestUpdate() içindeki kullanıcı tarafından sağlanır).

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Genişletilmiş PAN kimliğini temsil eder.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Örgü Yerel Önekini temsil eder.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Meshcop TLV türlerini temsil eder.

otNetworkKey

struct otNetworkKey otNetworkKey

Thread ağ anahtarını temsil eder.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Bu veri türü, NetworkKey parametresine ait KeyRef'i temsil eder.

Anahtara Referans

otNetworkName

struct otNetworkName otNetworkName

Ağ Adını temsil eder.

otNetworkName, boş sonlandırılmış bir C dizesidir (ör. m8 karakter dizisi, \0 boş karakterle bitmelidir.

otOperationalDataset

struct otOperationalDataset otOperationalDataset

Etkin veya Beklemedeki Bir Operasyonel Veri Kümesini temsil ediyor.

Veri kümesindeki bileşenler isteğe bağlıdır. mComponents yapısı, Veri kümesinde hangi bileşenlerin bulunduğunu belirtir.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Etkin veya Beklemedeki Operasyonel Veri Kümesinde farklı bileşenlerin varlığını gösterir.

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Etkin veya Beklemedeki Bir Operasyonel Veri Kümesini temsil ediyor.

Operasyonel Veri Kümesi, Thread tarafından belirtilen şekilde TLV kodlanmıştır.

otPskc

struct otPskc otPskc

PSKc'yi temsil eder.

otPskcRef

otCryptoKeyRef otPskcRef

Bu veri türü, PSKc'ye ait KeyRef'i temsil eder.

Anahtara Referans

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Güvenlik Politikası'nı temsil etmelidir.

otTimestamp

struct otTimestamp otTimestamp

İş parçacığı veri kümesi zaman damgası bileşenini temsil eder.

Değişkenler

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

İşlevler

otDatasetConvertToTlvs

otError otDatasetConvertToTlvs(
  const otOperationalDataset *aDataset,
  otOperationalDatasetTlvs *aDatasetTlvs
)

Belirli bir operasyonel veri kümesini otOperationalDatasetTlvs türüne dönüştürür.

Ayrıntılar
Parametreler
[in] aDataset
TLV'lere dönüştürülecek Operasyonel veri kümesi.
[out] aDatasetTlvs
Sonucu döndürmek için veri kümesi TLV'lerine gösterilen bir işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
aDataset başarıyla dönüştürüldü ve aDatasetTlvs güncellendi.
OT_ERROR_INVALID_ARGS
aDataset geçersiz; etkin veya beklemedeki zaman damgaları içermiyor.

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Yalnızca FTD için yeni bir ağ oluştururken kullanılacak yeni bir Operasyonel Veri Kümesi oluşturur.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[out] aDataset
Operasyonel Veri Kümesi.
Döndürülen Değerler
OT_ERROR_NONE
Yeni bir Operasyonel Veri Kümesi başarıyla oluşturuldu.
OT_ERROR_FAILED
Yeni parametreler için rastgele değerler oluşturulamadı.

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

Belirli bir parola, ağ adı ve genişletilmiş PAN kimliğinden PSKc oluşturur.

PSKc, Yetkili Oturumu oluşturmak için kullanılır.

Ayrıntılar
Parametreler
[in] aPassPhrase
Görevlendirme parolası.
[in] aNetworkName
PSKc hesaplaması için ağ adı.
[in] aExtPanId
PSKc hesaplaması için genişletilmiş PAN kimliği.
[out] aPskc
Oluşturulan PSKc'nin çıktısını almak için değişkenin işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
PSKc başarıyla oluşturuldu.
OT_ERROR_INVALID_ARGS
Giriş bağımsız değişkenlerinden herhangi biri geçersizse.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Etkin Operasyonel Veri Kümesini alır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[out] aDataset
Etkin Operasyonel Veri Kümesinin yerleştirileceği yeri gösteren işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
Etkin Operasyonel Veri Kümesi başarıyla alındı.
OT_ERROR_NOT_FOUND
Ayar deposunda buna karşılık gelen bir değer yok.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Etkin Operasyonel Veri Kümesini alır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[out] aDataset
Etkin Operasyonel Veri Kümesinin yerleştirileceği yeri gösteren işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
Etkin Operasyonel Veri Kümesi başarıyla alındı.
OT_ERROR_NOT_FOUND
Ayar deposunda buna karşılık gelen bir değer yok.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Yalnızca FTD için minimum gecikme zamanlayıcısı sağlanır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
Döndürülen Değerler
the
minimum gecikme zamanlayıcısının değeri (ms cinsinden).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Beklemedeki Operasyonel Veri Kümesini alır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[out] aDataset
Beklemedeki Operasyonel Veri Kümesinin yerleştirileceği yeri gösteren işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
Beklemedeki Operasyonel Veri Kümesi başarıyla alındı.
OT_ERROR_NOT_FOUND
Ayar deposunda buna karşılık gelen bir değer yok.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Beklemedeki Operasyonel Veri Kümesini alır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[out] aDataset
Beklemedeki Operasyonel Veri Kümesinin yerleştirileceği yeri gösteren işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
Beklemedeki Operasyonel Veri Kümesi başarıyla alındı.
OT_ERROR_NOT_FOUND
Ayar deposunda buna karşılık gelen bir değer yok.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Etkin Operasyonel Veri Kümesinde geçerli bir ağın mevcut olup olmadığını belirtir.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
İadeler
Etkin Operasyonel Veri Kümesinde geçerli bir ağ varsa DOĞRU, aksi takdirde YANLIŞ olur.

otDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

Belirli bir otOperationalDatasetTlvs öğesinden Operasyonel Veri Kümesini ayrıştırır.

Ayrıntılar
Parametreler
[in] aDatasetTlvs
Veri kümesi TLV'lerine yönlendiren bir işaretçi.
[out] aDataset
Veri kümesinin yerleştirileceği yeri gösteren bir işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
aDataset, aDatasetTlvs cihazından başarıyla ayarlandı.
OT_ERROR_INVALID_ARGS
aDatasetTlvs numaralı telefon geçersiz.

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

MGMT_ACTIVE_GET gönderir.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDatasetComponents
Hangi bileşenlerin isteneceğini belirten Veri Kümesi Bileşenleri yapısına yönelik işaretçi.
[in] aTlvTypes
İstenecek ek ham TLV türlerini içeren diziye işaretçi.
[in] aLength
aTlvTypes uzunluğu.
[in] aAddress
IPv6 hedefine işaretçi (NULL ise) varsayılan olarak Lider ALOC kullanılır.
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.

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

MGMT_ACTIVE_SET gönderir.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDataset
Operasyonel veri kümesi işaretçisi.
[in] aTlvs
TLV'lere işaret eden bir işaretçi.
[in] aLength
TLV'lerin uzunluğu.
[in] aCallback
Yanıt alımında veya zaman aşımında çağrılan bir işlevin işaretçisi.
[in] aContext
aCallback için uygulamaya özel bağlama işaret eden bir işaretçi.
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_BUSY
Önceki bir istek devam ediyor.

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

MGMT_PENDING_GET gönderir.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDatasetComponents
Hangi bileşenlerin isteneceğini belirten Veri Kümesi Bileşenleri yapısına yönelik işaretçi.
[in] aTlvTypes
İstenecek ek ham TLV türlerini içeren diziye işaretçi.
[in] aLength
aTlvTypes uzunluğu.
[in] aAddress
IPv6 hedefine işaretçi (NULL ise) varsayılan olarak Lider ALOC kullanılır.
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.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

MGMT_PENDING_SET gönderir.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDataset
Operasyonel veri kümesi işaretçisi.
[in] aTlvs
TLV'lere işaret eden bir işaretçi.
[in] aLength
TLV'lerin uzunluğu.
[in] aCallback
Yanıt alımında veya zaman aşımında çağrılan bir işlevin işaretçisi.
[in] aContext
aCallback için uygulamaya özel bağlama işaret eden bir işaretçi.
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_BUSY
Önceki bir istek devam ediyor.

otDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Etkin Operasyonel Veri Kümesini ayarlar.

Veri kümesinde bir Etkin Zaman Damgası yoksa veri kümesinin yalnızca bir kısmı tamamlanmıştır.

Kısmen tamamlanmış bir Aktif Veri Kümesine sahip bir cihazda Thread etkinleştirilirse cihaz, veri kümesindeki mevcut bilgileri kullanarak mevcut bir Thread ağına bağlanmayı dener. Bir ağa bağlanmak için yalnızca Thread Ağ Anahtarı gerekir.

Kanal, veri kümesine dahil edilmemişse cihaz, diğer kanallardaki komşuları bulmak için farklı kanallarda Çok Dilli Ses Duyurusu mesajları gönderir.

Cihaz bir Thread ağına başarıyla bağlanırsa cihaz, tüm etkin veri kümesini üst öğesinden alır. Yönlendirici özellikli bir cihazın, tam bir Aktif Veri Kümesine sahip olana kadar Yönlendirici veya Lider rollerine geçiş yapmayacağını unutmayın.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDataset
Etkin Operasyonel Veri Kümesinin işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
Etkin Operasyonel Veri Kümesi başarıyla ayarlandı.
OT_ERROR_NO_BUFS
Etkin Operasyonel Veri Kümesi'ni ayarlamak için yetersiz arabellek alanı.
OT_ERROR_NOT_IMPLEMENTED
Platform, ayar işlevini uygulamaz.

otDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Etkin Operasyonel Veri Kümesini ayarlar.

Veri kümesinde bir Etkin Zaman Damgası yoksa veri kümesinin yalnızca bir kısmı tamamlanmıştır.

Kısmen tamamlanmış bir Aktif Veri Kümesine sahip bir cihazda Thread etkinleştirilirse cihaz, veri kümesindeki mevcut bilgileri kullanarak mevcut bir Thread ağına bağlanmayı dener. Bir ağa bağlanmak için yalnızca Thread Ağ Anahtarı gerekir.

Kanal, veri kümesine dahil edilmemişse cihaz, diğer kanallardaki komşuları bulmak için farklı kanallarda Çok Dilli Ses Duyurusu mesajları gönderir.

Cihaz bir Thread ağına başarıyla bağlanırsa cihaz, tüm etkin veri kümesini üst öğesinden alır. Yönlendirici özellikli bir cihazın, tam bir Aktif Veri Kümesine sahip olana kadar Yönlendirici veya Lider rollerine geçiş yapmayacağını unutmayın.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDataset
Etkin Operasyonel Veri Kümesinin işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
Etkin Operasyonel Veri Kümesi başarıyla ayarlandı.
OT_ERROR_NO_BUFS
Etkin Operasyonel Veri Kümesi'ni ayarlamak için yetersiz arabellek alanı.
OT_ERROR_NOT_IMPLEMENTED
Platform, ayar işlevini uygulamaz.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Yalnızca FTD için minimum gecikme süresi ölçer.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDelayTimerMinimal
Minimum gecikme zamanlayıcısının değeri (ms cinsinden).
Döndürülen Değerler
OT_ERROR_NONE
Minimum gecikmeli zamanlayıcı başarıyla ayarlandı.
OT_ERROR_INVALID_ARGS
aDelayTimerMinimal geçerli değilse.

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

Beklemedeki Operasyonel Veri Kümesini ayarlar.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDataset
Beklemedeki Operasyonel Veri Kümesi işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
Beklemedeki Operasyonel Veri Kümesi başarıyla ayarlandı.
OT_ERROR_NO_BUFS
Beklemedeki Operasyonel Veri Kümesi'ni ayarlamak için yetersiz arabellek alanı.
OT_ERROR_NOT_IMPLEMENTED
Platform, ayar işlevini uygulamaz.

otDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

Beklemedeki Operasyonel Veri Kümesini ayarlar.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDataset
Beklemedeki Operasyonel Veri Kümesi işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
Beklemedeki Operasyonel Veri Kümesi başarıyla ayarlandı.
OT_ERROR_NO_BUFS
Beklemedeki Operasyonel Veri Kümesi'ni ayarlamak için yetersiz arabellek alanı.
OT_ERROR_NOT_IMPLEMENTED
Platform, ayar işlevini uygulamaz.

otDatasetUpdateTlvs

otError otDatasetUpdateTlvs(
  const otOperationalDataset *aDataset,
  otOperationalDatasetTlvs *aDatasetTlvs
)

Belirli bir Operasyonel Veri Kümesini günceller.

aDataset, güncellenecek alanları ve bu alanların yeni değerlerini içeriyor.

Ayrıntılar
Parametreler
[in] aDataset
Güncellenecek tür ve değer grubunu belirtir.
[in,out] aDatasetTlvs
Güncellenecek veri kümesi TLV'lerinin işaretçisi.
Döndürülen Değerler
OT_ERROR_NONE
aDatasetTlvs başarıyla güncellendi.
OT_ERROR_INVALID_ARGS
aDataset geçersiz değerler içeriyor.
OT_ERROR_NO_BUFS
Güncellemenin uygulanması için aDatasetTlvs cihazında yeterli alan yok.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Devam eden (varsa) bir Operasyonel Veri Kümesi güncelleme isteğini iptal eder.

OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE etkinleştirildiğinde kullanılabilir.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Devam eden bir İşlem Veri Kümesi güncelleme isteği olup olmadığını belirtir.

OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE etkinleştirildiğinde kullanılabilir.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
Döndürülen Değerler
TRUE
Devam eden bir güncelleme var.
FALSE
Devam eden bir güncelleme yok.

otDatasetUpdaterRequestUpdate

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

Operasyonel Veri Kümesi için güncelleme isteğinde bulundu.

OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE etkinleştirildiğinde kullanılabilir.

aDataset güncellenecek alanları ve bu alanların yeni değerlerini içermelidir. Etkin veya Beklemedeki Zaman Damgası alanları içermemelidir. Gecikme alanı isteğe bağlıdır. Sağlanmazsa bir varsayılan değer (1000 ms) kullanılır.

Ayrıntılar
Parametreler
[in] aInstance
OpenThread örneğinin işaretçisi.
[in] aDataset
Değiştirilecek alanları içeren veri kümesinin işaretçisi.
[in] aCallback
Veri kümesi güncelleme isteğinin tamamlandığını belirten bir geri çağırma.
[in] aContext
Geri çağırmaya iletilen rastgele bağlam.
Döndürülen Değerler
OT_ERROR_NONE
Veri kümesi güncellemesi başarıyla başlatıldı (İşlem tamamlandığında aCallback çağrılacak).
OT_ERROR_INVALID_STATE
Cihaz devre dışı (MLE devre dışı).
OT_ERROR_INVALID_ARGS
aDataset geçerli değil (Etkin veya Beklemedeki Zaman Damgası içeriyor).
OT_ERROR_BUSY
Güncelleme başlatılamıyor, önceki bir güncelleme devam ediyor.
OT_ERROR_NO_BUFS
Veri Kümesinin kaydedilmesi için arabellek tahsis edilemedi.

otNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

Boş sonlandırılmış belirli bir C dizesinden otNetworkName örneği ayarlar.

aNameString, UTF-8 kodlamasına uygun olmalı ve Ağ Adı en fazla OT_NETWORK_NAME_MAX_SIZE olmalıdır.

Ayrıntılar
Parametreler
[out] aNetworkName
Ayarlanacak otNetworkName öğesinin işaretçisi.
[in] aNameString
Ad C dizesi.
Döndürülen Değerler
OT_ERROR_NONE
aNetworkName, aNameString cihazından başarıyla ayarlandı.
OT_ERROR_INVALID_ARGS
aNameStrng geçersiz (çok uzun veya UTF-8 kodlamasına uymuyor).

Makrolar

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Kanal 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Kanal 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Kanal 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Kanal 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Kanal 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Kanal 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Kanal 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Kanal 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Kanal 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Kanal 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Kanal 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Kanal 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Kanal 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Kanal 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Kanal 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Kanal 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Kanal 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Kanal 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Kanal 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Kanal 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Kanal 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Kanal 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Kanal 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Kanal 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Kanal 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Kanal 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

İş Parçacığı PAN kimliğinin boyutu (bayt)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Örgü Yerel Önekinin Boyutu (bayt)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Thread Ağ Anahtarının boyutu (bayt)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

İş Parçacığı Ağ Adı alanının maksimum boyutu (bayt)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Operasyonel Veri Kümesinin bayt cinsinden maksimum uzunluğu.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Maksimum PSKc boyutu (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.