Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.
Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Router/Pimpinan

Modul ini mencakup fungsi untuk Thread dan Router Thread.

Ringkasan

Enumerasi

otCacheEntryState enum
Enumerasi ini 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
Enumerasi ini menentukan konstanta yang digunakan dalam otNeighborTableCallback untuk menunjukkan perubahan dalam tabel tetangga.

Typedef

otCacheEntryInfo typedef
Struktur ini mewakili entri cache EID.
otCacheEntryIterator typedef
Jenis ini mewakili iterator yang digunakan untuk iterasi melalui entri tabel cache EID.
otCacheEntryState typedef
Enumerasi ini menentukan status entri cache EID.
otChildIp6AddressIterator typedef
uint16_t
Digunakan untuk melakukan iterasi melalui alamat IPv6 entri Thread Child.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
Pointer fungsi ini dipanggil untuk memberi tahu bahwa ada perubahan dalam tabel tetangga.

Functions

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 disertakan oleh indeks tabel internal.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Fungsi ini mendapatkan alamat IPv6 berikutnya (menggunakan iterator) untuk turunan tertentu.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
Dapatkan parameter CONFLICT_ID_REUSE_ANR yang digunakan dalam peran Pemimpin.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
Mendapatkan Port UDP Penggabung.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
Mendapatkan Thread Leader Weight yang digunakan saat beroperasi dalam peran Leader.
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_ARPPU yang digunakan dalam peran Router.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Fungsi ini mendapatkan entri EID cache berikutnya (menggunakan iterator).
otThreadGetParentPriority(otInstance *aInstance)
int8_t
Mendapatkan prioritas induk yang ditetapkan.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
Mendapatkan ID Partisi Thread Leader yang digunakan saat beroperasi dalam peran Leader.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
Mendapatkan PSKc Thread.
otThreadGetPskcRef(otInstance *aInstance)
Mendapatkan Referensi Kunci ke 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
Fungsi ini 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 Thread Router yang diberikan.
otThreadGetRouterSelectionJitter(otInstance *aInstance)
uint8_t
Dapatkan parameter ROUTER_SAMPLE_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
Metode ini menunjukkan apakah perangkat memenuhi syarat router atau tidak.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
Fungsi ini mendaftarkan fungsi callback tabel tetangga.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
Merilis ID Router yang telah dialokasikan oleh perangkat dalam peran Leader.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
Fungsi ini menetapkan apakah perangkat digunakan menggunakan CCM.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
Tetapkan parameter CONFLICT_ID_REUSE_ANR yang digunakan dalam peran Pemimpin.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
Menetapkan Joint UDP Port.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
Menetapkan Thread Leader Weight 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 alamat IP maksimum yang dapat didaftarkan oleh setiap turunan MTD dengan perangkat ini sebagai induk.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
Tetapkan parameter NETWORK_ID_lokasi yang digunakan dalam peran Pemimpin.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
Tetapkan prioritas induk.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
Menetapkan ID Partisi Thread Thread pilihan yang digunakan saat beroperasi dalam peran Leader.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
Setel ID Router pilihan.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
Menetapkan Thread PSKc.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
Menetapkan Thread PSKc.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Tetapkan parameter ROUTER_DOWNGRADE_THRESHOLD yang digunakan dalam peran Pemimpin.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
Fungsi ini menetapkan apakah perangkat memenuhi syarat router atau tidak.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Fungsi ini menetapkan rentang ID router yang diizinkan untuk ditetapkan ke node dalam jaringan thread.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
Tetapkan parameter ROUTER_Select_JITTER yang digunakan dalam peran REED/Router.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
Tetapkan parameter ROUTER_UPGRADE_THRESHOLD yang digunakan dalam peran Pimpinan.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Mengatur data Steering keluar dari band.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
Fungsi ini menetapkan apakah nilai minimum versi TLV Kebijakan Keamanan untuk pemilihan rute (kolom VR) diaktifkan.

Struct

otCacheEntryInfo

Struktur ini mewakili entri cache EID.

otCacheEntryIterator

Jenis ini mewakili iterator yang digunakan untuk iterasi melalui entri tabel cache EID.

otChildInfo

Struktur ini menyimpan informasi diagnostik untuk Thread Turunan.

otNeighborTableEntryInfo

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

Enumerasi

otCacheEntryState

 otCacheEntryState

Enumerasi ini menentukan status entri cache EID.

otNeighborTableEvent

 otNeighborTableEvent

Enumerasi ini menentukan konstanta yang digunakan dalam otNeighborTableCallback untuk menunjukkan perubahan dalam 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.

Typedef

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Struktur ini mewakili entri cache EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

Jenis ini mewakili iterator yang digunakan untuk iterasi melalui entri tabel cache EID.

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

otCacheEntryState

enum otCacheEntryState otCacheEntryState

Enumerasi ini menentukan status entri cache EID.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Digunakan untuk melakukan iterasi melalui alamat IPv6 entri Thread Child.

otNeighborTableCallback

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

Pointer fungsi ini dipanggil untuk memberi tahu bahwa ada perubahan dalam tabel tetangga.

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

Functions

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.

otThreadMenjadiRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Mencoba menjadi router.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mulai mencoba 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 Turunan atau RLOC16 untuk turunan yang dilampirkan.
[out] aChildInfo
Pointer tempat lokasi informasi turunan.
Nilai yang Ditampilkan
OT_ERROR_NONE
aChildInfo berhasil diperbarui dengan informasi untuk ID yang diberikan.
OT_ERROR_NOT_FOUND
Tidak ada anak 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 disertakan oleh indeks tabel internal.

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

