Contoh

Modul ini mencakup fungsi yang mengontrol Instance OpenThread.

Ringkasan

Enumerasi
anonymous enum { OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, OT_CHANGED_THREAD_ROLE = 1 << 2, OT_CHANGED_THREAD_LL_ADDR = 1 << 3, OT_CHANGED_THREAD_ML_ADDR = 1 << 4, OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, OT_CHANGED_THREAD_NETDATA = 1 << 9, OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, OT_CHANGED_THREAD_CHANNEL = 1 << 14, OT_CHANGED_THREAD_PANID = 1 << 15, OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, OT_CHANGED_THREAD_EXT_PANID = 1 << 17, OT_CHANGED_NETWORK_KEY = 1 << 18, OT_CHANGED_PSKC = 1 << 19, OT_CHANGED_SECURITY_POLICY = 1 << 20, OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, OT_CHANGED_COMMISSIONER_STATE = 1 << 23, OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, OT_CHANGED_JOINER_STATE = 1 << 27, OT_CHANGED_ACTIVE_DATASET = 1 << 28, OT_CHANGED_PENDING_DATASET = 1 << 29 }	enum Pencacahan ini mendefinisikan bendera yang disahkan sebagai bagian dari `otStateChangedCallback` .

Enumerasi

anonymous enum {
 OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
 OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
 OT_CHANGED_THREAD_ROLE = 1 << 2,
 OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
 OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
 OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
 OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
 OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
 OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
 OT_CHANGED_THREAD_NETDATA = 1 << 9,
 OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
 OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
 OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
 OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
 OT_CHANGED_THREAD_CHANNEL = 1 << 14,
 OT_CHANGED_THREAD_PANID = 1 << 15,
 OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
 OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
 OT_CHANGED_NETWORK_KEY = 1 << 18,
 OT_CHANGED_PSKC = 1 << 19,
 OT_CHANGED_SECURITY_POLICY = 1 << 20,
 OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
 OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
 OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
 OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
 OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
 OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
 OT_CHANGED_JOINER_STATE = 1 << 27,
 OT_CHANGED_ACTIVE_DATASET = 1 << 28,
 OT_CHANGED_PENDING_DATASET = 1 << 29
 }

enum

Pencacahan ini mendefinisikan bendera yang disahkan sebagai bagian dari otStateChangedCallback .

Typedefs
`otChangedFlags`	typedef `uint32_t` Jenis ini mewakili bidang bit yang menunjukkan status/konfigurasi tertentu yang telah berubah.
`otInstance`	typedef `struct otInstance` Struktur ini mewakili struktur instance OpenThread.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	typedef `void(*` Penunjuk fungsi ini dipanggil untuk memberi tahu konfigurasi tertentu atau perubahan status dalam OpenThread.

