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

Umum

Modul ini mencakup fungsi untuk semua peran Thread.

Ringkasan

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

Semua fungsi dalam modul ini mengharuskan OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE 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
} 		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
Mewakili peran perangkat Thread.
otNetDataPublisherEvent{
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
  OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
} 		enum
Enumerasi ini 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
Struktur ini mewakili konfigurasi Border Router.
otDetachGracefullyCallback)(void *aContext) typedef
void(*
Callback ini akan memberi tahu aplikasi bahwa proses pelepasan telah selesai.
otExternalRouteConfig typedef
Struktur ini mewakili konfigurasi Rute Eksternal.
otIpCounters typedef
struct otIpCounters
Struktur ini mewakili penghitung tingkat IP.
otLeaderData typedef
struct otLeaderData
Struktur ini mewakili Data Pemimpin Thread.
otLinkModeConfig typedef
Struktur ini mewakili konfigurasi Mode Link MLE.
otMleCounters typedef
struct otMleCounters
Struktur ini mewakili penghitung Thread MLE.
otNeighborInfoIterator typedef
int16_t
Digunakan untuk melakukan iterasi melalui tabel tetangga.
otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Jenis pointer fungsi ini 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 fungsi ini menentukan callback yang digunakan untuk memberi tahu ketika awalan (rute mesh atau eksternal) ditambahkan ke atau dihapus dari Data Jaringan Thread.
otNetDataPublisherEvent typedef
Enumerasi ini mewakili peristiwa yang dilaporkan dari callback Penayang.
otNetworkDataIterator typedef
uint32_t
Digunakan untuk melakukan iterasi melalui informasi Data Jaringan.
otNetworkDiagChildEntry typedef
Struktur ini mewakili Entri Tabel Turunan Diagnostik Jaringan.
otNetworkDiagConnectivity typedef
Struktur ini mewakili nilai Konektivitas Diagnostik Jaringan.
otNetworkDiagIterator typedef
uint16_t
Digunakan untuk melakukan iterasi melalui TLV Diagnostik Jaringan.
otNetworkDiagMacCounters typedef
Struktur ini mewakili nilai Penghitung Mac Diagnostik Jaringan.
otNetworkDiagRoute typedef
Struktur ini mewakili nilai TLV Rute Diagnostik Jaringan.
otNetworkDiagRouteData typedef
Struktur ini mewakili data Rute Diagnostik Jaringan.
otNetworkDiagTlv typedef
Struktur ini mewakili TLV Diagnostik Jaringan.
otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
Pointer fungsi ini dipanggil saat respons Diagnostik Jaringan diterima.
otRoutePreference typedef
Menentukan nilai yang valid untuk mPreference di otExternalRouteConfig dan otBorderRouterConfig.
otServerConfig typedef
Struktur ini mewakili konfigurasi Server.
otServiceConfig typedef
Struktur ini mewakili konfigurasi Layanan.
otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
Jenis pointer fungsi ini menentukan callback untuk memberi tahu hasil permintaan otThreadLocateAnycastDestination().
otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Pointer fungsi ini dipanggil setiap kali pesan Permintaan Penemuan MLE diterima.
otThreadDiscoveryRequestInfo typedef
Struktur ini mewakili data Permintaan Penemuan Thread.
otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Pointer fungsi ini dipanggil setiap kali pesan Respons Orang Tua MLE diterima.
otThreadParentResponseInfo typedef
Struktur ini mewakili data Respons Orang Tua MLE.

Functions
otNetDataContainsOmrPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Fungsi ini memeriksa apakah Awalan tertentu dapat bertindak sebagai awalan OMR yang valid dan juga Data Jaringan Pemimpin berisi awalan ini.
otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Metode ini memberikan salinan lengkap atau stabil dari Data Jaringan Thread Partisi.
otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Fungsi ini mendapatkan Awalan On Mesh berikutnya di Data Jaringan partisi.
otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Fungsi ini mendapatkan rute eksternal berikutnya dalam Data Jaringan partisi.
otNetDataGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Fungsi ini 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
Fungsi ini menunjukkan apakah entri "DNS/SRP Service" saat ini ditambahkan ke Data Jaringan Thread.
otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Fungsi ini menunjukkan apakah entri awalan yang dipublikasikan (rute mesh atau eksternal) saat ini ditambahkan ke Data Jaringan Thread.
otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)
void
Fungsi ini meminta "DNS/SRP Service Anycast Address" untuk dipublikasikan dalam Data Jaringan Thread.
otNetDataPublishDnsSrpServiceUnicast(otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Fungsi ini meminta "DNS/SRP Service Unicast Address" untuk dipublikasikan dalam Data Jaringan Thread.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)
void
Fungsi ini meminta "DNS/SRP Service Unicast Address" untuk dipublikasikan dalam Data Jaringan Thread.
otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Fungsi ini meminta awalan rute eksternal untuk dipublikasikan dalam Data Jaringan Thread.
otNetDataPublishOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Fungsi ini meminta awalan mesh untuk dipublikasikan di Data Jaringan Thread.
otNetDataSetDnsSrpServicePublisherCallback(otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Fungsi ini menetapkan callback untuk memberi tahu kapan "DNS/SRP Service&quot yang dipublikasikan; benar-benar ditambahkan ke atau dihapus dari Data Jaringan Thread.
otNetDataSetPrefixPublisherCallback(otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Fungsi ini menetapkan callback untuk memberi tahu ketika entri awalan yang dipublikasikan benar-benar ditambahkan ke atau dihapus dari Data Jaringan Thread.
otNetDataSteeringDataCheckJoiner(otInstance *aInstance, const otExtAddress *aEui64)
Periksa apakah data kemudi menyertakan Joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Periksa apakah data kemudi menyertakan Joiner dengan nilai berbeda yang ditentukan.
otNetDataUnpublishDnsSrpService(otInstance *aInstance)
void
Membatalkan publikasi semua entri Layanan DNS/SRP (Anycast atau Unicast) yang sebelumnya ditambahkan dari Data Jaringan Thread.
otNetDataUnpublishPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Membatalkan publikasi Awalan On-Mesh atau Rute Eksternal yang dipublikasikan sebelumnya.
otThreadBecomeChild(otInstance *aInstance)
Upayakan untuk melampirkan kembali sebagai anak.
otThreadBecomeDetached(otInstance *aInstance)
Melepaskan dari jaringan Thread.
otThreadDetachGracefully(otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Fungsi ini memberi tahu node lain dalam jaringan (jika ada), lalu menghentikan operasi protokol Thread.
otThreadDeviceRoleToString(otDeviceRole aRole)
const char *
Ubah 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)
Fungsi ini memulai pemindaian Thread Discovery.
otThreadGetChildTimeout(otInstance *aInstance)
uint32_t
Mendapatkan Thread Child Timeout yang digunakan saat menjalankan dalam peran Turunan.
otThreadGetDeviceRole(otInstance *aInstance)
Mendapatkan peran perangkat.
otThreadGetDomainName(otInstance *aInstance)
const char *
Mendapatkan Nama Domain Thread.
otThreadGetExtendedPanId(otInstance *aInstance)
const otExtendedPanId *
Dapatkan 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.
otThreadGetLeaderData(otInstance *aInstance, otLeaderData *aLeaderData)
Fungsi ini mendapatkan Data Thread Thread.
otThreadGetLeaderRloc(otInstance *aInstance, otIp6Address *aLeaderRloc)
Fungsi ini menampilkan pointer ke RLOC Leader.
otThreadGetLeaderRouterId(otInstance *aInstance)
uint8_t
Dapatkan ID Router Leader.
otThreadGetLeaderWeight(otInstance *aInstance)
uint8_t
Dapatkan Berat Pemimpin.
otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Fungsi ini menampilkan alamat multicast Node Thread Link-Local All Thread.
otThreadGetLinkLocalIp6Address(otInstance *aInstance)
const otIp6Address *
Fungsi ini menampilkan alamat IPv6 lokal link-thread.
otThreadGetLinkMode(otInstance *aInstance)
Dapatkan konfigurasi Mode Link MLE.
otThreadGetMeshLocalEid(otInstance *aInstance)
const otIp6Address *
Fungsi ini menampilkan pointer ke alamat EID Lokal Mesh.
otThreadGetMeshLocalPrefix(otInstance *aInstance)
Fungsi ini menampilkan pointer ke Awalan Lokal Mesh.
otThreadGetMleCounters(otInstance *aInstance)
const otMleCounters *
Mendapatkan penghitung Thread MLE.
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)
Fungsi ini mendapatkan TLV Diagnostik Jaringan berikutnya dalam pesan.
otThreadGetNextNeighborInfo(otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Fungsi ini mendapatkan informasi tetangga berikutnya.
otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
Fungsi ini mengambil RSSI rata-rata untuk Thread Parent.
otThreadGetParentInfo(otInstance *aInstance, otRouterInfo *aParentInfo)
Fungsi ini mengambil informasi diagnostik untuk Thread Router sebagai induk.
otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi)
Fungsi ini mengambil RSSI paket terakhir dari Thread Parent.
otThreadGetPartitionId(otInstance *aInstance)
uint32_t
Mendapatkan ID Partisi.
otThreadGetRealmLocalAllThreadNodesMulticastAddress(otInstance *aInstance)
const otIp6Address *
Fungsi ini menampilkan alamat multicast Node Thread Realm-Local Node.
otThreadGetRloc(otInstance *aInstance)
const otIp6Address *
Fungsi ini menampilkan pointer ke alamat Thread Routing Locator (RLOC).
otThreadGetRloc16(otInstance *aInstance)
uint16_t
Dapatkan RLOC16.
otThreadGetServiceAloc(otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Fungsi ini mengambil ALOC Layanan untuk ID Layanan tertentu.
otThreadGetVersion(void)
uint16_t
Fungsi ini mendapatkan versi protokol Thread.
otThreadIsAnycastLocateInProgress(otInstance *aInstance)
bool
Fungsi ini menunjukkan apakah permintaan lokasi anycast sedang berlangsung.
otThreadIsDiscoverInProgress(otInstance *aInstance)
bool
Fungsi ini menentukan apakah Penemuan Thread MLE sedang berlangsung.
otThreadIsSingleton(otInstance *aInstance)
bool
Fungsi ini menunjukkan apakah node adalah satu-satunya router di jaringan.
otThreadLocateAnycastDestination(otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Fungsi ini meminta tujuan terdekat dari alamat anycast tertentu.
otThreadRegisterParentResponseCallback(otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Fungsi ini mendaftarkan callback untuk menerima data Respons Orang Tua MLE.
otThreadResetIp6Counters(otInstance *aInstance)
void
Mereset penghitung IPv6.
otThreadResetMleCounters(otInstance *aInstance)
void
Mereset penghitung MLE Thread.
otThreadSendAddressNotification(otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Fungsi ini mengirimkan pesan Notifikasi Proaktif Alamat (SharedPreference_NTF.ntf).
otThreadSendDiagnosticGet(otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Mengirim permintaan Dapatkan 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)
Fungsi ini mengirim pesan Proaktif Backbone Notification (PRO_BB.ntf) pada link Backbone.
otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)
void
Menyetel Waktu Tunggu Turunan Rangkaian Pesan yang digunakan saat beroperasi dalam peran Turunan.
otThreadSetDiscoveryRequestCallback(otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Fungsi ini menetapkan callback untuk menerima data Permintaan Penemuan MLE.
otThreadSetDomainName(otInstance *aInstance, const char *aDomainName)
Tetapkan Nama Domain Thread.
otThreadSetEnabled(otInstance *aInstance, bool aEnabled)
Fungsi ini memulai operasi protokol Thread.
otThreadSetExtendedPanId(otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Setel ID PAN IEEE 802.15.4 Extended.
otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Menetapkan/Menghapus ID Antarmuka yang ditentukan secara manual untuk Alamat Unicast Thread Domain.
otThreadSetJoinerAdvertisement(otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Metode ini menetapkan Iklan Gabungan Thread saat menemukan jaringan Thread.
otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Menetapkan thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Setel thrKeySwitchGuardTime.
otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)
Setel konfigurasi Mode Link MLE.
otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Fungsi ini menetapkan Awalan Lokal Mesh.
otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey)
Tetapkan Kunci Jaringan Thread.
otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
Tetapkan Kunci Jaringan Thread sebagai otNetworkKeyRef.
otThreadSetNetworkName(otInstance *aInstance, const char *aNetworkName)
Tetapkan Nama Jaringan Thread.

Struct
otBorderRouterConfig

Struktur ini mewakili konfigurasi Border Router.

otExternalRouteConfig

Struktur ini mewakili konfigurasi Rute Eksternal.

otIpCounter

Struktur ini mewakili penghitung tingkat IP.

otLeaderData

Struktur ini mewakili Data Pemimpin Thread.

otLinkModeConfig

Struktur ini mewakili konfigurasi Mode Link MLE.

otMleCounter

Struktur ini mewakili penghitung Thread MLE.

otNeighborInfo

Struktur ini menyimpan informasi diagnostik untuk node Thread yang berdekatan.

otNetworkDiagChildEntry

Struktur ini mewakili Entri Tabel Turunan Diagnostik Jaringan.

otNetworkDiagConnectivity

Struktur ini mewakili nilai Konektivitas Diagnostik Jaringan.

otNetworkDiagMacCounters

Struktur ini mewakili nilai Penghitung Mac Diagnostik Jaringan.

otNetworkDiagRoute

Struktur ini mewakili nilai TLV Rute Diagnostik Jaringan.

otNetworkDiagRouteData

Struktur ini mewakili data Rute Diagnostik Jaringan.

otNetworkDiagTlv

Struktur ini mewakili TLV Diagnostik Jaringan.

otRouterInfo

Struktur ini menyimpan informasi diagnostik untuk Thread Router.

otServerConfig

Struktur ini mewakili konfigurasi Server.

otServiceConfig

Struktur ini mewakili konfigurasi Layanan.

otThreadDiscoveryRequestInfo

Struktur ini mewakili data Permintaan Penemuan Thread.

otThreadParentResponseInfo

Struktur ini mewakili data Respons Orang Tua MLE.

Enumerasi

enum anonim

 anonymous enum
Properti
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Tingkat Baterai TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV Halaman Channel.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

Tabel Turunan TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

TLV Konektivitas.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV Alamat yang Diperluas MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

Daftar Alamat IPv6 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

Data TLV Pemimpin.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

MAC Penghitung TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV Waktu Tunggu Turunan Maks.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Mode TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV Data Jaringan.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

TLV Route64.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

TLV Alamat16.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Tegangan Pasokan TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Waktu tunggu TLV (jangka waktu polling maksimum untuk SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Ketik TLV Daftar.

otDeviceRole

 otDeviceRole

Mewakili peran perangkat Thread.

Properti
OT_DEVICE_ROLE_CHILD

Peran Thread Child.

OT_DEVICE_ROLE_DETACHED

Saat ini tidak berpartisipasi dalam jaringan/partisi Thread.

OT_DEVICE_ROLE_DISABLED

Stack Thread dinonaktifkan.

OT_DEVICE_ROLE_LEADER

Peran Thread Leader.

OT_DEVICE_ROLE_ROUTER

Peran Thread Router.

otNetDataPublisherEvent

 otNetDataPublisherEvent

Enumerasi ini mewakili peristiwa yang dilaporkan dari callback Penayang.

Properti
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

Entri yang dipublikasikan ditambahkan ke Data Jaringan Thread.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

Entri yang dipublikasikan 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

Struktur ini mewakili konfigurasi Border Router.

otDetachGraceFullCallback

void(* otDetachGracefullyCallback)(void *aContext)

Callback ini akan memberi tahu aplikasi bahwa proses pelepasan telah selesai.

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

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Struktur ini mewakili konfigurasi Rute Eksternal.

OTIpCounter

struct otIpCounters otIpCounters

Struktur ini mewakili penghitung tingkat IP.

otLeaderData

struct otLeaderData otLeaderData

Struktur ini mewakili Data Pemimpin Thread.

OtLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Struktur ini mewakili konfigurasi Mode Link MLE.

OTMleCounter

struct otMleCounters otMleCounters

Struktur ini mewakili penghitung Thread MLE.

otInfoInfoIterator

int16_t otNeighborInfoIterator

Digunakan untuk melakukan iterasi melalui tabel tetangga.

otNetDataDnsSrpServicePublisherCallback

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

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

Jika dihapus, callback akan dipanggil secara independen terlepas dari apakah entri dihapus oleh Publisher (misalnya, jika terlalu banyak entri serupa yang sudah ada 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 untuk konteks khusus aplikasi.

otNetDataPrefixPublisherCallback

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

Jenis pointer fungsi ini menentukan callback yang digunakan untuk memberi tahu ketika awalan (rute mesh atau eksternal) ditambahkan ke atau dihapus dari Data Jaringan Thread.

Jika dihapus, callback akan dipanggil secara independen terlepas dari apakah entri dihapus oleh Publisher (misalnya, jika ada terlalu banyak entri serupa yang 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 untuk konteks khusus aplikasi.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Enumerasi ini mewakili peristiwa yang dilaporkan dari callback Penayang.

otNetworkDataIterator

uint32_t otNetworkDataIterator

Digunakan untuk melakukan iterasi melalui informasi Data Jaringan.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Struktur ini mewakili Entri Tabel Turunan Diagnostik Jaringan.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Struktur ini mewakili nilai Konektivitas Diagnostik Jaringan.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

Digunakan untuk melakukan iterasi melalui TLV Diagnostik Jaringan.

otNetworkDiagMacCounter

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Struktur ini mewakili nilai Penghitung Mac Diagnostik Jaringan.

Lihat RFC 2863 untuk definisi kolom anggota.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Struktur ini mewakili nilai TLV Rute Diagnostik Jaringan.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Struktur ini mewakili data Rute Diagnostik Jaringan.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Struktur ini mewakili TLV Diagnostik Jaringan.

otReceiveDiagnosticGetCallback

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

Pointer fungsi ini dipanggil saat respons Diagnostik Jaringan diterima.

Detail
Parameter
[in] aError
Error saat gagal mendapatkan respons.
[in] aMessage
Pointer ke buffer pesan yang berisi payload respons Get Diagnostik Jaringan 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 untuk konteks khusus aplikasi.

otRoutePreference

enum otRoutePreference otRoutePreference

Menentukan nilai yang valid untuk mPreference di otExternalRouteConfig dan otBorderRouterConfig.

otServerConfig

struct otServerConfig otServerConfig

Struktur ini mewakili konfigurasi Server.

otServiceConfig

struct otServiceConfig otServiceConfig

Struktur ini mewakili konfigurasi Layanan.

OTThreadAnycastLocatorCallback

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

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

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

otThreadDiscoveryRequestCallback

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

Pointer fungsi ini dipanggil setiap kali pesan Permintaan Penemuan MLE diterima.

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

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Struktur ini mewakili data Permintaan Penemuan Thread.

otThreadParentResponseCallback

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

Pointer fungsi ini dipanggil setiap kali pesan Respons Orang Tua MLE diterima.

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

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Struktur ini mewakili data Respons Orang Tua MLE.

Functions

otNetDataContainsOmrPrefix

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

Fungsi ini memeriksa apakah Awalan tertentu dapat bertindak sebagai awalan OMR yang valid dan juga Data Jaringan Pemimpin berisi awalan ini.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPrefix
Pointer ke awalan IPv6.
Hasil
Apakah aPrefix adalah 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
)

Metode ini memberikan salinan lengkap atau stabil dari 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
Pada entri, ukuran buffer data diarahkan dengan aData. Saat keluar, jumlah byte yang disalin.

otNetDataGetNextOnMeshPrefix

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

Fungsi ini mendapatkan 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 mesh pertama, tetapkan ke OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointer ke tempat informasi Awalan On Mesh akan ditempatkan.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menemukan awalan On Mesh berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada awalan On Mesh berikutnya di Data Jaringan Thread.

otNetDataGetNextRoute

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

Fungsi ini mendapatkan rute eksternal berikutnya dalam 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, rute harus ditetapkan ke OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointer tempat informasi Rute Eksternal akan ditempatkan.
Nilai yang Ditampilkan
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
)

Fungsi ini 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, nilai harus ditetapkan ke OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointer tempat informasi layanan akan ditempatkan.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menemukan layanan berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada layanan selanjutnya di 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.

otNetDataIsDnsSrpServiceDitambahkan

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Fungsi ini menunjukkan apakah entri "DNS/SRP Service" saat ini ditambahkan ke Data Jaringan Thread.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE diaktifkan.

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

otNetDataIsPrefixAdded

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

Fungsi ini menunjukkan apakah entri awalan yang dipublikasikan (rute mesh atau eksternal) saat ini ditambahkan ke Data Jaringan Thread.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPrefix
Pointer ke awalan (HARUS TIDAK berupa NULL).
Nilai yang Ditampilkan
TRUE
Entri awalan yang dipublikasikan 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
)

Fungsi ini meminta "DNS/SRP Service Anycast Address" untuk dipublikasikan dalam Data Jaringan Thread.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE diaktifkan.

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

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

otNetDataPublishDnsSrpServiceUnicast

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

Fungsi ini meminta "DNS/SRP Service Unicast Address" untuk dipublikasikan dalam Data Jaringan Thread.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE diaktifkan.

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

Fungsi ini menerbitkan "DNS/SRP Service Unicast Address" dengan menyertakan alamat dan info port dalam data TLV Layanan.

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

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Fungsi ini meminta "DNS/SRP Service Unicast Address" untuk dipublikasikan dalam Data Jaringan Thread.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE diaktifkan.

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

Tidak seperti otNetDataPublishDnsSrpServiceUnicast() yang memerlukan pemberian alamat yang dipublikasikan dan menyertakan info dalam data TLV Layanan, fungsi ini menggunakan EID mesh-lokal 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
)

Fungsi ini meminta awalan rute eksternal untuk dipublikasikan dalam Data Jaringan Thread.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE diaktifkan.

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

Panggilan berikutnya ke metode ini akan menggantikan permintaan sebelumnya untuk awalan yang sama. Khususnya, jika panggilan baru hanya mengubah tanda (mis., tingkat preferensi) dan awalan sudah ditambahkan di Data Jaringan, perubahan pada tanda akan langsung ditampilkan di Data Jaringan. Ini memastikan entri yang ada dalam Data Jaringan tidak dihapus secara tiba-tiba. Perlu diketahui bahwa perubahan tingkat preferensi dapat berpotensi menyebabkan entri dihapus dari Data Jaringan setelah menentukan terdapat 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 yang Ditampilkan
OT_ERROR_NONE
Rute eksternal berhasil dipublikasikan.
OT_ERROR_INVALID_ARGS
aConfig tidak valid (awalan buruk, kombinasi tanda tidak valid, atau tidak stabil).
OT_ERROR_NO_BUFS
Tidak dapat mengalokasikan entri untuk permintaan baru. Penayang mendukung jumlah entri terbatas (dibagikan 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
)

Fungsi ini meminta awalan mesh untuk dipublikasikan di Data Jaringan Thread.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE diaktifkan.

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

Panggilan berikutnya ke metode ini akan menggantikan permintaan sebelumnya untuk awalan yang sama. Khususnya, jika panggilan baru hanya mengubah tanda (mis., tingkat preferensi) dan awalan sudah ditambahkan di Data Jaringan, perubahan pada tanda akan langsung ditampilkan di Data Jaringan. Ini memastikan entri yang ada dalam Data Jaringan tidak dihapus secara tiba-tiba. Perlu diketahui bahwa perubahan tingkat preferensi dapat berpotensi menyebabkan entri dihapus dari Data Jaringan setelah menentukan terdapat 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 untuk dipublikasikan (HARUS TIDAK berupa NULL).
Nilai yang Ditampilkan
OT_ERROR_NONE
Awalan mesh pada berhasil dipublikasikan.
OT_ERROR_INVALID_ARGS
aConfig tidak valid (awalan buruk, kombinasi tanda tidak valid, atau tidak stabil).
OT_ERROR_NO_BUFS
Tidak dapat mengalokasikan entri untuk permintaan baru. Penayang mendukung jumlah entri terbatas (dibagikan antara awalan on-mesh dan rute eksternal) yang ditentukan oleh konfigurasi OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES.

otNetDataSetDnsSrpServicePublisherCallback

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

Fungsi ini menetapkan callback untuk memberi tahu kapan "DNS/SRP Service&quot yang dipublikasikan; benar-benar ditambahkan ke atau dihapus dari Data Jaringan Thread.

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

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE diaktifkan.

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

otNetDataSetPrefixPublisherCallback

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

Fungsi ini menetapkan callback untuk memberi tahu ketika 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.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer fungsi callback (dapat menjadi 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 kemudi menyertakan Joiner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEui64
Pointer ke IEEE EUI-64 milik Joiner.
Nilai yang Ditampilkan
OT_ERROR_NONE
aEui64 disertakan dalam data kemudi.
OT_ERROR_INVALID_STATE
Tidak ada data kemudi.
OT_ERROR_NOT_FOUND
aEui64 tidak disertakan dalam data berkendara.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

Periksa apakah data kemudi menyertakan Joiner dengan nilai berbeda yang ditentukan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDiscerner
Pointer ke Joiner Discerner.
Nilai yang Ditampilkan
OT_ERROR_NONE
aDiscerner disertakan dalam data kemudi.
OT_ERROR_INVALID_STATE
Tidak ada data kemudi.
OT_ERROR_NOT_FOUND
aDiscerner tidak disertakan dalam data berkendara.

otNetDataUnregisterDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

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

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE harus diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otNetDataUnregisterPrefix

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

Membatalkan publikasi Awalan On-Mesh atau Rute Eksternal 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 berupa NULL).
Nilai yang Ditampilkan
OT_ERROR_NONE
Awalan berhasil dibatalkan publikasinya.
OT_ERROR_NOT_FOUND
Tidak dapat menemukan awalan di daftar yang dipublikasikan.

OTThreadMenjadi Turunan

otError otThreadBecomeChild(
  otInstance *aInstance
)

Upayakan untuk melampirkan kembali sebagai anak.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mulai mencoba menjadi anak.
OT_ERROR_INVALID_STATE
Rangkaian pesan dinonaktifkan.

OTThreadMenjadi Dilepas

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Melepaskan dari jaringan Thread.

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

OTThreadDetachGracely

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

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

Ini mengirimkan Rilis Alamat jika itu router, atau mengatur waktu tunggu turunannya ke 0 jika itu adalah anak.

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

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Ubah peran perangkat menjadi string yang dapat dibaca manusia.

Detail
Parameter
[in] aRole
Peran perangkat untuk berkonversi.
Hasil
String yang mewakili aRole.

ThreadThreadDiscover

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

Fungsi ini memulai pemindaian Thread Discovery.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aScanChannels
Vektor bit yang menunjukkan saluran mana yang harus dipindai (misalnya OT_CHANNEL_11_MASK).
[in] aPanId
Filter ID PAN (disetel ke Broadcast PAN untuk menonaktifkan filter).
[in] aJoiner
Nilai Tanda Penggabung di TLV Permintaan Discovery.
[in] aEnableEui64Filtering
TRUE untuk memfilter respons pada EUI-64, FALSE jika tidak.
[in] aCallback
Pointer ke fungsi yang dipanggil saat menerima Respons Pemindaian MLE atau pemindaian selesai.
[in] aCallbackContext
Pointer untuk konteks khusus aplikasi.
Nilai yang Ditampilkan
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 Thread Child Timeout yang digunakan saat menjalankan 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 yang Ditampilkan
OT_DEVICE_ROLE_DISABLED
Stack Thread dinonaktifkan.
OT_DEVICE_ROLE_DETACHED
Perangkat saat ini tidak berpartisipasi dalam jaringan/partisi Thread.
OT_DEVICE_ROLE_CHILD
Perangkat saat ini beroperasi sebagai Thread Child.
OT_DEVICE_ROLE_ROUTER
Perangkat saat ini beroperasi sebagai Thread Router.
OT_DEVICE_ROLE_LEADER
Perangkat saat ini beroperasi sebagai Thread Leader.

OTThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Mendapatkan Nama Domain Thread.

Fungsi ini hanya tersedia sejak Thread 1.2.

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

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Dapatkan ID PAN IEEE 802.15.4 Extended.

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

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

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

Fungsi ini hanya tersedia sejak Thread 1.2 saat OPENTHREAD_CONFIG_DUA_ENABLE diaktifkan.

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

otThreadGetIp6Counter

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Mendapatkan penghitung IPv6.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
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.

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

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Fungsi ini mendapatkan Data Thread Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aLeaderData
Pointer tempat data pemimpin ditempatkan.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengambil data pemimpin.
OT_ERROR_DETACHED
Saat ini tidak dilampirkan.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Fungsi ini menampilkan pointer ke RLOC Leader.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aLeaderRloc
Petunjuk ke RLOC Pemimpin.
Nilai yang Ditampilkan
OT_ERROR_NONE
RLOC Pemimpin berhasil ditulis ke aLeaderRloc.
OT_ERROR_INVALID_ARGS
aLeaderRloc telah NULL.
OT_ERROR_DETACHED
Saat ini tidak dilampirkan ke Partisi Rangkaian Pesan.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Dapatkan ID Router Leader.

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

otThreadGetLeaderBerat

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
)

Fungsi ini menampilkan alamat multicast Node Thread Link-Local All Thread.

Alamat adalah Alamat Multcast Berbasis Awal Unicast link lokal [RFC 3306], dengan:

  • flps diatur ke 3 (P = 1 dan T = 1)
  • scop disetel ke 2
  • tolong setel 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 Node Thread Link-Local All Threads.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Fungsi ini menampilkan alamat IPv6 lokal link-thread.

Alamat lokal tautan Thread berasal menggunakan Alamat yang Diperpanjang IEEE802.15.4 sebagai Pengenal Antarmuka.

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

OTThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Dapatkan konfigurasi Mode Link MLE.

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

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Fungsi ini menampilkan pointer ke alamat EID Lokal Mesh.

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

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Fungsi ini menampilkan pointer ke Awalan Lokal Mesh.

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

otThreadGetMleCounter

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Mendapatkan penghitung Thread MLE.

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

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.

Fungsi ini 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 dalam 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
)

Fungsi ini mendapatkan TLV Diagnostik Jaringan berikutnya dalam pesan.

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

Detail
Parameter
[in] aMessage
Pointer pesan.
[in,out] aIterator
Pointer ke konteks iterator Diagnostik Jaringan. Untuk mendapatkan TLV Diagnostik Jaringan pertama, rangkaian ini harus disetel ke OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Pointer tempat informasi TLV Diagnostik Jaringan akan ditempatkan.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menemukan TLV Diagnostik Jaringan berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada TLV Diagnostik Jaringan berikutnya dalam pesan.
OT_ERROR_PARSE
Mengurai Diagnostik Jaringan berikutnya gagal.

otThreadGetNextNeighborInfo

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

Fungsi ini mendapatkan informasi tetangga berikutnya.

Ini digunakan untuk memeriksa entri tabel tetangga.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Pointer ke konteks iterator. Untuk mendapatkan entri tetangga pertama, tetapkan ke OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Pointer ke informasi tetangga.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menemukan entri tetangga berikutnya di 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 Thread Parent.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aParentRssi
Pointer ke lokasi RSSI induk.

OTThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

Fungsi ini mengambil informasi diagnostik untuk Thread Router sebagai induk.

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

ThreadThreadGetParentLastRssi

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 tempat lokasi RSSI terakhir harus ditempatkan.
Nilai yang Ditampilkan
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
)

Mendapatkan ID Partisi.

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

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Fungsi ini menampilkan alamat multicast Node Thread Realm-Local Node.

Alamat adalah Alamat Multcast Berbasis Awal Unicast lokal yang nyata [RFC 3306], dengan:

  • flps diatur ke 3 (P = 1 dan T = 1)
  • scop disetel ke 3
  • tolong setel 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 Node Thread Realm-Local Node.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Fungsi ini menampilkan pointer ke 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
)