otThreadGetChildNextIp6Alamat

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

Fungsi ini 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 diupdate agar mengarah ke entri berikutnya dalam daftar. Untuk mendapatkan alamat IPv6 pertama, iterator harus diatur ke OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Pointer ke alamat IPv6 tempat alamat berikutnya anak ditempatkan (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 adalah NULL, atau turunan pada aChildIndex tidak valid.
Lihat juga:
otThreadGetChildInfoByIndex

otThreadGetContextIdUnusedDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Dapatkan parameter CONFLICT_ID_REUSE_ANR yang digunakan dalam peran Pemimpin.

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

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Mendapatkan Port UDP Penggabung.

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

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Mendapatkan Thread Leader Weight yang digunakan saat beroperasi dalam peran Leader.

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

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Mendapatkan jumlah maksimum turunan yang saat ini diizinkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Jumlah maksimum turunan yang saat ini diizinkan.
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.
Hasil
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.
Hasil
ID router maksimum yang diizinkan.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Dapatkan parameter NETWORK_ID_ARPPU yang digunakan dalam peran Router.

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

otThreadGetNextCacheEntry

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

Fungsi ini mendapatkan entri EID cache 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. Nilai tersebut akan diperbarui agar mengarah ke entri berikutnya yang berhasil. Untuk mendapatkan entri pertama, lakukan inisialisasi iterator dengan menetapkan semua kolomnya ke nol (mis., 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 lagi dalam tabel cache alamat.

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

otThreadGetSelectedLeadereritionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

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

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Nilai ID Partisi Thread 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 ke Thread PSKc yang disimpan.

Fungsi ini memerlukan pengaktifan fitur waktu build OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Referensi Kunci 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.
Hasil
Nilai ROUTER_DOWNGRADE_THRESHOLD.
Lihat juga:
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdRange

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

Fungsi ini 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 Thread Router yang diberikan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aRouterId
ID router atau RLOC16 untuk router tertentu.
[out] aRouterInfo
Pointer tempat informasi router diletakkan.
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 adalah NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Dapatkan parameter ROUTER_SAMPLE_JITTER yang digunakan dalam peran REED/Router.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Nilai ROUTER_SAMPLE_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.
Hasil
Nilai ROUTER_UPGRADE_THRESHOLD.
Lihat juga:
otThreadSetRouterUpgradeThreshold

otThreadIsRouterValid

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Metode ini 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.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Fungsi ini mendaftarkan fungsi callback tabel tetangga.

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

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

Merilis 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 melepaskan ID router.
OT_ERROR_INVALID_ARGS
aRouterId tidak berada dalam rentang [0, 62].
OT_ERROR_INVALID_STATE
Perangkat saat ini tidak beroperasi sebagai posisi teratas.
OT_ERROR_NOT_FOUND
ID router saat ini tidak dialokasikan.

otThreadSetCcmDiaktifkan

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Fungsi ini menetapkan apakah perangkat digunakan menggunakan CCM.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEnabled
TRUE jika perangkat digunakan menggunakan CCM, FALSE jika tidak.

otThreadSetContextIdUseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Tetapkan parameter CONFLICT_ID_REUSE_ANR yang digunakan dalam peran Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDelay
Nilai CONFLICT_ID_REUSE_ANR.
Lihat juga:
otThreadGetContextIdUseDelay

OTThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Menetapkan Joint UDP Port.

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

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

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

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 saat ini diizinkan.

Parameter ini hanya dapat ditetapkan ketika operasi protokol Thread dihentikan.

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

otThreadSetMaxChildIpAlamat

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Menetapkan atau memulihkan jumlah alamat IP maksimum 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 melampaui jumlah maksimum yang diizinkan.
Lihat juga:
otThreadGetMaxChildIpAddress

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Tetapkan parameter NETWORK_ID_lokasi yang digunakan dalam peran Pemimpin.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aTimeout
Nilai NETWORK_ID_adtype.
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 di antara 1, 0, -1, dan -2.
Lihat juga:
otThreadGetParentPriority

otThreadSetSelectedLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

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

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

otThreadSetSelectedRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Setel ID Router pilihan.

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

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

OTThreadSetPskc

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

Menetapkan Thread PSKc.

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

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

OTThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Menetapkan Thread PSKc.

Fungsi ini memerlukan pengaktifan fitur waktu build OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

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

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

otThreadSetRouterDowngradeThreshold

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
)

Fungsi ini menetapkan apakah perangkat memenuhi syarat router atau tidak.

Jika aEligible salah dan perangkat saat ini beroperasi sebagai router, panggilan ini akan menyebabkan perangkat terlepas dan mencoba memasang ulang sebagai turunan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEligible
TRUE untuk mengonfigurasi perangkat sebagai memenuhi syarat router, FALSE jika tidak.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menyetel 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
)

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

ThreadThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Tetapkan parameter ROUTER_Select_JITTER yang digunakan dalam peran REED/Router.

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

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Tetapkan parameter ROUTER_UPGRADE_THRESHOLD yang digunakan dalam peran Pimpinan.

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
)

Mengatur data Steering keluar dari band.

Opsi konfigurasi OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE harus disetel untuk mengaktifkan setelan setir data.

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

otThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Fungsi ini 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 ambang batas versi TLV Kebijakan Keamanan untuk pemilihan rute, FALSE jika tidak.

Makro

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Penginisialisasi otChildIP6AddressIterator.

Materi

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