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

Router/Pemimpin

Modul ini menyertakan fungsi untuk Thread Router dan Leaders.

Ringkasan

Enumerasi
otCacheEntryState enum
Menentukan status entri cache EID.
otNeighborTableEvent{
  OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
} 		enum
Menentukan konstanta yang digunakan di otNeighborTableCallback untuk menunjukkan perubahan pada tabel tetangga.
otPowerSupply{
  OT_POWER_SUPPLY_BATTERY = 0,
  OT_POWER_SUPPLY_EXTERNAL = 1,
  OT_POWER_SUPPLY_EXTERNAL_STABLE = 2,
  OT_POWER_SUPPLY_EXTERNAL_UNSTABLE = 3
} 		enum
Mewakili properti catu daya pada perangkat.

Typedef
otCacheEntryInfo typedef
Merepresentasikan entri cache EID.
otCacheEntryIterator typedef
Merepresentasikan iterator yang digunakan untuk iterasi melalui entri tabel cache EID.
otCacheEntryState typedef
Menentukan status entri cache EID.
otChildIp6AddressIterator typedef
uint16_t
Digunakan untuk melakukan iterasi melalui alamat IPv6 entri Thread Child.
otDeviceProperties typedef
Mewakili properti perangkat yang digunakan untuk menghitung bobot pemimpin lokal di perangkat.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
Pointer dipanggil untuk memberi tahu bahwa ada perubahan pada tabel tetangga.

