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

Instance

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
Enumerasi ini menentukan flag yang diteruskan sebagai bagian dari otStateChangedCallback.

Typedef

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

Functions

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)
Fungsi ini menghapus semua info persisten OpenThread (setelan jaringan) yang disimpan di memori yang tidak stabil.
otInstanceFactoryReset(otInstance *aInstance)
void
Menghapus semua setelan yang disimpan di memori non-volatil, lalu memicu reset platform.
otInstanceFinalize(otInstance *aInstance)
void
Fungsi ini menonaktifkan library OpenThread.
otInstanceGetUptime(otInstance *aInstance)
uint64_t
Fungsi ini menampilkan waktu beroperasi instance saat ini (dalam milidetik).
otInstanceGetUptimeAsString(otInstance *aInstance, char *aBuffer, uint16_t aSize)
void
Fungsi ini menampilkan waktu beroperasi instance saat ini sebagai string yang dapat dibaca manusia.
otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize)
Fungsi ini menginisialisasi library OpenThread.
otInstanceInitSingle(void)
Fungsi ini menginisialisasi instance tunggal statis dari library OpenThread.
otInstanceIsInitialized(otInstance *aInstance)
bool
Fungsi ini menunjukkan apakah instance valid/diinisialisasi.
otInstanceReset(otInstance *aInstance)
void
Metode ini memicu reset platform.
otInstanceResetRadioStack(otInstance *aInstance)
void
Metode ini mereset status internal stack radio OpenThread.
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)
Fungsi ini mendaftarkan callback untuk menunjukkan kapan konfigurasi atau status tertentu berubah dalam OpenThread.

Enumerasi

enum anonim

 anonymous enum

Enumerasi ini menentukan flag yang diteruskan sebagai bagian dari otStateChangedCallback.

Properti
OT_CHANGED_ACTIVE_DATASET

Set Data Operasional Aktif diubah.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

Channel Thread tertunda baru dari Pengelola Saluran diubah.

OT_CHANGED_COMMISSIONER_STATE

Status komisioner diubah.

OT_CHANGED_IP6_ADDRESS_ADDED

Alamat IPv6 telah ditambahkan.

OT_CHANGED_IP6_ADDRESS_REMOVED

Alamat IPv6 telah dihapus.

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

Berlangganan alamat multicast IPv6.

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

Berhenti berlangganan alamat multicast IPv6.

OT_CHANGED_JOINER_STATE

Status join diubah.

OT_CHANGED_NETWORK_KEY

Kunci jaringan diubah.

OT_CHANGED_PENDING_DATASET

Set Data Operasional yang tertunda telah diubah.

OT_CHANGED_PSKC

PSKc berubah.

OT_CHANGED_SECURITY_POLICY

Kebijakan Keamanan diubah.

OT_CHANGED_SUPPORTED_CHANNEL_MASK

Masker saluran yang didukung diubah.

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

Konfigurasi Router Backbone Lokal diubah.

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

Status Backbone Router diubah.

OT_CHANGED_THREAD_CHANNEL

Saluran jaringan rangkaian pesan diubah.

OT_CHANGED_THREAD_CHILD_ADDED

Anak telah ditambahkan.

OT_CHANGED_THREAD_CHILD_REMOVED

Anak dihapus.

OT_CHANGED_THREAD_EXT_PANID

ID PAN diperpanjang jaringan thread diubah.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

Urutan Kunci Rangkaian Pesan diubah.

OT_CHANGED_THREAD_LL_ADDR

Alamat link-local diubah.

OT_CHANGED_THREAD_ML_ADDR

Alamat mesh-local diubah.

OT_CHANGED_THREAD_NETDATA

Data Jaringan Thread diubah.

OT_CHANGED_THREAD_NETIF_STATE

Status antarmuka jaringan thread diubah.

OT_CHANGED_THREAD_NETWORK_NAME

Nama jaringan rangkaian pesan diubah.

OT_CHANGED_THREAD_PANID

ID PAN jaringan thread diubah.

OT_CHANGED_THREAD_PARTITION_ID

ID partisi diubah.

OT_CHANGED_THREAD_RLOC_ADDED

RLOC ditambahkan.

OT_CHANGED_THREAD_RLOC_REMOVED

RLOC dihapus.

OT_CHANGED_THREAD_ROLE

Peran (dinonaktifkan, terlepas, turunan, router, pemimpin) diubah.

Typedef

otChangedFlags

