Link
Dieses Modul enthält Funktionen zur Steuerung der Konfiguration auf Link-Ebene.
Zusammenfassung
Aufzählungen |
|
---|---|
otMacFilterAddressMode{
|
enum Definiert den Adressmodus des Mac-Filters. |
Typedefs |
|
---|---|
otActiveScanResult
|
typedefstruct otActiveScanResult
Stellt ein empfangenes IEEE 802.15.4-Beacon dar. |
otEnergyScanResult
|
typedefstruct otEnergyScanResult
Stellt ein Ergebnis des Energiescans dar. |
otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext)
|
typedefvoid(*
Pointer wird während eines aktiven IEEE 802.15.4-Scans aufgerufen, wenn ein IEEE 802.15.4-Beacon empfangen wird oder der Scan abgeschlossen ist. |
otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext)
|
typedefvoid(*
Pointer wird während eines IEEE 802.15.4-Energiescans aufgerufen, wenn das Ergebnis für einen Kanal bereit ist oder der Scan abgeschlossen ist. |
otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext)
|
typedefvoid(*
Pointer wird aufgerufen, wenn ein IEEE 802.15.4-Frame empfangen wird. |
otMacCounters
|
typedefstruct otMacCounters
Stellt die MAC-Ebenenzähler dar. |
otMacFilterAddressMode
|
typedef Definiert den Adressmodus des Mac-Filters. |
otMacFilterEntry
|
typedefstruct otMacFilterEntry
Stellt einen Mac-Filtereintrag dar. |
otMacFilterIterator
|
typedefuint8_t
Wird verwendet, um durch Mac-Filtereinträge zu iterieren. |
otThreadLinkInfo
|
typedefstruct otThreadLinkInfo
Linkspezifische Informationen zu Nachrichten, die vom Thread-Funk empfangen wurden. |
Funktionen |
|
---|---|
otLinkActiveScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void *aCallbackContext)
|
Startet einen aktiven Scan gemäß IEEE 802.15.4.
|
otLinkConvertLinkQualityToRss(otInstance *aInstance, uint8_t aLinkQuality)
|
int8_t
Wandelt die Linkqualität in die typische Empfangssignalstärke um.
|
otLinkConvertRssToLinkQuality(otInstance *aInstance, int8_t aRss)
|
uint8_t
Wandelt die empfangene Signalstärke in die Linkqualität um.
|
otLinkEnergyScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext)
|
Startet einen IEEE 802.15.4-Energiescan.
|
otLinkFilterAddAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
|
Fügt dem MAC-Filter eine erweiterte Adresse hinzu.
|
otLinkFilterAddRssIn(otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss)
|
Fügt die angegebene erweiterte Adresse der
RssIn -Liste hinzu (oder ändert eine vorhandene Adresse in der RssIn -Liste) und legt den Eintrag für die empfangene Signalstärke (in dBm) für Nachrichten von dieser Adresse fest. |
otLinkFilterClearAddresses(otInstance *aInstance)
|
void
Löscht alle erweiterten Adressen aus dem MAC-Filter.
|
otLinkFilterClearAllRssIn(otInstance *aInstance)
|
void
Löscht alle Einträge für die empfangene Signalstärke (
rss ) und die Linkqualitätsanzeige (lqi ) (einschließlich Standardeinstellungen) aus der Liste RssIn . |
otLinkFilterClearDefaultRssIn(otInstance *aInstance)
|
void
Löscht die zuvor eingestellte Standardstärke des empfangenen Signals (in dBm) im MAC-Filter.
|
otLinkFilterGetAddressMode(otInstance *aInstance)
|
Ruft den Adressmodus des MAC-Filters ab.
|
otLinkFilterGetNextAddress(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
|
Ruft einen bereits verwendeten Adressfilter ab.
|
otLinkFilterGetNextRssIn(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
|
Ruft einen bereits verwendeten RssIn-Filtereintrag ab.
|
otLinkFilterRemoveAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
|
void
Entfernt eine erweiterte Adresse aus dem MAC-Filter.
|
otLinkFilterRemoveRssIn(otInstance *aInstance, const otExtAddress *aExtAddress)
|
void
Entfernt die angegebene erweiterte Adresse aus der
RssIn -Liste. |
otLinkFilterSetAddressMode(otInstance *aInstance, otMacFilterAddressMode aMode)
|
void
Legt den Adressmodus des MAC-Filters fest.
|
otLinkFilterSetDefaultRssIn(otInstance *aInstance, int8_t aRss)
|
void
Legt die Standardstärke des empfangenen Signals (in dBm) für MAC Filter fest.
|
otLinkGetCcaFailureRate(otInstance *aInstance)
|
uint16_t
Gibt die aktuelle CCA-Fehlerrate (Clear Channel Assessment) zurück.
|
otLinkGetChannel(otInstance *aInstance)
|
uint8_t
Rufen Sie den IEEE 802.15.4-Kanal ab.
|
otLinkGetCounters(otInstance *aInstance)
|
const otMacCounters *
Rufen Sie die MAC-Ebenenzähler ab.
|
otLinkGetCslChannel(otInstance *aInstance)
|
uint8_t
Ruft den CSL-Kanal ab.
|
otLinkGetCslPeriod(otInstance *aInstance)
|
uint32_t
Ruft den CSL-Zeitraum in Mikrosekunden ab.
|
otLinkGetCslTimeout(otInstance *aInstance)
|
uint32_t
Ruft das CSL-Zeitlimit ab.
|
otLinkGetExtendedAddress(otInstance *aInstance)
|
const otExtAddress *
Ruft die erweiterte IEEE 802.15.4-Adresse ab.
|
otLinkGetFactoryAssignedIeeeEui64(otInstance *aInstance, otExtAddress *aEui64)
|
void
Holen Sie sich das werkseitig zugewiesene IEEE EUI-64.
|
otLinkGetMaxFrameRetriesDirect(otInstance *aInstance)
|
uint8_t
Gibt die maximale Anzahl von Frame-Wiederholungen während der direkten Übertragung zurück.
|
otLinkGetMaxFrameRetriesIndirect(otInstance *aInstance)
|
uint8_t
Gibt die maximale Anzahl von Frame-Wiederholungen während der indirekten Übertragung zurück.
|
otLinkGetPanId(otInstance *aInstance)
|
Rufen Sie die IEEE 802.15.4-PAN-ID ab.
|
otLinkGetPollPeriod(otInstance *aInstance)
|
uint32_t
Datenabfragezeitraum für ein schläfriges Endgerät abrufen.
|
otLinkGetRegion(otInstance *aInstance, uint16_t *aRegionCode)
|
Rufen Sie den Regionscode ab.
|
otLinkGetShortAddress(otInstance *aInstance)
|
Rufen Sie die IEEE 802.15.4-Kurzadresse ab.
|
otLinkGetSupportedChannelMask(otInstance *aInstance)
|
uint32_t
Rufen Sie die unterstützte Kanalmaske der MAC-Ebene ab.
|
otLinkGetTxDirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)
|
const uint32_t *
Ruft das Histogramm der Wiederholungsversuche für ein einzelnes direktes Paket bis zum Erfolg ab.
|
otLinkGetTxIndirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)
|
const uint32_t *
Ruft das Histogramm der Wiederholungsversuche für ein einzelnes indirektes Paket bis zum Erfolg ab.
|
otLinkIsActiveScanInProgress(otInstance *aInstance)
|
bool
Gibt an, ob gerade ein aktiver IEEE 802.15.4-Scan ausgeführt wird.
|
otLinkIsCslEnabled(otInstance *aInstance)
|
bool
Gibt an, ob CSL aktiviert ist.
|
otLinkIsCslSupported(otInstance *aInstance)
|
bool
Gibt an, ob das Gerät mit einem Elternteil verbunden ist, der CSL unterstützt.
|
otLinkIsEnabled(otInstance *aInstance)
|
bool
Gibt an, ob die Link-Ebene aktiviert ist.
|
otLinkIsEnergyScanInProgress(otInstance *aInstance)
|
bool
Gibt an, ob gerade ein IEEE 802.15.4-Energiescan ausgeführt wird.
|
otLinkIsInTransmitState(otInstance *aInstance)
|
bool
Gibt an, ob sich ein IEEE 802.15.4-MAC im Übertragungsstatus befindet.
|
otLinkIsPromiscuous(otInstance *aInstance)
|
bool
Gibt an, ob der promiskuitive Modus auf Linkebene aktiviert ist.
|
otLinkIsRadioFilterEnabled(otInstance *aInstance)
|
bool
Gibt an, ob der IEEE 802.15.4-Funkfilter aktiviert ist oder nicht.
|
otLinkResetCounters(otInstance *aInstance)
|
void
Setzt die MAC-Ebenenzähler zurück.
|
otLinkResetTxRetrySuccessHistogram(otInstance *aInstance)
|
void
Löscht Histogrammstatistiken für direkte und indirekte Übertragungen.
|
otLinkSendDataRequest(otInstance *aInstance)
|
Stellt eine IEEE 802.15.4-Datenanfragenachricht zur Übertragung in die Warteschlange.
|
otLinkSendEmptyData(otInstance *aInstance)
|
Weist das Gerät an, einen leeren IEEE 802.15.4-Dataframe zu senden.
|
otLinkSetChannel(otInstance *aInstance, uint8_t aChannel)
|
Legen Sie den IEEE 802.15.4-Kanal fest.
|
otLinkSetCslChannel(otInstance *aInstance, uint8_t aChannel)
|
Legt den CSL-Kanal fest.
|
otLinkSetCslPeriod(otInstance *aInstance, uint32_t aPeriod)
|
Legt den CSL-Zeitraum in Mikrosekunden fest.
|
otLinkSetCslTimeout(otInstance *aInstance, uint32_t aTimeout)
|
Legt das CSL-Zeitlimit in Sekunden fest.
|
otLinkSetEnabled(otInstance *aInstance, bool aEnable)
|
Aktiviert oder deaktiviert die Link-Ebene.
|
otLinkSetExtendedAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
|
Legt die erweiterte IEEE 802.15.4-Adresse fest.
|
otLinkSetMaxFrameRetriesDirect(otInstance *aInstance, uint8_t aMaxFrameRetriesDirect)
|
void
Legt die maximale Anzahl von Frame-Wiederholungen während der direkten Übertragung fest.
|
otLinkSetMaxFrameRetriesIndirect(otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect)
|
void
Legt die maximale Anzahl von Frame-Wiederholungen während der indirekten Übertragung fest.
|
otLinkSetPanId(otInstance *aInstance, otPanId aPanId)
|
Legen Sie die IEEE 802.15.4-PAN-ID fest.
|
otLinkSetPcapCallback(otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext)
|
void
Registriert einen Callback, um empfangene Roh-IEEE 802.15.4-Frames bereitzustellen.
|
otLinkSetPollPeriod(otInstance *aInstance, uint32_t aPollPeriod)
|
Hiermit wird der Zeitraum der vom Nutzer angegebenen/externen Datenabfrage für schläfriges Endgerät festgelegt/gelöscht.
|
otLinkSetPromiscuous(otInstance *aInstance, bool aPromiscuous)
|
Aktiviert oder deaktiviert den promiskuitiven Modus der Link-Ebene.
|
otLinkSetRadioFilterEnabled(otInstance *aInstance, bool aFilterEnabled)
|
void
Aktiviert/deaktiviert den IEEE 802.15.4-Funkfiltermodus.
|
otLinkSetRegion(otInstance *aInstance, uint16_t aRegionCode)
|
Legt den Regionscode fest.
|
otLinkSetSupportedChannelMask(otInstance *aInstance, uint32_t aChannelMask)
|
Legen Sie die unterstützte Kanalmaske der MAC-Ebene fest.
|
Strukturen |
|
---|---|
otActiveScanResult |
Stellt ein empfangenes IEEE 802.15.4-Beacon dar. |
otEnergyScanResult |
Stellt ein Ergebnis des Energiescans dar. |
otMacCounters |
Stellt die MAC-Ebenenzähler dar. |
otMacFilterEntry |
Stellt einen Mac-Filtereintrag dar. |
otThreadLinkInfo |
Linkspezifische Informationen zu Nachrichten, die vom Thread-Funk empfangen wurden. |
Aufzählungen
otMacFilterAddressMode
otMacFilterAddressMode
Definiert den Adressmodus des Mac-Filters.
Attribute | |
---|---|
OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST
|
Der Modus zum Filtern von Adressen auf der Zulassungsliste ist aktiviert. |
OT_MAC_FILTER_ADDRESS_MODE_DENYLIST
|
Der Filtermodus für die Sperrliste ist aktiviert. |
OT_MAC_FILTER_ADDRESS_MODE_DISABLED
|
Adressfilter ist deaktiviert. |
Typedefs
otActiveScanResult
struct otActiveScanResult otActiveScanResult
Stellt ein empfangenes IEEE 802.15.4-Beacon dar.
otEnergyScanResult
struct otEnergyScanResult otEnergyScanResult
Stellt ein Ergebnis des Energiescans dar.
otHandleActiveScanResult
void(* otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext)
Pointer wird während eines aktiven IEEE 802.15.4-Scans aufgerufen, wenn ein IEEE 802.15.4-Beacon empfangen wird oder der Scan abgeschlossen ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otHandleEnergyScanResult
void(* otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext)
Pointer wird während eines IEEE 802.15.4-Energiescans aufgerufen, wenn das Ergebnis für einen Kanal bereit ist oder der Scan abgeschlossen ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otLinkPcapCallback
void(* otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext)
Pointer wird aufgerufen, wenn ein IEEE 802.15.4-Frame empfangen wird.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otMacFilterAddressMode
enum otMacFilterAddressMode otMacFilterAddressMode
Definiert den Adressmodus des Mac-Filters.
otMacFilterIterator
uint8_t otMacFilterIterator
Wird verwendet, um durch Mac-Filtereinträge zu iterieren.
otThreadLinkInfo
struct otThreadLinkInfo otThreadLinkInfo
Linkspezifische Informationen zu Nachrichten, die vom Thread-Funk empfangen wurden.
Funktionen
otLinkActiveScan
otError otLinkActiveScan( otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void *aCallbackContext )
Startet einen aktiven Scan gemäß IEEE 802.15.4.
Details | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||
Rückgabewerte |
|
otLinkConvertLinkQualityToRss
int8_t otLinkConvertLinkQualityToRss( otInstance *aInstance, uint8_t aLinkQuality )
Wandelt die Linkqualität in die typische Empfangssignalstärke um.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabe |
Typische Plattform hat eine Zuordnung der Signalstärke zu
aLinkQuality empfangen. |
otLinkConvertRssToLinkQuality
uint8_t otLinkConvertRssToLinkQuality( otInstance *aInstance, int8_t aRss )
Wandelt die empfangene Signalstärke in die Linkqualität um.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabe |
Zuordnung des Qualitätswerts zu
aRss verknüpfen. |
otLinkEnergyScan
otError otLinkEnergyScan( otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext )
Startet einen IEEE 802.15.4-Energiescan.
Details | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||
Rückgabewerte |
|
otLinkFilterAddAddress
otError otLinkFilterAddAddress( otInstance *aInstance, const otExtAddress *aExtAddress )
Fügt dem MAC-Filter eine erweiterte Adresse hinzu.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otLinkFilterAddRssIn
otError otLinkFilterAddRssIn( otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss )
Fügt die angegebene erweiterte Adresse der RssIn
-Liste hinzu (oder ändert eine vorhandene Adresse in der RssIn
-Liste) und legt den Eintrag für die empfangene Signalstärke (in dBm) für Nachrichten von dieser Adresse fest.
Die erweiterte Adresse muss nicht unbedingt im Filter address allowlist/denylist
enthalten sein, um rss
festzulegen.
OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otLinkFilterClearAddresses
void otLinkFilterClearAddresses( otInstance *aInstance )
Löscht alle erweiterten Adressen aus dem MAC-Filter.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Details | |||
---|---|---|---|
Parameter |
|
otLinkFilterClearAllRssIn
void otLinkFilterClearAllRssIn( otInstance *aInstance )
Löscht alle Einträge für die empfangene Signalstärke (rss
) und die Linkqualitätsanzeige (lqi
) (einschließlich Standardeinstellungen) aus der Liste RssIn
.
Diese Aktion bedeutet, dass alle erweiterten Adressen das On-Air-Signal verwenden.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Details | |||
---|---|---|---|
Parameter |
|
otLinkFilterClearDefaultRssIn
void otLinkFilterClearDefaultRssIn( otInstance *aInstance )
Löscht die zuvor eingestellte Standardstärke des empfangenen Signals (in dBm) im MAC-Filter.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Details | |||
---|---|---|---|
Parameter |
|
otLinkFilterGetAddressMode
otMacFilterAddressMode otLinkFilterGetAddressMode( otInstance *aInstance )
Ruft den Adressmodus des MAC-Filters ab.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
im Adressmodus.
|
otLinkFilterGetNextAddress
otError otLinkFilterGetNextAddress( otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry )
Ruft einen bereits verwendeten Adressfilter ab.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otLinkFilterGetNextRssIn
otError otLinkFilterGetNextRssIn( otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry )
Ruft einen bereits verwendeten RssIn-Filtereintrag ab.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otLinkFilterRemoveAddress
void otLinkFilterRemoveAddress( otInstance *aInstance, const otExtAddress *aExtAddress )
Entfernt eine erweiterte Adresse aus dem MAC-Filter.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Wenn im Filter kein Eintrag vorhanden ist, der mit der angegebenen erweiterten Adresse übereinstimmt, wird keine Aktion ausgeführt.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otLinkFilterRemoveRssIn
void otLinkFilterRemoveRssIn( otInstance *aInstance, const otExtAddress *aExtAddress )
Entfernt die angegebene erweiterte Adresse aus der RssIn
-Liste.
Nach dem Entfernen aus der RssIn
-Liste verwendet diese MAC-Adresse stattdessen die Standardeinstellungen rss
und lqi
, sofern Standardeinstellungen festgelegt wurden. Wenn keine Standardeinstellungen festgelegt sind, wird das Over-Air-Signal verwendet.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Wenn in der Liste RssIn
kein Eintrag für die angegebene erweiterte Adresse vorhanden ist, wird keine Aktion ausgeführt.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otLinkFilterSetAddressMode
void otLinkFilterSetAddressMode( otInstance *aInstance, otMacFilterAddressMode aMode )
Legt den Adressmodus des MAC-Filters fest.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otLinkFilterSetDefaultRssIn
void otLinkFilterSetDefaultRssIn( otInstance *aInstance, int8_t aRss )
Legt die Standardstärke des empfangenen Signals (in dBm) für MAC Filter fest.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Der RSS-Standardwert wird für alle empfangenen Frames von Adressen verwendet, für die in der Filterliste kein expliziter RSS-IN-Eintrag vorhanden ist (durch otLinkFilterAddRssIn()
hinzugefügt).
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otLinkGetCcaFailureRate
uint16_t otLinkGetCcaFailureRate( otInstance *aInstance )
Gibt die aktuelle CCA-Fehlerrate (Clear Channel Assessment) zurück.
Die Rate wird über ein Fenster der (ungefähr) letzten Frameübertragungen von OPENTHREAD_CONFIG_CCA_FAILURE_RATE_AVERAGING_WINDOW
beibehalten.
Details | |
---|---|
Rückgabe |
Die CCA-Fehlerrate mit dem Höchstwert
0xffff , der einer Fehlerrate von 100% entspricht. |
otLinkGetChannel
uint8_t otLinkGetChannel( otInstance *aInstance )
Rufen Sie den IEEE 802.15.4-Kanal ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der IEEE 802.15.4-Kanal.
|
otLinkSetChannel
otLinkGetCounters
const otMacCounters * otLinkGetCounters( otInstance *aInstance )
Rufen Sie die MAC-Ebenenzähler ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf die MAC-Ebenenzähler.
|
otLinkGetCslChannel
uint8_t otLinkGetCslChannel( otInstance *aInstance )
Ruft den CSL-Kanal ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der CSL-Kanal.
|
otLinkGetCslPeriod
uint32_t otLinkGetCslPeriod( otInstance *aInstance )
Ruft den CSL-Zeitraum in Mikrosekunden ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der CSL-Zeitraum in Mikrosekunden.
|
otLinkGetCslTimeout
uint32_t otLinkGetCslTimeout( otInstance *aInstance )
Ruft das CSL-Zeitlimit ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Das CSL-Zeitlimit in Sekunden.
|
otLinkGetExtendedAddress
const otExtAddress * otLinkGetExtendedAddress( otInstance *aInstance )
Ruft die erweiterte IEEE 802.15.4-Adresse ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Verweis auf die erweiterte IEEE 802.15.4-Adresse.
|
otLinkGetFactoryAssignedIeeeEui64
void otLinkGetFactoryAssignedIeeeEui64( otInstance *aInstance, otExtAddress *aEui64 )
Holen Sie sich das werkseitig zugewiesene IEEE EUI-64.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otLinkGetMaxFrameRetriesDirect
uint8_t otLinkGetMaxFrameRetriesDirect( otInstance *aInstance )
Gibt die maximale Anzahl von Frame-Wiederholungen während der direkten Übertragung zurück.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die maximale Anzahl der Wiederholungsversuche während der direkten Übertragung.
|
otLinkGetMaxFrameRetriesIndirect
uint8_t otLinkGetMaxFrameRetriesIndirect( otInstance *aInstance )
Gibt die maximale Anzahl von Frame-Wiederholungen während der indirekten Übertragung zurück.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die maximale Anzahl der Wiederholungsversuche während der indirekten Übertragung.
|
otLinkGetPanId
otPanId otLinkGetPanId( otInstance *aInstance )
Rufen Sie die IEEE 802.15.4-PAN-ID ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die IEEE 802.15.4-PAN-ID.
|
otLinkSetPanId
otLinkGetPollPeriod
uint32_t otLinkGetPollPeriod( otInstance *aInstance )
Datenabfragezeitraum für ein schläfriges Endgerät abrufen.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Der Zeitraum der Datenabfrage des schläfrigen Endgeräts in Millisekunden.
|
otLinkSetPollPeriod
otLinkGetRegion
otError otLinkGetRegion( otInstance *aInstance, uint16_t *aRegionCode )
Rufen Sie den Regionscode ab.
Das Format der Funkregion entspricht der 2-Byte-ASCII-Darstellung des Alpha-2-Codes nach ISO 3166.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Rückgabewerte |
|
otLinkGetShortAddress
otShortAddress otLinkGetShortAddress( otInstance *aInstance )
Rufen Sie die IEEE 802.15.4-Kurzadresse ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Ein Zeiger auf die IEEE 802.15.4-Kurzadresse.
|
otLinkGetSupportedChannelMask
uint32_t otLinkGetSupportedChannelMask( otInstance *aInstance )
Rufen Sie die unterstützte Kanalmaske der MAC-Ebene ab.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
Die unterstützte Kanalmaske als
uint32_t mit einer Zuordnung von Bit 0 (lsb) zu Kanal 0, Bit 1 zu Kanal 1 usw. |
otLinkGetTxDirectRetrySuccessHistogram
const uint32_t * otLinkGetTxDirectRetrySuccessHistogram( otInstance *aInstance, uint8_t *aNumberOfEntries )
Ruft das Histogramm der Wiederholungsversuche für ein einzelnes direktes Paket bis zum Erfolg ab.
Ist gültig, wenn die Konfiguration OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabe |
Ein Zeiger auf das Histogramm der Wiederholungsversuche (in Form eines Arrays). Das n-te Element gibt an, dass das Paket mit dem n-ten Wiederholungsversuch gesendet wurde.
|
otLinkGetTxIndirectRetrySuccessHistogram
const uint32_t * otLinkGetTxIndirectRetrySuccessHistogram( otInstance *aInstance, uint8_t *aNumberOfEntries )
Ruft das Histogramm der Wiederholungsversuche für ein einzelnes indirektes Paket bis zum Erfolg ab.
Ist gültig, wenn die Konfiguration OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabe |
Ein Zeiger auf das Histogramm der Wiederholungsversuche (in Form eines Arrays). Das n-te Element gibt an, dass das Paket mit dem n-ten Wiederholungsversuch gesendet wurde.
|
otLinkIsActiveScanInProgress
bool otLinkIsActiveScanInProgress( otInstance *aInstance )
Gibt an, ob gerade ein aktiver IEEE 802.15.4-Scan ausgeführt wird.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
„true“, wenn ein aktiver Scan gemäß IEEE 802.15.4 ausgeführt wird, andernfalls „false“.
|
otLinkIsCslEnabled
bool otLinkIsCslEnabled( otInstance *aInstance )
Gibt an, ob CSL aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otLinkIsCslSupported
bool otLinkIsCslSupported( otInstance *aInstance )
Gibt an, ob das Gerät mit einem Elternteil verbunden ist, der CSL unterstützt.
Details | |||||
---|---|---|---|---|---|
Rückgabewerte |
|
otLinkIsEnabled
bool otLinkIsEnabled( otInstance *aInstance )
Gibt an, ob die Link-Ebene aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otLinkIsEnergyScanInProgress
bool otLinkIsEnergyScanInProgress( otInstance *aInstance )
Gibt an, ob gerade ein IEEE 802.15.4-Energiescan ausgeführt wird.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
„true“, wenn ein IEEE 802.15.4-Energiescan ausgeführt wird, andernfalls „false“.
|
otLinkIsInTransmitState
bool otLinkIsInTransmitState( otInstance *aInstance )
Gibt an, ob sich ein IEEE 802.15.4-MAC im Übertragungsstatus befindet.
Das MAC-Modul befindet sich während der CSMA/CA-Verfahren bzw. der CCA-, Daten-, Beacon- oder Datenanfrage-Frameübertragung im Übertragungsstatus und empfängt eine Bestätigung eines übertragenen Frames. Das MAC-Modul befindet sich bei der Übertragung eines ACK-Frames oder eines Beacon-Request-Frames nicht im Übertragungsstatus.
Details | |||
---|---|---|---|
Parameter |
|
||
Rückgabe |
„true“, wenn ein IEEE 802.15.4-MAC im Übertragungsstatus ist, andernfalls „false“.
|
otLinkIsPromiscuous
bool otLinkIsPromiscuous( otInstance *aInstance )
Gibt an, ob der promiskuitive Modus auf Linkebene aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otLinkIsRadioFilterEnabled
bool otLinkIsRadioFilterEnabled( otInstance *aInstance )
Gibt an, ob der IEEE 802.15.4-Funkfilter aktiviert ist oder nicht.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Details | |||||
---|---|---|---|---|---|
Rückgabewerte |
|
otLinkResetCounters
void otLinkResetCounters( otInstance *aInstance )
Setzt die MAC-Ebenenzähler zurück.
Details | |||
---|---|---|---|
Parameter |
|
otLinkResetTxRetrySuccessHistogram
void otLinkResetTxRetrySuccessHistogram( otInstance *aInstance )
Löscht Histogrammstatistiken für direkte und indirekte Übertragungen.
Ist gültig, wenn die Konfiguration OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE aktiviert ist.
Details | |||
---|---|---|---|
Parameter |
|
otLinkSendDataRequest
otError otLinkSendDataRequest( otInstance *aInstance )
Stellt eine IEEE 802.15.4-Datenanfragenachricht zur Übertragung in die Warteschlange.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otLinkSendEmptyData
otError otLinkSendEmptyData( otInstance *aInstance )
Weist das Gerät an, einen leeren IEEE 802.15.4-Dataframe zu senden.
Wird nur auf einem Rx-Off-When-Idle-Gerät unterstützt, das einen leeren Dataframe an das übergeordnete Gerät sendet. Hinweis: Nur verfügbar, wenn OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
aktiviert ist.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otLinkSetChannel
otError otLinkSetChannel( otInstance *aInstance, uint8_t aChannel )
Legen Sie den IEEE 802.15.4-Kanal fest.
Nur erfolgreich, wenn Thread-Protokolle deaktiviert sind. Ein erfolgreicher Aufruf dieser Funktion macht die aktiven und ausstehenden operativen Datasets im nichtflüchtigen Speicher ungültig.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otLinkGetChannel
otLinkSetCslChannel
otError otLinkSetCslChannel( otInstance *aInstance, uint8_t aChannel )
Legt den CSL-Kanal fest.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otLinkSetCslPeriod
otError otLinkSetCslPeriod( otInstance *aInstance, uint32_t aPeriod )
Legt den CSL-Zeitraum in Mikrosekunden fest.
Deaktivieren Sie CSL, indem Sie diesen Parameter auf 0
setzen.
Der CSL-Zeitraum MUSS ein Vielfaches von OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC
sein, andernfalls wird OT_ERROR_INVALID_ARGS
zurückgegeben.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otLinkSetCslTimeout
otError otLinkSetCslTimeout( otInstance *aInstance, uint32_t aTimeout )
Legt das CSL-Zeitlimit in Sekunden fest.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otLinkSetEnabled
otError otLinkSetEnabled( otInstance *aInstance, bool aEnable )
Aktiviert oder deaktiviert die Link-Ebene.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otLinkSetExtendedAddress
otError otLinkSetExtendedAddress( otInstance *aInstance, const otExtAddress *aExtAddress )
Legt die erweiterte IEEE 802.15.4-Adresse fest.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otLinkSetMaxFrameRetriesDirect
void otLinkSetMaxFrameRetriesDirect( otInstance *aInstance, uint8_t aMaxFrameRetriesDirect )
Legt die maximale Anzahl von Frame-Wiederholungen während der direkten Übertragung fest.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otLinkSetMaxFrameRetriesIndirect
void otLinkSetMaxFrameRetriesIndirect( otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect )
Legt die maximale Anzahl von Frame-Wiederholungen während der indirekten Übertragung fest.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otLinkSetPanId
otError otLinkSetPanId( otInstance *aInstance, otPanId aPanId )
Legen Sie die IEEE 802.15.4-PAN-ID fest.
Nur erfolgreich, wenn Thread-Protokolle deaktiviert sind. Ein erfolgreicher Aufruf dieser Funktion macht auch die aktiven und ausstehenden operativen Datasets im nichtflüchtigen Speicher ungültig.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otLinkGetPanId
otLinkSetPcapCallback
void otLinkSetPcapCallback( otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext )
Registriert einen Callback, um empfangene Roh-IEEE 802.15.4-Frames bereitzustellen.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otLinkSetPollPeriod
otError otLinkSetPollPeriod( otInstance *aInstance, uint32_t aPollPeriod )
Hiermit wird der Zeitraum der vom Nutzer angegebenen/externen Datenabfrage für schläfriges Endgerät festgelegt/gelöscht.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otLinkGetPollPeriod
otLinkSetPromiscuous
otError otLinkSetPromiscuous( otInstance *aInstance, bool aPromiscuous )
Aktiviert oder deaktiviert den promiskuitiven Modus der Link-Ebene.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
otLinkSetRadioFilterEnabled
void otLinkSetRadioFilterEnabled( otInstance *aInstance, bool aFilterEnabled )
Aktiviert/deaktiviert den IEEE 802.15.4-Funkfiltermodus.
Ist verfügbar, wenn die OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
-Konfiguration aktiviert ist.
Der Funkfilter ist hauptsächlich zum Testen gedacht. Es kann verwendet werden, um vorübergehend alle tx/rx auf der 802.15.4-Funkschnittstelle zu blockieren. Wenn der Funkfilter aktiviert ist, wird das Radio in den Ruhezustand versetzt und nicht in den Empfang, um sicherzustellen, dass das Gerät keinen Frame empfängt und/oder keine Bestätigung sendet. Außerdem werden die Anfragen zur Frameübertragung sofort zurückgegeben, ohne dass der Frame over-the-air gesendet wird. Wenn eine Bestätigung angefordert wird, wird der Fehler „no ack“ zurückgegeben, andernfalls „Erfolg“.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
otLinkSetRegion
otError otLinkSetRegion( otInstance *aInstance, uint16_t aRegionCode )
Legt den Regionscode fest.
Das Format der Funkregion entspricht der 2-Byte-ASCII-Darstellung des Alpha-2-Codes nach ISO 3166.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Rückgabewerte |
|
otLinkSetSupportedChannelMask
otError otLinkSetSupportedChannelMask( otInstance *aInstance, uint32_t aChannelMask )
Legen Sie die unterstützte Kanalmaske der MAC-Ebene fest.
Nur erfolgreich, wenn Thread-Protokolle deaktiviert sind.
Details | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Rückgabewerte |
|
Makros
OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC
OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC (160)
Stellt die Einheit des CSL-Zeitraums mit zehn Symbolen in Mikrosekunden dar.
Der CSL-Zeitraum (in Mikrosekunden) MUSS ein Vielfaches dieses Werts sein.
OT_MAC_FILTER_FIXED_RSS_DISABLED
OT_MAC_FILTER_FIXED_RSS_DISABLED 127
Wird verwendet, um anzuzeigen, dass keine feste Empfangssignalstärke eingestellt wurde.
OT_MAC_FILTER_ITERATOR_INIT
OT_MAC_FILTER_ITERATOR_INIT 0
Initialisierer für otMacFilterIterator.
OT_US_PER_TEN_SYMBOLS
OT_US_PER_TEN_SYMBOLS OT_RADIO_TEN_SYMBOLS_TIME
Zeit für 10 Symbole in Mikrosekunden.
Ressourcen
OpenThread API-Referenzthemen stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen finden Sie unter Ressourcen. Dort können Sie auch einen Beitrag zu unserer Dokumentation leisten.