Örnek

Bu modül, OpenThread Örneği'ni kontrol eden işlevler içerir.

Özet

Sıralamalar

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
Bu sıralama, otStateChangedCallback kapsamında iletilen işaretleri tanımlar.

Türler

otChangedFlags Tür
uint32_t
Bu tür, değişen belirli durumu/yapılandırmayı belirten bir bit alanını temsil eder.
otInstance Tür
struct otInstance
Bu yapı, OpenThread örneği yapısını temsil eder.
otStateChangedCallback)(otChangedFlags aFlags, void *aContext) Tür
void(*
Bu işlev işaretçisi, OpenThread içindeki belirli yapılandırma veya durum değişikliklerini bildirmek için çağrılır.

İşlevler

otGetRadioVersionString(otInstance *aInstance)
const char *
Bu işlev, OpenThread radyo sürüm dizesini alır.
otGetVersionString(void)
const char *
Bu işlev, OpenThread sürüm dizesini alır.
otInstanceErasePersistentInfo(otInstance *aInstance)
Bu işlev, kalıcı olmayan bellekte depolanan tüm OpenThread kalıcı bilgilerini (ağ ayarları) siler.
otInstanceFactoryReset(otInstance *aInstance)
void
Bu yöntem, kalıcı olmayan bellekte depolanan tüm ayarları siler ve platformun sıfırlanmasını tetikler.
otInstanceFinalize(otInstance *aInstance)
void
Bu işlev, OpenThread kitaplığını devre dışı bırakır.
otInstanceGetUptime(otInstance *aInstance)
uint64_t
Bu işlev, geçerli örnek çalışma süresini (m/sn) döndürür.
otInstanceGetUptimeAsString(otInstance *aInstance, char *aBuffer, uint16_t aSize)
void
Bu işlev, geçerli örnek çalışma süresini kullanıcılar tarafından okunabilir bir dize olarak döndürür.
otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize)
Bu işlev, OpenThread kitaplığını başlatır.
otInstanceInitSingle(void)
Bu işlev, OpenThread kitaplığının statik tek örneğini başlatır.
otInstanceIsInitialized(otInstance *aInstance)
bool
Bu işlev, örneğin geçerli/başlatılmış olup olmadığını gösterir.
otInstanceReset(otInstance *aInstance)
void
Bu yöntem platformun sıfırlanmasını tetikler.
otInstanceResetRadioStack(otInstance *aInstance)
void
Bu yöntem, OpenThread radyo yığınının dahili durumlarını sıfırlar.
otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
Bu işlev, OpenThread içinde belirli yapılandırma veya durumun ne zaman değiştiğini belirtmek için geri çağırmayı kaldırır.
otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
Bu işlev, OpenThread içinde belirli yapılandırma veya durumun ne zaman değiştiğini belirtmek için bir geri çağırma kaydeder.

Sıralamalar

anonim enum

 anonymous enum

Bu sıralama, otStateChangedCallback kapsamında iletilen işaretleri tanımlar.

Özellikler
OT_CHANGED_ACTIVE_DATASET

Etkin Operasyonel Veri Kümesi değiştirildi.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

Kanal Yöneticisi'nin yeni bekleyen Mesaj dizisi kanalı değişti.

OT_CHANGED_COMMISSIONER_STATE

Komisyoncu durumu değişti.

OT_CHANGED_IP6_ADDRESS_ADDED

IPv6 adresi eklendi.

OT_CHANGED_IP6_ADDRESS_REMOVED

IPv6 adresi kaldırıldı.

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

IPv6 çoklu yayın adresine abone olundu.

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

IPv6 çoklu yayın adresinin aboneliğinden çıkıldı.

OT_CHANGED_JOINER_STATE

Tamamlayıcı durumu değişti.

OT_CHANGED_NETWORK_KEY

Ağ anahtarı değişti.

OT_CHANGED_PENDING_DATASET

Beklemedeki İşlem Veri Kümesi değiştirildi.

OT_CHANGED_PSKC

PSKc değişti.

OT_CHANGED_SECURITY_POLICY

Güvenlik Politikası değişti.

OT_CHANGED_SUPPORTED_CHANNEL_MASK

Desteklenen kanal maskesi değiştirildi.

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

Yerel Omurga Yönlendirici yapılandırması değişti.

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

Omurga Yönlendirici durumu değişti.

OT_CHANGED_THREAD_CHANNEL

Mesaj dizisi ağ kanalı değiştirildi.

OT_CHANGED_THREAD_CHILD_ADDED

Çocuk eklendi.

OT_CHANGED_THREAD_CHILD_REMOVED

Çocuk kaldırıldı.

OT_CHANGED_THREAD_EXT_PANID

Mesaj dizisi ağı genişletilmiş PAN kimliği değiştirildi.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

Mesaj Dizisi Anahtar Sırası değiştirildi.

OT_CHANGED_THREAD_LL_ADDR

