Contoh

Modul ini mencakup fungsi yang mengontrol Instans OpenThread.

Ringkasan

Pencacahan
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_MASTER_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 `otStateChangedCallback` ini mendefinisikan tanda yang diteruskan sebagai bagian dari `otStateChangedCallback` .

Pencacahan

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_MASTER_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

otStateChangedCallback ini mendefinisikan tanda yang diteruskan sebagai bagian dari otStateChangedCallback .

Typedefs
`otChangedFlags`	typedef `uint32_t` Jenis ini mewakili bit-field 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 atau perubahan status tertentu 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-volatile.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Metode ini menghapus semua pengaturan yang disimpan di memori non-volatile, dan kemudian memicu reset platform.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Fungsi ini menonaktifkan pustaka OpenThread.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Fungsi ini menginisialisasi pustaka OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` Fungsi ini menginisialisasi instance tunggal statis dari pustaka OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Fungsi ini menunjukkan apakah instance tersebut valid / diinisialisasi atau tidak.
`otInstanceReset ( otInstance *aInstance)`	`void` Metode ini memicu penyetelan ulang platform.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Fungsi ini menghapus callback untuk menunjukkan kapan 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.

Pencacahan

enum anonim

 anonymous enum

otStateChangedCallback ini mendefinisikan tanda yang diteruskan sebagai bagian dari otStateChangedCallback .

Properti
`OT_CHANGED_ACTIVE_DATASET`	Set Data Operasional Aktif berubah.
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Channel Manager, baru saluran Thread tertunda berubah.
`OT_CHANGED_COMMISSIONER_STATE`	Negara bagian 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_MASTER_KEY`	Kunci master berubah.
`OT_CHANGED_PENDING_DATASET`	Set Data Operasional Tertunda berubah.
`OT_CHANGED_PSKC`	PSKc berubah.
`OT_CHANGED_SECURITY_POLICY`	Kebijakan Keamanan berubah.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Masker saluran yang didukung berubah.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Konfigurasi Local Backbone Router berubah.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Status Backbone Router berubah.
`OT_CHANGED_THREAD_CHANNEL`	Saluran jaringan benang berubah.
`OT_CHANGED_THREAD_CHILD_ADDED`	Anak ditambahkan.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Anak telah dihapus.
`OT_CHANGED_THREAD_EXT_PANID`	ID PAN diperpanjang jaringan thread berubah.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Urutan Kunci Benang berubah.
`OT_CHANGED_THREAD_LL_ADDR`	Alamat link-local berubah.
`OT_CHANGED_THREAD_ML_ADDR`	Alamat mesh-local berubah.
`OT_CHANGED_THREAD_NETDATA`	Data Jaringan Benang berubah.
`OT_CHANGED_THREAD_NETIF_STATE`	Keadaan antarmuka jaringan benang 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 ditambahkan.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC telah dihapus.
`OT_CHANGED_THREAD_ROLE`	Peran (dinonaktifkan, terlepas, anak, router, pemimpin) berubah.

Typedefs

otChangedFlags

uint32_t otChangedFlags

Tipe ini mewakili bit-field yang menunjukkan status / konfigurasi tertentu yang telah berubah.

Lihat definisi OT_CHANGED_* .

otInstance

struct otInstance otInstance

.dll

Struktur ini mewakili struktur instance OpenThread.

otStateChangedCallback

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

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

Detail

Parameter

`[in] aFlags`	Bit-field yang menunjukkan status tertentu yang telah berubah. Lihat definisi `OT_CHANGED_*` .
`[in] aContext`	Penunjuk ke konteks khusus aplikasi.

Fungsi

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Fungsi ini mendapatkan string versi radio OpenThread.

Detail

Parameter

[in] aInstance

Penunjuk ke instance OpenThread.

Kembali

Penunjuk ke versi radio OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Fungsi ini mendapatkan string versi OpenThread.

Detail
Kembali	Penunjuk ke versi OpenThread.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

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

Penghapusan berhasil hanya jika perangkat dalam status / peran disabled .

Detail

Parameter

[in] aInstance

Penunjuk ke instance OpenThread.

Kembalikan Nilai

`OT_ERROR_NONE`	Semua info / status yang ada berhasil dihapus.
`OT_ERROR_INVALID_STATE`	Perangkat tidak dalam status / peran `disabled` .

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Metode ini menghapus semua pengaturan yang disimpan di memori non-volatile, dan kemudian memicu reset platform.

Detail

Parameter

[in] aInstance

Penunjuk ke instance OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Fungsi ini menonaktifkan pustaka OpenThread.

Panggil fungsi ini saat OpenThread tidak lagi digunakan.

Detail

Parameter

[in] aInstance

Penunjuk ke instance OpenThread.

otInstanceInit

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

Fungsi ini menginisialisasi pustaka OpenThread.

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

Fungsi ini tersedia dan hanya dapat digunakan jika dukungan untuk beberapa instans OpenThread diaktifkan.

Detail

Parameter

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

Kembali

Sebuah pointer ke instance OpenThread baru.

Lihat juga:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

Fungsi ini menginisialisasi instance tunggal statis dari pustaka OpenThread.

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

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

Detail
Kembali	Penunjuk ke satu instance OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Fungsi ini menunjukkan apakah instance tersebut valid / diinisialisasi atau tidak.

Instance dianggap valid jika diperoleh dan diinisialisasi menggunakan otInstanceInitSingle() (dalam kasus instans tunggal) atau otInstanceInit() (dalam kasus multi instans). Panggilan berikutnya ke otInstanceFinalize() menyebabkan instance dianggap tidak diinisialisasi.

Detail

Parameter

[in] aInstance

Penunjuk ke instance OpenThread.

Kembali

TRUE jika contoh yang diberikan valid / diinisialisasi, FALSE sebaliknya.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Metode ini memicu penyetelan ulang platform.

Proses reset memastikan bahwa semua status / info OpenThread (disimpan dalam memori volatile) dihapus. Perhatikan bahwa otPlatformReset tidak menghapus status / info persisten yang disimpan dalam memori non-volatile.

Detail

Parameter

[in] aInstance

Penunjuk ke instance OpenThread.

otRemoveStateChangeCallback

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

Fungsi ini menghapus callback untuk menunjukkan kapan konfigurasi atau status tertentu berubah dalam OpenThread.

Detail

Parameter

`[in] aInstance`	Penunjuk ke instance OpenThread.
`[in] aCallback`	Penunjuk ke fungsi yang dipanggil dengan konfigurasi atau perubahan status tertentu.
`[in] aContext`	Penunjuk 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.

Detail

Parameter

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

Kembalikan Nilai

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