Fungsi
otThreadBecomeLeader(otInstance *aInstance)
Jadilah pemimpin dan mulai partisi baru.
otThreadBecomeRouter(otInstance *aInstance)
Mencoba menjadi router.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
Mendapatkan informasi diagnostik untuk Turunan yang dilampirkan berdasarkan ID Turunannya atau RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
Fungsi ini menyimpan informasi diagnostik untuk Turunan yang dilampirkan oleh indeks tabel internal.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Mendapatkan alamat IPv6 berikutnya (menggunakan iterator) untuk turunan tertentu.
otThreadGetChildRouterLinks(otInstance *aInstance)
uint8_t
Dapatkan parameter MLE_CHILD_ROUTER_LINKS yang digunakan dalam peran REED.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
Dapatkan parameter Konteks_ID_REUSE_ menarik yang digunakan dalam peran Pemimpin.
otThreadGetDeviceProperties(otInstance *aInstance)
Mendapatkan properti perangkat saat ini.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
Mendapatkan Port UDP Penggabung.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
Mendapatkan Bobot Pemimpin Thread yang digunakan saat beroperasi dalam peran Pemimpin.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
Mendapatkan jumlah maksimum turunan yang saat ini diizinkan.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
Mendapatkan jumlah maksimum alamat IP yang dapat didaftarkan oleh setiap turunan MTD dengan perangkat ini sebagai induk.
otThreadGetMaxRouterId(otInstance *aInstance)
uint8_t
Fungsi ini menampilkan ID router maksimum yang diizinkan.
otThreadGetNetworkIdTimeout(otInstance *aInstance)
uint8_t
Dapatkan parameter NETWORK_ID_ID yang digunakan dalam peran Router.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Mendapatkan entri cache EID berikutnya (menggunakan iterator).
otThreadGetNextHopAndPathCost(otInstance *aInstance, uint16_t aDestRloc16, uint16_t *aNextHopRloc16, uint8_t *aPathCost)
void
Mendapatkan biaya hop dan jalur berikutnya menuju tujuan RLOC16 tertentu.
otThreadGetParentPriority(otInstance *aInstance)
int8_t
Mendapatkan prioritas induk yang ditetapkan.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
Mendapatkan ID Partisi Pemimpin Thread yang dipilih yang digunakan saat beroperasi dalam peran Leader.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
Mendapatkan PSKc Thread.
otThreadGetPskcRef(otInstance *aInstance)
Mendapatkan Referensi Kunci untuk Thread PSKc yang disimpan.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
Dapatkan parameter ROUTER_DOWNGRADE_THRESHOLD yang digunakan dalam peran Router.
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
Mendapatkan rentang ID router yang diizinkan untuk ditetapkan ke node dalam jaringan thread.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
Mendapatkan Urutan ID Router saat ini.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
Fungsi ini menyimpan informasi diagnostik untuk Router Thread tertentu.
otThreadGetRouterSelectionJitter(otInstance *aInstance)
uint8_t
Dapatkan parameter ROUTER_USAGE_JITTER yang digunakan dalam peran REED/Router.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
uint8_t
Dapatkan parameter ROUTER_UPGRADE_THRESHOLD yang digunakan dalam peran REED.
otThreadIsRouterEligible(otInstance *aInstance)
bool
Menunjukkan apakah perangkat memenuhi syarat router atau tidak.
otThreadIsRouterIdAllocated(otInstance *aInstance, uint8_t aRouterId)
bool
Menunjukkan apakah ID Router saat ini dialokasikan atau tidak.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
Mendaftarkan fungsi callback tabel tetangga.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
Rilis ID Router yang telah dialokasikan oleh perangkat dalam peran Leader.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
Menetapkan apakah perangkat dipesan menggunakan CCM.
otThreadSetChildRouterLinks(otInstance *aInstance, uint8_t aChildRouterLinks)
Tetapkan parameter MLE_CHILD_ROUTER_LINKS yang digunakan dalam peran REED.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
Tetapkan parameter Konteks_ID_REUSE_ menarik yang digunakan dalam peran Pemimpin.
otThreadSetDeviceProperties(otInstance *aInstance, const otDeviceProperties *aDeviceProperties)
void
Tetapkan properti perangkat yang kemudian digunakan untuk menentukan dan menetapkan Bobot Pemimpin.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
Menetapkan Joinr UDP Port.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
Menetapkan Berat Thread Leader yang digunakan saat beroperasi dalam peran Leader.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
Menetapkan jumlah maksimum turunan yang saat ini diizinkan.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
Menetapkan atau memulihkan jumlah maksimum alamat IP yang dapat didaftarkan oleh setiap turunan MTD dengan perangkat ini sebagai induk.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
Tetapkan parameter NETWORK_ID_possesiveDirect yang digunakan dalam peran Leader.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
Tetapkan prioritas induk.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
Menetapkan ID Partisi Pemimpin Thread yang dipilih yang digunakan saat beroperasi dalam peran Leader.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
Setel ID Router yang diinginkan.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
Menetapkan PSKc Thread.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
Menetapkan PSKc Thread.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Tetapkan parameter ROUTER_DOWNGRADE_THRESHOLD yang digunakan dalam peran Pemimpin.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
Menetapkan apakah perangkat memenuhi syarat router.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Menetapkan rentang ID router yang diizinkan untuk ditetapkan ke node dalam jaringan thread.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
Tetapkan parameter ROUTER_USAGE_JITTER yang digunakan dalam peran REED/Router.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Tetapkan parameter ROUTER_UPGRADE_THRESHOLD yang digunakan dalam peran Leader.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Menyetel data Steering dari band.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
Menetapkan apakah nilai minimum versi TLV Kebijakan Keamanan untuk pemilihan rute (kolom VR) diaktifkan.

Struct
otCacheEntryInfo

Merepresentasikan entri cache EID.

otCacheEntryIterator

Merepresentasikan iterator yang digunakan untuk iterasi melalui entri tabel cache EID.

otChildInfo

Menyimpan informasi diagnostik untuk Thread Child.

otDeviceProperties

Mewakili properti perangkat yang digunakan untuk menghitung bobot pemimpin lokal di perangkat.

otNeighborTableEntryInfo

Merepresentasikan info entri tabel tetangga (turunan atau router) dan digunakan sebagai parameter dalam callback tabel tetangga otNeighborTableCallback.

Enumerasi

otCacheEntryState

 otCacheEntryState

Menentukan status entri cache EID.

OTNeighborTableEvent

 otNeighborTableEvent

Menentukan konstanta yang digunakan di otNeighborTableCallback untuk menunjukkan perubahan pada tabel tetangga.

Properti
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

Anak sedang ditambahkan.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

Mode anak yang ada diubah.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Anak sedang dihapus.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Router sedang ditambahkan.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Router sedang dihapus.