uint32_t otChangedFlags

Jenis ini mewakili kolom bit yang menunjukkan status/konfigurasi tertentu yang telah diubah.

Lihat definisi OT_CHANGED_*.

OTInstance

struct otInstance otInstance

Struktur ini mewakili struktur instance OpenThread.

otStateChangedCallback

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

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

Detail
Parameter
[in] aFlags
Kolom bit yang menunjukkan status tertentu yang telah diubah. Lihat definisi OT_CHANGED_*.
[in] aContext
Pointer untuk konteks khusus aplikasi.

Functions

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Fungsi ini mendapatkan string versi radio OpenThread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke versi radio OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Fungsi ini mendapatkan string versi OpenThread.

Detail
Hasil
Pointer ke versi OpenThread.

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Fungsi ini menghapus semua info persisten OpenThread (setelan jaringan) yang disimpan di memori yang tidak stabil.

Penghapusan hanya berhasil jika perangkat dalam status/peran disabled.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
OT_ERROR_NONE
Semua info/status persisten berhasil dihapus.
OT_ERROR_INVALID_STATE
Perangkat tidak dalam status/peran disabled.

OtInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

Menghapus semua setelan yang disimpan di memori non-volatil, lalu memicu reset platform.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otInstanceFinalisasi

void otInstanceFinalize(
  otInstance *aInstance
)

Fungsi ini menonaktifkan library OpenThread.

Panggil fungsi ini saat OpenThread tidak lagi digunakan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

Fungsi ini menampilkan waktu beroperasi instance saat ini (dalam milidetik).

Fungsi ini memerlukan pengaktifan OPENTHREAD_CONFIG_UPTIME_ENABLE.

Waktu beroperasi diberikan sebagai jumlah milidetik sejak instance OpenThread diinisialisasi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Waktu beroperasi (jumlah milidetik).

otInstanceGetUptimeAsString

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

Fungsi ini menampilkan waktu beroperasi instance saat ini sebagai string yang dapat dibaca manusia.

Fungsi ini memerlukan pengaktifan OPENTHREAD_CONFIG_UPTIME_ENABLE.

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

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

Jika string yang dihasilkan tidak sesuai dengan aBuffer (dalam karakter aSize), string akan terpotong, tetapi string yang dihasilkan selalu diakhiri dengan null.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aBuffer
Pointer ke array char untuk menghasilkan string.
[in] aSize
Ukuran aBuffer (dalam byte). Sebaiknya gunakan OT_UPTIME_STRING_SIZE.

otInstanceInit

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

Fungsi ini menginisialisasi library OpenThread.

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

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

Detail
Parameter
[in] aInstanceBuffer
Buffering 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.
Hasil
Pointer ke instance OpenThread baru.
Lihat juga:
otInstanceFinalize

otInstanceInitSatu

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 lainnya ke OpenThread.

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

Detail
Hasil
Pointer ke instance OpenThread tunggal.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Fungsi ini menunjukkan apakah instance valid/diinisialisasi.

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

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
TRUE jika instance yang diberikan valid/diinisialisasi, FALSE jika tidak.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Metode ini memicu reset platform.

Proses reset akan memastikan bahwa semua status/info OpenThread (disimpan dalam memori yang tidak stabil) dihapus. Perlu diperhatikan bahwa otPlatformReset tidak menghapus status/info persisten yang disimpan dalam memori yang tidak stabil.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

Metode ini mereset status internal stack radio OpenThread.

Callback dan konfigurasi dipertahankan.

API ini hanya tersedia pada build radio (OPENTHREAD_RADIO = 1).

Detail
Parameter
[in] aInstance
Pointer 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
Pointer ke instance OpenThread.
[in] aCallback
Pointer ke fungsi yang dipanggil dengan konfigurasi atau perubahan status tertentu.
[in] aContext
Pointer untuk konteks khusus aplikasi.

otSetStateChangedCallback

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

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

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer ke fungsi yang dipanggil dengan konfigurasi atau perubahan status tertentu.
[in] aContext
Pointer untuk konteks khusus aplikasi.
Nilai yang Ditampilkan
OT_ERROR_NONE
Menambahkan callback ke daftar callback.
OT_ERROR_ALREADY
Callback sudah terdaftar.
OT_ERROR_NO_BUFS
Tidak dapat menambahkan callback karena keterbatasan resource.

Makro

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

Ukuran yang direkomendasikan untuk representasi string waktu beroperasi.

Resource

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