Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.

Set Data Operasional

Modul ini mencakup fungsi untuk Updateset Set Data.

Ringkasan

Fungsi dalam modul ini tersedia saat fitur Updateset Set Data diaktifkan (yaitu OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE ditetapkan ke 1). Lebih lanjut, fitur ini hanya tersedia di build FTD.

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

Typedef

otChannelMask typedef
uint32_t
Jenis ini mewakili Masker Saluran.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
Pointer fungsi ini dipanggil saat respons terhadap permintaan MGMT_SET diterima atau waktu habis.
otDatasetUpdaterCallback)(otError aError, void *aContext) typedef
void(*
Pointer fungsi callback ini dipanggil saat permintaan pembaruan Dataset selesai, melaporkan status berhasil atau gagal dari permintaan pembaruan Dataset.
otExtendedPanId typedef
Struktur ini mewakili ID PAN yang Diperluas.
otMeshLocalPrefix typedef
Struktur ini mewakili Awalan Mesh Lokal.
otMeshcopTlvType typedef
Enumerasi ini mewakili jenis TLV meshcop.
otNetworkKey typedef
struct otNetworkKey
Struktur ini mewakili Kunci Jaringan Thread.
otNetworkKeyRef typedef
Jenis data ini mewakili KeyRef ke NetworkKey.
otNetworkName typedef
struct otNetworkName
Struktur ini mewakili Nama Jaringan.
otOperationalDataset typedef
Struktur ini mewakili Set Data Operasional Aktif atau Menunggu Persetujuan.
otOperationalDatasetComponents typedef
Struktur ini mewakili adanya komponen yang berbeda di Set Data Operasional Aktif atau Menunggu Keputusan.
otOperationalDatasetTlvs typedef
Struktur ini mewakili Set Data Operasional Aktif atau Menunggu Persetujuan.
otPskc typedef
struct otPskc
Struktur ini mewakili PSKc.
otPskcRef typedef
Jenis data ini mewakili KeyRef untuk PSKc.
otSecurityPolicy typedef
Struktur ini mewakili Kebijakan Keamanan.
otTimestamp typedef
struct otTimestamp
Struktur ini mewakili komponen stempel waktu Rangkaian Data Thread.

Variabel

OT_TOOL_PACKED_END

Fungsi

otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
Metode ini membuat Set Data Operasional baru untuk digunakan saat membentuk jaringan baru.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Fungsi ini menghasilkan PSKc dari frasa sandi, nama jaringan, dan ID PAN yang diperluas.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
Fungsi ini mendapatkan Set Data Operasional Aktif.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Fungsi ini mendapatkan Set Data Operasional Aktif.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
Dapatkan timer penundaan minimal.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
Fungsi ini mendapatkan Set Data Operasional yang Tertunda.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Fungsi ini mendapatkan Set Data Operasional yang Tertunda.
otDatasetIsCommissioned(otInstance *aInstance)
bool
Fungsi ini menunjukkan apakah jaringan yang valid ada di Set Data Operasional Aktif atau tidak.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Fungsi ini mengurai Set Data Operasional dari otOperationalDatasetTlvs.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Fungsi ini mengirim MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Fungsi ini mengirim MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Fungsi ini mengirim MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Fungsi ini mengirim MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
Fungsi ini menetapkan Set Data Operasional Aktif.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Fungsi ini menetapkan Set Data Operasional Aktif.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
Setel timer penundaan minimal.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
Fungsi ini menetapkan Set Data Operasional yang Tertunda.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Fungsi ini menetapkan Set Data Operasional yang Tertunda.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
Fungsi ini membatalkan permintaan update Set Data Operasional yang sedang berlangsung (jika ada).
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
Fungsi ini menunjukkan apakah ada permintaan update Dataset Operasi yang sedang berlangsung.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Fungsi ini meminta update untuk Set Data Operasional.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
Fungsi ini menetapkan instance otNetworkName dari string C yang dihentikan null.

Struct

otExtendedPanId

Struktur ini mewakili ID PAN yang Diperluas.

otNetworkKey

Struktur ini mewakili Kunci Jaringan Thread.

otNetworkName

Struktur ini mewakili Nama Jaringan.

otOperasionalDataset

Struktur ini mewakili Set Data Operasional Aktif atau Menunggu Persetujuan.

otOperationalDatasetComponents

Struktur ini mewakili adanya komponen yang berbeda di Set Data Operasional Aktif atau Menunggu Keputusan.

otOperationalDatasetTlvs

Struktur ini mewakili Set Data Operasional Aktif atau Menunggu Persetujuan.

otPskc

Struktur ini mewakili PSKc.

otSecurityPolicy

Struktur ini mewakili Kebijakan Keamanan.

otTimestamp

Struktur ini mewakili komponen stempel waktu Rangkaian Data Thread.

Enumerasi

otMeshcopTlvType

 otMeshcopTlvType

Enumerasi ini mewakili jenis TLV meshcop.

Properti
OT_MESHCOP_TLV_ACTIVETIMESTAMP

meshcop Stempel Waktu Aktif TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

TLV Locator Agen Perbatasan 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

meshcop Komisioner UDP Port TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

ID Sesi Komisaris meshcop TLV

OT_MESHCOP_TLV_COUNT

Jumlah meshcop TLV

OT_MESHCOP_TLV_DELAYTIMER

meshcop Delay Timer TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV Permintaan Discovery meshcop

OT_MESHCOP_TLV_DISCOVERYRESPONSE

TLV Respons Discovery meshcop

OT_MESHCOP_TLV_ENERGY_LIST

TLV Daftar Energi meshcop

OT_MESHCOP_TLV_EXTPANID

meshcop Extended Pan ID TLV

OT_MESHCOP_TLV_GET

meshcop Dapatkan TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

meshcop alamat IPv6 TLV

OT_MESHCOP_TLV_JOINERADVERTISEMENT

TLV Iklan Penyambung meshcop

OT_MESHCOP_TLV_JOINER_DTLS

meshcop Joiner DTLS Encapsulation TLV

OT_MESHCOP_TLV_JOINER_IID

meshcop joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

meshcop Joiner Router Locator TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Router Penggabung meshcop KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

meshcop joiner UDP Port TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

meshcop Mesh Local Prefix TLV

OT_MESHCOP_TLV_NETWORKKEY

Kunci Jaringan meshcop TLV

OT_MESHCOP_TLV_NETWORKNAME

Nama Jaringan meshcop TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

Urutan Kunci Jaringan meshcop TLV

OT_MESHCOP_TLV_PANID

Id Pan TLV meshcop

OT_MESHCOP_TLV_PENDINGTIMESTAMP

meshcop TLV Stempel Waktu Tertunda

OT_MESHCOP_TLV_PERIOD

TLV Periode meshcop

OT_MESHCOP_TLV_PROVISIONING_URL

TLV URL Penyedia meshcop

OT_MESHCOP_TLV_PSKC

meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

Durasi Pemindaian meshcop TLV

OT_MESHCOP_TLV_SECURITYPOLICY

Kebijakan Keamanan meshcop TLV

OT_MESHCOP_TLV_STATE

TLV Status meshcop

OT_MESHCOP_TLV_STEERING_DATA

TLV Data Kemudi meshcop

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV enkapsulasi 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

Vendor Stack Versi meshcop TLV

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

Vendor meshcop SW Versi TLV

Typedef

otChannelMask

uint32_t otChannelMask

Jenis ini mewakili Masker Saluran.

otDatasetMgmtSetCallback

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

Pointer fungsi ini dipanggil saat respons terhadap permintaan MGMT_SET diterima atau waktu habis.

Detail
Parameter
[in] aResult
Hasil dari operasi.
[in] aContext
Pointer ke konteks khusus aplikasi.
Nilai yang Ditampilkan
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 Dataset selesai, melaporkan status berhasil atau gagal dari permintaan pembaruan Dataset.

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

otExtendedPanId

struct otExtendedPanId otExtendedPanId

Struktur ini mewakili ID PAN yang Diperluas.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Struktur ini mewakili Awalan Mesh Lokal.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Enumerasi ini mewakili jenis TLV meshcop.

otNetworkKey

struct otNetworkKey otNetworkKey

Struktur ini mewakili Kunci Jaringan Thread.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Jenis data ini mewakili KeyRef ke NetworkKey.

Referensi ke Kunci

otNetworkName

struct otNetworkName otNetworkName

Struktur ini mewakili Nama Jaringan.

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

otOperasionalSet Data

struct otOperationalDataset otOperationalDataset

Struktur ini mewakili Set Data Operasional Aktif atau Menunggu Persetujuan.

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

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Struktur ini mewakili adanya komponen yang berbeda di Set Data Operasional Aktif atau Menunggu Keputusan.

otOperationalDatasetTlv

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Struktur ini mewakili Set Data Operasional Aktif atau Menunggu Persetujuan.

Set Data Operasional dienkode TLV sebagaimana ditentukan oleh Thread.

OTPskc

struct otPskc otPskc

Struktur ini mewakili PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

Jenis data ini mewakili KeyRef untuk PSKc.

Referensi ke Kunci

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

Struktur ini mewakili Kebijakan Keamanan.

otStempel waktu

struct otTimestamp otTimestamp

Struktur ini mewakili komponen stempel waktu Rangkaian Data Thread.

Variabel

OT_TOOL_PACKED_END [OT_ALAT_PACKED]

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Fungsi

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Metode ini membuat Set Data Operasional baru untuk digunakan saat membentuk jaringan baru.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aDataset
Set Data Operasional.
Nilai yang Ditampilkan
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
)

