{i>Router<i}/Pemimpin

Modul ini mencakup fungsi untuk Router dan Pemimpin Thread.

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 di tabel di sekitar.
otPowerSupply{
  OT_POWER_SUPPLY_BATTERY = 0,
  OT_POWER_SUPPLY_EXTERNAL = 1,
  OT_POWER_SUPPLY_EXTERNAL_STABLE = 2,
  OT_POWER_SUPPLY_EXTERNAL_UNSTABLE = 3
} 		enum
Menampilkan properti catu daya pada perangkat.

Typedef
otCacheEntryInfo typedef
Mewakili entri cache EID.
otCacheEntryIterator typedef
Mewakili 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 Turunan.
otDeviceProperties typedef
Mewakili properti perangkat yang digunakan untuk menghitung bobot pemimpin lokal pada perangkat.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
Pointer dipanggil untuk memberi tahu bahwa ada perubahan di tabel tetangga.

Fungsi
otThreadBecomeLeader(otInstance *aInstance)
Jadilah pemimpin dan mulai partisi baru.
otThreadBecomeRouter(otInstance *aInstance)
Mencoba menjadi router.
otThreadGetAdvertisementTrickleIntervalMax(otInstance *aInstance)
uint32_t
Mendapatkan nilai Interval Maksimal saat ini yang digunakan oleh timer tetesan Iklan.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
Mendapatkan informasi diagnostik untuk Turunan yang terkait melalui ID Turunannya atau RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
Fungsi ini menyimpan informasi diagnostik untuk Turunan yang terlampir berdasarkan 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 CONTEXT_ID_REUSE_ langkah yang digunakan dalam peran Pemimpin.
otThreadGetDeviceProperties(otInstance *aInstance)
Mendapatkan properti perangkat saat ini.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
Mendapatkan Port UDP Joiner.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
Mendapatkan Berat Pemimpin Thread yang digunakan saat beroperasi dalam peran Pemimpin.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
Mendapatkan jumlah maksimum anak 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
Mendapatkan parameter NETWORK_ID_TIMEOUT.
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
Dapatkan ID Partisi Pemimpin Thread yang digunakan saat beroperasi dalam peran Pemimpin.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
Mendapatkan Thread PSKc.
otThreadGetPskcRef(otInstance *aInstance)
Mendapatkan Referensi Kunci ke Thread PSKc yang disimpan.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
Dapatkan parameter ROUTER_DOWNGRADE_DEADLINE 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_SELECTION_JITTER yang digunakan dalam peran REED/Router.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
uint8_t
Dapatkan parameter ROUTER_UPGRADE_ingat yang digunakan dalam peran REED.
otThreadIsRouterEligible(otInstance *aInstance)
bool
Menunjukkan apakah perangkat memenuhi syarat untuk 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 Pemimpin.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
Menetapkan apakah perangkat ditugaskan menggunakan CCM.
otThreadSetChildRouterLinks(otInstance *aInstance, uint8_t aChildRouterLinks)
Setel parameter MLE_CHILD_ROUTER_LINKS yang digunakan dalam peran REED.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
Setel parameter CONTEXT_ID_REUSE_ unik yang digunakan dalam peran Pemimpin.
otThreadSetDeviceProperties(otInstance *aInstance, const otDeviceProperties *aDeviceProperties)
void
Tetapkan properti perangkat yang kemudian digunakan untuk menentukan dan menetapkan Berat Pemimpin.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
Menetapkan Port UDP Joiner.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
Menetapkan Berat Pemimpin Thread yang digunakan saat beroperasi dalam peran Pemimpin.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
Menetapkan jumlah maksimum turunan yang diizinkan saat ini.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
Menyetel 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
Setel parameter NETWORK_ID_TIMEOUT.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
Tetapkan prioritas induk.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
Tetapkan ID Partisi Pemimpin Thread yang digunakan saat beroperasi dalam peran Pemimpin.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
Tetapkan ID Router yang diinginkan.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
Setel Thread PSKc.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
Setel Key Reference ke Thread PSKc.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Tetapkan parameter ROUTER_DOWNGRADE_DEADLINE yang digunakan dalam peran Pemimpin.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
Menetapkan apakah perangkat memenuhi syarat untuk router atau tidak.
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_SELECTION_JITTER yang digunakan dalam peran REED/Router.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Tetapkan parameter ROUTER_UPGRADE_ingat yang digunakan dalam peran Pemimpin.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Setel data Pengarah dari tali.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
Menetapkan apakah nilai minimum versi TLV Kebijakan Keamanan untuk pemilihan rute (kolom VR) diaktifkan.