Bağlantı yerel adresi değişti.

OT_CHANGED_THREAD_ML_ADDR

Örgü yerel adresi değişti.

OT_CHANGED_THREAD_NETDATA

Mesaj Dizisi Ağ Verileri değişti.

OT_CHANGED_THREAD_NETIF_STATE

Mesaj dizisi ağ arayüzü durumu değişti.

OT_CHANGED_THREAD_NETWORK_NAME

Mesaj dizisi ağ adı değiştirildi.

OT_CHANGED_THREAD_PANID

Mesaj dizisi ağı PAN kimliği değişti.

OT_CHANGED_THREAD_PARTITION_ID

Bölüm kimliği değişti.

OT_CHANGED_THREAD_RLOC_ADDED

RLOC eklendi.

OT_CHANGED_THREAD_RLOC_REMOVED

RLOC kaldırıldı.

OT_CHANGED_THREAD_ROLE

Rol (devre dışı, ayrılmış, alt, yönlendirici, lider) değiştirildi.

Türler

otChangedİşaretler

uint32_t otChangedFlags

Bu tür, değişen belirli durumu/yapılandırmayı belirten bir bit alanını temsil eder.

OT_CHANGED_* tanımları göster.

OctInance

struct otInstance otInstance

Bu yapı, OpenThread örneği yapısını temsil eder.

otStateChangedGeri Çağırma

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

Bu işlev işaretçisi, OpenThread içindeki belirli yapılandırma veya durum değişikliklerini bildirmek için çağrılır.

Ayrıntılar
Parametreler
[in] aFlags
Değişen belirli durumu belirten bir bit alanı. OT_CHANGED_* tanımları göster.
[in] aContext
Uygulamaya özel bağlama işaretçi.

İşlevler

otGetRadioVersionDize

const char * otGetRadioVersionString(
  otInstance *aInstance
)

Bu işlev, OpenThread radyo sürüm dizesini alır.

Ayrıntılar
Parametreler
[in] aInstance
Bir OpenThread örneğine bir işaretçi.
İadeler
OpenThread radyo sürümünün işaretçisi.

otGetVersionString

const char * otGetVersionString(
  void
)

Bu işlev, OpenThread sürüm dizesini alır.

Ayrıntılar
İadeler
OpenThread sürümünün işaretçisi.

otInstanceDeleteKalıcıBilgi

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Bu işlev, kalıcı olmayan bellekte depolanan tüm OpenThread kalıcı bilgilerini (ağ ayarları) siler.

Silme işlemi yalnızca cihaz disabled durumunda/roldeyse başarılı olur.

Ayrıntılar
Parametreler
[in] aInstance
Bir OpenThread örneğine bir işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
Kalıcı tüm bilgiler/durumlar başarıyla silindi.
OT_ERROR_INVALID_STATE
Cihaz disabled durumunda/rolde değil.

otInstanceFactorySıfırla

void otInstanceFactoryReset(
  otInstance *aInstance
)

Bu yöntem, kalıcı olmayan bellekte depolanan tüm ayarları siler ve platformun sıfırlanmasını tetikler.

Ayrıntılar
Parametreler
[in] aInstance
Bir OpenThread örneğine bir işaretçi.

otInstanceNihai

void otInstanceFinalize(
  otInstance *aInstance
)

Bu işlev, OpenThread kitaplığını devre dışı bırakır.

OpenThread artık kullanılmıyorsa bu işlevi çağırın.

Ayrıntılar
Parametreler
[in] aInstance
Bir OpenThread örneğine bir işaretçi.

otInstanceGetUp Süresi

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

Bu işlev, geçerli örnek çalışma süresini (m/sn) döndürür.

Bu işlev, OPENTHREAD_CONFIG_UPTIME_ENABLE özelliğinin etkinleştirilmesini gerektirir.

OpenThread örneği ilk kullanıma hazırlandığından itibaren çalışma süresi, milisaniye cinsinden verilir.

Ayrıntılar
Parametreler
[in] aInstance
Bir OpenThread örneğine bir işaretçi.
İadeler
Çalışma süresi (milisaniye cinsinden).

otInstanceGetUptimeAsString

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

Bu işlev, geçerli örnek çalışma süresini kullanıcılar tarafından okunabilir bir dize olarak döndürür.

Bu işlev, OPENTHREAD_CONFIG_UPTIME_ENABLE özelliğinin etkinleştirilmesini gerektirir.

Dize; "&",::.&;

g.::." (bir günden uzunsa).

Oluşturulan dize aBuffer karakterine (aSize karakteri içinde) uymuyorsa dize kesilir, ancak ortaya çıkan dize her zaman null olarak sonlandırılır.

Ayrıntılar
Parametreler
[in] aInstance
Bir OpenThread örneğine bir işaretçi.
[out] aBuffer
Dizeyi oluşturmak için bir karakter dizisine işaret eden.
[in] aSize
aBuffer boyutu (bayt cinsinden). OT_UPTIME_STRING_SIZE kullanmanız önerilir.