Fungsi ini 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 menghasilkan ALOC Layanan. TIDAK BOLEH DINULL.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengambil Service ALOC.
OT_ERROR_DETACHED
Antarmuka Thread saat ini tidak dilampirkan ke Partisi Thread.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Fungsi ini mendapatkan versi protokol Thread.

Detail
Hasil
versi protokol Thread.

otThreadIsAnycastFindDalam Progres

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Fungsi ini menunjukkan apakah permintaan lokasi anycast sedang berlangsung.

Fungsi ini hanya tersedia jika OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
TRUE jika permintaan lokasi anycast sedang berlangsung, FALSE jika tidak.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Fungsi ini menentukan apakah Penemuan Thread MLE sedang berlangsung.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

OTThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Fungsi ini menunjukkan apakah node adalah satu-satunya router di jaringan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
TRUE
Router adalah satu-satunya router di jaringan.
FALSE
Server ini adalah turunan atau bukan router tunggal dalam jaringan.

otThreadFindAnycastDestination

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

Fungsi ini meminta tujuan terdekat dari alamat anycast tertentu.

Fungsi ini hanya tersedia jika OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE diaktifkan.

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

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

otThreadRegisterParentResponseCallback

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

Fungsi ini mendaftarkan callback untuk menerima data Respons Orang Tua MLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer ke fungsi yang dipanggil setelah menerima pesan Respons Orang Tua MLE.
[in] aContext
Pointer untuk memanggil konteks khusus klien.