Struct
otCacheEntryInfo

Mewakili entri cache EID.

otCacheEntryIterator

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

otChildInfo

Menyimpan informasi diagnostik untuk Turunan Thread.

otDeviceProperties

Mewakili properti perangkat yang digunakan untuk menghitung bobot pemimpin lokal pada 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 di tabel di sekitar.

Properti
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

Turunan sedang ditambahkan.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

Mode anak yang ada diubah.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Akun anak sedang dihapus.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Router sedang ditambahkan.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Router sedang dihapus.

otPowerSupply

 otPowerSupply

Menampilkan properti catu daya pada perangkat.

Ini digunakan sebagai properti di otDeviceProperties untuk menghitung bobot posisi teratas.

Properti
OT_POWER_SUPPLY_BATTERY

Bertenaga baterai.

OT_POWER_SUPPLY_EXTERNAL

Bertenaga eksternal (bertenaga listrik).

OT_POWER_SUPPLY_EXTERNAL_STABLE

Daya eksternal yang stabil dengan cadangan baterai atau UPS.

OT_POWER_SUPPLY_EXTERNAL_UNSTABLE

Daya listrik di aset yang berpotensi tidak stabil (misalnya bohlam yang dihidupkan melalui tombol).

Typedef

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Mewakili entri cache EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

Mewakili 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.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Digunakan untuk melakukan iterasi melalui alamat IPv6 entri Thread Turunan.

otDeviceProperties

struct otDeviceProperties otDeviceProperties

Mewakili properti perangkat yang digunakan untuk menghitung bobot pemimpin lokal pada 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. Hal ini dapat mencakup kasus berikut:

  • Perangkat secara internal mendeteksi bahwa perangkat kehilangan catu daya eksternal lebih sering dari biasanya. Hal yang biasa ditentukan oleh vendor.
  • Perangkat secara internal mendeteksi bahwa perangkat dimulai ulang lebih sering dari biasanya. Hal yang biasa ditentukan oleh vendor.

otNeighborTableCallback

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

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

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

Fungsi

otThreadBecomeLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Jadilah pemimpin dan mulai partisi baru.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menjadi pemimpin dan memulai partisi baru.
OT_ERROR_INVALID_STATE
Thread dinonaktifkan.

otThreadBecomeRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Mencoba menjadi router.

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

otThreadGetAdvertisementTrickleIntervalMax

uint32_t otThreadGetAdvertisementTrickleIntervalMax(
  otInstance *aInstance
)

Mendapatkan nilai Interval Maksimal saat ini yang digunakan oleh timer tetesan Iklan.

API ini memerlukan OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE, dan hanya ditujukan untuk pengujian.

Detail
Hasil
Penghitung waktu mengalir Interval Maksimal Iklan dalam milidetik.

otThreadGetChildInfoById

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

Mendapatkan informasi diagnostik untuk Turunan yang terkait melalui ID Turunannya atau RLOC16.

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

otThreadGetChildInfoByIndex

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

Fungsi ini menyimpan informasi diagnostik untuk Turunan yang terlampir berdasarkan indeks tabel internal.

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

otThreadGetChildNextIp6Address

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 agar mengarah ke entri berikutnya dalam daftar. Untuk mendapatkan alamat IPv6 pertama, iterator harus disetel ke OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Penunjuk ke alamat IPv6 tempat alamat anak berikutnya ditempatkan (jika berhasil).
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menemukan alamat IPv6 berikutnya (aAddress berhasil diperbarui).
OT_ERROR_NOT_FOUND
Turunan tidak memiliki entri alamat IPv6 berikutnya.
OT_ERROR_INVALID_ARGS
aIterator atau aAddress adalah NULL, atau turunan pada aChildIndex tidak valid.
Lihat juga:
otThreadGetChildInfoByIndex 