Fungsi
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Fungsi ini mendapatkan string versi radio OpenThread.
`otGetVersionString (void)`	`const char *` Fungsi ini mendapatkan string versi OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Fungsi ini menghapus semua info persisten OpenThread (pengaturan jaringan) yang disimpan di memori non-volatil.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Metode ini menghapus semua pengaturan yang tersimpan di memori non-volatil, dan kemudian memicu penyetelan ulang platform.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Fungsi ini menonaktifkan perpustakaan OpenThread.
`otInstanceGetUptime ( otInstance *aInstance)`	`uint64_t` Fungsi ini mengembalikan uptime instance saat ini (dalam msec).
`otInstanceGetUptimeAsString ( otInstance aInstance, char aBuffer, uint16_t aSize)`	`void` Fungsi ini mengembalikan uptime instance saat ini sebagai string yang dapat dibaca manusia.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Fungsi ini menginisialisasi perpustakaan OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` Fungsi ini menginisialisasi instance tunggal statis dari library OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Fungsi ini menunjukkan apakah instance valid/diinisialisasi atau tidak.
`otInstanceReset ( otInstance *aInstance)`	`void` Metode ini memicu reset platform.
`otInstanceResetRadioStack ( otInstance *aInstance)`	`void` Metode ini mengatur ulang status internal tumpukan radio OpenThread.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Fungsi ini menghapus panggilan balik untuk menunjukkan ketika konfigurasi atau status tertentu berubah dalam OpenThread.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Fungsi ini mendaftarkan panggilan balik untuk menunjukkan ketika konfigurasi atau status tertentu berubah dalam OpenThread.

Enumerasi

enum anonim

 anonymous enum

Pencacahan ini mendefinisikan bendera yang disahkan sebagai bagian dari otStateChangedCallback .

Properti
`OT_CHANGED_ACTIVE_DATASET`	Dataset Operasional Aktif berubah.
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Channel Manager baru saluran Utas tertunda berubah.
`OT_CHANGED_COMMISSIONER_STATE`	Status komisaris berubah.
`OT_CHANGED_IP6_ADDRESS_ADDED`	Alamat IPv6 telah ditambahkan.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	Alamat IPv6 telah dihapus.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Berlangganan ke alamat multicast IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Berhenti berlangganan dari alamat multicast IPv6.
`OT_CHANGED_JOINER_STATE`	Status joiner berubah.
`OT_CHANGED_NETWORK_KEY`	Kunci jaringan berubah.
`OT_CHANGED_PENDING_DATASET`	Dataset Operasional Tertunda berubah.
`OT_CHANGED_PSKC`	PSKc berubah.
`OT_CHANGED_SECURITY_POLICY`	Kebijakan Keamanan berubah.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Masker saluran yang didukung telah diubah.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Konfigurasi Router Backbone Lokal berubah.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Status Router Tulang Belakang berubah.
`OT_CHANGED_THREAD_CHANNEL`	Saluran jaringan utas berubah.
`OT_CHANGED_THREAD_CHILD_ADDED`	Anak telah ditambahkan.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Anak telah dihapus.
`OT_CHANGED_THREAD_EXT_PANID`	ID PAN yang diperluas jaringan utas berubah.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Urutan Kunci Utas berubah.
`OT_CHANGED_THREAD_LL_ADDR`	Alamat tautan-lokal berubah.
`OT_CHANGED_THREAD_ML_ADDR`	Alamat mesh-local berubah.
`OT_CHANGED_THREAD_NETDATA`	Data Jaringan Utas berubah.
`OT_CHANGED_THREAD_NETIF_STATE`	Status antarmuka jaringan utas berubah.
`OT_CHANGED_THREAD_NETWORK_NAME`	Nama jaringan utas berubah.
`OT_CHANGED_THREAD_PANID`	Id PAN jaringan utas berubah.
`OT_CHANGED_THREAD_PARTITION_ID`	ID partisi berubah.
`OT_CHANGED_THREAD_RLOC_ADDED`	RLOC telah ditambahkan.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC telah dihapus.
`OT_CHANGED_THREAD_ROLE`	Peran (dinonaktifkan, terlepas, anak, router, pemimpin) berubah.

Typedefs

otBerubahBendera

uint32_t otChangedFlags

Jenis ini mewakili bidang bit yang menunjukkan status/konfigurasi tertentu yang telah berubah.

Lihat OT_CHANGED_* definisi.

otInstance

struct otInstance otInstance

Struktur ini mewakili struktur instance OpenThread.

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

Penunjuk fungsi ini dipanggil untuk memberi tahu konfigurasi tertentu atau perubahan status dalam OpenThread.

rincian

Parameter

`[in] aFlags`	Bidang bit yang menunjukkan status tertentu yang telah berubah. Lihat `OT_CHANGED_*` definisi.
`[in] aContext`	Pointer ke konteks khusus aplikasi.

Fungsi

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Fungsi ini mendapatkan string versi radio OpenThread.

rincian

Parameter

[in] aInstance

Pointer ke instance OpenThread.

Kembali

Sebuah pointer ke versi radio OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Fungsi ini mendapatkan string versi OpenThread.

rincian
Kembali	Sebuah pointer ke versi OpenThread.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Fungsi ini menghapus semua info persisten OpenThread (pengaturan jaringan) yang disimpan di memori non-volatil.

Erase berhasil hanya jika perangkat dalam disabled negara / peran.

rincian

Parameter

[in] aInstance

Pointer ke instance OpenThread.

Mengembalikan Nilai

`OT_ERROR_NONE`	Semua info/status persisten berhasil dihapus.
`OT_ERROR_INVALID_STATE`	Perangkat tidak dalam `disabled` negara / peran.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Metode ini menghapus semua pengaturan yang tersimpan di memori non-volatil, dan kemudian memicu penyetelan ulang platform.

rincian

Parameter

[in] aInstance

Pointer ke instance OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Fungsi ini menonaktifkan perpustakaan OpenThread.

Panggil fungsi ini saat OpenThread tidak lagi digunakan.

rincian

Parameter

[in] aInstance

Pointer ke instance OpenThread.

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

Fungsi ini mengembalikan uptime instance saat ini (dalam msec).

Fungsi ini membutuhkan OPENTHREAD_CONFIG_UPTIME_ENABLE harus diaktifkan.

Uptime diberikan sebagai jumlah milidetik sejak instance OpenThread diinisialisasi.

rincian

Parameter

[in] aInstance

Pointer ke instance OpenThread.

Kembali

Waktu aktif (jumlah milidetik).

otInstanceGetUptimeAsString

void otInstanceGetUptimeAsString(
  otInstance *aInstance,
  char *aBuffer,
  uint16_t aSize
)

Fungsi ini mengembalikan uptime instance saat ini sebagai string yang dapat dibaca manusia.

Fungsi ini membutuhkan OPENTHREAD_CONFIG_UPTIME_ENABLE harus diaktifkan.

String mengikuti format " : : . " untuk jam, menit, detik, dan milidetik (jika waktu aktif lebih pendek dari satu hari) atau "

D. : : . " (jika lebih dari sehari).

Jika string yang dihasilkan tidak cocok di aBuffer (dalam nya aSize karakter), string akan dipotong tapi string dikeluarkan selalu null-dihentikan.

rincian

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[out] aBuffer`	Pointer ke array char untuk menampilkan string.
`[in] aSize`	Ukuran `aBuffer` (dalam byte). Dianjurkan untuk menggunakan `OT_UPTIME_STRING_SIZE` .

otInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

Fungsi ini menginisialisasi perpustakaan OpenThread.

Fungsi ini menginisialisasi OpenThread dan mempersiapkannya untuk panggilan OpenThread API berikutnya. Fungsi ini harus dipanggil sebelum panggilan lain ke OpenThread.

Fungsi ini tersedia dan hanya dapat digunakan ketika dukungan untuk beberapa instance OpenThread diaktifkan.

rincian

Parameter

`[in] aInstanceBuffer`	Buffer untuk OpenThread digunakan untuk mengalokasikan struktur otInstance.
`[in,out] aInstanceBufferSize`	Pada input, ukuran aInstanceBuffer. Pada output, jika tidak cukup ruang untuk otInstance, jumlah byte yang diperlukan untuk otInstance.

Kembali

Pointer ke instance OpenThread baru.

Lihat juga:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

Fungsi ini menginisialisasi instance tunggal statis dari library OpenThread.

Fungsi ini menginisialisasi OpenThread dan mempersiapkannya untuk panggilan OpenThread API berikutnya. Fungsi ini harus dipanggil sebelum panggilan lain ke OpenThread.

Fungsi ini tersedia dan hanya dapat digunakan ketika dukungan untuk beberapa instans OpenThread dinonaktifkan.

rincian
Kembali	Pointer ke instance OpenThread tunggal.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Fungsi ini menunjukkan apakah instance valid/diinisialisasi atau tidak.

Contoh dianggap sah jika diperoleh dan diinisialisasi baik menggunakan otInstanceInitSingle() (dalam hal kasus tunggal) atau otInstanceInit() (dalam hal kasus multifinance). Sebuah panggilan berikutnya untuk otInstanceFinalize() menyebabkan contoh dianggap sebagai diinisiasi.

rincian

Parameter

[in] aInstance

Pointer ke instance OpenThread.

Kembali

TRUE jika instance yang diberikan valid/diinisialisasi, FALSE jika tidak.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Metode ini memicu reset platform.

Proses reset memastikan bahwa semua status/info OpenThread (disimpan dalam memori yang mudah menguap) terhapus. Perhatikan bahwa otPlatformReset tidak menghapus negara terus-menerus / info disimpan dalam memori non-volatile.

rincian

Parameter

[in] aInstance

Pointer ke instance OpenThread.

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

Metode ini mengatur ulang status internal tumpukan radio OpenThread.

Callback dan konfigurasi dipertahankan.

API ini hanya tersedia di bawah radio membangun ( OPENTHREAD_RADIO = 1 ).

rincian

Parameter

[in] aInstance

Pointer ke instance OpenThread.

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Fungsi ini menghapus panggilan balik untuk menunjukkan ketika konfigurasi atau status tertentu berubah dalam OpenThread.

rincian

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aCallback`	Pointer ke fungsi yang dipanggil dengan konfigurasi atau status tertentu berubah.
`[in] aContext`	Pointer ke konteks khusus aplikasi.

otSetStateChangedCallback

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

Fungsi ini mendaftarkan panggilan balik untuk menunjukkan ketika konfigurasi atau status tertentu berubah dalam OpenThread.

rincian

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aCallback`	Pointer ke fungsi yang dipanggil dengan konfigurasi atau status tertentu berubah.
`[in] aContext`	Pointer ke konteks khusus aplikasi.

Mengembalikan Nilai

`OT_ERROR_NONE`	Menambahkan panggilan balik ke daftar panggilan balik.
`OT_ERROR_ALREADY`	Panggilan balik sudah terdaftar.
`OT_ERROR_NO_BUFS`	Tidak dapat menambahkan panggilan balik karena keterbatasan sumber daya.

makro

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

Ukuran yang disarankan untuk representasi string waktu aktif.