catu daya

 otPowerSupply

Mewakili properti catu daya pada perangkat.

Ini digunakan sebagai properti di otDeviceProperties untuk menghitung bobot pemimpin.

Properti
OT_POWER_SUPPLY_BATTERY

Bertenaga baterai.

OT_POWER_SUPPLY_EXTERNAL

Didukung secara eksternal (didukung daya).

OT_POWER_SUPPLY_EXTERNAL_STABLE

Daya eksternal yang stabil dengan cadangan baterai atau UPS.

OT_POWER_SUPPLY_EXTERNAL_UNSTABLE

Daya ekstrim yang tidak stabil (misalnya bohlam yang dinyalakan melalui tombol).

Typedef

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Merepresentasikan entri cache EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

Merepresentasikan iterator yang digunakan untuk iterasi melalui entri tabel cache EID.

Untuk melakukan inisialisasi iterator dan memulai dari entri pertama dalam tabel cache, tetapkan semua kolomnya dalam struktur ke nol (misalnya, memset iterator ke nol).

otCacheEntryState

enum otCacheEntryState otCacheEntryState

Menentukan status entri cache EID.

otChildIp6AlamatIterator

uint16_t otChildIp6AddressIterator

Digunakan untuk melakukan iterasi melalui alamat IPv6 entri Thread Child.

otDeviceProperties

struct otDeviceProperties otDeviceProperties

Mewakili properti perangkat yang digunakan untuk menghitung bobot pemimpin lokal di perangkat.

Parameter ditetapkan berdasarkan kemampuan perangkat, baik sebagai router pembatas, konfigurasi catu dayanya, dll.

mIsUnstable menunjukkan stabilitas operasional perangkat dan ditentukan melalui mekanisme khusus vendor. Data ini dapat mencakup kasus berikut:

  • Perangkat mendeteksi secara internal bahwa perangkat kehilangan catu daya eksternal lebih sering dari biasanya. Yang biasanya ditentukan oleh vendor.
  • Perangkat mendeteksi secara internal bahwa perangkat melakukan reboot lebih sering dari biasanya. Yang biasanya ditentukan oleh vendor.

OTNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

Pointer dipanggil untuk memberi tahu bahwa ada perubahan pada tabel tetangga.

Detail
Parameter
[in] aEvent
Flag peristiwa.
[in] aEntryInfo
Pointer ke info entri tabel.

Fungsi

OTThreadMenjadi Pemimpin

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Jadilah pemimpin dan mulai partisi baru.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menjadi pemimpin dan memulai partisi baru.
OT_ERROR_INVALID_STATE
Rangkaian pesan dinonaktifkan.

OTThreadMenjadi Router

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Mencoba menjadi router.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil memulai upaya untuk menjadi router.
OT_ERROR_INVALID_STATE
Rangkaian pesan dinonaktifkan.

otThreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

Mendapatkan informasi diagnostik untuk Turunan yang dilampirkan berdasarkan ID Turunannya atau RLOC16.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aChildId
ID Anak atau RLOC16 untuk anak terlampir.
[out] aChildInfo
Pointer ke tempat informasi turunan ditempatkan.
Nilai yang Ditampilkan
OT_ERROR_NONE
aChildInfo berhasil diperbarui dengan info untuk ID yang diberikan.
OT_ERROR_NOT_FOUND
Tidak ada anak yang valid dengan ID Anak ini.
OT_ERROR_INVALID_ARGS
Jika aChildInfo NULL.

otThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

Fungsi ini menyimpan informasi diagnostik untuk Turunan yang dilampirkan oleh indeks tabel internal.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aChildIndex
Indeks tabel.
[out] aChildInfo
Pointer ke tempat informasi turunan ditempatkan.
Nilai yang Ditampilkan
OT_ERROR_NONE
aChildInfo berhasil diperbarui dengan info untuk indeks tertentu.
OT_ERROR_NOT_FOUND
Tidak ada turunan yang valid pada indeks ini.
OT_ERROR_INVALID_ARGS
aChildInfo NULL, atau aChildIndex di luar rentang (lebih tinggi dari indeks tabel maksimum).
Lihat juga:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Alamat

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