otInstanceInit

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

Bu işlev, OpenThread kitaplığını başlatır.

Bu işlev, OpenThread öğesini başlatır ve sonraki OpenThread API çağrıları için hazırlar. Bu işlev, diğer tüm OpenThread çağrılarından önce çağrılmalıdır.

Bu işlev yalnızca birden fazla OpenThread örneği desteği etkinken kullanılabilir.

Ayrıntılar
Parametreler
[in] aInstanceBuffer
otInstance yapısını ayırt etmek için kullanılacak OpenThread arabelleği.
[in,out] aInstanceBufferSize
Girişte, InSanceBuffer'ın boyutu. Çıkışta, otInstance için yeterli alan yoksa otInstance için gereken bayt sayısı.
İadeler
Yeni OpenThread örneğine bir işaretçi.
Şunları da inceleyin:
otInstanceFinalize

otInstanceInitTek

otInstance * otInstanceInitSingle(
  void
)

Bu işlev, OpenThread kitaplığının statik tek örneğini başlatır.

Bu işlev, OpenThread öğesini başlatır ve sonraki OpenThread API çağrıları için hazırlar. Bu işlev, diğer tüm OpenThread çağrılarından önce çağrılmalıdır.

Bu işlev yalnızca birden çok OpenThread örneği desteği devre dışı bırakıldığında kullanılabilir.

Ayrıntılar
İadeler
Tek OpenThread örneğine bir işaretçi.

otInstanceIsStarted

bool otInstanceIsInitialized(
  otInstance *aInstance
)

Bu işlev, örneğin geçerli/başlatılmış olup olmadığını gösterir.

otInstanceInitSingle() (tek örnekli örnekte) veya otInstanceInit() (çok örnekli durumlarda) kullanılarak edinilir ve başlatılırsa örnek geçerli olarak kabul edilir. Sonraki otInstanceFinalize() çağrısı, örneğin ilk kullanım dışı olarak kabul edilmesine neden olur.

Ayrıntılar
Parametreler
[in] aInstance
Bir OpenThread örneğine bir işaretçi.
İadeler
Belirtilen örnek geçerli/başlatılmışsa TRUE, aksi takdirde FALSE.

otInstanceSıfırla

void otInstanceReset(
  otInstance *aInstance
)

Bu yöntem platformun sıfırlanmasını tetikler.

Sıfırlama işlemi, tüm OpenThread durumunun/bilgilerinin (değişken bellekte depolanan) silinmesini sağlar. otPlatformReset öğesinin, kalıcı olmayan bellekte kayıtlı kalıcı durumu/bilgileri silmediğini unutmayın.

Ayrıntılar
Parametreler
[in] aInstance
Bir OpenThread örneğine bir işaretçi.

otInstanceresetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

Bu yöntem, OpenThread radyo yığınının dahili durumlarını sıfırlar.

Geri çağırmalar ve yapılandırmalar korunur.

Bu API, yalnızca radyo derlemeleri (OPENTHREAD_RADIO = 1) altında kullanılabilir.

Ayrıntılar
Parametreler
[in] aInstance
Bir OpenThread örneğine bir işaretçi.

otRemoveStateChangeCallback

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

Bu işlev, OpenThread içinde belirli yapılandırma veya durumun ne zaman değiştiğini belirtmek için geri çağırmayı kaldırır.

Ayrıntılar
Parametreler
[in] aInstance
Bir OpenThread örneğine bir işaretçi.
[in] aCallback
Belirli yapılandırma veya durum değişiklikleriyle çağrılan bir işlevin işaretçisi.
[in] aContext
Uygulamaya özel bağlama işaretçi.

otSetStateChangedGeri Çağırma

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

Bu işlev, OpenThread içinde belirli yapılandırma veya durumun ne zaman değiştiğini belirtmek için bir geri çağırma kaydeder.

Ayrıntılar
Parametreler
[in] aInstance
Bir OpenThread örneğine bir işaretçi.
[in] aCallback
Belirli yapılandırma veya durum değişiklikleriyle çağrılan bir işlevin işaretçisi.
[in] aContext
Uygulamaya özel bağlama işaretçi.
Döndürülen Değerler
OT_ERROR_NONE
Geri çağırma, geri çağırma listesine eklendi.
OT_ERROR_ALREADY
Geri çağırma zaten kaydedildi.
OT_ERROR_NO_BUFS
Kaynak kısıtlamaları nedeniyle geri arama eklenemedi.

Makrolar

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

Çalışma süresinin dize gösterimi için önerilen boyut.

Kaynaklar

OpenThread API Referans konularının kaynağı, GitHub'daki kaynak kodudur. Daha fazla bilgi edinmek veya dokümanlarımıza katkıda bulunmak için Kaynaklar'a bakın.