Umum

Modul ini mencakup fungsi untuk semua peran Thread.

Ringkasan

Penayang Data Jaringan menyediakan mekanisme untuk membatasi jumlah entri Layanan dan/atau Awalan (awalan on-mesh atau rute eksternal) yang serupa dalam Data Jaringan Thread dengan memantau Data Jaringan dan mengelola apakah atau kapan harus menambahkan atau menghapus entri.

Semua fungsi dalam modul ini memerlukan OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE untuk diaktifkan.

Enumerasi

anonymous enum{
  OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
  OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
  OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
  OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
  OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
  OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
  OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
  OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
  OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
  OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
  OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
  OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
  OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
  OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19,
  OT_NETWORK_DIAGNOSTIC_TLV_VERSION = 24,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME = 25,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL = 26,
  OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION = 27,
  OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION = 28,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD = 29,
  OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST = 30,
  OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR = 31,
  OT_NETWORK_DIAGNOSTIC_TLV_ANSWER = 32,
  OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID = 33,
  OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS = 34
}
enum
otDeviceRole{
  OT_DEVICE_ROLE_DISABLED = 0,
  OT_DEVICE_ROLE_DETACHED = 1,
  OT_DEVICE_ROLE_CHILD = 2,
  OT_DEVICE_ROLE_ROUTER = 3,
  OT_DEVICE_ROLE_LEADER = 4
}
enum
Merepresentasikan peran perangkat Thread.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
enum
Mewakili peristiwa yang dilaporkan dari callback Penayang.
otRoutePreference{
  OT_ROUTE_PREFERENCE_LOW = -1,
  OT_ROUTE_PREFERENCE_MED = 0,
  OT_ROUTE_PREFERENCE_HIGH = 1
}
enum
Menentukan nilai yang valid untuk mPreference di otExternalRouteConfig dan otBorderRouterConfig.

Typedef