Mendapatkan alamat IPv6 berikutnya (menggunakan iterator) untuk turunan tertentu.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aChildIndex
Indeks turunan.
[in,out] aIterator
Pointer ke iterator. Jika berhasil, iterator akan diperbarui untuk diarahkan ke entri berikutnya dalam daftar. Untuk mendapatkan alamat IPv6 pertama, iterator harus ditetapkan ke OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Pointer ke alamat IPv6 tempat alamat anak berikutnya berada (jika berhasil).
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menemukan alamat IPv6 berikutnya (aAddress berhasil diperbarui).
OT_ERROR_NOT_FOUND
Anak tidak memiliki entri alamat IPv6 berikutnya.
OT_ERROR_INVALID_ARGS
aIterator atau aAddress NULL, atau turunan di aChildIndex tidak valid.
Lihat juga:
otThreadGetChildInfoByIndex 

uint8_t otThreadGetChildRouterLinks(
  otInstance *aInstance
)

Dapatkan parameter MLE_CHILD_ROUTER_LINKS yang digunakan dalam peran REED.

Parameter ini menetapkan jumlah maksimum router yang berdekatan yang akan digunakan untuk melakukan penautan perangkat (sebagai FED).

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Nilai MLE_CHILD_ROUTER_LINKS.
Lihat juga:
otThreadSetChildRouterLinks

otThreadGetContextIdPenggunaanPenundaan

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Dapatkan parameter Konteks_ID_REUSE_ menarik yang digunakan dalam peran Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Nilai Context_ID_REUSE_ menarik.
Lihat juga:
otThreadSetContextIdUnusedDelay

otThreadGetDeviceProperties

const otDeviceProperties * otThreadGetDeviceProperties(
  otInstance *aInstance
)

Mendapatkan properti perangkat saat ini.

Detail
Pengembalian
Properti perangkat otDeviceProperties.

OTThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Mendapatkan Port UDP Penggabung.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Nomor Port UDP Bersama.
Lihat juga:
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderBerat

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Mendapatkan Bobot Pemimpin Thread yang digunakan saat beroperasi dalam peran Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Nilai Bobot Thread Leader.
Lihat juga:
otThreadSetLeaderWeight
otThreadSetDeviceProperties

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Mendapatkan jumlah maksimum turunan yang saat ini diizinkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Jumlah maksimum anak yang diizinkan saat ini.
Lihat juga:
otThreadSetMaxAllowedChildren

otThreadGetMaxChildIpAlamat

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Mendapatkan jumlah maksimum alamat IP yang dapat didaftarkan oleh setiap turunan MTD dengan perangkat ini sebagai induk.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Jumlah maksimum alamat IP yang dapat didaftarkan oleh setiap turunan MTD dengan perangkat ini sebagai induk.
Lihat juga:
otThreadSetMaxChildIpAddress

OTThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

Fungsi ini menampilkan ID router maksimum yang diizinkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
ID router maksimum yang diizinkan.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Dapatkan parameter NETWORK_ID_ID yang digunakan dalam peran Router.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Nilai NETWORK_ID_ID.
Lihat juga:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

Mendapatkan entri cache EID berikutnya (menggunakan iterator).

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aEntryInfo
Pointer tempat informasi entri cache EID ditempatkan.
[in,out] aIterator
Pointer ke iterator. Kode ini akan diperbarui agar mengarah ke entri berikutnya yang berhasil. Untuk mendapatkan entri pertama, lakukan inisialisasi iterator dengan menetapkan semua kolomnya ke nol (misalnya, memset struktur iterator ke nol).
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengisi aEntryInfo untuk entri cache EID berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada entri lain dalam tabel cache alamat.

otThreadGetNextHopAndPathCost

void otThreadGetNextHopAndPathCost(
  otInstance *aInstance,
  uint16_t aDestRloc16,
  uint16_t *aNextHopRloc16,
  uint8_t *aPathCost
)

Mendapatkan biaya hop dan jalur berikutnya menuju tujuan RLOC16 tertentu.

