Link
Ten moduł zawiera funkcje, które kontrolują konfigurację warstwy linków.
Podsumowanie
Wyliczenia |
|
|---|---|
otMacFilterAddressMode{
|
enum | typ wyliczeniowy Definiuje tryb adresu filtra Maca. |
Definicje typów |
|
|---|---|
otActiveScanResult
|
typedefstruct otActiveScanResult
Reprezentuje otrzymany obraz typu IEEE 802.15.4. |
otEnergyScanResult
|
typedefstruct otEnergyScanResult
Reprezentuje wynik skanowania energii. |
otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext)
|
typedefvoid(*
Wskaźnik jest wywoływany podczas aktywnego skanowania IEEE 802.15.4 po otrzymaniu sygnału IEEE 802.15.4 lub zakończeniu skanowania. |
otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext)
|
typedefvoid(*
Wskaźnik jest wywoływany podczas skanowania energii IEEE 802.15.4, gdy wynik dla kanału jest gotowy lub skanowanie dobiega końca. |
otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext)
|
typedefvoid(*
Wskaźnik jest wywoływany po odebraniu ramki IEEE 802.15.4. |
otMacCounters
|
typedefstruct otMacCounters
Reprezentuje liczniki warstw MAC. |
otMacFilterAddressMode
|
typedef Definiuje tryb adresu filtra Maca. |
otMacFilterEntry
|
typedefstruct otMacFilterEntry
Reprezentuje wpis filtra Maca. |
otMacFilterIterator
|
typedefuint8_t
Służy do iteracji wpisów filtra Maca. |
otThreadLinkInfo
|
typedefstruct otThreadLinkInfo
Reprezentuje informacje o linkach dotyczące wiadomości otrzymanych z radia Thread. |
Funkcje |
|
|---|---|
otLinkActiveScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void *aCallbackContext)
|
Uruchamia aktywne skanowanie IEEE 802.15.4.
|
otLinkConvertLinkQualityToRss(otInstance *aInstance, uint8_t aLinkQuality)
|
int8_t
Przekształca jakość linku na typową siłę sygnału odbieranego.
|
otLinkConvertRssToLinkQuality(otInstance *aInstance, int8_t aRss)
|
uint8_t
Przekształca siłę odbieranego sygnału na jakość linku.
|
otLinkEnergyScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext)
|
Uruchamia skanowanie energii IEEE 802.15.4.
|
otLinkFilterAddAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
|
Dodaje Rozszerzony adres do filtra MAC.
|
otLinkFilterAddRssIn(otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss)
|
Dodaje określony adres rozszerzony do listy
RssIn (lub zmienia istniejący adres na liście RssIn) i ustawia pozycję siły odbieranego sygnału (w dBm) dla wiadomości przychodzących z tego adresu. |
otLinkFilterClearAddresses(otInstance *aInstance)
|
void
Usuwa wszystkie adresy rozszerzone z filtra MAC.
|
otLinkFilterClearAllRssIn(otInstance *aInstance)
|
void
Usuwa wszystkie wpisy o sile odbieranego sygnału (
rss) i wskaźniku jakości linku (lqi) (w tym wartości domyślne) z listy RssIn. |
otLinkFilterClearDefaultRssIn(otInstance *aInstance)
|
void
Usuwa wszystkie wcześniej ustawione domyślne ustawienia siły odbieranego sygnału (w dBm) w filtrze MAC.
|
otLinkFilterGetAddressMode(otInstance *aInstance)
|
Pobiera tryb adresu filtra MAC.
|
otLinkFilterGetNextAddress(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
|
Pobiera używany wpis filtra adresów.
|
otLinkFilterGetNextRssIn(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
|
Pobiera używany wpis filtra RssIn.
|
otLinkFilterRemoveAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
|
void
Usuwa rozszerzony adres z filtra MAC.
|
otLinkFilterRemoveRssIn(otInstance *aInstance, const otExtAddress *aExtAddress)
|
void
Usuwa określony adres rozszerzony z listy
RssIn. |
otLinkFilterSetAddressMode(otInstance *aInstance, otMacFilterAddressMode aMode)
|
void
Ustawia tryb adresu filtra MAC.
|
otLinkFilterSetDefaultRssIn(otInstance *aInstance, int8_t aRss)
|
void
Ustawia domyślną siłę odbieranego sygnału (w dBm) w filtrze MAC.
|
otLinkGetCcaFailureRate(otInstance *aInstance)
|
uint16_t
Zwraca bieżący odsetek błędów CCA (Clear Channel Assessment).
|
otLinkGetChannel(otInstance *aInstance)
|
uint8_t
Pobierz kanał IEEE 802.15.4.
|
otLinkGetCounters(otInstance *aInstance)
|
const otMacCounters *
Pobieranie liczników warstw MAC.
|
otLinkGetCslChannel(otInstance *aInstance)
|
uint8_t
Pobiera kanał CSL.
|
otLinkGetCslPeriod(otInstance *aInstance)
|
uint32_t
Pobiera okres CSL w mikrosekundach.
|
otLinkGetCslTimeout(otInstance *aInstance)
|
uint32_t
Pobiera czas oczekiwania CSL.
|
otLinkGetExtendedAddress(otInstance *aInstance)
|
const otExtAddress *
Pobiera rozszerzony adres IEEE 802.15.4.
|
otLinkGetFactoryAssignedIeeeEui64(otInstance *aInstance, otExtAddress *aEui64)
|
void
Pobierz IEEE EUI-64 z przypisaną fabryką.
|
otLinkGetMaxFrameRetriesDirect(otInstance *aInstance)
|
uint8_t
Zwraca maksymalną liczbę ponownych prób wprowadzenia klatek podczas transmisji bezpośredniej.
|
otLinkGetMaxFrameRetriesIndirect(otInstance *aInstance)
|
uint8_t
Zwraca maksymalną liczbę ponownych prób klatek podczas transmisji pośredniej.
|
otLinkGetPanId(otInstance *aInstance)
|
Uzyskaj identyfikator PAN IEEE 802.15.4.
|
otLinkGetPollPeriod(otInstance *aInstance)
|
uint32_t
Ustaw okres badania danych na urządzeniu śpiącym.
|
otLinkGetRegion(otInstance *aInstance, uint16_t *aRegionCode)
|
Pobierz kod regionu.
|
otLinkGetShortAddress(otInstance *aInstance)
|
Uzyskaj krótki adres IEEE 802.15.4.
|
otLinkGetSupportedChannelMask(otInstance *aInstance)
|
uint32_t
Uzyskaj obsługiwaną maskę kanału warstwy MAC.
|
otLinkGetTxDirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)
|
const uint32_t *
Pobiera histogram ponownych prób dla pojedynczej pakietu bezpośredniego aż do sukcesu.
|
otLinkGetTxIndirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)
|
const uint32_t *
Pobiera histogram ponownych prób dla pojedynczej pakietu pośredniego do momentu powodzenia.
|
otLinkIsActiveScanInProgress(otInstance *aInstance)
|
bool
Wskazuje, czy trwa aktywne skanowanie IEEE 802.15.4.
|
otLinkIsCslEnabled(otInstance *aInstance)
|
bool
Wskazuje, czy CSL jest włączony.
|
otLinkIsCslSupported(otInstance *aInstance)
|
bool
Wskazuje, czy urządzenie jest połączone z rodzicem, który obsługuje CSL.
|
otLinkIsEnabled(otInstance *aInstance)
|
bool
Wskazuje, czy warstwa linku jest włączona.
|
otLinkIsEnergyScanInProgress(otInstance *aInstance)
|
bool
Wskazuje, czy trwa skanowanie energii IEEE 802.15.4.
|
otLinkIsInTransmitState(otInstance *aInstance)
|
bool
Wskazuje, czy adres MAC IEEE 802.15.4 jest w stanie transmisji.
|
otLinkIsPromiscuous(otInstance *aInstance)
|
bool
Wskazuje, czy tryb nasłuchiwania jest włączony w warstwie linku.
|
otLinkIsRadioFilterEnabled(otInstance *aInstance)
|
bool
Wskazuje, czy filtr radiowy IEEE 802.15.4 jest włączony czy nie.
|
otLinkResetCounters(otInstance *aInstance)
|
void
Resetuje liczniki warstw MAC.
|
otLinkResetTxRetrySuccessHistogram(otInstance *aInstance)
|
void
Czyści statystyki histogramu dla transmisji bezpośrednich i pośrednich.
|
otLinkSendDataRequest(otInstance *aInstance)
|
Powoduje umieszczenie w kolejce wiadomości żądania danych IEEE 802.15.4 do przesłania.
|
otLinkSendEmptyData(otInstance *aInstance)
|
Powoduje, że urządzenie ma wysłać pustą ramkę danych IEEE 802.15.4.
|
otLinkSetChannel(otInstance *aInstance, uint8_t aChannel)
|
Ustaw kanał IEEE 802.15.4.
|
otLinkSetCslChannel(otInstance *aInstance, uint8_t aChannel)
|
Ustawia kanał CSL.
|
otLinkSetCslPeriod(otInstance *aInstance, uint32_t aPeriod)
|
Ustawia okres CSL w mikrosekundach.
|
otLinkSetCslTimeout(otInstance *aInstance, uint32_t aTimeout)
|
Określa limit czasu CSL w sekundach.
|
otLinkSetEnabled(otInstance *aInstance, bool aEnable)
|
Włącza lub wyłącza warstwę linków.
|
otLinkSetExtendedAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
|
Ustawia rozszerzony adres IEEE 802.15.4.
|
otLinkSetMaxFrameRetriesDirect(otInstance *aInstance, uint8_t aMaxFrameRetriesDirect)
|
void
Określa maksymalną liczbę ponownych prób wprowadzenia klatek podczas transmisji bezpośredniej.
|
otLinkSetMaxFrameRetriesIndirect(otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect)
|
void
Określa maksymalną liczbę ponownych prób klatek podczas transmisji pośredniej.
|
otLinkSetPanId(otInstance *aInstance, otPanId aPanId)
|
Ustaw identyfikator IEEE 802.15.4.
|
otLinkSetPcapCallback(otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext)
|
void
Rejestruje wywołanie zwrotne w celu dostarczenia otrzymanych nieprzetworzonych ramek IEEE 802.15.4.
|
otLinkSetPollPeriod(otInstance *aInstance, uint32_t aPollPeriod)
|
Ustaw lub wyczyść określony przez użytkownika lub zewnętrzny okres ankiety z danymi zewnętrznymi dla śpiącego urządzenia.
|
otLinkSetPromiscuous(otInstance *aInstance, bool aPromiscuous)
|
Włącza lub wyłącza tryb nasłuchiwania w warstwie linku.
|
otLinkSetRadioFilterEnabled(otInstance *aInstance, bool aFilterEnabled)
|
void
Włącza lub wyłącza tryb filtra radiowego IEEE 802.15.4.
|
otLinkSetRegion(otInstance *aInstance, uint16_t aRegionCode)
|
Ustawia kod regionu.
|
otLinkSetSupportedChannelMask(otInstance *aInstance, uint32_t aChannelMask)
|
Ustaw obsługiwaną maskę kanału warstwy MAC.
|
Konstrukcja |
|
|---|---|
| otActiveScanResult |
Reprezentuje otrzymany obraz typu IEEE 802.15.4. |
| otEnergyScanResult |
Reprezentuje wynik skanowania energii. |
| otMacCounters |
Reprezentuje liczniki warstw MAC. |
| otMacFilterEntry |
Reprezentuje wpis filtra Maca. |
| otThreadLinkInfo |
Reprezentuje informacje o linkach dotyczące wiadomości otrzymanych z radia Thread. |
Wyliczenia
otMacFilterAddressMode
otMacFilterAddressMode
Definiuje tryb adresu filtra Maca.
| Właściwości | |
|---|---|
OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST
|
Tryb filtra adresów listy dozwolonych jest włączony. |
OT_MAC_FILTER_ADDRESS_MODE_DENYLIST
|
Tryb filtra adresów listy odrzuconych jest włączony. |
OT_MAC_FILTER_ADDRESS_MODE_DISABLED
|
Filtr adresów jest wyłączony. |
Definicje typów
otActiveScanResult
struct otActiveScanResult otActiveScanResult
Reprezentuje otrzymany obraz typu IEEE 802.15.4.
otEnergyScanResult
struct otEnergyScanResult otEnergyScanResult
Reprezentuje wynik skanowania energii.
otHandleActiveScanResult
void(* otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext)
Wskaźnik jest wywoływany podczas aktywnego skanowania IEEE 802.15.4 po otrzymaniu sygnału IEEE 802.15.4 lub zakończeniu skanowania.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
otHandleEnergyScanResult
void(* otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext)
Wskaźnik jest wywoływany podczas skanowania energii IEEE 802.15.4, gdy wynik dla kanału jest gotowy lub skanowanie dobiega końca.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
otLinkPcapCallback
void(* otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext)
Wskaźnik jest wywoływany po odebraniu ramki IEEE 802.15.4.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
otMacFilterAddressMode
enum otMacFilterAddressMode otMacFilterAddressMode
Definiuje tryb adresu filtra Maca.
otMacFilterIterator
uint8_t otMacFilterIterator
Służy do iteracji wpisów filtra Maca.
otThreadLinkInfo
struct otThreadLinkInfo otThreadLinkInfo
Reprezentuje informacje o linkach dotyczące wiadomości otrzymanych z radia Thread.
Funkcje
otLinkActiveScan
otError otLinkActiveScan( otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void *aCallbackContext )
Uruchamia aktywne skanowanie IEEE 802.15.4.
| Szczegóły | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||||||
| Zwracane wartości |
|
||||||||||
otLinkConvertLinkQualityToRss
int8_t otLinkConvertLinkQualityToRss( otInstance *aInstance, uint8_t aLinkQuality )
Przekształca jakość linku na typową siłę sygnału odbieranego.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwroty |
Typowe mapowanie siły sygnału odebrała platforma na
aLinkQuality. |
||||
otLinkConvertRssToLinkQuality
uint8_t otLinkConvertRssToLinkQuality( otInstance *aInstance, int8_t aRss )
Przekształca siłę odbieranego sygnału na jakość linku.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwroty |
Połącz mapowanie wartości jakości z właściwością
aRss. |
||||
otLinkEnergyScan
otError otLinkEnergyScan( otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext )
Uruchamia skanowanie energii IEEE 802.15.4.
| Szczegóły | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||||||
| Zwracane wartości |
|
||||||||||
otLinkFilterAddAddress
otError otLinkFilterAddAddress( otInstance *aInstance, const otExtAddress *aExtAddress )
Dodaje Rozszerzony adres do filtra MAC.
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwracane wartości |
|
||||
otLinkFilterAddRssIn
otError otLinkFilterAddRssIn( otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss )
Dodaje określony adres rozszerzony do listy RssIn (lub zmienia istniejący adres na liście RssIn) i ustawia pozycję siły odbieranego sygnału (w dBm) dla wiadomości przychodzących z tego adresu.
Rozszerzony adres nie musi znajdować się w filtrze address allowlist/denylist, aby można było ustawić rss.
OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||
otLinkFilterClearAddresses
void otLinkFilterClearAddresses( otInstance *aInstance )
Usuwa wszystkie adresy rozszerzone z filtra MAC.
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
otLinkFilterClearAllRssIn
void otLinkFilterClearAllRssIn( otInstance *aInstance )
Usuwa wszystkie wpisy o sile odbieranego sygnału (rss) i wskaźniku jakości linku (lqi) (w tym wartości domyślne) z listy RssIn.
Spowoduje to, że wszystkie rozszerzone adresy będą korzystały z sygnału na żywo.
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
otLinkFilterClearDefaultRssIn
void otLinkFilterClearDefaultRssIn( otInstance *aInstance )
Usuwa wszystkie wcześniej ustawione domyślne ustawienia siły odbieranego sygnału (w dBm) w filtrze MAC.
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
otLinkFilterGetAddressMode
otMacFilterAddressMode otLinkFilterGetAddressMode( otInstance *aInstance )
Pobiera tryb adresu filtra MAC.
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
tryb adresu.
|
||
otLinkFilterGetNextAddress
otError otLinkFilterGetNextAddress( otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry )
Pobiera używany wpis filtra adresów.
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||
otLinkFilterGetNextRssIn
otError otLinkFilterGetNextRssIn( otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry )
Pobiera używany wpis filtra RssIn.
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||
otLinkFilterRemoveAddress
void otLinkFilterRemoveAddress( otInstance *aInstance, const otExtAddress *aExtAddress )
Usuwa rozszerzony adres z filtra MAC.
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
Jeśli w polu „Filtr” nie ma żadnego wpisu pasującego do podanego adresu rozszerzonego, nie jest wykonywana żadna czynność.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
otLinkFilterRemoveRssIn
void otLinkFilterRemoveRssIn( otInstance *aInstance, const otExtAddress *aExtAddress )
Usuwa określony adres rozszerzony z listy RssIn.
Po usunięciu z listy RssIn adres MAC będzie używać domyślnych ustawień rss i lqi, o ile zostały ustawione wartości domyślne. (Jeśli nie zostały ustawione żadne wartości domyślne, używany jest sygnał bezprzewodowy).
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
Jeśli na liście RssIn nie ma żadnej pozycji pasującej do podanego adresu rozszerzonego, nie są wykonywane żadne działania.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
otLinkFilterSetAddressMode
void otLinkFilterSetAddressMode( otInstance *aInstance, otMacFilterAddressMode aMode )
Ustawia tryb adresu filtra MAC.
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
otLinkFilterSetDefaultRssIn
void otLinkFilterSetDefaultRssIn( otInstance *aInstance, int8_t aRss )
Ustawia domyślną siłę odbieranego sygnału (w dBm) w filtrze MAC.
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
Domyślna wartość RSS jest używana w przypadku wszystkich odebranych ramek z adresów, dla których na liście Filtr nie ma wpisu RSS-IN (dodanego za pomocą funkcji otLinkFilterAddRssIn()).
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
otLinkGetCcaFailureRate
uint16_t otLinkGetCcaFailureRate( otInstance *aInstance )
Zwraca bieżący odsetek błędów CCA (Clear Channel Assessment).
Szybkość jest utrzymywana w okresie (w przybliżeniu) ostatnich OPENTHREAD_CONFIG_CCA_FAILURE_RATE_AVERAGING_WINDOW transmisji klatek.
| Szczegóły | |
|---|---|
| Zwroty |
Odsetek niepowodzeń CCA z maksymalną wartością
0xffff odpowiadającą odsetkowi błędów na poziomie 100%. |
otLinkGetChannel
uint8_t otLinkGetChannel( otInstance *aInstance )
Pobierz kanał IEEE 802.15.4.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Kanał IEEE 802.15.4.
|
||
otLinkSetChannel
otLinkGetCounters
const otMacCounters * otLinkGetCounters( otInstance *aInstance )
Pobieranie liczników warstw MAC.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Wskaźnik do liczników warstw MAC.
|
||
otLinkGetCslChannel
uint8_t otLinkGetCslChannel( otInstance *aInstance )
Pobiera kanał CSL.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Kanał CSL.
|
||
otLinkGetCslPeriod
uint32_t otLinkGetCslPeriod( otInstance *aInstance )
Pobiera okres CSL w mikrosekundach.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Okres CSL w mikrosekundach.
|
||
otLinkGetCslTimeout
uint32_t otLinkGetCslTimeout( otInstance *aInstance )
Pobiera czas oczekiwania CSL.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Limit czasu CSL w sekundach.
|
||
otLinkGetExtendedAddress
const otExtAddress * otLinkGetExtendedAddress( otInstance *aInstance )
Pobiera rozszerzony adres IEEE 802.15.4.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Wskaźnik do rozszerzonego adresu IEEE 802.15.4.
|
||
otLinkGetFactoryAssignedIeeeEui64
void otLinkGetFactoryAssignedIeeeEui64( otInstance *aInstance, otExtAddress *aEui64 )
Pobierz IEEE EUI-64 z przypisaną fabryką.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
otLinkGetMaxFrameRetriesDirect
uint8_t otLinkGetMaxFrameRetriesDirect( otInstance *aInstance )
Zwraca maksymalną liczbę ponownych prób wprowadzenia klatek podczas transmisji bezpośredniej.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Maksymalna liczba ponownych prób podczas transmisji bezpośredniej.
|
||
otLinkGetMaxFrameRetriesIndirect
uint8_t otLinkGetMaxFrameRetriesIndirect( otInstance *aInstance )
Zwraca maksymalną liczbę ponownych prób klatek podczas transmisji pośredniej.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Maksymalna liczba ponownych prób podczas transmisji pośredniej.
|
||
otLinkGetPanId
otPanId otLinkGetPanId( otInstance *aInstance )
Uzyskaj identyfikator PAN IEEE 802.15.4.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
identyfikator IEEE 802.15.4 PAN.
|
||
otLinkSetPanId
otLinkGetPollPeriod
uint32_t otLinkGetPollPeriod( otInstance *aInstance )
Ustaw okres badania danych na urządzeniu śpiącym.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Okres badania danych w milisekundach dla sennego urządzenia.
|
||
otLinkSetPollPeriod
otLinkGetRegion
otError otLinkGetRegion( otInstance *aInstance, uint16_t *aRegionCode )
Pobierz kod regionu.
Format regionu radiowego to 2-bajtowy format ASCII zgodny z kodem ISO 3166 alfa-2.
| Szczegóły | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||||
| Zwracane wartości |
|
||||||||
otLinkGetShortAddress
otShortAddress otLinkGetShortAddress( otInstance *aInstance )
Uzyskaj krótki adres IEEE 802.15.4.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Wskaźnik do skróconego adresu IEEE 802.15.4.
|
||
otLinkGetSupportedChannelMask
uint32_t otLinkGetSupportedChannelMask( otInstance *aInstance )
Uzyskaj obsługiwaną maskę kanału warstwy MAC.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Obsługiwana maska kanału jako
uint32_t z bitem 0 (lsb) mapowanym na kanał 0, bitem 1 na kanał 1 itd. |
||
otLinkGetTxDirectRetrySuccessHistogram
const uint32_t * otLinkGetTxDirectRetrySuccessHistogram( otInstance *aInstance, uint8_t *aNumberOfEntries )
Pobiera histogram ponownych prób dla pojedynczej pakietu bezpośredniego aż do sukcesu.
Jest prawidłowe, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwroty |
Wskaźnik histogramu ponownych prób (w postaci tablicy). N-ty element wskazuje, że pakiet został wysłany z n-tą próbą.
|
||||
otLinkGetTxIndirectRetrySuccessHistogram
const uint32_t * otLinkGetTxIndirectRetrySuccessHistogram( otInstance *aInstance, uint8_t *aNumberOfEntries )
Pobiera histogram ponownych prób dla pojedynczej pakietu pośredniego do momentu powodzenia.
Jest prawidłowe, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwroty |
Wskaźnik histogramu ponownych prób (w postaci tablicy). N-ty element wskazuje, że pakiet został wysłany z n-tą próbą.
|
||||
otLinkIsActiveScanInProgress
bool otLinkIsActiveScanInProgress( otInstance *aInstance )
Wskazuje, czy trwa aktywne skanowanie IEEE 802.15.4.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Wartość true, jeśli trwa aktywne skanowanie IEEE 802.15.4, w przeciwnym razie ma wartość fałsz.
|
||
otLinkIsCslEnabled
bool otLinkIsCslEnabled( otInstance *aInstance )
Wskazuje, czy CSL jest włączony.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwracane wartości |
|
||||
otLinkIsCslSupported
bool otLinkIsCslSupported( otInstance *aInstance )
Wskazuje, czy urządzenie jest połączone z rodzicem, który obsługuje CSL.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Zwracane wartości |
|
||||
otLinkIsEnabled
bool otLinkIsEnabled( otInstance *aInstance )
Wskazuje, czy warstwa linku jest włączona.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwracane wartości |
|
||||
otLinkIsEnergyScanInProgress
bool otLinkIsEnergyScanInProgress( otInstance *aInstance )
Wskazuje, czy trwa skanowanie energii IEEE 802.15.4.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Wartość true, jeśli trwa skanowanie energii IEEE 802.15.4, w przeciwnym razie ma wartość fałsz.
|
||
otLinkIsInTransmitState
bool otLinkIsInTransmitState( otInstance *aInstance )
Wskazuje, czy adres MAC IEEE 802.15.4 jest w stanie transmisji.
Moduł MAC jest w stanie transmisji podczas procedury CSMA/CA, CCA, danych, obrazu typu beacon lub ramki żądania danych i otrzymuje potwierdzenie przesyłanej ramki. Moduł MAC nie jest w stanie transmisji podczas przesyłania ramki potwierdzenia lub żądania Beacon.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
| Zwroty |
Prawda, jeśli MAC IEEE 802.15.4 jest w stanie przesyłania, w przeciwnym razie ma wartość Fałsz.
|
||
otLinkIsPromiscuous
bool otLinkIsPromiscuous( otInstance *aInstance )
Wskazuje, czy tryb nasłuchiwania jest włączony w warstwie linku.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwracane wartości |
|
||||
otLinkIsRadioFilterEnabled
bool otLinkIsRadioFilterEnabled( otInstance *aInstance )
Wskazuje, czy filtr radiowy IEEE 802.15.4 jest włączony czy nie.
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Zwracane wartości |
|
||||
otLinkResetCounters
void otLinkResetCounters( otInstance *aInstance )
Resetuje liczniki warstw MAC.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
otLinkResetTxRetrySuccessHistogram
void otLinkResetTxRetrySuccessHistogram( otInstance *aInstance )
Czyści statystyki histogramu dla transmisji bezpośrednich i pośrednich.
Jest prawidłowe, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
otLinkSendDataRequest
otError otLinkSendDataRequest( otInstance *aInstance )
Powoduje umieszczenie w kolejce wiadomości żądania danych IEEE 802.15.4 do przesłania.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||
otLinkSendEmptyData
otError otLinkSendEmptyData( otInstance *aInstance )
Powoduje, że urządzenie ma wysłać pustą ramkę danych IEEE 802.15.4.
Jest obsługiwane tylko na urządzeniach Rx-Off-When-Nieaktywnych w celu wysłania pustej ramki danych do rodzica. Uwaga: ta funkcja jest dostępna tylko wtedy, gdy włączona jest zasada OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||
otLinkSetChannel
otError otLinkSetChannel( otInstance *aInstance, uint8_t aChannel )
Ustaw kanał IEEE 802.15.4.
Niepowodzenie tylko wtedy, gdy protokoły Thread są wyłączone. Udane wywołanie tej funkcji powoduje unieważnienie aktywnych i oczekujących zbiorów danych operacyjnych w pamięci nieulotnej.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||
otLinkGetChannel
otLinkSetCslChannel
otError otLinkSetCslChannel( otInstance *aInstance, uint8_t aChannel )
Ustawia kanał CSL.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwracane wartości |
|
||||
otLinkSetCslPeriod
otError otLinkSetCslPeriod( otInstance *aInstance, uint32_t aPeriod )
Ustawia okres CSL w mikrosekundach.
Wyłącz CSL, ustawiając ten parametr na 0.
Okres CSL MUSI być wielokrotnością liczby OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC. W przeciwnym razie zwracana jest wartość OT_ERROR_INVALID_ARGS.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwracane wartości |
|
||||
otLinkSetCslTimeout
otError otLinkSetCslTimeout( otInstance *aInstance, uint32_t aTimeout )
Określa limit czasu CSL w sekundach.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwracane wartości |
|
||||
otLinkSetEnabled
otError otLinkSetEnabled( otInstance *aInstance, bool aEnable )
Włącza lub wyłącza warstwę linków.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwracane wartości |
|
||||
otLinkSetExtendedAddress
otError otLinkSetExtendedAddress( otInstance *aInstance, const otExtAddress *aExtAddress )
Ustawia rozszerzony adres IEEE 802.15.4.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||
otLinkSetMaxFrameRetriesDirect
void otLinkSetMaxFrameRetriesDirect( otInstance *aInstance, uint8_t aMaxFrameRetriesDirect )
Określa maksymalną liczbę ponownych prób wprowadzenia klatek podczas transmisji bezpośredniej.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
otLinkSetMaxFrameRetriesIndirect
void otLinkSetMaxFrameRetriesIndirect( otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect )
Określa maksymalną liczbę ponownych prób klatek podczas transmisji pośredniej.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
otLinkSetPanId
otError otLinkSetPanId( otInstance *aInstance, otPanId aPanId )
Ustaw identyfikator IEEE 802.15.4.
Niepowodzenie tylko wtedy, gdy protokoły Thread są wyłączone. Udane wywołanie tej funkcji powoduje też unieważnienie aktywnych i oczekujących zbiorów danych operacyjnych w pamięci nieulotnej.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||
otLinkGetPanId
otLinkSetPcapCallback
void otLinkSetPcapCallback( otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext )
Rejestruje wywołanie zwrotne w celu dostarczenia otrzymanych nieprzetworzonych ramek IEEE 802.15.4.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
otLinkSetPollPeriod
otError otLinkSetPollPeriod( otInstance *aInstance, uint32_t aPollPeriod )
Ustaw lub wyczyść określony przez użytkownika lub zewnętrzny okres ankiety z danymi zewnętrznymi dla śpiącego urządzenia.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwracane wartości |
|
||||
otLinkGetPollPeriod
otLinkSetPromiscuous
otError otLinkSetPromiscuous( otInstance *aInstance, bool aPromiscuous )
Włącza lub wyłącza tryb nasłuchiwania w warstwie linku.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwracane wartości |
|
||||
otLinkSetRadioFilterEnabled
void otLinkSetRadioFilterEnabled( otInstance *aInstance, bool aFilterEnabled )
Włącza lub wyłącza tryb filtra radiowego IEEE 802.15.4.
Jest dostępne, gdy włączona jest konfiguracja OPENTHREAD_CONFIG_MAC_FILTER_ENABLE.
Filtr radiowy jest przeznaczony głównie do testowania. Można go użyć do tymczasowego zablokowania wszystkich tx/rx w radiu 802.15.4. Gdy filtr radiowy jest włączony, radio zostaje przełączone w tryb uśpienia, a nie odbiera (w celu zapewnienia, że urządzenie nie odbierze żadnej ramki i/lub nie wyśle potwierdzenia). Poza tym żądania transmisji ramki są zwracane natychmiast bez wysyłania klatki bezprzewodowo (zwróć błąd „brak potwierdzenia”, jeśli wymagane jest potwierdzenie. W przeciwnym razie zwrócony uda się).
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
otLinkSetRegion
otError otLinkSetRegion( otInstance *aInstance, uint16_t aRegionCode )
Ustawia kod regionu.
Format regionu radiowego to 2-bajtowy format ASCII zgodny z kodem ISO 3166 alfa-2.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||
otLinkSetSupportedChannelMask
otError otLinkSetSupportedChannelMask( otInstance *aInstance, uint32_t aChannelMask )
Ustaw obsługiwaną maskę kanału warstwy MAC.
Niepowodzenie tylko wtedy, gdy protokoły Thread są wyłączone.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwracane wartości |
|
||||
Makra
OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC
OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC (160)
Reprezentuje jednostkę okresu 10 symboli CSL w mikrosekundach.
Okres CSL (w mikrosekundach) MUSI być wielokrotnością tej wartości.
OT_MAC_FILTER_FIXED_RSS_DISABLED
OT_MAC_FILTER_FIXED_RSS_DISABLED 127
Służy do wskazywania, że nie ustawiono stałej siły sygnału odbieranego.
OT_MAC_FILTER_ITERATOR_INIT
OT_MAC_FILTER_ITERATOR_INIT 0
Inicjator narzędzia otMacFilterIterator.
OT_US_PER_TEN_SYMBOLS
OT_US_PER_TEN_SYMBOLS OT_RADIO_TEN_SYMBOLS_TIME
Czas na 10 symboli w jednostkach mikrosekundowych.
Zasoby
Tematy referencyjne interfejsu OpenThread API pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dołączyć do naszej dokumentacji, skorzystaj z sekcji Zasoby.