Fungsi ini menghasilkan PSKc dari frasa sandi, nama jaringan, dan ID PAN yang diperluas.

PSKc digunakan untuk membangun Sesi Komisaris.

Detail
Parameter
[in] aPassPhrase
Frasa sandi komisi.
[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 yang Ditampilkan
OT_ERROR_NONE
Berhasil membuat PSKc.
OT_ERROR_INVALID_ARGS
Jika ada argumen input yang tidak valid.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Fungsi ini mendapatkan Set Data Operasional Aktif.

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

otDatasetGetActiveTlv

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Fungsi ini mendapatkan Set Data Operasional Aktif.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aDataset
Pointer ke tempat set data Operasional Aktif akan ditempatkan.
Nilai yang Ditampilkan
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
)

Dapatkan timer penundaan minimal.

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

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Fungsi ini mendapatkan Set Data Operasional yang Tertunda.

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

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

Fungsi ini mendapatkan Set Data Operasional yang Tertunda.

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

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

Fungsi ini menunjukkan apakah jaringan yang valid ada di Set Data Operasional Aktif atau tidak.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Menampilkan
TRUE jika jaringan yang valid ada di Set Data Operasional Aktif, FALSE jika sebaliknya.

otDatasetParseTlv

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

Fungsi ini mengurai Set Data Operasional dari otOperationalDatasetTlvs.

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