otThreadResetIp6Counter

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Mereset penghitung IPv6.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otThreadResetMleCounter

void otThreadResetMleCounters(
  otInstance *aInstance
)

Mereset penghitung MLE Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otThreadSendAddressNotification

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

Fungsi ini mengirimkan pesan Notifikasi Proaktif Alamat (SharedPreference_NTF.ntf).

Fungsi ini hanya tersedia jika OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE diaktifkan.

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

otThreadSendDiagnosticGet

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

Mengirim permintaan Dapatkan Diagnostik Jaringan.

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 dalam aTlvTypes.
[in] aCallback
Pointer ke fungsi yang dipanggil saat respons Diagnostik Jaringan diterima atau NULL untuk menonaktifkan callback.
[in] aCallbackContext
Pointer untuk konteks khusus aplikasi.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengantrekan DIAG_GET.req.
OT_ERROR_NO_BUFS
Buffering pesan 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.

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

otThreadSendProactiveBackboneNotification

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

Fungsi ini mengirim pesan Proaktif Backbone Notification (PRO_BB.ntf) pada link Backbone.

Fungsi ini 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 dari pesan PRO_BB.ntf.
[in] aTimeSinceLastTransaction
Waktu sejak transaksi terakhir (dalam detik).
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengirim PRO_BB.ntf pada link backbone.
OT_ERROR_NO_BUFS
Jika buffer pesan tidak tersedia.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Menyetel Waktu Tunggu Turunan Rangkaian Pesan 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
)

