Set Data Operasional

Mencakup fungsi untuk Operational Dataset API.

Ringkasan

Khusus untuk build FTD, Dataset Updater menyertakan fungsi untuk mengelola pembaruan set data.

Untuk build FTD dan MTD, Operational Dataset API menyertakan fungsi untuk mengelola set data Aktif dan Tertunda serta TLV set data.

Enumerasi
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
Mewakili jenis TLV meshcop.

Typedef
otChannelMask typedef
uint32_t
Merepresentasikan Mask Saluran.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
Pointer dipanggil ketika respons terhadap permintaan MGMT_SET diterima atau waktu habis.
otDatasetUpdaterCallback)(otError aError, void *aContext) typedef
void(*
Pointer fungsi callback ini dipanggil saat permintaan pembaruan Set data selesai, melaporkan status berhasil atau gagal dari permintaan pembaruan Set data.
otExtendedPanId typedef
Mewakili ID PAN yang Diperluas.
otMeshLocalPrefix typedef
Mewakili Awalan Lokal Mesh.
otMeshcopTlvType typedef
Mewakili jenis TLV meshcop.
otNetworkKey typedef
struct otNetworkKey
Merepresentasikan Kunci Jaringan Thread.
otNetworkKeyRef typedef
Jenis data ini mewakili KeyRef ke NetworkKey.
otNetworkName typedef
struct otNetworkName
Mewakili Nama Jaringan.
otOperationalDataset typedef
Mewakili Set Data Operasional Aktif atau Tertunda.
otOperationalDatasetComponents typedef
Mewakili kehadiran berbagai komponen dalam Set Data Operasional Aktif atau Tertunda.
otOperationalDatasetTlvs typedef
Mewakili Set Data Operasional Aktif atau Tertunda.
otPskc typedef
struct otPskc
Merepresentasikan PSKc.
otPskcRef typedef
Jenis data ini mewakili KeyRef ke PSKc.
otSecurityPolicy typedef
Mewakili Kebijakan Keamanan.
otTimestamp typedef
struct otTimestamp
Mewakili komponen stempel waktu Set Data Thread.

Variabel
OT_TOOL_PACKED_END

Fungsi
otDatasetConvertToTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Mengonversi Set Data Operasional tertentu menjadi otOperationalDatasetTlvs.
otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Khusus FTD, buat Set Data Operasional baru untuk digunakan saat membuat jaringan baru.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Menghasilkan PSKc dari frasa sandi, nama jaringan, dan ID PAN yang diperluas tertentu.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Mendapatkan Set Data Operasional Aktif.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Mendapatkan Set Data Operasional Aktif.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
Khusus untuk FTD, dapatkan timer penundaan minimal.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Mendapatkan Set Data Operasional yang Tertunda.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Mendapatkan Set Data Operasional yang Tertunda.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Menunjukkan apakah ada jaringan yang valid di Set Data Operasional Aktif atau tidak.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Mengurai Set Data Operasional dari otOperationalDatasetTlvs tertentu.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Mengirim MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Mengirim MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Mengirim MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Mengirim MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
Menetapkan Set Data Operasional Aktif.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Menetapkan Set Data Operasional Aktif.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
Hanya untuk FTD, setel timer penundaan minimal.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Menetapkan Set Data Operasional Tertunda.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Menetapkan Set Data Operasional Tertunda.
otDatasetUpdateTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Memperbarui Set Data Operasional tertentu.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Membatalkan permintaan pembaruan Set Data Operasional yang sedang berlangsung (jika ada).
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Menunjukkan apakah ada permintaan pembaruan Set Data Operasi yang sedang berlangsung.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Meminta update pada Set Data Operasional.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Menetapkan instance otNetworkName dari string C yang dihentikan null tertentu.

Struct
otExtendedPanId

Mewakili ID PAN yang Diperluas.

otNetworkKey

Merepresentasikan Kunci Jaringan Thread.

otNetworkName

Mewakili Nama Jaringan.

otOperationalDataset

Mewakili Set Data Operasional Aktif atau Tertunda.

otOperationalDatasetComponents

Mewakili kehadiran berbagai komponen dalam Set Data Operasional Aktif atau Tertunda.

otOperationalDatasetTlvs

Mewakili Set Data Operasional Aktif atau Tertunda.

otPskc

Merepresentasikan PSKc.

otSecurityPolicy

Mewakili Kebijakan Keamanan.

otTimestamp

Mewakili komponen stempel waktu Set Data Thread.

Enumerasi

otMeshcopTlvType

 otMeshcopTlvType

Mewakili jenis TLV meshcop.

Properti
OT_MESHCOP_TLV_ACTIVETIMESTAMP

TLV Stempel Waktu Aktif meshcop

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

TLV Border Agent Locator meshcop

OT_MESHCOP_TLV_CHANNEL

TLV Saluran meshcop

OT_MESHCOP_TLV_CHANNELMASK

TLV Masker Saluran meshcop

OT_MESHCOP_TLV_COMMISSIONER_ID

ID Komisaris meshcop TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

TLV Port UDP Commissioner meshcop

OT_MESHCOP_TLV_COMM_SESSION_ID

ID Sesi Commissioner meshcop TLV

OT_MESHCOP_TLV_COUNT

Jumlah meshcop TLV

OT_MESHCOP_TLV_DELAYTIMER

TLV Penundaan meshcop

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV Permintaan Penemuan meshcop

OT_MESHCOP_TLV_DISCOVERYRESPONSE

TLV Respons Penemuan meshcop

OT_MESHCOP_TLV_ENERGY_LIST

TLV Daftar Energi meshcop

OT_MESHCOP_TLV_EXTPANID

TLV ID Pan yang Diperluas meshcop

OT_MESHCOP_TLV_GET

meshcop Dapatkan TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

TLV alamat IPv6 meshcop

OT_MESHCOP_TLV_JOINERADVERTISEMENT

TLV Iklan Penyambung meshcop

OT_MESHCOP_TLV_JOINER_DTLS

Enkapsulasi TLV DTLS sambungan meshcop

OT_MESHCOP_TLV_JOINER_IID

Meshcop Joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

TLV Pencari Lokasi Router Meshcop

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Router Meshcop Joiner KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

TLV Port UDP Penyambung Meshcop

OT_MESHCOP_TLV_MESHLOCALPREFIX

Awalan Lokal Mesh meshcop TLV

OT_MESHCOP_TLV_NETWORKKEY

TLV Kunci Jaringan meshcop

OT_MESHCOP_TLV_NETWORKNAME

TLV Nama Jaringan meshcop

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

TLV Urutan Kunci Jaringan meshcop

OT_MESHCOP_TLV_PANID

TLV ID Pan meshcop

OT_MESHCOP_TLV_PENDINGTIMESTAMP

TLV Stempel Waktu Tertunda meshcop

OT_MESHCOP_TLV_PERIOD

Periode meshcop TLV

OT_MESHCOP_TLV_PROVISIONING_URL

TLV URL Penyediaan meshcop

OT_MESHCOP_TLV_PSKC

meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

TLV Durasi Pemindaian meshcop

OT_MESHCOP_TLV_SECURITYPOLICY

TLV Kebijakan Keamanan meshcop

OT_MESHCOP_TLV_STATE

TLV Status meshcop

OT_MESHCOP_TLV_STEERING_DATA

TLV Data Pengarah meshcop

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

enkapsulasi TLV UDP meshcop

OT_MESHCOP_TLV_VENDOR_DATA_TLV

TLV Data Vendor meshcop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Model Vendor meshcop TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Nama Vendor meshcop TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

TLV Stack Vendor meshcop

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

Vendor meshcop SW Versi TLV

Typedef

otChannelMask

uint32_t otChannelMask

Merepresentasikan Mask Saluran.

otDatasetMgmtSetCallback

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

Pointer dipanggil ketika respons terhadap permintaan MGMT_SET diterima atau waktu habis.

Detail
Parameter
[in] aResult
Hasil operasi.
[in] aContext
Pointer ke konteks khusus aplikasi.
Nilai Pengembalian
OT_ERROR_NONE
Permintaan diterima oleh pemimpin.
OT_ERROR_REJECTED
Permintaan ditolak oleh pemimpin.
OT_ERROR_PARSE
Terjadi error saat mengurai respons.
OT_ERROR_ABORT
Permintaan direset oleh pembanding.
OT_ERROR_RESPONSE_TIMEOUT
Tidak ada respons atau konfirmasi yang diterima selama periode waktu tunggu.

otDatasetUpdaterCallback

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

Pointer fungsi callback ini dipanggil saat permintaan pembaruan Set data selesai, melaporkan status berhasil atau gagal dari permintaan pembaruan Set data.

Tersedia jika OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE diaktifkan.

Detail
Parameter
[in] aError
Status error. OT_ERROR_NONE menunjukkan pembaruan Set data yang berhasil. OT_ERROR_INVALID_STATE menunjukkan kegagalan karena status tidak valid (MLE dinonaktifkan). OT_ERROR_ALREADY menunjukkan kegagalan karena perangkat lain dalam jaringan meminta pembaruan Set data yang bertentangan.
[in] aContext
Pointer ke konteks arbitrer (disediakan oleh pengguna di otDatasetUpdaterRequestUpdate()).

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Mewakili ID PAN yang Diperluas.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Mewakili Awalan Lokal Mesh.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Mewakili jenis TLV meshcop.

otNetworkKey

struct otNetworkKey otNetworkKey

Merepresentasikan Kunci Jaringan Thread.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Jenis data ini mewakili KeyRef ke NetworkKey.

Referensi ke Kunci

otNetworkName

struct otNetworkName otNetworkName

Mewakili Nama Jaringan.

otNetworkName adalah string C yang dihentikan null (yaitu, Array karakter m8 HARUS diakhiri dengan karakter null \0).

otOperationalDataset

struct otOperationalDataset otOperationalDataset

Mewakili Set Data Operasional Aktif atau Tertunda.

Komponen di Set data bersifat opsional. Struktur mComponents menentukan komponen mana yang ada di Set data.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Mewakili kehadiran berbagai komponen dalam Set Data Operasional Aktif atau Tertunda.

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Mewakili Set Data Operasional Aktif atau Tertunda.

Set Data Operasional adalah TLV yang dienkode seperti yang ditentukan oleh Thread.

otPskc

struct otPskc otPskc

Merepresentasikan PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

Jenis data ini mewakili KeyRef ke PSKc.

Referensi ke Kunci

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Mewakili Kebijakan Keamanan.

otTimestamp

struct otTimestamp otTimestamp

Mewakili komponen stempel waktu Set Data Thread.

Variabel

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Fungsi

otDatasetConvertToTlvs

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

Mengonversi Set Data Operasional tertentu menjadi otOperationalDatasetTlvs.

Detail
Parameter
[in] aDataset
Set data Operasional untuk dikonversi ke TLV.
[out] aDatasetTlvs
Pointer ke TLV set data untuk menampilkan hasil.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengonversi aDataset dan memperbarui aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDataset tidak valid, tidak berisi stempel waktu aktif atau tertunda.

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Khusus FTD, buat Set Data Operasional baru untuk digunakan saat membuat jaringan baru.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aDataset
Set Data Operasional
Nilai Pengembalian
OT_ERROR_NONE
Berhasil membuat Set Data Operasional baru.
OT_ERROR_FAILED
Gagal membuat nilai acak untuk parameter baru.

otDatasetGeneratePskc

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

Menghasilkan PSKc dari frasa sandi, nama jaringan, dan ID PAN yang diperluas tertentu.

PSKc digunakan untuk membentuk Sesi Komisaris.

Detail
Parameter
[in] aPassPhrase
Frasa sandi commissioning.
[in] aNetworkName
Nama jaringan untuk komputasi PSKc.
[in] aExtPanId
ID PAN yang diperluas untuk komputasi PSKc.
[out] aPskc
Pointer ke variabel untuk menghasilkan PSKc yang dihasilkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil membuat PSKc.
OT_ERROR_INVALID_ARGS
Jika salah satu argumen input tidak valid.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Mendapatkan Set Data Operasional Aktif.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aDataset
Pointer ke tempat {i>Active Operational Dataset<i} akan ditempatkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengambil Set Data Operasional Aktif.
OT_ERROR_NOT_FOUND
Tidak ada nilai yang sesuai di penyimpanan setelan.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Mendapatkan Set Data Operasional Aktif.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aDataset
Pointer ke tempat {i>Active Operational Dataset<i} akan ditempatkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengambil Set Data Operasional Aktif.
OT_ERROR_NOT_FOUND
Tidak ada nilai yang sesuai di penyimpanan setelan.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Khusus untuk FTD, dapatkan timer penundaan minimal.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
the
nilai timer tunda minimal (dalam md).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Mendapatkan Set Data Operasional yang Tertunda.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aDataset
Pointer ke tempat Set Data Operasional yang Tertunda akan ditempatkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengambil Set Data Operasional Tertunda.
OT_ERROR_NOT_FOUND
Tidak ada nilai yang sesuai di penyimpanan setelan.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Mendapatkan Set Data Operasional yang Tertunda.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aDataset
Pointer ke tempat Set Data Operasional yang Tertunda akan ditempatkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengambil Set Data Operasional Tertunda.
OT_ERROR_NOT_FOUND
Tidak ada nilai yang sesuai di penyimpanan setelan.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Menunjukkan apakah ada jaringan yang valid di Set Data Operasional Aktif atau tidak.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
TRUE jika ada jaringan yang valid dalam Set Data Operasional Aktif, FALSE jika tidak.

otDatasetParseTlvs

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

Mengurai Set Data Operasional dari otOperationalDatasetTlvs tertentu.

Detail
Parameter
[in] aDatasetTlvs
Pointer ke TLV set data.
[out] aDataset
Pointer ke tempat set data akan ditempatkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menyetel aDataset dari aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDatasetTlvs tidak valid.

otDatasetSendMgmtActiveGet

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

Mengirim MGMT_ACTIVE_GET.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDatasetComponents
Pointer ke struktur Komponen Set Data yang menentukan komponen yang akan diminta.
[in] aTlvTypes
Pointer ke array yang berisi jenis TLV mentah tambahan yang akan diminta.
[in] aLength
Panjang aTlvTypes.
[in] aAddress
Sebuah pointer ke tujuan IPv6, jika NULL, akan menggunakan Leader ALOC sebagai {i>default<i}.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengirim perintah set data meshcop.
OT_ERROR_NO_BUFS
Ruang buffer tidak cukup untuk mengirim.

otDatasetSendMgmtActiveSet

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

Mengirim MGMT_ACTIVE_SET.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDataset
Pointer ke set data operasional.
[in] aTlvs
Pointer ke TLV.
[in] aLength
Panjang TLV.
[in] aCallback
Pointer ke fungsi yang dipanggil pada penerimaan respons atau waktu tunggu.
[in] aContext
Pointer ke konteks khusus aplikasi untuk aCallback.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengirim perintah set data meshcop.
OT_ERROR_NO_BUFS
Ruang buffer tidak cukup untuk mengirim.
OT_ERROR_BUSY
Permintaan sebelumnya sedang berlangsung.

otDatasetSendMgmtPendingGet

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

Mengirim MGMT_PENDING_GET.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDatasetComponents
Pointer ke struktur Komponen Set Data yang menentukan komponen yang akan diminta.
[in] aTlvTypes
Pointer ke array yang berisi jenis TLV mentah tambahan yang akan diminta.
[in] aLength
Panjang aTlvTypes.
[in] aAddress
Sebuah pointer ke tujuan IPv6, jika NULL, akan menggunakan Leader ALOC sebagai {i>default<i}.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengirim perintah set data meshcop.
OT_ERROR_NO_BUFS
Ruang buffer tidak cukup untuk mengirim.

otDatasetSendMgmtPendingSet

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

Mengirim MGMT_PENDING_SET.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDataset
Pointer ke set data operasional.
[in] aTlvs
Pointer ke TLV.
[in] aLength
Panjang TLV.
[in] aCallback
Pointer ke fungsi yang dipanggil pada penerimaan respons atau waktu tunggu.
[in] aContext
Pointer ke konteks khusus aplikasi untuk aCallback.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengirim perintah set data meshcop.
OT_ERROR_NO_BUFS
Ruang buffer tidak cukup untuk mengirim.
OT_ERROR_BUSY
Permintaan sebelumnya sedang berlangsung.

otDatasetSetActive

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

Menetapkan Set Data Operasional Aktif.

Jika set data tidak menyertakan Stempel Waktu Aktif, set data hanya akan selesai sebagian.

Jika Thread diaktifkan pada perangkat yang memiliki Set Data Aktif yang lengkap sebagian, perangkat akan mencoba untuk terhubung ke jaringan Thread yang ada menggunakan informasi yang ada dalam set data. Hanya Kunci Jaringan Thread yang diperlukan untuk terhubung ke jaringan.

Jika saluran tidak disertakan dalam set data, perangkat akan mengirimkan pesan Pengumuman MLE di berbagai saluran untuk menemukan tetangga di saluran lain.

Jika perangkat berhasil terhubung ke jaringan Thread, perangkat akan mengambil Set Data Aktif lengkap dari Induknya. Perhatikan bahwa perangkat yang mendukung router tidak akan beralih ke peran {i>Router<i} atau Pemimpin hingga memiliki Set Data Aktif yang lengkap.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDataset
Pointer ke {i>Active Operational Dataset<i}.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan Set Data Operasional Aktif.
OT_ERROR_NO_BUFS
Ruang buffer tidak cukup untuk menetapkan Set Data Operasional Aktif.
OT_ERROR_NOT_IMPLEMENTED
Platform tidak menerapkan fungsi setelan.

otDatasetSetActiveTlvs

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

Menetapkan Set Data Operasional Aktif.

Jika set data tidak menyertakan Stempel Waktu Aktif, set data hanya akan selesai sebagian.

Jika Thread diaktifkan pada perangkat yang memiliki Set Data Aktif yang lengkap sebagian, perangkat akan mencoba untuk terhubung ke jaringan Thread yang ada menggunakan informasi yang ada dalam set data. Hanya Kunci Jaringan Thread yang diperlukan untuk terhubung ke jaringan.

Jika saluran tidak disertakan dalam set data, perangkat akan mengirimkan pesan Pengumuman MLE di berbagai saluran untuk menemukan tetangga di saluran lain.

Jika perangkat berhasil terhubung ke jaringan Thread, perangkat akan mengambil Set Data Aktif lengkap dari Induknya. Perhatikan bahwa perangkat yang mendukung router tidak akan beralih ke peran {i>Router<i} atau Pemimpin hingga memiliki Set Data Aktif yang lengkap.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDataset
Pointer ke {i>Active Operational Dataset<i}.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan Set Data Operasional Aktif.
OT_ERROR_NO_BUFS
Ruang buffer tidak cukup untuk menetapkan Set Data Operasional Aktif.
OT_ERROR_NOT_IMPLEMENTED
Platform tidak menerapkan fungsi setelan.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Hanya untuk FTD, setel timer penundaan minimal.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDelayTimerMinimal
Nilai timer tunda minimal (dalam md).
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menyetel timer penundaan minimal.
OT_ERROR_INVALID_ARGS
Jika aDelayTimerMinimal tidak valid.

otDatasetSetPending

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

Menetapkan Set Data Operasional Tertunda.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDataset
Pointer ke Set Data Operasional yang Tertunda.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan Set Data Operasional Tertunda.
OT_ERROR_NO_BUFS
Ruang buffer tidak cukup untuk menetapkan Set Data Operasional Tertunda.
OT_ERROR_NOT_IMPLEMENTED
Platform tidak menerapkan fungsi setelan.

otDatasetSetPendingTlvs

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

Menetapkan Set Data Operasional Tertunda.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDataset
Pointer ke Set Data Operasional yang Tertunda.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan Set Data Operasional Tertunda.
OT_ERROR_NO_BUFS
Ruang buffer tidak cukup untuk menetapkan Set Data Operasional Tertunda.
OT_ERROR_NOT_IMPLEMENTED
Platform tidak menerapkan fungsi setelan.

otDatasetUpdateTlvs

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

Memperbarui Set Data Operasional tertentu.

aDataset berisi kolom yang akan diperbarui dan nilai barunya.

Detail
Parameter
[in] aDataset
Menentukan kumpulan jenis dan nilai yang akan diperbarui.
[in,out] aDatasetTlvs
Pointer ke TLV set data yang akan diperbarui.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil memperbarui aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDataset berisi nilai yang tidak valid.
OT_ERROR_NO_BUFS
Ruang di aDatasetTlvs tidak cukup untuk menerapkan update.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Membatalkan permintaan pembaruan Set Data Operasional yang sedang berlangsung (jika ada).

Tersedia jika OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Menunjukkan apakah ada permintaan pembaruan Set Data Operasi yang sedang berlangsung.

Tersedia jika OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
TRUE
Ada update yang sedang berlangsung.
FALSE
Tidak ada update yang sedang berlangsung.

otDatasetUpdaterRequestUpdate

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

Meminta update pada Set Data Operasional.

Tersedia jika OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE diaktifkan.

aDataset harus berisi kolom yang akan diperbarui dan nilai barunya. Label tersebut tidak boleh berisi kolom Stempel Waktu Aktif atau Tertunda. Kolom Delay bersifat opsional, jika tidak diberikan nilai default (1.000 md) akan digunakan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDataset
Pointer ke Set Data yang berisi kolom yang akan diubah.
[in] aCallback
Callback untuk menunjukkan kapan permintaan pembaruan Set data selesai.
[in] aContext
Konteks arbitrer yang diteruskan ke callback.
Nilai Pengembalian
OT_ERROR_NONE
Pembaruan set data berhasil dimulai (aCallback akan dipanggil saat selesai).
OT_ERROR_INVALID_STATE
Perangkat dinonaktifkan (MLE dinonaktifkan).
OT_ERROR_INVALID_ARGS
aDataset tidak valid (berisi Stempel Waktu Aktif atau Tertunda).
OT_ERROR_BUSY
Tidak dapat memulai pembaruan, pembaruan sebelumnya sedang berlangsung.
OT_ERROR_NO_BUFS
Tidak dapat mengalokasikan buffer untuk menyimpan Set data.

otNetworkNameFromString

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

Menetapkan instance otNetworkName dari string C yang dihentikan null tertentu.

aNameString harus mengikuti encoding UTF-8 dan panjang Nama Jaringan tidak boleh lebih dari OT_NETWORK_NAME_MAX_SIZE.

Detail
Parameter
[out] aNetworkName
Pointer ke otNetworkName yang akan ditetapkan.
[in] aNameString
String nama C.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menyetel aNetworkName dari aNameString.
OT_ERROR_INVALID_ARGS
aNameStrng tidak valid (terlalu panjang atau tidak mengikuti encoding UTF-8).

Makro

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

Saluran 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

Saluran 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

Saluran 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

Saluran 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

Saluran 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

Saluran 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

Saluran 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

Saluran 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

Saluran 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

Saluran 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Saluran 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

Saluran 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

Saluran 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

Saluran 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

Saluran 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

Saluran 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

Saluran 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

Saluran 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Saluran 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Saluran 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Saluran 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Saluran 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

Saluran 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Saluran 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Saluran 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Saluran 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Ukuran ID PAN Thread (byte)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Ukuran Awalan Lokal Mesh (byte)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Ukuran Kunci Jaringan Thread (byte)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Ukuran maksimum kolom Nama Jaringan Thread (byte)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

Panjang maksimum Set Data Operasional dalam byte.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Ukuran maksimum PSKc (byte)

Referensi

Topik Referensi OpenThread API berasal dari kode sumber yang tersedia di GitHub. Untuk informasi selengkapnya, atau untuk berkontribusi pada dokumentasi kami, lihat Referensi.