otDatasetSendMgmtActiveDapatkan

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

Fungsi ini mengirim MGMT_ACTIVE_GET.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDatasetComponents
Pointer ke struktur Komponen Dataset yang menentukan komponen mana yang akan diminta.
[in] aTlvTypes
Pointer ke array yang berisi jenis TLV mentah tambahan yang akan diminta.
[in] aLength
Durasi aTlvTypes.
[in] aAddress
Pointer ke tujuan IPv6, jika NULL, akan menggunakan Leader ALOC sebagai default.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengirimkan 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
)

Fungsi ini 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 saat penerimaan respons atau waktu tunggu.
[in] aContext
Pointer untuk konteks khusus aplikasi untuk aCallback.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengirimkan 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
)

Fungsi ini mengirim MGMT_PENDING_GET.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDatasetComponents
Pointer ke struktur Komponen Dataset yang menentukan komponen mana yang akan diminta.
[in] aTlvTypes
Pointer ke array yang berisi jenis TLV mentah tambahan yang akan diminta.
[in] aLength
Durasi aTlvTypes.
[in] aAddress
Pointer ke tujuan IPv6, jika NULL, akan menggunakan Leader ALOC sebagai default.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengirimkan 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
)

Fungsi ini 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 saat penerimaan respons atau waktu tunggu.
[in] aContext
Pointer untuk konteks khusus aplikasi untuk aCallback.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengirimkan perintah set data meshcop.
OT_ERROR_NO_BUFS
Ruang buffer tidak cukup untuk mengirim.
OT_ERROR_BUSY
Permintaan sebelumnya sedang berlangsung.