uint8_t otThreadGetChildRouterLinks(
  otInstance *aInstance
)

Dapatkan parameter MLE_CHILD_ROUTER_LINKS yang digunakan dalam peran REED.

Parameter ini menentukan jumlah maksimum router tetangga yang akan digunakan perangkat (sebagai FED) untuk mencoba membuat link.

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

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Dapatkan parameter CONTEXT_ID_REUSE_ langkah yang digunakan dalam peran Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Nilai CONTEXT_ID_REUSE_ unik.
Lihat juga:
otThreadSetContextIdReuseDelay

otThreadGetDeviceProperties

const otDeviceProperties * otThreadGetDeviceProperties(
  otInstance *aInstance
)

Mendapatkan properti perangkat saat ini.

Memerlukan OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE.

Detail
Hasil
Properti perangkat otDeviceProperties.

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Mendapatkan Port UDP Joiner.

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

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

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

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

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Mendapatkan jumlah maksimum anak yang saat ini diizinkan.

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

otThreadGetMaxChildIpAddresses

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.
Hasil
Jumlah maksimum alamat IP yang dapat didaftarkan oleh setiap turunan MTD dengan perangkat ini sebagai induk.
Lihat juga:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

Fungsi ini menampilkan ID router maksimum yang diizinkan.

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

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Mendapatkan parameter NETWORK_ID_TIMEOUT.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Nilai NETWORK_ID_TIMEOUT.
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 ke tempat informasi entri cache EID ditempatkan.
[in,out] aIterator
Pointer ke iterator. Kolom tersebut akan diperbarui agar mengarah ke entri berikutnya jika berhasil. Untuk mendapatkan entri pertama, inisialisasi iterator dengan menetapkan semua kolomnya ke nol (misalnya, memset struktur iterator ke nol).
Nilai Pengembalian
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 sebagai NULL yang menunjukkan pemanggil tidak ingin mendapatkan nilai.

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

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Mendapatkan prioritas induk yang ditetapkan.

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

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Dapatkan ID Partisi Pemimpin Thread yang digunakan saat beroperasi dalam peran Pemimpin.

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

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Mendapatkan Thread PSKc.

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 ke Thread PSKc yang disimpan.

Memerlukan pengaktifan fitur waktu build OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

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

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Dapatkan parameter ROUTER_DOWNGRADE_DEADLINE yang digunakan dalam peran Router.

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

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Mendapatkan Urutan ID Router saat ini.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
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 {i>router<i} atau RLOC16 untuk {i>router<i} tertentu.
[out] aRouterInfo
Pointer yang menunjukkan lokasi informasi router.
Nilai Pengembalian
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 adalah NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Dapatkan parameter ROUTER_SELECTION_JITTER yang digunakan dalam peran REED/Router.

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

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Dapatkan parameter ROUTER_UPGRADE_ingat yang digunakan dalam peran REED.

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

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Menunjukkan apakah perangkat memenuhi syarat untuk router atau tidak.

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

otThreadIsRouterIdAllocated

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 yang akan diperiksa.
Nilai Pengembalian
TRUE
aRouterId dialokasikan.
FALSE
aRouterId tidak dialokasikan.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Mendaftarkan fungsi callback tabel tetangga.

Callback yang diberikan (jika non-NULL) akan dipanggil ketika ada perubahan di tabel tetangga (misalnya, entri turunan atau router tetangga sedang ditambahkan/dihapus atau mode anak yang ada diubah).

Panggilan berikutnya ke metode ini akan menimpa callback sebelumnya. Perhatikan bahwa callback ini dipanggil saat tabel tetangga/turunan sedang 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 Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aRouterId
ID Router yang akan dilepaskan. Rentang yang valid adalah [0, 62].
Nilai Pengembalian
OT_ERROR_NONE
Berhasil merilis ID router.
OT_ERROR_INVALID_ARGS
aRouterId tidak dalam rentang [0, 62].
OT_ERROR_INVALID_STATE
Saat ini perangkat tidak beroperasi sebagai posisi teratas.
OT_ERROR_NOT_FOUND
ID router saat ini tidak dialokasikan.

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Menetapkan apakah perangkat ditugaskan menggunakan CCM.

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