Dapat digunakan dengan aNextHopRloc16 atau aPathCost yang NULL yang menunjukkan bahwa pemanggil tidak ingin mendapatkan nilai.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDesRloct16
RLOC16 tujuan.
[out] aNextHopRloc16
Pointer untuk menampilkan RLOC16 hop berikutnya, 0xfffe jika tidak ada hop berikutnya.
[out] aPathCost
Pointer untuk menampilkan biaya jalur menuju tujuan.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Mendapatkan prioritas induk yang ditetapkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Nilai prioritas induk yang ditetapkan, -2 berarti tidak ditetapkan.
Lihat juga:
otThreadSetParentPriority

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Mendapatkan ID Partisi Pemimpin Thread yang dipilih yang digunakan saat beroperasi dalam peran Leader.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Nilai ID Partisi Pemimpin Thread.

OTThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Mendapatkan PSKc Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aPskc
Pointer ke otPskc untuk menampilkan Thread PSKc yang diambil.
Lihat juga:
otThreadSetPskc

OTThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Mendapatkan Referensi Kunci untuk Thread PSKc yang disimpan.

Memerlukan pengaktifan fitur waktu build OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Referensi Utama ke PSKc
Lihat juga:
otThreadSetPskcRef

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Dapatkan parameter ROUTER_DOWNGRADE_THRESHOLD yang digunakan dalam peran Router.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Nilai ROUTER_DOWNGRADE_THRESHOLD.
Lihat juga:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdRange

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

Mendapatkan rentang ID router yang diizinkan untuk ditetapkan ke node dalam jaringan thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aMinRouterId
ID router minimum.
[out] aMaxRouterId
ID router maksimum.
Lihat juga:
otThreadSetRouterIdRange

otThreadGetRouterIdUrutan

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Mendapatkan Urutan ID Router saat ini.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Urutan ID Router.

otThreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

Fungsi ini menyimpan informasi diagnostik untuk Router Thread tertentu.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aRouterId
ID router atau RLOC16 untuk router tertentu.
[out] aRouterInfo
Pointer tempat informasi router ditempatkan.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengambil info router untuk id yang diberikan.
OT_ERROR_NOT_FOUND
Tidak ada entri router dengan id yang diberikan.
OT_ERROR_INVALID_ARGS
aRouterInfo NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Dapatkan parameter ROUTER_USAGE_JITTER yang digunakan dalam peran REED/Router.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Nilai ROUTER_USAGE_JITTER.
Lihat juga:
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Dapatkan parameter ROUTER_UPGRADE_THRESHOLD yang digunakan dalam peran REED.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Pengembalian
Nilai ROUTER_UPGRADE_THRESHOLD.
Lihat juga:
otThreadSetRouterUpgradeThreshold

OTThreadIsRouterValid

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Menunjukkan apakah perangkat memenuhi syarat router atau tidak.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
TRUE
Apakah perangkat memenuhi syarat router.
FALSE
Jika perangkat tidak memenuhi syarat router.

otThreadIsRouterIdAllokasi

bool otThreadIsRouterIdAllocated(
  otInstance *aInstance,
  uint8_t aRouterId
)

Menunjukkan apakah ID Router saat ini dialokasikan atau tidak.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aRouterId
ID router untuk diperiksa.
Nilai yang Ditampilkan
TRUE
aRouterId dialokasikan.
FALSE
aRouterId tidak dialokasikan.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Mendaftarkan fungsi callback tabel tetangga.

Callback yang disediakan (jika non-NULL) akan dipanggil saat ada perubahan di tabel tetangga (mis., entri turunan turunan atau router ditambahkan/dihapus atau mode turunan yang ada diubah).

Panggilan berikutnya ke metode ini akan menimpa callback sebelumnya. Perhatikan bahwa callback ini dipanggil saat tabel tetangga/turunan diperbarui dan selalu sebelum otStateChangedCallback.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer ke fungsi pengendali callback.

OTThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Rilis ID Router yang telah dialokasikan oleh perangkat dalam peran Leader.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aRouterId
ID Router yang akan dirilis. Rentang yang valid adalah [0, 62].
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil merilis ID router.
OT_ERROR_INVALID_ARGS
aRouterId tidak dalam rentang [0, 62].
OT_ERROR_INVALID_STATE
Perangkat saat ini tidak beroperasi sebagai pemimpin.
OT_ERROR_NOT_FOUND
ID router saat ini tidak dialokasikan.

OTThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Menetapkan apakah perangkat dipesan menggunakan CCM.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEnabled
TRUE jika perangkat digunakan menggunakan CCM, FALSE jika tidak. 
otError otThreadSetChildRouterLinks(
  otInstance *aInstance,
  uint8_t aChildRouterLinks
)

Tetapkan parameter MLE_CHILD_ROUTER_LINKS yang digunakan dalam peran REED.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aChildRouterLinks
Nilai MLE_CHILD_ROUTER_LINKS.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menetapkan nilai.
OT_ERROR_INVALID_STATE
Protokol thread diaktifkan.
Lihat juga:
otThreadGetChildRouterLinks

otThreadSetContextIdUnusedPenundaan

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Tetapkan parameter Konteks_ID_REUSE_ menarik yang digunakan dalam peran Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDelay
Nilai Context_ID_REUSE_ menarik.
Lihat juga:
otThreadGetContextIdUnusedDelay

OTThreadSetDeviceProperties

void otThreadSetDeviceProperties(
  otInstance *aInstance,
  const otDeviceProperties *aDeviceProperties
)

Tetapkan properti perangkat yang kemudian digunakan untuk menentukan dan menetapkan Bobot Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDeviceProperties
Properti perangkat.

OTThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Menetapkan Joinr UDP Port.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aJoinerUdpPort
Nomor Port UDP Bersama.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menyetel Port UDP Sambungan.
Lihat juga:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderBerat

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Menetapkan Berat Thread Leader yang digunakan saat beroperasi dalam peran Leader.

Langsung menetapkan Bobot Pemimpin ke nilai baru, menggantikan nilai sebelumnya (yang mungkin telah ditentukan dari otDeviceProperties saat ini).

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aWeight
Nilai Bobot Thread Leader.
Lihat juga:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Menetapkan jumlah maksimum turunan yang saat ini diizinkan.

Parameter ini hanya dapat ditetapkan saat operasi protokol Thread telah dihentikan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aMaxChildren
Jumlah turunan maksimum yang diizinkan.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menetapkan CPC maks
OT_ERROR_INVALID_ARGS
Jika aMaxChildren tidak berada dalam rentang [1, OPENCAMPAIGNCOUNT_CONFIG_MLE_MAX_CHILDREN].
OT_ERROR_INVALID_STATE
Jika Thread tidak dihentikan.
Lihat juga:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAlamat

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Menetapkan atau memulihkan jumlah maksimum alamat IP yang dapat didaftarkan oleh setiap turunan MTD dengan perangkat ini sebagai induk.

Teruskan 0 untuk menghapus setelan dan memulihkan setelan default.

Tersedia saat OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aMaxIpAddresses
Jumlah maksimum alamat IP yang dapat didaftarkan oleh setiap turunan MTD dengan perangkat ini sebagai induk. 0 untuk menghapus setelan dan memulihkan setelan default.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menyetel/menghapus nomor.
OT_ERROR_INVALID_ARGS
Jika melebihi jumlah maksimum yang diizinkan.
Lihat juga:
otThreadGetMaxChildIpAddress

OTThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Tetapkan parameter NETWORK_ID_possesiveDirect yang digunakan dalam peran Leader.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aTimeout
Nilai NETWORK_ID_ID.
Lihat juga:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Tetapkan prioritas induk.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aParentPriority
Nilai prioritas induk.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menyetel prioritas induk.
OT_ERROR_INVALID_ARGS
Jika nilai prioritas induk bukan antara 1, 0, -1, dan -2.
Lihat juga:
otThreadGetParentPriority

OTThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Menetapkan ID Partisi Pemimpin Thread yang dipilih yang digunakan saat beroperasi dalam peran Leader.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPartitionId
Nilai ID Partisi Pemimpin Thread.

OTThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Setel ID Router yang diinginkan.