otDatasetSetAktif

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

Fungsi ini menetapkan Set Data Operasional Aktif.

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

Jika Thread diaktifkan pada perangkat yang memiliki Set Data Aktif yang sebagian selesai, perangkat akan mencoba melampirkan ke jaringan Thread yang ada menggunakan informasi yang ada dalam set data. Hanya Thread Network Key yang diperlukan untuk terhubung ke jaringan.

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

Jika perangkat berhasil dipasang ke jaringan Thread, perangkat akan mengambil Set Data Aktif lengkap dari Induknya. Perhatikan bahwa perangkat yang mendukung router tidak akan beralih ke peran Router atau Leader sampai perangkat memiliki Set Data Aktif yang lengkap.

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

otDatasetSetActiveTlv

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

Fungsi ini menetapkan Set Data Operasional Aktif.

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

Jika Thread diaktifkan pada perangkat yang memiliki Set Data Aktif yang sebagian selesai, perangkat akan mencoba melampirkan ke jaringan Thread yang ada menggunakan informasi yang ada dalam set data. Hanya Thread Network Key yang diperlukan untuk terhubung ke jaringan.

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

Jika perangkat berhasil dipasang ke jaringan Thread, perangkat akan mengambil Set Data Aktif lengkap dari Induknya. Perhatikan bahwa perangkat yang mendukung router tidak akan beralih ke peran Router atau Leader sampai perangkat memiliki Set Data Aktif yang lengkap.

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

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Setel timer penundaan minimal.

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

otDatasetSetTertunda

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

Fungsi ini menetapkan Set Data Operasional yang Tertunda.

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

otDatasetSetPendingTlv

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

Fungsi ini menetapkan Set Data Operasional yang Tertunda.

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

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

Fungsi ini membatalkan permintaan update Set Data Operasional yang sedang berlangsung (jika ada).

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

Fungsi ini menunjukkan apakah ada permintaan update Dataset Operasi yang sedang berlangsung.

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

otDatasetUpdaterRequestUpdate

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

Fungsi ini meminta update untuk Set Data Operasional.

aDataset harus berisi kolom yang akan diperbarui dan nilai barunya. Tema tidak boleh berisi kolom Stempel Waktu Aktif atau Tertunda. Kolom Delay bersifat opsional, jika tidak ada nilai default (1.000 md) yang 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 update Set data selesai.
[in] aContext
Konteks arbitrer yang diteruskan ke callback.
Nilai yang Ditampilkan
OT_ERROR_NONE
Pembaruan set data berhasil dimulai (aCallback akan dipanggil setelah 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, yang sebelumnya sedang berlangsung.
OT_ERROR_NO_BUFS
Tidak dapat mengalokasikan buffer untuk menyimpan Dataset.

otNetworkNameFromString

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

Fungsi ini menetapkan instance otNetworkName dari string C yang dihentikan null.

Fungsi ini juga memvalidasi bahwa aNameString yang diberikan mengikuti encoding UTF-8 dan panjangnya tidak lebih dari OT_NETWORK_NAME_MAX_SIZE.

Detail
Parameter
[out] aNetworkName
Pointer ke otNetworkName untuk ditetapkan.
[in] aNameString
String nama C.
Nilai yang Ditampilkan
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)

Resource

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