Setel 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 Pengembalian
OT_ERROR_NONE
Berhasil menetapkan nilai.
OT_ERROR_INVALID_STATE
Protokol thread diaktifkan.
Lihat juga:
otThreadGetChildRouterLinks

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Setel parameter CONTEXT_ID_REUSE_ unik yang digunakan dalam peran Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDelay
Nilai CONTEXT_ID_REUSE_ unik.
Lihat juga:
otThreadGetContextIdReuseDelay

otThreadSetDeviceProperties

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

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

Memerlukan OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE.

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

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Menetapkan Port UDP Joiner.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aJoinerUdpPort
Nomor Port UDP Penyambung.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menyetel Port UDP Joiner.
Lihat juga:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

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

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

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

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Menetapkan jumlah maksimum turunan yang diizinkan saat ini.

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

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

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Menyetel 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 jika 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 Pengembalian
OT_ERROR_NONE
Berhasil menyetel/menghapus nomor.
OT_ERROR_INVALID_ARGS
Jika melebihi jumlah maksimum yang diizinkan.
Lihat juga:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Setel parameter NETWORK_ID_TIMEOUT.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aTimeout
Nilai NETWORK_ID_TIMEOUT.
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 Pengembalian
OT_ERROR_NONE
Berhasil menetapkan prioritas induk.
OT_ERROR_INVALID_ARGS
Jika nilai prioritas induk tidak berada di antara 1, 0, -1 dan -2.
Lihat juga:
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Tetapkan ID Partisi Pemimpin Thread yang digunakan saat beroperasi dalam peran Pemimpin.

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

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Tetapkan ID Router yang diinginkan.

Setelah menjadi router/pemimpin, node mencoba menggunakan ID Router ini. Jika ID Router pilihan tidak ditetapkan atau 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 dipilih.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan ID Router yang diinginkan.
OT_ERROR_INVALID_STATE
Tidak dapat menetapkan (peran tidak dilepas atau dinonaktifkan)

otThreadSetPskc

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

Setel Thread PSKc.

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

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

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Setel Key Reference ke Thread PSKc.

Memerlukan pengaktifan fitur waktu build OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Hanya akan berhasil jika protokol Thread dinonaktifkan. Setelah berhasil, ini juga akan membatalkan Set Data Operasional Aktif dan Tertunda dalam memori non-volatil.

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

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Tetapkan parameter ROUTER_DOWNGRADE_DEADLINE yang digunakan dalam peran Pemimpin.

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

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Menetapkan apakah perangkat memenuhi syarat untuk router atau tidak.

Jika aEligible disetel ke salah (false) dan perangkat saat ini beroperasi sebagai router, panggilan ini akan menyebabkan perangkat terlepas dan mencoba memasangnya kembali sebagai turunan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEligible
TRUE untuk mengonfigurasi perangkat sebagai valid untuk router, FALSE untuk mengonfigurasi perangkat.
Nilai Pengembalian
OT_ERROR_NONE
Berhasil menetapkan konfigurasi yang memenuhi syarat router.
OT_ERROR_NOT_CAPABLE
Perangkat tidak mampu 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 Pengembalian
OT_ERROR_NONE
Berhasil menetapkan rentang.
OT_ERROR_INVALID_ARGS
aMinRouterId > aMaxRouterId, atau rentang tidak tercakup oleh [0, 62].
Lihat juga:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Tetapkan parameter ROUTER_SELECTION_JITTER yang digunakan dalam peran REED/Router.

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

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Tetapkan parameter ROUTER_UPGRADE_ingat yang digunakan dalam peran Pemimpin.

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

otThreadSetSteeringData

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

Setel data Pengarah dari tali.

Opsi konfigurasi OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE harus disetel untuk mengaktifkan setelan pengarahan data dari tali smartwatch.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aExtAddress
Alamat yang digunakan untuk memperbarui data mengemudi. Semua angka nol untuk menghapus data setir (tidak ada data pengarahan). Semua 0xFF untuk menyetel filter pengarah data/bloom untuk menerima/mengizinkan semua. EUI64 spesifik yang kemudian ditambahkan ke filter data/bloom pengarahan 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 pemilihan rute, FALSE jika tidak.

Makro

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Initializer untuk otChildIP6AddressIterator.

Referensi

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