Fungsi ini 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 untuk konteks khusus aplikasi callback.

ThreadThreadSetDomainName

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

Tetapkan Nama Domain Thread.

Fungsi ini hanya tersedia sejak Thread 1.2. Fungsi ini hanya berhasil jika protokol Thread dinonaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDomainName
Pointer ke Nama Domain Thread.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menyetel Nama Domain Thread.
OT_ERROR_INVALID_STATE
Protokol rangkaian pesan diaktifkan.
Lihat juga:
otThreadGetDomainName

OTThreadSetDiaktifkan

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Fungsi ini memulai operasi protokol Thread.

Antarmuka harus aktif saat memanggil fungsi ini.

Memanggil fungsi ini dengan aEnabled yang disetel ke SALAH akan menghentikan proses pelepasan yang sedang berlangsung yang dimulai oleh otThreadDetachGraceied(). Callbacknya akan dipanggil.

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

OtThreadSetExtendedPanId

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

Setel ID PAN IEEE 802.15.4 Extended.

Fungsi ini hanya dapat dipanggil saat protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini akan membatalkan Set Data Operasional yang Aktif dan Tertunda dalam memori yang tidak stabil.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aExtendedPanId
Pointer ke ID PAN Diperpanjang IEEE 802.15.4.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menyetel ID PAN yang Diperluas.
OT_ERROR_INVALID_STATE
Protokol rangkaian pesan diaktifkan.
Lihat juga:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

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

