Lien
Ce module comprend des fonctions qui contrôlent la configuration de la couche de liaison.
Résumé
Énumérations |
|
---|---|
otMacFilterAddressMode{
|
enum Définit le mode d'adresse du filtre Mac. |
Typedefs |
|
---|---|
otActiveScanResult
|
typedefstruct otActiveScanResult
Représente une balise IEEE 802.15.4 reçue. |
otEnergyScanResult
|
typedefstruct otEnergyScanResult
Représente un résultat d'analyse d'énergie. |
otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext)
|
typedefvoid(*
Le pointeur est appelé lors d'une analyse active IEEE 802.15.4 lors de la réception d'une balise IEEE 802.15.4 ou de la fin de l'analyse. |
otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext)
|
typedefvoid(*
Le pointeur est appelé lors d'une analyse énergétique IEEE 802.15.4 lorsque le résultat d'un canal est prêt ou que la recherche est terminée. |
otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext)
|
typedefvoid(*
Le pointeur est appelé lorsqu'une trame IEEE 802.15.4 est reçue. |
otMacCounters
|
typedefstruct otMacCounters
Représente les compteurs de couche MAC. |
otMacFilterAddressMode
|
typedef Définit le mode d'adresse du filtre Mac. |
otMacFilterEntry
|
typedefstruct otMacFilterEntry
Représente une entrée de filtre Mac. |
otMacFilterIterator
|
typedefuint8_t
Utilisé pour itérer les entrées de filtre Mac. |
otThreadLinkInfo
|
typedefstruct otThreadLinkInfo
Représente les informations spécifiques au lien pour les messages reçus depuis la radio Thread. |
distantes |
|
---|---|
otLinkActiveScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void *aCallbackContext)
|
Démarre une analyse active de la norme IEEE 802.15.4.
|
otLinkConvertLinkQualityToRss(otInstance *aInstance, uint8_t aLinkQuality)
|
int8_t
Convertit la qualité du lien en intensité standard du signal reçu.
|
otLinkConvertRssToLinkQuality(otInstance *aInstance, int8_t aRss)
|
uint8_t
Convertit l'intensité du signal reçu en qualité de la liaison.
|
otLinkEnergyScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext)
|
Démarre une analyse énergétique IEEE 802.15.4.
|
otLinkFilterAddAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
|
Ajoute une adresse étendue au filtre MAC.
|
otLinkFilterAddRssIn(otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss)
|
Ajoute l'adresse étendue spécifiée à la liste
RssIn (ou modifie une adresse existante dans la liste RssIn ) et définit l'intensité du signal reçu (en dBm) pour les messages provenant de cette adresse. |
otLinkFilterClearAddresses(otInstance *aInstance)
|
void
Efface toutes les adresses étendues de MAC.
|
otLinkFilterClearAllRssIn(otInstance *aInstance)
|
void
Efface toutes les entrées d'intensité du signal reçu (
rss ) et de l'indicateur de qualité du lien (lqi ) (y compris les valeurs par défaut) de la liste RssIn . |
otLinkFilterClearDefaultRssIn(otInstance *aInstance)
|
void
Efface l'intensité du signal reçu par défaut (en dBm) définie sur le filtre MAC.
|
otLinkFilterGetAddressMode(otInstance *aInstance)
|
Récupère le mode d'adresse du filtre MAC.
|
otLinkFilterGetNextAddress(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
|
Récupère une entrée de filtre d'adresses en cours d'utilisation.
|
otLinkFilterGetNextRssIn(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
|
Récupère une entrée de filtre RssIn en cours d'utilisation.
|
otLinkFilterRemoveAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
|
void
Supprime une adresse étendue du filtre MAC.
|
otLinkFilterRemoveRssIn(otInstance *aInstance, const otExtAddress *aExtAddress)
|
void
Supprime l'adresse étendue spécifiée de la liste
RssIn . |
otLinkFilterSetAddressMode(otInstance *aInstance, otMacFilterAddressMode aMode)
|
void
Définit le mode d'adresse du filtre MAC.
|
otLinkFilterSetDefaultRssIn(otInstance *aInstance, int8_t aRss)
|
void
Définit l'intensité du signal reçu par défaut (en dBm) sur le filtre MAC.
|
otLinkGetCcaFailureRate(otInstance *aInstance)
|
uint16_t
Renvoie le taux d'échec actuel de l'évaluation des canaux de distribution (CCA, Clear Channel Assessment).
|
otLinkGetChannel(otInstance *aInstance)
|
uint8_t
Obtenir le canal IEEE 802.15.4
|
otLinkGetCounters(otInstance *aInstance)
|
const otMacCounters *
Obtenez les compteurs de couche MAC.
|
otLinkGetCslChannel(otInstance *aInstance)
|
uint8_t
Récupère le canal CSL.
|
otLinkGetCslPeriod(otInstance *aInstance)
|
uint32_t
Récupère la période CSL en microsecondes.
|
otLinkGetCslTimeout(otInstance *aInstance)
|
uint32_t
Récupère le délai avant expiration de CSL.
|
otLinkGetExtendedAddress(otInstance *aInstance)
|
const otExtAddress *
Récupère l'adresse étendue IEEE 802.15.4.
|
otLinkGetFactoryAssignedIeeeEui64(otInstance *aInstance, otExtAddress *aEui64)
|
void
Obtenez l'IEEE EUI-64 attribué en usine.
|
otLinkGetMaxFrameRetriesDirect(otInstance *aInstance)
|
uint8_t
Renvoie le nombre maximal de tentatives d'une trame lors de la transmission directe.
|
otLinkGetMaxFrameRetriesIndirect(otInstance *aInstance)
|
uint8_t
Renvoie le nombre maximal de tentatives d'affichage des trames lors de la transmission indirecte.
|
otLinkGetPanId(otInstance *aInstance)
|
Obtenez l'ID de PAN IEEE 802.15.4.
|
otLinkGetPollPeriod(otInstance *aInstance)
|
uint32_t
Obtenez la période d'interrogation des données de l'appareil final endormi.
|
otLinkGetRegion(otInstance *aInstance, uint16_t *aRegionCode)
|
Obtenez le code régional.
|
otLinkGetShortAddress(otInstance *aInstance)
|
Obtenez l'adresse courte IEEE 802.15.4.
|
otLinkGetSupportedChannelMask(otInstance *aInstance)
|
uint32_t
Obtenir le masque de canal compatible de la couche MAC
|
otLinkGetTxDirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)
|
const uint32_t *
Récupère l'histogramme des nouvelles tentatives pour un seul paquet direct jusqu'à un succès.
|
otLinkGetTxIndirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)
|
const uint32_t *
Récupère l'histogramme des nouvelles tentatives pour un seul paquet indirect jusqu'à ce que l'opération réussisse.
|
otLinkIsActiveScanInProgress(otInstance *aInstance)
|
bool
Indique si une analyse active IEEE 802.15.4 est en cours.
|
otLinkIsCslEnabled(otInstance *aInstance)
|
bool
Indique si CSL est activé ou non.
|
otLinkIsCslSupported(otInstance *aInstance)
|
bool
Indique si l'appareil est connecté à un parent compatible avec CSL.
|
otLinkIsEnabled(otInstance *aInstance)
|
bool
Indique si la couche de lien est activée ou non.
|
otLinkIsEnergyScanInProgress(otInstance *aInstance)
|
bool
Indique si une analyse énergétique IEEE 802.15.4 est en cours.
|
otLinkIsInTransmitState(otInstance *aInstance)
|
bool
Indique si un MAC IEEE 802.15.4 est en état de transmission.
|
otLinkIsPromiscuous(otInstance *aInstance)
|
bool
Indique si le mode promiscuité est activé ou non au niveau de la couche de liaison.
|
otLinkIsRadioFilterEnabled(otInstance *aInstance)
|
bool
Indique si le filtre radio IEEE 802.15.4 est activé ou non.
|
otLinkResetCounters(otInstance *aInstance)
|
void
Réinitialise les compteurs de couche MAC.
|
otLinkResetTxRetrySuccessHistogram(otInstance *aInstance)
|
void
Efface les statistiques de l'histogramme pour les transmissions directes et indirectes.
|
otLinkSendDataRequest(otInstance *aInstance)
|
Met en file d'attente un message de requête de données IEEE 802.15.4 en vue de sa transmission.
|
otLinkSendEmptyData(otInstance *aInstance)
|
Ordonne à l'appareil d'envoyer une trame de données IEEE 802.15.4 vide.
|
otLinkSetChannel(otInstance *aInstance, uint8_t aChannel)
|
Définissez le canal IEEE 802.15.4.
|
otLinkSetCslChannel(otInstance *aInstance, uint8_t aChannel)
|
Définit le canal CSL.
|
otLinkSetCslPeriod(otInstance *aInstance, uint32_t aPeriod)
|
Définit la période CSL en microsecondes.
|
otLinkSetCslTimeout(otInstance *aInstance, uint32_t aTimeout)
|
Définit le délai avant expiration CSL en secondes.
|
otLinkSetEnabled(otInstance *aInstance, bool aEnable)
|
Active ou désactive la couche de liaison.
|
otLinkSetExtendedAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
|
Définit l'adresse étendue IEEE 802.15.4.
|
otLinkSetMaxFrameRetriesDirect(otInstance *aInstance, uint8_t aMaxFrameRetriesDirect)
|
void
Définit le nombre maximal de tentatives d'affichage des images au cours de la transmission directe.
|
otLinkSetMaxFrameRetriesIndirect(otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect)
|
void
Définit le nombre maximal de tentatives d'affichage des images lors de la transmission indirecte.
|
otLinkSetPanId(otInstance *aInstance, otPanId aPanId)
|
Définissez l'ID de PAN IEEE 802.15.4.
|
otLinkSetPcapCallback(otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext)
|
void
Enregistre un rappel pour fournir les trames IEEE 802.15.4 brutes reçues.
|
otLinkSetPollPeriod(otInstance *aInstance, uint32_t aPollPeriod)
|
Définir/Effacer la période d'interrogation des données externes/spécifiées par l'utilisateur pour l'appareil endormi.
|
otLinkSetPromiscuous(otInstance *aInstance, bool aPromiscuous)
|
Active ou désactive le mode promiscuité de la couche de liaison.
|
otLinkSetRadioFilterEnabled(otInstance *aInstance, bool aFilterEnabled)
|
void
Active/désactive le mode de filtrage radio IEEE 802.15.4.
|
otLinkSetRegion(otInstance *aInstance, uint16_t aRegionCode)
|
Définit le code régional.
|
otLinkSetSupportedChannelMask(otInstance *aInstance, uint32_t aChannelMask)
|
Définissez le masque de canal compatible de la couche MAC.
|
Structs |
|
---|---|
otActiveScanResult |
Représente une balise IEEE 802.15.4 reçue. |
otEnergyScanResult |
Représente un résultat d'analyse d'énergie. |
otMacCounters |
Représente les compteurs de couche MAC. |
otMacFilterEntry |
Représente une entrée de filtre Mac. |
otThreadLinkInfo |
Représente les informations spécifiques au lien pour les messages reçus depuis la radio Thread. |
Énumérations
otMacFilterAddressMode
otMacFilterAddressMode
Définit le mode d'adresse du filtre Mac.
Propriétés | |
---|---|
OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST
|
Le mode de filtrage des adresses dans la liste d'autorisation est activé. |
OT_MAC_FILTER_ADDRESS_MODE_DENYLIST
|
Le mode de filtrage des adresses sur liste de blocage est activé. |
OT_MAC_FILTER_ADDRESS_MODE_DISABLED
|
Le filtre d'adresses est désactivé. |
Typedefs
otActiveScanResult
struct otActiveScanResult otActiveScanResult
Représente une balise IEEE 802.15.4 reçue.
otEnergyScanResult
struct otEnergyScanResult otEnergyScanResult
Représente un résultat d'analyse d'énergie.
otHandleActiveScanResult
void(* otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext)
Le pointeur est appelé lors d'une analyse active IEEE 802.15.4 lors de la réception d'une balise IEEE 802.15.4 ou de la fin de l'analyse.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otHandleEnergyScanResult
void(* otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext)
Le pointeur est appelé lors d'une analyse énergétique IEEE 802.15.4 lorsque le résultat d'un canal est prêt ou que la recherche est terminée.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otLinkPcapCallback
void(* otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext)
Le pointeur est appelé lorsqu'une trame IEEE 802.15.4 est reçue.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
otMacFilterAddressMode
enum otMacFilterAddressMode otMacFilterAddressMode
Définit le mode d'adresse du filtre Mac.
otMacFilterIterator
uint8_t otMacFilterIterator
Utilisé pour itérer les entrées de filtre Mac.
otThreadLinkInfo
struct otThreadLinkInfo otThreadLinkInfo
Représente les informations spécifiques au lien pour les messages reçus depuis la radio Thread.
distantes
otLinkActiveScan
otError otLinkActiveScan( otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void *aCallbackContext )
Démarre une analyse active de la norme IEEE 802.15.4.
Détails | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||||
Valeurs de retour |
|
otLinkConvertLinkQualityToRss
int8_t otLinkConvertLinkQualityToRss( otInstance *aInstance, uint8_t aLinkQuality )
Convertit la qualité du lien en intensité standard du signal reçu.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Renvoie |
L'intensité du signal reçue par la plate-forme habituelle correspond à
aLinkQuality . |
otLinkConvertRssToLinkQuality
uint8_t otLinkConvertRssToLinkQuality( otInstance *aInstance, int8_t aRss )
Convertit l'intensité du signal reçu en qualité de la liaison.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Renvoie |
Associez la mise en correspondance de la valeur de qualité à
aRss . |
otLinkEnergyScan
otError otLinkEnergyScan( otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext )
Démarre une analyse énergétique IEEE 802.15.4.
Détails | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||||
Valeurs de retour |
|
otLinkFilterAddAddress
otError otLinkFilterAddAddress( otInstance *aInstance, const otExtAddress *aExtAddress )
Ajoute une adresse étendue au filtre MAC.
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs de retour |
|
otLinkFilterAddRssIn
otError otLinkFilterAddRssIn( otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss )
Ajoute l'adresse étendue spécifiée à la liste RssIn
(ou modifie une adresse existante dans la liste RssIn
) et définit l'intensité du signal reçu (en dBm) pour les messages provenant de cette adresse.
L'adresse étendue ne doit pas nécessairement figurer dans le filtre address allowlist/denylist
pour définir rss
.
OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs de retour |
|
otLinkFilterClearAddresses
void otLinkFilterClearAddresses( otInstance *aInstance )
Efface toutes les adresses étendues de MAC.
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Détails | |||
---|---|---|---|
Paramètres |
|
otLinkFilterClearAllRssIn
void otLinkFilterClearAllRssIn( otInstance *aInstance )
Efface toutes les entrées d'intensité du signal reçu (rss
) et de l'indicateur de qualité du lien (lqi
) (y compris les valeurs par défaut) de la liste RssIn
.
Cette action signifie que toutes les adresses étendues utiliseront le signal à l'antenne.
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Détails | |||
---|---|---|---|
Paramètres |
|
otLinkFilterClearDefaultRssIn
void otLinkFilterClearDefaultRssIn( otInstance *aInstance )
Efface l'intensité du signal reçu par défaut (en dBm) définie sur le filtre MAC.
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Détails | |||
---|---|---|---|
Paramètres |
|
otLinkFilterGetAddressMode
otMacFilterAddressMode otLinkFilterGetAddressMode( otInstance *aInstance )
Récupère le mode d'adresse du filtre MAC.
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
le mode d'adresse.
|
otLinkFilterGetNextAddress
otError otLinkFilterGetNextAddress( otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry )
Récupère une entrée de filtre d'adresses en cours d'utilisation.
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs de retour |
|
otLinkFilterGetNextRssIn
otError otLinkFilterGetNextRssIn( otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry )
Récupère une entrée de filtre RssIn en cours d'utilisation.
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs de retour |
|
otLinkFilterRemoveAddress
void otLinkFilterRemoveAddress( otInstance *aInstance, const otExtAddress *aExtAddress )
Supprime une adresse étendue du filtre MAC.
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Aucune action n'est effectuée si aucune entrée existante dans le filtre ne correspond à l'adresse étendue donnée.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otLinkFilterRemoveRssIn
void otLinkFilterRemoveRssIn( otInstance *aInstance, const otExtAddress *aExtAddress )
Supprime l'adresse étendue spécifiée de la liste RssIn
.
Une fois supprimée de la liste RssIn
, cette adresse MAC utilisera à la place les paramètres rss
et lqi
par défaut, en supposant que des valeurs par défaut aient été définies. (Si aucune valeur par défaut n'a été définie, le signal Over The Air est utilisé.)
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Aucune action n'est effectuée si la liste RssIn
ne contient aucune entrée correspondant à l'adresse étendue spécifiée.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otLinkFilterSetAddressMode
void otLinkFilterSetAddressMode( otInstance *aInstance, otMacFilterAddressMode aMode )
Définit le mode d'adresse du filtre MAC.
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otLinkFilterSetDefaultRssIn
void otLinkFilterSetDefaultRssIn( otInstance *aInstance, int8_t aRss )
Définit l'intensité du signal reçu par défaut (en dBm) sur le filtre MAC.
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
La valeur RSS par défaut est utilisée pour tous les frames reçus à partir d'adresses pour lesquelles il n'y a pas d'entrée RSS-IN explicite dans la liste des filtres (ajoutée avec otLinkFilterAddRssIn()
).
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otLinkGetCcaFailureRate
uint16_t otLinkGetCcaFailureRate( otInstance *aInstance )
Renvoie le taux d'échec actuel de l'évaluation des canaux de distribution (CCA, Clear Channel Assessment).
Le débit est maintenu sur une fenêtre des dernières transmissions de trames (approximativement) OPENTHREAD_CONFIG_CCA_FAILURE_RATE_AVERAGING_WINDOW
.
Détails | |
---|---|
Renvoie |
Taux d'échec des CCA, avec une valeur maximale de
0xffff correspondant à un taux d'échec de 100 %. |
otLinkGetChannel
uint8_t otLinkGetChannel( otInstance *aInstance )
Obtenir le canal IEEE 802.15.4
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Canal IEEE 802.15.4.
|
otLinkSetChannel
otLinkGetCounters
const otMacCounters * otLinkGetCounters( otInstance *aInstance )
Obtenez les compteurs de couche MAC.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Un pointeur vers les compteurs de couche MAC.
|
otLinkGetCslChannel
uint8_t otLinkGetCslChannel( otInstance *aInstance )
Récupère le canal CSL.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Version CSL
|
otLinkGetCslPeriod
uint32_t otLinkGetCslPeriod( otInstance *aInstance )
Récupère la période CSL en microsecondes.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Période CSL en microsecondes.
|
otLinkGetCslTimeout
uint32_t otLinkGetCslTimeout( otInstance *aInstance )
Récupère le délai avant expiration de CSL.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Délai avant expiration de CSL en secondes.
|
otLinkGetExtendedAddress
const otExtAddress * otLinkGetExtendedAddress( otInstance *aInstance )
Récupère l'adresse étendue IEEE 802.15.4.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Pointeur vers l'adresse étendue IEEE 802.15.4.
|
otLinkGetFactoryAssignedIeeeEui64
void otLinkGetFactoryAssignedIeeeEui64( otInstance *aInstance, otExtAddress *aEui64 )
Obtenez l'IEEE EUI-64 attribué en usine.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otLinkGetMaxFrameRetriesDirect
uint8_t otLinkGetMaxFrameRetriesDirect( otInstance *aInstance )
Renvoie le nombre maximal de tentatives d'une trame lors de la transmission directe.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Nombre maximal de tentatives lors de la transmission directe.
|
otLinkGetMaxFrameRetriesIndirect
uint8_t otLinkGetMaxFrameRetriesIndirect( otInstance *aInstance )
Renvoie le nombre maximal de tentatives d'affichage des trames lors de la transmission indirecte.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Nombre maximal de tentatives lors de la transmission indirecte.
|
otLinkGetPanId
otPanId otLinkGetPanId( otInstance *aInstance )
Obtenez l'ID de PAN IEEE 802.15.4.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
ID du PAN IEEE 802.15.4.
|
otLinkSetPanId
otLinkGetPollPeriod
uint32_t otLinkGetPollPeriod( otInstance *aInstance )
Obtenez la période d'interrogation des données de l'appareil final endormi.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Période d'interrogation des données de l'appareil final endormi, en millisecondes.
|
otLinkSetPollPeriod
otLinkGetRegion
otError otLinkGetRegion( otInstance *aInstance, uint16_t *aRegionCode )
Obtenez le code régional.
Le format de la région radio est la représentation ASCII de deux octets du code alpha-2 de la norme ISO 3166.
Détails | |||||||||
---|---|---|---|---|---|---|---|---|---|
Paramètres |
|
||||||||
Valeurs de retour |
|
otLinkGetShortAddress
otShortAddress otLinkGetShortAddress( otInstance *aInstance )
Obtenez l'adresse courte IEEE 802.15.4.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Pointeur vers l'adresse abrégée IEEE 802.15.4.
|
otLinkGetSupportedChannelMask
uint32_t otLinkGetSupportedChannelMask( otInstance *aInstance )
Obtenir le masque de canal compatible de la couche MAC
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
Masque de canal compatible en tant que
uint32_t , avec le bit 0 (lsb) mappé au canal 0, le bit 1 au canal 1, etc. |
otLinkGetTxDirectRetrySuccessHistogram
const uint32_t * otLinkGetTxDirectRetrySuccessHistogram( otInstance *aInstance, uint8_t *aNumberOfEntries )
Récupère l'histogramme des nouvelles tentatives pour un seul paquet direct jusqu'à un succès.
Est valide lorsque la configuration OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE est activée.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Renvoie |
Pointeur vers l'histogramme des nouvelles tentatives (sous la forme d'un tableau). Le n-ième élément indique que le paquet a été envoyé avec n-ième tentative.
|
otLinkGetTxIndirectRetrySuccessHistogram
const uint32_t * otLinkGetTxIndirectRetrySuccessHistogram( otInstance *aInstance, uint8_t *aNumberOfEntries )
Récupère l'histogramme des nouvelles tentatives pour un seul paquet indirect jusqu'à ce que l'opération réussisse.
Est valide lorsque la configuration OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE est activée.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Renvoie |
Pointeur vers l'histogramme des nouvelles tentatives (sous la forme d'un tableau). Le n-ième élément indique que le paquet a été envoyé avec n-ième tentative.
|
otLinkIsActiveScanInProgress
bool otLinkIsActiveScanInProgress( otInstance *aInstance )
Indique si une analyse active IEEE 802.15.4 est en cours.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
"true" si une analyse active de la norme IEEE 802.15.4 est en cours, ou "false" dans le cas contraire.
|
otLinkIsCslEnabled
bool otLinkIsCslEnabled( otInstance *aInstance )
Indique si CSL est activé ou non.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs de retour |
|
otLinkIsCslSupported
bool otLinkIsCslSupported( otInstance *aInstance )
Indique si l'appareil est connecté à un parent compatible avec CSL.
Détails | |||||
---|---|---|---|---|---|
Valeurs de retour |
|
otLinkIsEnabled
bool otLinkIsEnabled( otInstance *aInstance )
Indique si la couche de lien est activée ou non.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs de retour |
|
otLinkIsEnergyScanInProgress
bool otLinkIsEnergyScanInProgress( otInstance *aInstance )
Indique si une analyse énergétique IEEE 802.15.4 est en cours.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
"true" si une analyse énergétique IEEE 802.15.4 est en cours, ou "false" dans le cas contraire.
|
otLinkIsInTransmitState
bool otLinkIsInTransmitState( otInstance *aInstance )
Indique si un MAC IEEE 802.15.4 est en état de transmission.
Le module MAC est à l'état de transmission pendant la transmission de la procédure CSMA/CA, CCA, des données, des balises ou des trames de requête de données et lors de la réception d'un ACK d'une trame transmise. Le module MAC n'est pas à l'état de transmission lors de la transmission d'une trame ACK ou d'une trame Beacon Request.
Détails | |||
---|---|---|---|
Paramètres |
|
||
Renvoie |
"true" si un MAC IEEE 802.15.4 est en état de transmission, "false" dans le cas contraire.
|
otLinkIsPromiscuous
bool otLinkIsPromiscuous( otInstance *aInstance )
Indique si le mode promiscuité est activé ou non au niveau de la couche de liaison.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs de retour |
|
otLinkIsRadioFilterEnabled
bool otLinkIsRadioFilterEnabled( otInstance *aInstance )
Indique si le filtre radio IEEE 802.15.4 est activé ou non.
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Détails | |||||
---|---|---|---|---|---|
Valeurs de retour |
|
otLinkResetCounters
void otLinkResetCounters( otInstance *aInstance )
Réinitialise les compteurs de couche MAC.
Détails | |||
---|---|---|---|
Paramètres |
|
otLinkResetTxRetrySuccessHistogram
void otLinkResetTxRetrySuccessHistogram( otInstance *aInstance )
Efface les statistiques de l'histogramme pour les transmissions directes et indirectes.
Est valide lorsque la configuration OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE est activée.
Détails | |||
---|---|---|---|
Paramètres |
|
otLinkSendDataRequest
otError otLinkSendDataRequest( otInstance *aInstance )
Met en file d'attente un message de requête de données IEEE 802.15.4 en vue de sa transmission.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs de retour |
|
otLinkSendEmptyData
otError otLinkSendEmptyData( otInstance *aInstance )
Ordonne à l'appareil d'envoyer une trame de données IEEE 802.15.4 vide.
N'est compatible qu'avec les appareils Rx-Off-When-Inactif pour envoyer une trame de données vide à son parent. Remarque: disponible uniquement lorsque OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
est activé.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs de retour |
|
otLinkSetChannel
otError otLinkSetChannel( otInstance *aInstance, uint8_t aChannel )
Définissez le canal IEEE 802.15.4.
L'opération ne fonctionne que lorsque les protocoles Thread sont désactivés. L'appel réussi de cette fonction invalide les ensembles de données opérationnels actifs et en attente en mémoire non volatile.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs de retour |
|
otLinkGetChannel
otLinkSetCslChannel
otError otLinkSetCslChannel( otInstance *aInstance, uint8_t aChannel )
Définit le canal CSL.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs de retour |
|
otLinkSetCslPeriod
otError otLinkSetCslPeriod( otInstance *aInstance, uint32_t aPeriod )
Définit la période CSL en microsecondes.
Désactivez CSL en définissant ce paramètre sur 0
.
La période CSL DOIT être un multiple de OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC
. Sinon, la valeur OT_ERROR_INVALID_ARGS
est renvoyée.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs de retour |
|
otLinkSetCslTimeout
otError otLinkSetCslTimeout( otInstance *aInstance, uint32_t aTimeout )
Définit le délai avant expiration CSL en secondes.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs de retour |
|
otLinkSetEnabled
otError otLinkSetEnabled( otInstance *aInstance, bool aEnable )
Active ou désactive la couche de liaison.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs de retour |
|
otLinkSetExtendedAddress
otError otLinkSetExtendedAddress( otInstance *aInstance, const otExtAddress *aExtAddress )
Définit l'adresse étendue IEEE 802.15.4.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs de retour |
|
otLinkSetMaxFrameRetriesDirect
void otLinkSetMaxFrameRetriesDirect( otInstance *aInstance, uint8_t aMaxFrameRetriesDirect )
Définit le nombre maximal de tentatives d'affichage des images au cours de la transmission directe.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otLinkSetMaxFrameRetriesIndirect
void otLinkSetMaxFrameRetriesIndirect( otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect )
Définit le nombre maximal de tentatives d'affichage des images lors de la transmission indirecte.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otLinkSetPanId
otError otLinkSetPanId( otInstance *aInstance, otPanId aPanId )
Définissez l'ID de PAN IEEE 802.15.4.
L'opération ne fonctionne que lorsque les protocoles Thread sont désactivés. L'appel réussi à cette fonction invalide également les ensembles de données opérationnels actifs et en attente dans la mémoire non volatile.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs de retour |
|
otLinkGetPanId
otLinkSetPcapCallback
void otLinkSetPcapCallback( otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext )
Enregistre un rappel pour fournir les trames IEEE 802.15.4 brutes reçues.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
otLinkSetPollPeriod
otError otLinkSetPollPeriod( otInstance *aInstance, uint32_t aPollPeriod )
Définir/Effacer la période d'interrogation des données externes/spécifiées par l'utilisateur pour l'appareil endormi.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs de retour |
|
otLinkGetPollPeriod
otLinkSetPromiscuous
otError otLinkSetPromiscuous( otInstance *aInstance, bool aPromiscuous )
Active ou désactive le mode promiscuité de la couche de liaison.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs de retour |
|
otLinkSetRadioFilterEnabled
void otLinkSetRadioFilterEnabled( otInstance *aInstance, bool aFilterEnabled )
Active/désactive le mode de filtrage radio IEEE 802.15.4.
Disponible lorsque la configuration OPENTHREAD_CONFIG_MAC_FILTER_ENABLE
est activée.
Le filtre radio est principalement destiné à des tests. Il peut être utilisé pour bloquer temporairement tous les tx/rx sur la radio 802.15.4. Lorsque le filtre radio est activé, la radio est mise en veille au lieu de recevoir (pour s'assurer que l'appareil ne reçoit aucune trame et/ou n'envoie pas de message de confirmation). De plus, les requêtes de transmission de trame renvoient immédiatement sans envoyer la trame Over The Air (renvoyez l'erreur "no ack" si un ACK est demandé, sinon renvoyez l'opération réussie).
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
otLinkSetRegion
otError otLinkSetRegion( otInstance *aInstance, uint16_t aRegionCode )
Définit le code régional.
Le format de la région radio est la représentation ASCII de deux octets du code alpha-2 de la norme ISO 3166.
Détails | |||||||
---|---|---|---|---|---|---|---|
Paramètres |
|
||||||
Valeurs de retour |
|
otLinkSetSupportedChannelMask
otError otLinkSetSupportedChannelMask( otInstance *aInstance, uint32_t aChannelMask )
Définissez le masque de canal compatible de la couche MAC.
L'opération ne fonctionne que lorsque les protocoles Thread sont désactivés.
Détails | |||||
---|---|---|---|---|---|
Paramètres |
|
||||
Valeurs de retour |
|
Macros
OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC
OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC (160)
Représente l'unité de symboles de la période CSL en microsecondes.
La période CSL (en microsecondes) DOIT être un multiple de cette valeur.
OT_MAC_FILTER_FIXED_RSS_DISABLED
OT_MAC_FILTER_FIXED_RSS_DISABLED 127
Indique qu'aucune intensité de signal reçu fixe n'a été définie.
OT_MAC_FILTER_ITERATOR_INIT
OT_MAC_FILTER_ITERATOR_INIT 0
Initialiseur pour otMacFilterIterator.
OT_US_PER_TEN_SYMBOLS
OT_US_PER_TEN_SYMBOLS OT_RADIO_TEN_SYMBOLS_TIME
Temps pour 10 symboles en microsecondes.
Ressources
Les sujets de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou pour contribuer à notre documentation, consultez la section Ressources.