Örnek
Bu modül, OpenThread Örneği'ni kontrol eden işlevler içerir.
Özet
Türler |
|
---|---|
otChangedFlags
|
Türuint32_t
Bu tür, değişen belirli durumu/yapılandırmayı belirten bir bit alanını temsil eder. |
otInstance
|
Türstruct otInstance
Bu yapı, OpenThread örneği yapısını temsil eder. |
otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
|
Türvoid(*
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.
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 |
|
İşlevler
otGetRadioVersionDize
const char * otGetRadioVersionString( otInstance *aInstance )
Bu işlev, OpenThread radyo sürüm dizesini alır.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İ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 |
|
||||
Döndürülen Değerler |
|
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 |
|
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 |
|
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 |
|
||
İ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; "&",
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 |
|
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 |
|
||||
İadeler |
Yeni OpenThread örneğine bir işaretçi.
|
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 |
|
||
İ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 |
|
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 |
|
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 |
|
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 |
|
||||||
Döndürülen Değerler |
|
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.