Menetapkan/Menghapus ID Antarmuka yang ditentukan secara manual untuk Alamat Unicast Thread Domain.

Fungsi ini hanya tersedia sejak Thread 1.2 saat 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 dihapus.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menetapkan/menghapus ID Antarmuka.
OT_ERROR_INVALID_ARGS
ID Antarmuka yang ditentukan dicadangkan.
Lihat juga:
otThreadGetFixedDuaInterfaceIdentifier

OTThreadSetJoinerAdvertisingment

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

Metode ini menetapkan Iklan Gabungan Thread saat menemukan jaringan Thread.

Iklan Penyambung Rangkaian pesan digunakan untuk mengizinkan Penggabung mengiklankan informasi spesifik per aplikasinya sendiri (seperti ID Vendor, ID Produk, Diskriminator, dll.) melalui TLV Iklan Gabungan yang baru diusulkan, dan menyediakan informasi ini kepada Komisaris atau Kandidat Komisaris tanpa interaksi manusia.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aOui
Nilai OUI Vendor IEEE yang akan disertakan dalam Iklan Penggabung. Hanya 3 byte yang paling tidak signifikan yang akan digunakan, dan byte yang paling signifikan akan diabaikan.
[in] aAdvData
Pointer ke AdvData yang akan disertakan dalam Iklan Penggabung.
[in] aAdvDataLength
Panjang AdvData dalam byte.
Nilai yang Ditampilkan
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
)