otBorderRouterConfig typedef
Menampilkan konfigurasi Router Pembatas.
otDetachGracefullyCallback)(void *aContext) typedef
void(*
Callback ini memberi tahu aplikasi bahwa proses pelepasan telah selesai.
otExternalRouteConfig typedef
Menampilkan konfigurasi Rute Eksternal.
otIpCounters typedef
struct otIpCounters
Menggambarkan penghitung tingkat IP.
otLeaderData typedef
struct otLeaderData
Menampilkan Data Pemimpin Thread.
otLinkModeConfig typedef
Mewakili konfigurasi Mode Link MLE.
otLowpanContextInfo typedef
Mewakili informasi ID Konteks 6LoWPAN yang terkait dengan awalan dalam Data Jaringan.
otMleCounters typedef
struct otMleCounters
Merepresentasikan penghitung MLE Thread.
otNeighborInfoIterator typedef
int16_t
Digunakan untuk melakukan iterasi melalui tabel tetangga.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Jenis pointer menentukan callback yang digunakan untuk memberi tahu saat entri "DNS/SRP Service" ditambahkan ke atau dihapus dari Data Jaringan Thread.
otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
Jenis pointer menentukan callback yang digunakan untuk memberi tahu saat entri awalan (on-mesh atau rute eksternal) ditambahkan ke atau dihapus dari Data Jaringan Thread.
otNetDataPublisherEvent typedef
Mewakili peristiwa yang dilaporkan dari callback Penayang.
otNetworkDataIterator typedef
uint32_t
Digunakan untuk melakukan iterasi melalui informasi Data Jaringan.
otNetworkDiagChildEntry typedef
Merepresentasikan Entri Tabel Turunan Diagnostik Jaringan.
otNetworkDiagConnectivity typedef
Mewakili nilai Konektivitas Diagnostik Jaringan.
otNetworkDiagIterator typedef
uint16_t
Digunakan untuk melakukan iterasi melalui TLV Diagnostik Jaringan.
otNetworkDiagMacCounters typedef
Mewakili nilai Penghitung Mac Diagnostik Jaringan.
otNetworkDiagMleCounters typedef
Mewakili nilai Penghitung MLE Diagnostik Jaringan.
otNetworkDiagRoute typedef
Mewakili nilai TLV Rute Diagnostik Jaringan.
otNetworkDiagRouteData typedef
Menampilkan data Rute Diagnostik Jaringan.
otNetworkDiagTlv typedef
Merepresentasikan TLV Diagnostik Jaringan.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
Pointer dipanggil saat respons Network Diagnostic Get diterima.
otRoutePreference typedef
Menentukan nilai yang valid untuk mPreference di otExternalRouteConfig dan otBorderRouterConfig.
otServerConfig typedef
Mewakili konfigurasi Server.
otServiceConfig typedef
Mewakili konfigurasi Layanan.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
Jenis pointer menentukan callback untuk memberi tahu hasil permintaan otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Pointer dipanggil setiap kali pesan Permintaan Penemuan MLE diterima.
otThreadDiscoveryRequestInfo typedef
Menampilkan data Permintaan Thread Discovery.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Pointer dipanggil setiap kali pesan Respons Orang Tua MLE diterima.
otThreadParentResponseInfo typedef
Merepresentasikan data Respons Orang Tua MLE.

Fungsi

otConvertDurationInSecondsToString(uint32_t aDuration, char *aBuffer, uint16_t aSize)
void
Mengonversi durasi uint32_t (dalam detik) menjadi string yang dapat dibaca manusia.
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Memeriksa apakah Awalan tertentu dapat berfungsi sebagai awalan OMR yang valid dan juga Data Jaringan Pemimpin berisi awalan ini.
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Memberikan salinan lengkap atau stabil Data Jaringan Thread Partisi.
otNetDataGetCommissioningDataset(otInstance *aInstance, otCommissioningDataset *aDataset)
void
Mendapatkan Set Data Commissioning dari Data Jaringan partisi.
otNetDataGetLength(otInstance *aInstance)
uint8_t
Mendapatkan panjang (jumlah byte) Data Jaringan Thread Partisi saat ini.
otNetDataGetMaxLength(otInstance *aInstance)
uint8_t
Dapatkan panjang maksimum Data Jaringan Thread yang diamati sejak inisialisasi stack OT atau sejak panggilan terakhir ke otNetDataResetMaxLength().
otNetDataGetNextLowpanContextInfo(otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
Dapatkan info 6LoWPAN Context ID berikutnya di Data Jaringan partisi.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Dapatkan Awalan On Mesh berikutnya di Data Jaringan partisi.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Mendapatkan rute eksternal berikutnya di Data Jaringan partisi.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Mendapatkan layanan berikutnya di Data Jaringan partisi.
otNetDataGetStableVersion(otInstance *aInstance)
uint8_t
Mendapatkan Versi Data Jaringan Stabil.
otNetDataGetVersion(otInstance *aInstance)
uint8_t
Mendapatkan Versi Data Jaringan.
otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)
bool
Menunjukkan apakah saat ini entri "Layanan DNS/SRP" ditambahkan ke Data Jaringan Thread atau tidak.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Menunjukkan apakah saat ini entri awalan yang dipublikasikan (rute eksternal atau on-mesh) ditambahkan ke Data Jaringan Thread.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Meminta "DNS/SRP Service Anycast Address" untuk dipublikasikan di Data Jaringan Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Meminta "DNS/SRP Service Unicast Address" untuk dipublikasikan di Data Jaringan Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Meminta "DNS/SRP Service Unicast Address" untuk dipublikasikan di Data Jaringan Thread.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Meminta awalan rute eksternal dipublikasikan di Data Jaringan Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Meminta awalan on-mesh untuk dipublikasikan di Data Jaringan Thread.
otNetDataReplacePublishedExternalRoute(otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
Mengganti rute eksternal yang dipublikasikan sebelumnya di Data Jaringan Thread.
otNetDataResetMaxLength(otInstance *aInstance)
void
Reset panjang maksimum Data Jaringan Thread yang dilacak.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Menyetel callback untuk memberi tahu kapan "Layanan DNS/SRP" yang dipublikasikan benar-benar ditambahkan ke atau dihapus dari Data Jaringan Thread.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Menetapkan callback untuk memberi tahu kapan entri awalan yang dipublikasikan benar-benar ditambahkan ke atau dihapus dari Data Jaringan Thread.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Periksa apakah data pengarahan menyertakan Joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Periksa apakah data pengarahan menyertakan Joiner dengan nilai pembeda tertentu.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Membatalkan publikasi entri Layanan DNS/SRP (Anycast atau Unicast) yang ditambahkan sebelumnya dari Data Jaringan Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Membatalkan publikasi Awalan Rute Eksternal atau On-Mesh yang dipublikasikan sebelumnya.
otThreadBecomeChild(otInstance *aInstance)
Mencoba menambahkan kembali sebagai anak.
otThreadBecomeDetached(otInstance *aInstance)
Lepaskan dari jaringan Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Memberi tahu node lain dalam jaringan (jika ada), lalu menghentikan operasi protokol Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Konversi peran perangkat menjadi string yang dapat dibaca manusia.
otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Memulai pemindaian Thread Discovery.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Mendapatkan Waktu Tunggu Turunan Thread (dalam detik) yang digunakan saat beroperasi dalam peran Turunan.
otThreadGetDeviceRole(otInstance *aInstance)
Mendapatkan peran perangkat.
otThreadGetDomainName(otInstance *aInstance)
const char *
Mendapatkan Nama Domain Thread.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Mendapatkan ID PAN IEEE 802.15.4 Extended.
otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)
Mendapatkan ID Antarmuka yang ditentukan secara manual untuk Alamat Unicast Domain Thread.
otThreadGetIp6Counters(otInstance *aInstance)
const otIpCounters *
Mendapatkan penghitung IPv6.
otThreadGetKeySequenceCounter(otInstance *aInstance)
uint32_t
Mendapatkan thrKeySequenceCounter.
otThreadGetKeySwitchGuardTime(otInstance *aInstance)
uint32_t
Mendapatkan thrKeySwitchGuardTime (dalam jam).
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Mendapatkan Data Pemimpin Thread.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Menampilkan pointer ke RLOC Pemimpin.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Dapatkan ID Router Pemimpin.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Dapatkan Berat Pemimpin.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Mendapatkan alamat multicast Thread Link-Local All Thread Nodes.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Mendapatkan alamat IPv6 link-lokal Thread.
otThreadGetLinkMode(otInstance *aInstance)
Mendapatkan konfigurasi Mode Link MLE.
otThreadGetMaxTimeInQueue(otInstance *aInstance)
uint32_t
Mendapatkan waktu maksimum dalam antrean untuk pesan di antrean TX.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Mendapatkan alamat EID Lokal Mesh.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Menampilkan pointer ke Mesh Local Prefix.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Mendapatkan penghitung MLE Thread.
otThreadGetNetworkKey(otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Mendapatkan Kunci Jaringan Thread.
otThreadGetNetworkKeyRef(otInstance *aInstance)
Dapatkan otNetworkKeyRef untuk Kunci Jaringan Thread.
otThreadGetNetworkName(otInstance *aInstance)
const char *
Mendapatkan Nama Jaringan Thread.
otThreadGetNextDiagnosticTlv(const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Mendapatkan TLV Diagnostik Jaringan berikutnya dalam pesan.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Mendapatkan informasi tetangga berikutnya.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
Fungsi ini mengambil RSSI rata-rata untuk Induk Thread.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
Fungsi ini mengambil informasi diagnostik untuk Router Thread sebagai induk.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
Fungsi ini mengambil RSSI paket terakhir dari Thread Parent.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Dapatkan ID Partisi.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Mendapatkan alamat multicast Thread Realm-Local All Thread Node.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Mendapatkan alamat Thread Routing Locator (RLOC).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Dapatkan RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Mengambil ALOC Layanan untuk ID Layanan tertentu.
otThreadGetTimeInQueueHistogram(otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)
const uint32_t *
Mendapatkan histogram waktu dalam antrean untuk pesan di antrean TX.
otThreadGetVendorModel(otInstance *aInstance)
const char *
Mendapatkan string model vendor.
otThreadGetVendorName(otInstance *aInstance)
const char *
Mendapatkan string nama vendor.
otThreadGetVendorSwVersion(otInstance *aInstance)
const char *
Mendapatkan string versi sw vendor.
otThreadGetVersion(void)
uint16_t
Mendapatkan versi protokol Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Menunjukkan apakah permintaan cari anycast sedang berlangsung.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Menentukan apakah Penemuan Thread MLE saat ini sedang berlangsung.
otThreadIsSingleton(otInstance *aInstance)
bool
Menunjukkan apakah node adalah satu-satunya router di jaringan.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Meminta lokasi tujuan terdekat dari alamat anycast tertentu.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Mendaftarkan callback untuk menerima data Respons Induk MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Mereset penghitung IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Mereset penghitung MLE Thread.
otThreadResetTimeInQueueStat(otInstance *aInstance)
void
Mereset statistik waktu dalam antrean TX.
otThreadSearchForBetterParent(otInstance *aInstance)
Memulai proses bagi anak untuk menelusuri orang tua yang lebih baik sambil tetap terhubung dengan induknya saat ini.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Mengirim pesan Notifikasi Alamat Proaktif (ADDR_NTF.ntf).
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Kirim permintaan Get Diagnostik Jaringan.
otThreadSendDiagnosticReset(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Kirim permintaan Reset Diagnostik Jaringan.
otThreadSendProactiveBackboneNotification(otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Mengirim pesan Proaktif Backbone Notification (PRO_BB.ntf) di link Backbone.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Menetapkan Thread Child Timeout (dalam detik) yang digunakan saat beroperasi dalam peran Turunan.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Menetapkan callback untuk menerima data Permintaan Penemuan MLE.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
Menetapkan Nama Domain Thread.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Memulai operasi protokol Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Mengatur IEEE 802.15.4 Extended PAN ID.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Menetapkan atau menghapus ID Antarmuka yang ditentukan secara manual untuk Alamat Unicast Domain Thread.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Menyetel Iklan Penyambung Thread saat menemukan jaringan Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Menetapkan thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Menetapkan thrKeySwitchGuardTime (dalam jam).
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Tetapkan konfigurasi Mode Link MLE.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Menetapkan Awalan Lokal Mesh.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Setel Kunci Jaringan Thread.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Tetapkan Kunci Jaringan Thread sebagai otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Tetapkan Nama Jaringan Thread.
otThreadSetVendorModel(otInstance *aInstance, const char *aVendorModel)
Tetapkan string model vendor.
otThreadSetVendorName(otInstance *aInstance, const char *aVendorName)
Tetapkan string nama vendor.
otThreadSetVendorSwVersion(otInstance *aInstance, const char *aVendorSwVersion)
Menetapkan string versi software vendor.

Struct

otBorderRouterConfig

Menampilkan konfigurasi Router Pembatas.

otExternalRouteConfig

Menampilkan konfigurasi Rute Eksternal.

otIpCounters

Menggambarkan penghitung tingkat IP.

otLeaderData

Menampilkan Data Pemimpin Thread.

otLinkModeConfig

Mewakili konfigurasi Mode Link MLE.

otLowpanContextInfo

Mewakili informasi ID Konteks 6LoWPAN yang terkait dengan awalan dalam Data Jaringan.

otMleCounters

Merepresentasikan penghitung MLE Thread.

otNeighborInfo

Menyimpan informasi diagnostik untuk node Thread di dekatnya.

otNetworkDiagChildEntry

Merepresentasikan Entri Tabel Turunan Diagnostik Jaringan.

otNetworkDiagConnectivity

Mewakili nilai Konektivitas Diagnostik Jaringan.

otNetworkDiagMacCounters

Mewakili nilai Penghitung Mac Diagnostik Jaringan.

otNetworkDiagMleCounters

Mewakili nilai Penghitung MLE Diagnostik Jaringan.

otNetworkDiagRoute

Mewakili nilai TLV Rute Diagnostik Jaringan.

otNetworkDiagRouteData

Menampilkan data Rute Diagnostik Jaringan.

otNetworkDiagTlv

Merepresentasikan TLV Diagnostik Jaringan.

otRouterInfo

Menyimpan informasi diagnostik untuk Router Thread.

otServerConfig

Mewakili konfigurasi Server.

otServiceConfig

Mewakili konfigurasi Layanan.

otThreadDiscoveryRequestInfo

Menampilkan data Permintaan Thread Discovery.

otThreadParentResponseInfo

Merepresentasikan data Respons Orang Tua MLE.

Enumerasi

enum anonim

 anonymous enum
Properti
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER

Jawab TLV.

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

TLV Tingkat Baterai.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV Halaman Channel.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

TLV turunan.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

TLV Daftar Alamat IPv6 Turunan.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

TLV Tabel Turunan.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV konektivitas.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV Alamat MAC yang Diperluas.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV Daftar Alamat IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV Data Pemimpin.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

TLV Penghitung MAC.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV Waktu Tunggu Turunan Maks.

OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS

TLV Penghitung MLE.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Mode TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV Data Jaringan

OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID

TLV ID Kueri.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR

TLV Tetangga Router.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Address16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Voltase Suplai TLV.

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

TLV Versi Stack Thread.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

TLV waktu tunggu (jangka waktu polling maksimum untuk SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Type List TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL

Model Vendor TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME

Nama Vendor TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION

Vendor SW Version TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

Versi TLV.

otDeviceRole

 otDeviceRole

Merepresentasikan peran perangkat Thread.

Properti
OT_DEVICE_ROLE_CHILD

Peran Thread Child.

OT_DEVICE_ROLE_DETACHED

Saat ini tidak berpartisipasi dalam partisi/jaringan Thread.

OT_DEVICE_ROLE_DISABLED

Stack Thread dinonaktifkan.

OT_DEVICE_ROLE_LEADER

Peran Thread Leader.

OT_DEVICE_ROLE_ROUTER

Peran Router Thread.

otNetDataPublisherEvent

 otNetDataPublisherEvent

Mewakili peristiwa yang dilaporkan dari callback Penayang.

Properti
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

Entri yang dipublikasikan akan ditambahkan ke Data Jaringan Thread.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

Entri yang dipublikasikan akan dihapus dari Data Jaringan Thread.

otRoutePreference

 otRoutePreference

Menentukan nilai yang valid untuk mPreference di otExternalRouteConfig dan otBorderRouterConfig.

Properti
OT_ROUTE_PREFERENCE_HIGH

Preferensi rute tinggi.

OT_ROUTE_PREFERENCE_LOW

Preferensi rute rendah.

OT_ROUTE_PREFERENCE_MED

Preferensi rute sedang.

Typedef

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Menampilkan konfigurasi Router Pembatas.

otDetachGracefullyCallback

void(* otDetachGracefullyCallback)(void *aContext)

Callback ini memberi tahu aplikasi bahwa proses pelepasan telah selesai.

Detail
Parameter
[in] aContext
Pointer ke konteks khusus aplikasi.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Menampilkan konfigurasi Rute Eksternal.

otIpCounters

struct otIpCounters otIpCounters

Menggambarkan penghitung tingkat IP.

otLeaderData

struct otLeaderData otLeaderData

Menampilkan Data Pemimpin Thread.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Mewakili konfigurasi Mode Link MLE.

otLowpanContextInfo

struct otLowpanContextInfo otLowpanContextInfo

Mewakili informasi ID Konteks 6LoWPAN yang terkait dengan awalan dalam Data Jaringan.

otMleCounters

struct otMleCounters otMleCounters

Merepresentasikan penghitung MLE Thread.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Digunakan untuk melakukan iterasi melalui tabel tetangga.

otNetDataDnsSrpServicePublisherCallback

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

Jenis pointer menentukan callback yang digunakan untuk memberi tahu saat entri "DNS/SRP Service" ditambahkan ke atau dihapus dari Data Jaringan Thread.

Saat penghapusan, callback dipanggil, terlepas dari apakah entri dihapus oleh Publisher (misalnya, saat ada terlalu banyak entri serupa dalam Data Jaringan) atau melalui panggilan eksplisit untuk membatalkan publikasi entri (yaitu, panggilan ke otNetDataUnpublishDnsSrpService()).

Detail
Parameter
[in] aEvent
Menunjukkan peristiwa (apakah entri ditambahkan atau dihapus).
[in] aContext
Pointer ke konteks khusus aplikasi.

otNetDataPrefixPublisherCallback

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

Jenis pointer menentukan callback yang digunakan untuk memberi tahu saat entri awalan (on-mesh atau rute eksternal) ditambahkan ke atau dihapus dari Data Jaringan Thread.

Saat penghapusan, callback dipanggil, terlepas dari apakah entri dihapus oleh Publisher (misalnya, saat ada terlalu banyak entri serupa sudah ada di Data Jaringan) atau melalui panggilan eksplisit untuk membatalkan publikasi entri.

Detail
Parameter
[in] aEvent
Menunjukkan peristiwa (apakah entri ditambahkan atau dihapus).
[in] aPrefix
Pointer ke entri awalan.
[in] aContext
Pointer ke konteks khusus aplikasi.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Mewakili peristiwa yang dilaporkan dari callback Penayang.

otNetworkDataIterator

uint32_t otNetworkDataIterator

Digunakan untuk melakukan iterasi melalui informasi Data Jaringan.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Merepresentasikan Entri Tabel Turunan Diagnostik Jaringan.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Mewakili nilai Konektivitas Diagnostik Jaringan.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

Digunakan untuk melakukan iterasi melalui TLV Diagnostik Jaringan.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Mewakili nilai Penghitung Mac Diagnostik Jaringan.

Lihat RFC 2863 untuk definisi kolom anggota.

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

Mewakili nilai Penghitung MLE Diagnostik Jaringan.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Mewakili nilai TLV Rute Diagnostik Jaringan.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Menampilkan data Rute Diagnostik Jaringan.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Merepresentasikan TLV Diagnostik Jaringan.

otReceiveDiagnosticGetCallback

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

Pointer dipanggil saat respons Network Diagnostic Get diterima.

Detail
Parameter
[in] aError
Error saat gagal mendapatkan respons.
[in] aMessage
Pointer ke buffer pesan yang berisi payload respons Network Diagnostic Get yang diterima. Hanya tersedia jika aError adalah OT_ERROR_NONE.
[in] aMessageInfo
Pointer ke info pesan untuk aMessage. Hanya tersedia jika aError adalah OT_ERROR_NONE.
[in] aContext
Pointer ke konteks khusus aplikasi.

otRoutePreference

enum otRoutePreference otRoutePreference

Menentukan nilai yang valid untuk mPreference di otExternalRouteConfig dan otBorderRouterConfig.

otServerConfig

struct otServerConfig otServerConfig

Mewakili konfigurasi Server.

otServiceConfig

struct otServiceConfig otServiceConfig

Mewakili konfigurasi Layanan.

otThreadAnycastLocatorCallback

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

Jenis pointer menentukan callback untuk memberi tahu hasil permintaan otThreadLocateAnycastDestination().

Detail
Parameter
[in] aContext
Pointer ke konteks arbitrer (diberikan saat callback didaftarkan).
[in] aError
Error saat menangani permintaan. OT_ERROR_NONE menunjukkan keberhasilan. OT_ERROR_RESPONSE_TIMEOUT menunjukkan bahwa tujuan tidak dapat ditemukan. OT_ERROR_ABORT menunjukkan permintaan dibatalkan.
[in] aMeshLocalAddress
Pointer ke EID lokal mesh dari tujuan terdekat dari alamat anycast jika aError adalah OT_ERROR_NONE, NULL jika tidak.
[in] aRloc16
RLOC16 tujuan jika ditemukan, jika tidak, RLOC16 (0xfffe) tidak valid.

otThreadDiscoveryRequestCallback

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

Pointer dipanggil setiap kali pesan Permintaan Penemuan MLE diterima.

Detail
Parameter
[in] aInfo
Pointer ke data info Permintaan Penemuan.
[in] aContext
Pointer ke callback konteks khusus aplikasi.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Menampilkan data Permintaan Thread Discovery.

otThreadParentResponseCallback

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

Pointer dipanggil setiap kali pesan Respons Orang Tua MLE diterima.

Ini digunakan di otThreadRegisterParentResponseCallback().

Detail
Parameter
[in] aInfo
Pointer ke lokasi di tumpukan yang menyimpan data statistik.
[in] aContext
Pointer untuk callback konteks khusus klien.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Merepresentasikan data Respons Orang Tua MLE.

Fungsi

otConvertDurationInSecondsToString

void otConvertDurationInSecondsToString(
  uint32_t aDuration,
  char *aBuffer,
  uint16_t aSize
)

Mengonversi durasi uint32_t (dalam detik) menjadi string yang dapat dibaca manusia.

OPENTHREAD_CONFIG_UPTIME_ENABLE harus diaktifkan.

String mengikuti format "::" untuk jam, menit, detik (jika durasi lebih pendek dari satu hari) atau "

d.::" (jika lebih dari satu hari).

Jika string yang dihasilkan tidak sesuai dengan aBuffer (dalam karakter aSize-nya), string akan terpotong tetapi string yang dihasilkan selalu dihentikan null.

Dimaksudkan untuk digunakan dengan mAge atau mConnectionTime dalam struktur otNeighborInfo atau otChildInfo.

Detail
Parameter
[in] aDuration
Interval durasi dalam detik.
[out] aBuffer
Pointer ke array karakter untuk menghasilkan string.
[in] aSize
Ukuran aBuffer (dalam byte). Sebaiknya gunakan OT_DURATION_STRING_SIZE.

otNetDataContainsOmrPrefix

bool otNetDataContainsOmrPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Memeriksa apakah Awalan tertentu dapat berfungsi sebagai awalan OMR yang valid dan juga Data Jaringan Pemimpin berisi awalan ini.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPrefix
Sebuah pointer ke awalan IPv6.
Hasil
Apakah aPrefix merupakan awalan OMR yang valid dan Data Jaringan Pemimpin berisi awalan OMR aPrefix.

otNetDataGet

otError otNetDataGet(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

Memberikan salinan lengkap atau stabil Data Jaringan Thread Partisi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aStable
TRUE saat menyalin versi stabil, FALSE saat menyalin versi lengkap.
[out] aData
Pointer ke buffer data.
[in,out] aDataLength
Saat entri, ukuran buffer data ditunjukkan oleh aData. Saat keluar, jumlah byte yang disalin.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menyalin Data Jaringan Thread ke aData dan memperbarui aDataLength.
OT_ERROR_NO_BUFS
Ruang di aData tidak cukup untuk menyalin sepenuhnya Data Jaringan Thread.

otNetDataGetCommissioningDataset

void otNetDataGetCommissioningDataset(
  otInstance *aInstance,
  otCommissioningDataset *aDataset
)

Mendapatkan Set Data Commissioning dari Data Jaringan partisi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aDataset
Pointer ke otCommissioningDataset yang akan diisi.

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

Mendapatkan panjang (jumlah byte) Data Jaringan Thread Partisi saat ini.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Panjang Data Jaringan.

otNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

Dapatkan panjang maksimum Data Jaringan Thread yang diamati sejak inisialisasi stack OT atau sejak panggilan terakhir ke otNetDataResetMaxLength().

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Panjang maksimum Data Jaringan (tanda air tinggi untuk panjang Data Jaringan).

otNetDataGetNextLowpanContextInfo

otError otNetDataGetNextLowpanContextInfo(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otLowpanContextInfo *aContextInfo
)

Dapatkan info 6LoWPAN Context ID berikutnya di Data Jaringan partisi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Pointer ke iterator Data Jaringan. Untuk mendapatkan entri layanan pertama, entri harus ditetapkan ke OT_NETWORK_DATA_ITERATOR_INIT.
[out] aContextInfo
Pointer ke tempat informasi ID Konteks 6LoWPAN yang diambil akan ditempatkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menemukan info ID Konteks 6LoWPAN berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada info Konteks 6LoWPAN berikutnya dalam Data Jaringan partisi.

otNetDataGetNextOnMeshPrefix

otError otNetDataGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

Dapatkan Awalan On Mesh berikutnya di Data Jaringan partisi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Pointer ke konteks iterator Data Jaringan. Untuk mendapatkan entri on-mesh pertama, Anda harus disetel ke OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointer ke tempat informasi On Mesh Prefix akan ditempatkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menemukan awalan On Mesh berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada awalan On Mesh berikutnya dalam Data Jaringan Thread.

otNetDataGetNextRoute

otError otNetDataGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

Mendapatkan rute eksternal berikutnya di Data Jaringan partisi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Pointer ke konteks iterator Data Jaringan. Untuk mendapatkan entri rute eksternal pertama, Anda harus disetel ke OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointer ke tempat informasi Rute Eksternal akan ditempatkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menemukan Rute Eksternal berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada entri rute eksternal berikutnya dalam Data Jaringan Thread.

otNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

Mendapatkan layanan berikutnya di Data Jaringan partisi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Pointer ke konteks iterator Data Jaringan. Untuk mendapatkan entri layanan pertama, entri harus ditetapkan ke OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointer ke tempat informasi layanan akan ditempatkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menemukan layanan berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada layanan berikutnya dalam Data Jaringan partisi.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Mendapatkan Versi Data Jaringan Stabil.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Versi Data Jaringan Stabil.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Mendapatkan Versi Data Jaringan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Versi Data Jaringan.

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Menunjukkan apakah saat ini entri "Layanan DNS/SRP" ditambahkan ke Data Jaringan Thread atau tidak.

Mengharuskan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
TRUE
Entri Layanan DNS/SRP yang dipublikasikan akan ditambahkan ke Data Jaringan Thread.
FALSE
Entri tidak ditambahkan ke Data Jaringan Thread atau tidak ada entri untuk dipublikasikan.

otNetDataIsPrefixAdded

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Menunjukkan apakah saat ini entri awalan yang dipublikasikan (rute eksternal atau on-mesh) ditambahkan ke Data Jaringan Thread.

Mengharuskan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPrefix
Pointer ke awalan (TIDAK BOLEH NULL).
Nilai Pengembalian
TRUE
Entri awalan yang dipublikasikan akan ditambahkan ke Data Jaringan Thread.
FALSE
Entri tidak ditambahkan ke Data Jaringan Thread atau tidak ada entri untuk dipublikasikan.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Meminta "DNS/SRP Service Anycast Address" untuk dipublikasikan di Data Jaringan Thread.

Mengharuskan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE diaktifkan.

Panggilan ke fungsi ini akan menghapus dan mengganti entri "Layanan DNS/SRP" sebelumnya yang sedang dipublikasikan (dari panggilan sebelumnya ke fungsi otNetDataPublishDnsSrpService{Type}() mana pun).

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aSequenceNUmber
Nomor urut Layanan Anycast DNS/SRP.

otNetDataPublishDnsSrpServiceUnicast

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

Meminta "DNS/SRP Service Unicast Address" untuk dipublikasikan di Data Jaringan Thread.

Mengharuskan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE diaktifkan.

Panggilan ke fungsi ini akan menghapus dan mengganti entri "Layanan DNS/SRP" sebelumnya yang sedang dipublikasikan (dari panggilan sebelumnya ke fungsi otNetDataPublishDnsSrpService{Type}() mana pun).

Memublikasikan "Alamat Unicast Layanan DNS/SRP" dengan menyertakan info alamat dan port dalam data TLV Layanan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aAddress
Alamat server DNS/SRP yang akan diterbitkan (HARUS TIDAK NULL).
[in] aPort
Nomor port server SRP yang akan dipublikasikan.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Meminta "DNS/SRP Service Unicast Address" untuk dipublikasikan di Data Jaringan Thread.

Mengharuskan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE diaktifkan.

Panggilan ke fungsi ini akan menghapus dan mengganti entri "Layanan DNS/SRP" sebelumnya yang sedang dipublikasikan (dari panggilan sebelumnya ke fungsi otNetDataPublishDnsSrpService{Type}() mana pun).

Tidak seperti otNetDataPublishDnsSrpServiceUnicast() yang mengharuskan pemberian alamat yang dipublikasikan dan menyertakan info dalam data TLV Layanan, fungsi ini menggunakan EID lokal mesh perangkat dan menyertakan info dalam data TLV Server.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPort
Nomor port server SRP yang akan dipublikasikan.

otNetDataPublishExternalRoute

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

Meminta awalan rute eksternal dipublikasikan di Data Jaringan Thread.

Mengharuskan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE diaktifkan.

Hanya entri stabil yang dapat dipublikasikan (yaitu,aConfig.mStable HARUS BENAR).

Panggilan berikutnya ke metode ini akan menggantikan permintaan sebelumnya untuk awalan yang sama. Khususnya, jika panggilan baru hanya mengubah tanda (misalnya, tingkat preferensi) dan awalan sudah ditambahkan di Data Jaringan, perubahan pada tanda akan segera ditampilkan di Data Jaringan. Hal ini untuk memastikan bahwa entri yang ada dalam Data Jaringan tidak dihapus secara tiba-tiba. Perhatikan bahwa perubahan pada tingkat preferensi nantinya dapat menyebabkan entri dihapus dari Data Jaringan setelah menentukan ada node lain yang memublikasikan awalan yang sama dengan preferensi yang sama atau lebih tinggi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aConfig
Konfigurasi rute eksternal yang akan dipublikasikan (HARUS TIDAK NULL).
Nilai Pengembalian
OT_ERROR_NONE
Rute eksternal berhasil dipublikasikan.
OT_ERROR_INVALID_ARGS
aConfig tidak valid (awalan buruk, kombinasi flag tidak valid, atau tidak stabil).
OT_ERROR_NO_BUFS
Tidak dapat mengalokasikan entri untuk permintaan baru. Penayang mendukung jumlah entri yang terbatas (digunakan bersama antara awalan on-mesh dan rute eksternal) yang ditentukan oleh konfigurasi OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataPublishOnMeshPrefix

otError otNetDataPublishOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

Meminta awalan on-mesh untuk dipublikasikan di Data Jaringan Thread.

Mengharuskan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE diaktifkan.

Hanya entri stabil yang dapat dipublikasikan (yaitu,aConfig.mStable HARUS BENAR).

Panggilan berikutnya ke metode ini akan menggantikan permintaan sebelumnya untuk awalan yang sama. Khususnya, jika panggilan baru hanya mengubah tanda (misalnya, tingkat preferensi) dan awalan sudah ditambahkan di Data Jaringan, perubahan pada tanda akan segera ditampilkan di Data Jaringan. Hal ini untuk memastikan bahwa entri yang ada dalam Data Jaringan tidak dihapus secara tiba-tiba. Perhatikan bahwa perubahan pada tingkat preferensi nantinya dapat menyebabkan entri dihapus dari Data Jaringan setelah menentukan ada node lain yang memublikasikan awalan yang sama dengan preferensi yang sama atau lebih tinggi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aConfig
Konfigurasi awalan on-mesh yang akan dipublikasikan (TIDAK BOLEH NULL).
Nilai Pengembalian
OT_ERROR_NONE
Awalan on-mesh berhasil dipublikasikan.
OT_ERROR_INVALID_ARGS
aConfig tidak valid (awalan buruk, kombinasi flag tidak valid, atau tidak stabil).
OT_ERROR_NO_BUFS
Tidak dapat mengalokasikan entri untuk permintaan baru. Penayang mendukung jumlah entri yang terbatas (digunakan bersama antara awalan on-mesh dan rute eksternal) yang ditentukan oleh konfigurasi OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataReplacePublishedExternalRoute

otError otNetDataReplacePublishedExternalRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix,
  const otExternalRouteConfig *aConfig
)

Mengganti rute eksternal yang dipublikasikan sebelumnya di Data Jaringan Thread.

Mengharuskan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE diaktifkan.

Jika tidak ada rute eksternal yang cocok dengan aPrefix yang dipublikasikan sebelumnya, fungsi ini berperilaku mirip dengan otNetDataPublishExternalRoute(), yaitu, fungsi ini akan memulai proses publikasi aConfig sebagai rute eksternal dalam Data Jaringan Thread.

Jika ada entri rute yang dipublikasikan sebelumnya yang cocok dengan aPrefix, entri tersebut akan diganti dengan awalan baru dari aConfig.

  • Jika aPrefix sudah ditambahkan dalam Data Jaringan, perubahan pada awalan baru di aConfig akan segera ditampilkan dalam Data Jaringan. Hal ini memastikan bahwa entri rute dalam Data Jaringan tidak dihapus secara tiba-tiba dan transisi dari aPrefix ke awalan baru berjalan lancar.
  • Jika aPrefix lama yang dipublikasikan tidak ditambahkan ke Data Jaringan, kode tersebut akan diganti dengan awalan aConfig baru tetapi tidak akan segera ditambahkan. Sebaliknya, jaringan akan memulai proses publikasinya di Data Jaringan (memantau Data Jaringan untuk menentukan kapan/apakah awalan tersebut perlu ditambahkan, bergantung pada jumlah awalan serupa yang ada di Data Jaringan).

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPrefix
Awalan rute eksternal yang dipublikasikan sebelumnya yang akan diganti.
[in] aConfig
Konfigurasi rute eksternal yang akan dipublikasikan.
Nilai Pengembalian
OT_ERROR_NONE
Rute eksternal berhasil dipublikasikan.
OT_ERROR_INVALID_ARGS
aConfig tidak valid (awalan buruk, kombinasi flag tidak valid, atau tidak stabil).
OT_ERROR_NO_BUFS
Tidak dapat mengalokasikan entri untuk permintaan baru. Penayang mendukung jumlah entri yang terbatas (digunakan bersama antara awalan on-mesh dan rute eksternal) yang ditentukan oleh konfigurasi OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

Reset panjang maksimum Data Jaringan Thread yang dilacak.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Lihat juga:
otNetDataGetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

Menyetel callback untuk memberi tahu kapan "Layanan DNS/SRP" yang dipublikasikan benar-benar ditambahkan ke atau dihapus dari Data Jaringan Thread.

Panggilan berikutnya ke fungsi ini akan menggantikan fungsi callback yang ditetapkan sebelumnya.

Mengharuskan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer fungsi callback (bisa NULL jika tidak diperlukan).
[in] aContext
Pointer ke konteks khusus aplikasi (digunakan saat aCallback dipanggil).

otNetDataSetPrefixPublisherCallback

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

Menetapkan callback untuk memberi tahu kapan entri awalan yang dipublikasikan benar-benar ditambahkan ke atau dihapus dari Data Jaringan Thread.

Panggilan berikutnya ke fungsi ini akan menggantikan fungsi callback yang ditetapkan sebelumnya.

Mengharuskan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer fungsi callback (bisa NULL jika tidak diperlukan).
[in] aContext
Pointer ke konteks khusus aplikasi (digunakan saat aCallback dipanggil).

otNetDataSteeringDataCheckJoiner

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

Periksa apakah data pengarahan menyertakan Joiner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEui64
Penunjuk ke Joiner's IEEE EUI-64.
Nilai Pengembalian
OT_ERROR_NONE
aEui64 disertakan dalam data pengemudian.
OT_ERROR_INVALID_STATE
Tidak ada data pengarah.
OT_ERROR_NOT_FOUND
aEui64 tidak disertakan dalam data pengarahan.

otNetDataSteeringDataCheckJoinerWithDiscerner

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

Periksa apakah data pengarahan menyertakan Joiner dengan nilai pembeda tertentu.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDiscerner
Pointer ke Joiner Discerner.
Nilai Pengembalian
OT_ERROR_NONE
aDiscerner disertakan dalam data pengemudian.
OT_ERROR_INVALID_STATE
Tidak ada data pengarah.
OT_ERROR_NOT_FOUND
aDiscerner tidak disertakan dalam data pengarahan.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Membatalkan publikasi entri Layanan DNS/SRP (Anycast atau Unicast) yang ditambahkan sebelumnya dari Data Jaringan Thread.

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE harus diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otNetDataUnpublishPrefix

otError otNetDataUnpublishPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Membatalkan publikasi Awalan Rute Eksternal atau On-Mesh yang dipublikasikan sebelumnya.

OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE harus diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPrefix
Awalan untuk membatalkan publikasi (HARUS TIDAK NULL).
Nilai Pengembalian
OT_ERROR_NONE
Awalan berhasil dibatalkan publikasinya.
OT_ERROR_NOT_FOUND
Tidak dapat menemukan awalan dalam daftar yang dipublikasikan.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Mencoba menambahkan kembali sebagai anak.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil memulai upaya untuk menjadi anak.
OT_ERROR_INVALID_STATE
Thread dinonaktifkan.

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Lepaskan dari jaringan Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil dilepaskan dari jaringan Thread.
OT_ERROR_INVALID_STATE
Thread dinonaktifkan.

otThreadDetachGracefully

otError otThreadDetachGracefully(
  otInstance *aInstance,
  otDetachGracefullyCallback aCallback,
  void *aContext
)

Memberi tahu node lain dalam jaringan (jika ada), lalu menghentikan operasi protokol Thread.

Aplikasi akan mengirimkan Address Release jika itu adalah router, atau menyetel waktu tunggu turunannya ke 0 jika itu adalah turunan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer ke fungsi yang dipanggil setelah menyelesaikan pelepasan.
[in] aContext
Pointer ke callback konteks khusus aplikasi.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mulai melepaskan.
OT_ERROR_BUSY
Pelepasan sedang berlangsung.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Konversi peran perangkat menjadi string yang dapat dibaca manusia.

Detail
Parameter
[in] aRole
Peran perangkat yang akan dikonversi.
Hasil
String yang mewakili aRole.

otThreadDiscover

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

Memulai pemindaian Thread Discovery.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aScanChannels
Vektor bit yang menunjukkan saluran yang akan dipindai (misalnya OT_CHANNEL_11_MASK).
[in] aPanId
Filter ID PAN (disetel ke PAN Siaran untuk menonaktifkan filter).
[in] aJoiner
Nilai Tanda Penyambung di TLV Permintaan Penemuan.
[in] aEnableEui64Filtering
TRUE untuk memfilter respons pada EUI-64, FALSE jika sebaliknya.
[in] aCallback
Pointer ke fungsi yang dipanggil saat menerima Respons Penemuan MLE atau pemindaian selesai.
[in] aCallbackContext
Pointer ke konteks khusus aplikasi.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil memulai Pemindaian Thread Discovery.
OT_ERROR_INVALID_STATE
Antarmuka IPv6 tidak diaktifkan (netif tidak aktif).
OT_ERROR_NO_BUFS
Tidak dapat mengalokasikan pesan untuk Permintaan Penemuan.
OT_ERROR_BUSY
Pemindaian Thread Discovery sedang berlangsung.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Mendapatkan Waktu Tunggu Turunan Thread (dalam detik) yang digunakan saat beroperasi dalam peran Turunan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Nilai Waktu Tunggu Turunan Thread dalam detik.
Lihat juga:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Mendapatkan peran perangkat.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
OT_DEVICE_ROLE_DISABLED
Stack Thread dinonaktifkan.
OT_DEVICE_ROLE_DETACHED
Perangkat saat ini tidak berpartisipasi dalam partisi/jaringan Thread.
OT_DEVICE_ROLE_CHILD
Perangkat saat ini beroperasi sebagai Thread Turunan.
OT_DEVICE_ROLE_ROUTER
Perangkat saat ini beroperasi sebagai Router Thread.
OT_DEVICE_ROLE_LEADER
Perangkat saat ini beroperasi sebagai Thread Leader.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Mendapatkan Nama Domain Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke Nama Domain Thread.
Lihat juga:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Mendapatkan ID PAN IEEE 802.15.4 Extended.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Sebuah pointer ke IEEE 802.15.4 Extended PAN ID.
Lihat juga:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Mendapatkan ID Antarmuka yang ditentukan secara manual untuk Alamat Unicast Domain Thread.

Tersedia jika OPENTHREAD_CONFIG_DUA_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke Interface Identifier yang ditetapkan secara manual, atau NULL jika tidak ada yang ditetapkan.
Lihat juga:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Mendapatkan penghitung IPv6.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Sebuah pointer ke penghitung IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Mendapatkan thrKeySequenceCounter.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Nilai thrKeySequenceCounter.
Lihat juga:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Mendapatkan thrKeySwitchGuardTime (dalam jam).

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Nilai thrKeySwitchGuardTime (dalam jam).
Lihat juga:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Mendapatkan Data Pemimpin Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aLeaderData
Pointer ke lokasi data posisi teratas.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengambil data posisi teratas.
OT_ERROR_DETACHED
Saat ini tidak terlampir.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Menampilkan pointer ke RLOC Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aLeaderRloc
Petunjuk ke RLOC Pemimpin.
Nilai Pengembalian
OT_ERROR_NONE
RLOC Pemimpin berhasil ditulis ke aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc adalah NULL.
OT_ERROR_DETACHED
Saat ini tidak terpasang ke Partisi Thread.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Dapatkan ID Router Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
ID Router Pemimpin.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Dapatkan Berat Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Berat Pemimpin.

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Mendapatkan alamat multicast Thread Link-Local All Thread Nodes.

Alamatnya adalah Link-local Unicast Prefix-Based Multicast Address [RFC 3306], dengan:

  • flgs diatur ke 3 (P = 1 dan T = 1)
  • scop disetel ke 2
  • plen disetel ke 64
  • awalan jaringan ditetapkan ke Awalan Lokal Mesh
  • ID grup ditetapkan ke 1

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke alamat multicast Thread Link-Local All Thread Node.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Mendapatkan alamat IPv6 link-lokal Thread.

Alamat lokal tautan Thread diperoleh menggunakan IEEE802.15.4 Extended Address sebagai Interface Identifier.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke alamat IPv6 link-lokal Thread.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Mendapatkan konfigurasi Mode Link MLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Konfigurasi Mode Link MLE.
Lihat juga:
otThreadSetLinkMode

otThreadGetMaxTimeInQueue

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

Mendapatkan waktu maksimum dalam antrean untuk pesan di antrean TX.

Memerlukan OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Waktu dalam antrean dilacak untuk transmisi langsung saja dan diukur sebagai durasi dari saat pesan ditambahkan ke antrean pengiriman sampai diteruskan ke lapisan MAC untuk transmisi atau dijatuhkan.

Statistik yang dikumpulkan dapat direset dengan memanggil otThreadResetTimeInQueueStat().

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Waktu dalam antrean maksimum dalam milidetik untuk semua pesan dalam antrean TX (sejauh ini).

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Mendapatkan alamat EID Lokal Mesh.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke alamat EID Lokal Mesh.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Menampilkan pointer ke Mesh Local Prefix.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke Mesh Local Prefix.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Mendapatkan penghitung MLE Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke penghitung MLE Thread.

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Mendapatkan Kunci Jaringan Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aNetworkKey
Pointer ke otNetworkKey untuk menampilkan Kunci Jaringan Thread.
Lihat juga:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Dapatkan otNetworkKeyRef untuk Kunci Jaringan Thread.

Memerlukan pengaktifan fitur waktu build OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Referensi ke Kunci Jaringan Thread yang disimpan di memori.
Lihat juga:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Mendapatkan Nama Jaringan Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke Nama Jaringan Thread.
Lihat juga:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

Mendapatkan TLV Diagnostik Jaringan berikutnya dalam pesan.

Memerlukan OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Panggilan berikutnya ke fungsi ini hanya diizinkan jika nilai yang ditampilkan saat ini adalah OT_ERROR_NONE.

Detail
Parameter
[in] aMessage
Pointer ke pesan.
[in,out] aIterator
Pointer ke konteks iterator Diagnostik Jaringan. Untuk mendapatkan TLV Diagnostik Jaringan pertama, TLV harus disetel ke OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Penunjuk ke lokasi informasi TLV Diagnostik Jaringan akan ditempatkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menemukan TLV Diagnostik Jaringan berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada TLV Diagnostik Jaringan berikutnya dalam pesan.
OT_ERROR_PARSE
Gagal menguraikan Diagnostik Jaringan berikutnya.

otThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

Mendapatkan informasi tetangga berikutnya.

Ini digunakan untuk menelusuri entri dari tabel tetangga.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Pointer ke konteks iterator. Untuk mendapatkan entri tetangga pertama, Anda harus disetel ke OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Pointer ke informasi tetangga.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menemukan entri tetangga berikutnya dalam tabel.
OT_ERROR_NOT_FOUND
Tidak ada entri tetangga berikutnya dalam tabel.
OT_ERROR_INVALID_ARGS
aIterator atau aInfo adalah NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

Fungsi ini mengambil RSSI rata-rata untuk Induk Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aParentRssi
Pointer ke tempat RSSI induk harus ditempatkan.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

Fungsi ini mengambil informasi diagnostik untuk Router Thread sebagai induk.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aParentInfo
Pointer ke lokasi informasi router induk ditempatkan.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

Fungsi ini mengambil RSSI paket terakhir dari Thread Parent.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aLastRssi
Pointer ke tempat RSSI terakhir harus ditempatkan.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengambil data RSSI.
OT_ERROR_FAILED
Tidak bisa mendapatkan data RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi adalah NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Dapatkan ID Partisi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
ID Partisi.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Mendapatkan alamat multicast Thread Realm-Local All Thread Node.

Alamatnya adalah Alamat Multicast Berbasis Awalan Unicast realm [RFC 3306], dengan:

  • flgs diatur ke 3 (P = 1 dan T = 1)
  • scop disetel ke 3
  • plen disetel ke 64
  • awalan jaringan ditetapkan ke Awalan Lokal Mesh
  • ID grup ditetapkan ke 1

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke alamat multicast Thread Realm-Local All Thread Node.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Mendapatkan alamat Thread Routing Locator (RLOC).

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke alamat Thread Routing Locator (RLOC).

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Dapatkan RLOC16.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
RLOC16.

otThreadGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

Mengambil ALOC Layanan untuk ID Layanan tertentu.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aServiceId
ID layanan untuk mendapatkan ALOC.
[out] aServiceAloc
Pointer untuk membuat output Service ALOC. TIDAK BOLEH NULL.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengambil ALOC Layanan.
OT_ERROR_DETACHED
Antarmuka Thread saat ini tidak terpasang ke Partisi Thread.

otThreadGetTimeInQueueHistogram

const uint32_t * otThreadGetTimeInQueueHistogram(
  otInstance *aInstance,
  uint16_t *aNumBins,
  uint32_t *aBinInterval
)

Mendapatkan histogram waktu dalam antrean untuk pesan di antrean TX.

Memerlukan OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Histogram waktu antrian pesan dalam antrean transmisi dikumpulkan. Waktu dalam antrean dilacak untuk transmisi langsung saja dan diukur sebagai durasi dari saat pesan ditambahkan ke antrean pengiriman sampai diteruskan ke lapisan MAC untuk transmisi atau dijatuhkan.

Histogram ditampilkan sebagai array nilai uint32_t dengan entri aNumBins. Entri pertama dalam array (pada indeks 0) mewakili jumlah pesan dengan waktu dalam antrean kurang dari aBinInterval. Entri kedua menunjukkan jumlah pesan dengan waktu antrean lebih besar dari atau sama dengan aBinInterval, tetapi kurang dari 2 * aBinInterval. Dan seterusnya. Entri terakhir mewakili jumlah pesan dengan waktu dalam antrean lebih besar dari atau sama dengan (aNumBins - 1) * aBinInterval.

Statistik yang dikumpulkan dapat direset dengan memanggil otThreadResetTimeInQueueStat(). Informasi histogram dikumpulkan sejak instance OpenThread diinisialisasi atau sejak terakhir kali pengumpulan statistik direset dengan memanggil otThreadResetTimeInQueueStat().

Pointer aNumBins dan aBinInterval TIDAK BOLEH NULL.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aNumBins
Pointer untuk menampilkan jumlah bin dalam histogram (panjang array).
[out] aBinInterval
Pointer untuk menampilkan panjang interval kotak histogram dalam milidetik.
Hasil
Pointer ke array entri aNumBins yang mewakili info histogram yang dikumpulkan.

otThreadGetVendorModel

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

Mendapatkan string model vendor.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
String model vendor.

otThreadGetVendorName

const char * otThreadGetVendorName(
  otInstance *aInstance
)

Mendapatkan string nama vendor.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
String nama vendor.

otThreadGetVendorSwVersion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

Mendapatkan string versi sw vendor.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
String versi sw vendor.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Mendapatkan versi protokol Thread.

Detail
Hasil
versi protokol Thread.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Menunjukkan apakah permintaan cari anycast sedang berlangsung.

Hanya tersedia jika OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
TRUE jika permintaan pencari {i>anycast<i} sedang berlangsung, FALSE jika tidak.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Menentukan apakah Penemuan Thread MLE saat ini sedang berlangsung.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Menunjukkan apakah node adalah satu-satunya router di jaringan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
TRUE
Ini adalah satu-satunya {i>router<i} di jaringan.
FALSE
Ini adalah turunan atau bukan merupakan {i>router<i} tunggal di jaringan.

otThreadLocateAnycastDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

Meminta lokasi tujuan terdekat dari alamat anycast tertentu.

Hanya tersedia jika OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE diaktifkan.

Jika permintaan sebelumnya sedang berlangsung, panggilan berikutnya ke fungsi ini akan membatalkan dan menggantikan permintaan sebelumnya.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aAnycastAddress
Alamat anycast yang akan ditemukan. TIDAK BOLEH NULL.
[in] aCallback
Fungsi callback untuk melaporkan hasil.
[in] aContext
Konteks arbitrer yang digunakan dengan aCallback.
Nilai Pengembalian
OT_ERROR_NONE
Permintaan berhasil dimulai. aCallback akan dipanggil untuk melaporkan hasil.
OT_ERROR_INVALID_ARGS
aAnycastAddress bukan alamat anycast yang valid atau aCallback adalah NULL.
OT_ERROR_NO_BUFS
Kehabisan buffer untuk menyiapkan dan mengirim pesan permintaan.

otThreadRegisterParentResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

Mendaftarkan callback untuk menerima data Respons Induk MLE.

Memerlukan OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer ke fungsi yang dipanggil setelah menerima pesan MLE Parent Response.
[in] aContext
Pointer untuk callback konteks khusus klien.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Mereset penghitung IPv6.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Mereset penghitung MLE Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otThreadResetTimeInQueueStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

Mereset statistik waktu dalam antrean TX.

Memerlukan OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otThreadSearchForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

Memulai proses bagi anak untuk menelusuri orang tua yang lebih baik sambil tetap terhubung dengan induknya saat ini.

Harus digunakan ketika perangkat dipasang sebagai anak.

Detail
Nilai Pengembalian
OT_ERROR_NONE
Berhasil memulai proses untuk mencari orang tua yang lebih baik.
OT_ERROR_INVALID_STATE
Peran perangkat bukan anak-anak.

otThreadSendAddressNotification

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

Mengirim pesan Notifikasi Alamat Proaktif (ADDR_NTF.ntf).

Hanya tersedia jika OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDestination
Tujuan untuk mengirim pesan ADDR_NTF.ntf.
[in] aTarget
Alamat target pesan ADDR_NTF.ntf.
[in] aMlIid
ML-IID dari pesan ADDR_NTF.ntf.

otThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

Kirim permintaan Get Diagnostik Jaringan.

Memerlukan OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDestination
Pointer ke alamat tujuan.
[in] aTlvTypes
Array jenis TLV Diagnostik Jaringan.
[in] aCount
Jumlah jenis di aTlvTypes.
[in] aCallback
Pointer ke fungsi yang dipanggil saat respons Network Diagnostic Get diterima atau NULL untuk menonaktifkan callback.
[in] aCallbackContext
Pointer ke konteks khusus aplikasi.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengantrekan DIAG_GET.req.
OT_ERROR_NO_BUFS
Buffering pesan yang tersedia tidak memadai untuk mengirim DIAG_GET.req.

otThreadSendDiagnosticReset

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

Kirim permintaan Reset Diagnostik Jaringan.

Memerlukan OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDestination
Pointer ke alamat tujuan.
[in] aTlvTypes
Array jenis TLV Diagnostik Jaringan. Saat ini hanya Tipe 9 yang diizinkan.
[in] aCount
Jumlah jenis di aTlvTypes
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengantrekan DIAG_RST.ntf.
OT_ERROR_NO_BUFS
Buffering pesan yang tersedia tidak mencukupi untuk mengirim DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

Mengirim pesan Proaktif Backbone Notification (PRO_BB.ntf) di link Backbone.

Hanya tersedia jika OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aTarget
Alamat target pesan PRO_BB.ntf.
[in] aMlIid
ML-IID pesan PRO_BB.ntf.
[in] aTimeSinceLastTransaction
Waktu sejak transaksi terakhir (dalam detik).
Nilai Pengembalian
OT_ERROR_NONE
Berhasil mengirim PRO_BB.ntf di link backbone.
OT_ERROR_NO_BUFS
Jika buffer pesan yang tersedia tidak memadai.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Menetapkan Thread Child Timeout (dalam detik) yang digunakan saat beroperasi dalam peran Turunan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aTimeout
Nilai waktu tunggu dalam detik.
Lihat juga:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

Menetapkan callback untuk menerima data Permintaan Penemuan MLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer ke fungsi yang dipanggil setelah menerima pesan Permintaan Penemuan MLE.
[in] aContext
Pointer ke callback konteks khusus aplikasi.

otThreadSetDomainName

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

Menetapkan Nama Domain Thread.

Hanya berhasil jika protokol Thread dinonaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDomainName
Pointer ke Nama Domain Thread.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan Nama Domain Thread.
OT_ERROR_INVALID_STATE
Protokol thread diaktifkan.
Lihat juga:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Memulai operasi protokol Thread.

Antarmuka harus aktif saat memanggil fungsi ini.

Memanggil fungsi ini dengan aEnabled yang disetel ke FALSE akan menghentikan semua proses pelepasan yang sedang berlangsung, yang dimulai oleh otThreadDetachGracefully(). Callback-nya akan dipanggil.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEnabled
TRUE jika Thread diaktifkan, FALSE jika tidak.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil memulai operasi protokol Thread.
OT_ERROR_INVALID_STATE
Antarmuka jaringan tidak menyala.

otThreadSetExtendedPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

Mengatur IEEE 802.15.4 Extended PAN ID.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aExtendedPanId
Sebuah pointer ke IEEE 802.15.4 Extended PAN ID.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan ID PAN yang Diperluas.
OT_ERROR_INVALID_STATE
Protokol thread diaktifkan.
Lihat juga:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Menetapkan atau menghapus ID Antarmuka yang ditentukan secara manual untuk Alamat Unicast Domain Thread.

Tersedia jika OPENTHREAD_CONFIG_DUA_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aIid
Pointer ke ID Antarmuka yang akan ditetapkan atau NULL untuk menghapus.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan/menghapus ID Antarmuka.
OT_ERROR_INVALID_ARGS
ID Antarmuka yang ditentukan sudah dicadangkan.
Lihat juga:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

Menyetel Iklan Penyambung Thread saat menemukan jaringan Thread.

Iklan Penyambung Thread digunakan untuk mengizinkan Penyambung mengiklankan informasi khusus aplikasinya sendiri (seperti ID Vendor, ID Produk, Diskriminator, dll.) melalui TLV Iklan Penyambung yang baru diusulkan, dan untuk membuat informasi ini tersedia bagi Komisaris atau Kandidat Komisaris tanpa interaksi manusia.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aOui
Nilai OUI IEEE Vendor yang akan disertakan dalam Iklan Penggabung. Hanya byte yang paling tidak signifikan yang akan digunakan, dan byte yang paling signifikan akan diabaikan.
[in] aAdvData
Pointer ke AdvData yang akan disertakan dalam Joiner Advertisingment.
[in] aAdvDataLength
Panjang AdvData dalam byte.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan Iklan Penggabung.
OT_ERROR_INVALID_ARGS
AdvData tidak valid.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Menetapkan thrKeySequenceCounter.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aKeySequenceCounter
Nilai thrKeySequenceCounter.
Lihat juga:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Menetapkan thrKeySwitchGuardTime (dalam jam).

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aKeySwitchGuardTime
Nilai thrKeySwitchGuardTime (dalam jam).
Lihat juga:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Tetapkan konfigurasi Mode Link MLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aConfig
Pointer ke konfigurasi Mode Link.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menyetel konfigurasi Mode Link MLE.
Lihat juga:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

Menetapkan Awalan Lokal Mesh.

Hanya berhasil jika protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini akan membuat Set Data Operasional Aktif dan Tertunda dalam memori non-volatil.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aMeshLocalPrefix
Pointer ke Mesh Local Prefix.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan Awalan Lokal Mesh.
OT_ERROR_INVALID_STATE
Protokol thread diaktifkan.

otThreadSetNetworkKey

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

Setel Kunci Jaringan Thread.

Hanya berhasil jika protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini akan membuat Set Data Operasional Aktif dan Tertunda dalam memori non-volatil.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aKey
Pointer ke buffer yang berisi Kunci Jaringan Thread.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan Kunci Jaringan Thread.
OT_ERROR_INVALID_STATE
Protokol thread diaktifkan.
Lihat juga:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Tetapkan Kunci Jaringan Thread sebagai otNetworkKeyRef.

Hanya berhasil jika protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini akan membuat Set Data Operasional Aktif dan Tertunda dalam memori non-volatil.

Memerlukan pengaktifan fitur waktu build OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aKeyRef
Referensi ke Kunci Jaringan Thread.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan Kunci Jaringan Thread.
OT_ERROR_INVALID_STATE
Protokol thread diaktifkan.
Lihat juga:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

Tetapkan Nama Jaringan Thread.

Hanya berhasil jika protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini akan membuat Set Data Operasional Aktif dan Tertunda dalam memori non-volatil.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aNetworkName
Pointer ke Nama Jaringan Thread.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan Nama Jaringan Thread.
OT_ERROR_INVALID_STATE
Protokol thread diaktifkan.
Lihat juga:
otThreadGetNetworkName

otThreadSetVendorModel

otError otThreadSetVendorModel(
  otInstance *aInstance,
  const char *aVendorModel
)

Tetapkan string model vendor.

Memerlukan OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorModel harus berupa UTF8 dengan panjang maksimal 32 karakter (MAX_VENDOR_MODEL_TLV_LENGTH). Panjang maksimum tidak mencakup karakter \0 null.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aVendorModel
String model vendor.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan model vendor.
OT_ERROR_INVALID_ARGS
aVendorModel tidak valid (terlalu panjang atau bukan UTF8).

otThreadSetVendorName

otError otThreadSetVendorName(
  otInstance *aInstance,
  const char *aVendorName
)

Tetapkan string nama vendor.

Memerlukan OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorName harus berupa UTF8 dengan panjang maksimal 32 karakter (MAX_VENDOR_NAME_TLV_LENGTH). Panjang maksimum tidak mencakup karakter \0 null.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aVendorName
String nama vendor.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan nama vendor.
OT_ERROR_INVALID_ARGS
aVendorName tidak valid (terlalu panjang atau bukan UTF8).

otThreadSetVendorSwVersion

otError otThreadSetVendorSwVersion(
  otInstance *aInstance,
  const char *aVendorSwVersion
)

Menetapkan string versi software vendor.

Memerlukan OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE.

aVendorSwVersion harus berupa UTF8 dengan panjang maksimum 16 karakter(MAX_VENDOR_SW_VERSION_TLV_LENGTH). Panjang maksimum tidak mencakup karakter \0 null.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aVendorSwVersion
String versi software vendor.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan versi software vendor.
OT_ERROR_INVALID_ARGS
aVendorSwVersion tidak valid (terlalu panjang atau bukan UTF8).

Makro

OT_DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

Ukuran yang direkomendasikan untuk representasi string dengan durasi uint32_t dalam detik.

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Panjang Maksimum AdvData dari Iklan Penyambung.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Melakukan inisialisasi untuk otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Panjang nilai maksimum TLV Dasar Thread.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Nilai untuk menginisialisasi otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Ukuran entri Tabel Anak Diagnostik Jaringan.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Inisialisasi untuk otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

Panjang maksimum TLV Versi Stack Thread.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

Panjang maksimum Model Vendor TLV.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

Panjang maksimum TLV Nama Vendor.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

Panjang maksimum TLV Versi SW Vendor.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Jumlah Maksimum Jenis TLV Diagnostik Jaringan yang akan Diminta atau Direset.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

ID Router Maksimum.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Ukuran maksimum Data Server dalam byte. Batas teoretis, hampir jauh lebih rendah.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Ukuran maksimum Data Layanan dalam 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.