Setelah menjadi router/pemimpin, node mencoba menggunakan ID Router ini. Jika ID Router pilihan tidak ditetapkan atau jika tidak dapat digunakan, ID router yang dibuat secara acak akan dipilih. Properti ini hanya dapat disetel jika peran perangkat dilepas atau dinonaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aRouterId
ID Router yang diinginkan.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menyetel ID Router yang diinginkan.
OT_ERROR_INVALID_STATE
Tidak dapat menetapkan (peran tidak dilepas atau dinonaktifkan)

OTThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

Menetapkan PSKc Thread.

Hanya akan berhasil jika protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini juga akan membatalkan Set Data Operasional Aktif dan Tertunda di memori non-volatile.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPskc
Pointer ke Thread PSKc baru.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menetapkan PSKc Thread.
OT_ERROR_INVALID_STATE
Protokol thread diaktifkan.
Lihat juga:
otThreadGetPskc

OTThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Menetapkan PSKc Thread.

Memerlukan pengaktifan fitur waktu build OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Hanya akan berhasil jika protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini juga akan membatalkan Set Data Operasional Aktif dan Tertunda di memori non-volatile.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aKeyRef
Referensi Utama ke PSKc Thread baru.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menetapkan PSKc Thread.
OT_ERROR_INVALID_STATE
Protokol thread diaktifkan.
Lihat juga:
otThreadGetPskcRef

otThreadSetRouterDowngradeAmbang

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Tetapkan parameter ROUTER_DOWNGRADE_THRESHOLD yang digunakan dalam peran Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aThreshold
Nilai ROUTER_DOWNGRADE_THRESHOLD.
Lihat juga:
otThreadGetRouterDowngradeThreshold

OTThreadSetRouterValid

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Menetapkan apakah perangkat memenuhi syarat router.

Jika aEligible bernilai salah dan perangkat saat ini beroperasi sebagai router, panggilan ini akan menyebabkan perangkat dilepas dan mencoba dipasang kembali sebagai turunan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEligible
TRUE untuk mengonfigurasi perangkat sebagai memenuhi syarat router, FALSE jika sebaliknya.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menetapkan konfigurasi yang memenuhi syarat router.
OT_ERROR_NOT_CAPABLE
Perangkat tidak dapat menjadi router.

OTThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

Menetapkan rentang ID router yang diizinkan untuk ditetapkan ke node dalam jaringan thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aMinRouterId
ID router minimum.
[in] aMaxRouterId
ID router maksimum.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menetapkan rentang.
OT_ERROR_INVALID_ARGS
aMinRouterId > aMaxRouterId, atau rentang tidak dicakup oleh [0, 62].
Lihat juga:
otThreadGetRouterIdRange

OTThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Tetapkan parameter ROUTER_USAGE_JITTER yang digunakan dalam peran REED/Router.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aRouterJitter
Nilai ROUTER_USAGE_JITTER.
Lihat juga:
otThreadGetRouterSelectionJitter

OTThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Tetapkan parameter ROUTER_UPGRADE_THRESHOLD yang digunakan dalam peran Leader.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aThreshold
Nilai ROUTER_UPGRADE_THRESHOLD.
Lihat juga:
otThreadGetRouterUpgradeThreshold

OTThreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Menyetel data Steering dari band.

Opsi konfigurasi OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE harus disetel untuk mengaktifkan setelan data kemudi di luar pita.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aExtAddress
Alamat yang digunakan untuk memperbarui data pengarah. Semua angka nol untuk menghapus data setir (tidak ada data setir). Semua 0xFF untuk menyetel data kemudi/filter mekar untuk menerima/mengizinkan semua. EUI64 spesifik yang kemudian ditambahkan ke filter data/mekar kemudi saat ini.

OTThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Menetapkan apakah nilai minimum versi TLV Kebijakan Keamanan untuk pemilihan rute (kolom VR) diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEnabled
TRUE untuk mengaktifkan nilai minimum versi TLV Kebijakan Keamanan untuk perutean, FALSE jika sebaliknya.

Makro

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Penginisialisasi otChildIP6AddressIterator.

Resource

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