Setel thrKeySwitchGuardTime.

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

OTThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Setel konfigurasi Mode Link MLE.

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

otThreadSetMeshLocalPrefix

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

Fungsi ini menetapkan Awalan Lokal Mesh.

Fungsi ini hanya berhasil jika protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini akan membatalkan Set Data Operasional yang Aktif dan Tertunda dalam memori yang tidak stabil.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aMeshLocalPrefix
Pointer ke Awalan Lokal Mesh.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengatur Awalan Lokal Mesh.
OT_ERROR_INVALID_STATE
Protokol rangkaian pesan diaktifkan.

otThreadSetNetworkKey

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

Tetapkan Kunci Jaringan Thread.

Fungsi ini hanya berhasil jika protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini akan membatalkan Set Data Operasional yang Aktif dan Tertunda dalam memori yang tidak stabil.

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

OTThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Tetapkan Kunci Jaringan Thread sebagai otNetworkKeyRef.

Fungsi ini hanya berhasil jika protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini akan membatalkan Set Data Operasional yang Aktif dan Tertunda dalam memori yang tidak stabil.

Fungsi ini 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 yang Ditampilkan
OT_ERROR_NONE
Berhasil menyetel Kunci Jaringan Thread.
OT_ERROR_INVALID_STATE
Protokol rangkaian pesan diaktifkan.
Lihat juga:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

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

Tetapkan Nama Jaringan Thread.

Fungsi ini hanya berhasil jika protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini akan membatalkan Set Data Operasional yang Aktif dan Tertunda dalam memori yang tidak stabil.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aNetworkName
Pointer ke Nama Jaringan Thread.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menyetel Nama Jaringan Thread.
OT_ERROR_INVALID_STATE
Protokol rangkaian pesan diaktifkan.
Lihat juga:
otThreadGetNetworkName

Makro

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Durasi AdvData Maksimum dari Iklan Penggabung.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Penginisialisasi untuk otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_PANJANG

 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 melakukan inisialisasi otNetworkDataIterator.

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_Entry_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Ukuran entri Tabel Turunan Diagnostik Jaringan.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Penginisialisasi untuk otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Jumlah Maksimum Jenis TLV Diagnostik Jaringan untuk 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.

Resource

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