Lien brut

Ce module comprend des fonctions qui contrôlent la configuration de la couche de liens brute.

Résumé

Définitions
otLinkRawEnergyScanDone)(otInstance *aInstance, int8_t aEnergyScanMaxRssi) CANNOT TRANSLATE
void(*
Ce pointeur de fonction sur la réception d'un frame IEEE 802.15.4.
otLinkRawReceiveDone)(otInstance *aInstance, otRadioFrame *aFrame, otError aError) CANNOT TRANSLATE
void(*
Ce pointeur de fonction sur la réception d'un frame IEEE 802.15.4.
otLinkRawTransmitDone)(otInstance *aInstance, otRadioFrame *aFrame, otRadioFrame *aAckFrame, otError aError) CANNOT TRANSLATE
void(*
Ce pointeur de fonction sur la réception d'un frame IEEE 802.15.4.

Fonctions
otLinkRawEnergyScan(otInstance *aInstance, uint8_t aScanChannel, uint16_t aScanDuration, otLinkRawEnergyScanDone aCallback)
Cette méthode lance la séquence de recherche d'énergie à la radio.
otLinkRawGetCaps(otInstance *aInstance)
Bénéficiez des fonctionnalités radio.
otLinkRawGetPromiscuous(otInstance *aInstance)
bool
Cette fonction obtient l'état du mode promis.
otLinkRawGetRadioTime(otInstance *aInstance)
uint64_t
Obtenez le temps d'utilisation actuel de la puce radio (largeur 64 bits).
otLinkRawGetRssi(otInstance *aInstance)
int8_t
Obtenez la dernière mesure RSSI.
otLinkRawGetTransmitBuffer(otInstance *aInstance)
Le signal radio passe de la transmission à la réception.
otLinkRawIsEnabled(otInstance *aInstance)
bool
Cette fonction indique si la couche de liens brute est activée ou non.
otLinkRawReceive(otInstance *aInstance)
Je mets la radio en mode veille jusqu'à la réception.
otLinkRawSetMacFrameCounter(otInstance *aInstance, uint32_t aMacFrameCounter)
Permet de définir la valeur du compteur d'images MAC actuelle.
otLinkRawSetMacKey(otInstance *aInstance, uint8_t aKeyIdMode, uint8_t aKeyId, const otMacKey *aPrevKey, const otMacKey *aCurrKey, const otMacKey *aNextKey)
Mettre à jour les clés MAC et l'index des clés
otLinkRawSetPromiscuous(otInstance *aInstance, bool aEnable)
Cette fonction permet d'activer ou de désactiver le mode provocant.
otLinkRawSetReceiveDone(otInstance *aInstance, otLinkRawReceiveDone aCallback)
Cette fonction permet d'activer ou de désactiver la couche de liaison brute.
otLinkRawSetShortAddress(otInstance *aInstance, uint16_t aShortAddress)
Définissez l'adresse courte pour le filtrage d'adresses.
otLinkRawSleep(otInstance *aInstance)
Faire passer l'alarme de la réception au sommeil
otLinkRawSrcMatchAddExtEntry(otInstance *aInstance, const otExtAddress *aExtAddress)
Ajout d'adresse étendue au tableau de correspondance source.
otLinkRawSrcMatchAddShortEntry(otInstance *aInstance, uint16_t aShortAddress)
Ajout d'une adresse courte au tableau de correspondance source.
otLinkRawSrcMatchClearExtEntries(otInstance *aInstance)
Suppression de toutes les adresses étendues du tableau de correspondance source
otLinkRawSrcMatchClearExtEntry(otInstance *aInstance, const otExtAddress *aExtAddress)
Suppression de l'adresse étendue du tableau de correspondance source de la radio
otLinkRawSrcMatchClearShortEntries(otInstance *aInstance)
Supprimez toutes les adresses courtes du tableau de correspondance source.
otLinkRawSrcMatchClearShortEntry(otInstance *aInstance, uint16_t aShortAddress)
Suppression de l'adresse courte du tableau de correspondance source...
otLinkRawSrcMatchEnable(otInstance *aInstance, bool aEnable)
Active/Désactive la correspondance source pour le frame en attente.
otLinkRawTransmit(otInstance *aInstance, otLinkRawTransmitDone aCallback)
Cette méthode lance la séquence de transmission à la radio.

Définitions

otLinkRawEnergyScanTerminé

void(* otLinkRawEnergyScanDone)(otInstance *aInstance, int8_t aEnergyScanMaxRssi)

Ce pointeur de fonction sur la réception d'un frame IEEE 802.15.4.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aEnergyScanMaxRssi
RSSI maximal détecté sur la chaîne analysée.

otLinkRawReceiveDone

void(* otLinkRawReceiveDone)(otInstance *aInstance, otRadioFrame *aFrame, otError aError)

Ce pointeur de fonction sur la réception d'un frame IEEE 802.15.4.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aFrame
Pointeur vers l'image reçue ou NULL si l'opération de réception a été annulée.
[in] aError
OT_ERROR_NONE après avoir reçu une image OT_ERROR_ABORT lorsque la réception a été annulée et qu'aucune image n'a été reçue.

otLinkRawTransmitDone

void(* otLinkRawTransmitDone)(otInstance *aInstance, otRadioFrame *aFrame, otRadioFrame *aAckFrame, otError aError)

Ce pointeur de fonction sur la réception d'un frame IEEE 802.15.4.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aFrame
Pointeur vers l'image transmise.
[in] aAckFrame
Pointeur vers le frame ACK
[in] aError
OT_ERROR_NONE lors de la transmission de l'image. OT_ERROR_NO_ACK lorsque l'image a été transmise, mais qu'il n'a pas été reçu OT_ERROR_CHANNEL_ACCESS_FAILURE lorsque la transmission n'a pas pu avoir lieu en raison de l'activité sur la chaîne. OT_ERROR_ABORT lorsque la transmission a été annulée pour d'autres raisons.

Fonctions

otLinkRawEnergyScan

otError otLinkRawEnergyScan(
  otInstance *aInstance,
  uint8_t aScanChannel,
  uint16_t aScanDuration,
  otLinkRawEnergyScanDone aCallback
)

Cette méthode lance la séquence de recherche d'énergie à la radio.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aScanChannel
Canal pour lequel vous souhaitez effectuer une recherche énergétique.
[in] aScanDuration
Durée, en millisecondes, de l'analyse de la chaîne.
[in] aCallback
Pointeur vers une fonction appelée à la fin d'une chaîne analysée.
Valeurs renvoyées
OT_ERROR_NONE
L'analyse de la chaîne a réussi.
OT_ERROR_BUSY
La radio effectue une recherche "émeri".
OT_ERROR_NOT_IMPLEMENTED
La radio n'est pas compatible avec la recherche d'énergie.
OT_ERROR_INVALID_STATE
Si la couche de liens brute n'est pas activée.

otLinkRawGetCaps

otRadioCaps otLinkRawGetCaps(
  otInstance *aInstance
)

Bénéficiez des fonctionnalités radio.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Vecteur de bit de fonctionnalité radio. La pile active ou désactive certaines fonctions en fonction de cette valeur.

otLinkRawGetPromiscuous

bool otLinkRawGetPromiscuous(
  otInstance *aInstance
)

Cette fonction obtient l'état du mode promis.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
true
Le mode proactif est activé.
false
Le mode provocateur est désactivé.

otLinkRawGetRadioTime

uint64_t otLinkRawGetRadioTime(
  otInstance *aInstance
)

Obtenez le temps d'utilisation actuel de la puce radio (largeur 64 bits).

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Heure radio actuelle en microsecondes.

otLinkRawGetRssi

int8_t otLinkRawGetRssi(
  otInstance *aInstance
)

Obtenez la dernière mesure RSSI.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
RSSI (en DHCP) lorsqu'il est valide 127 lorsque RSSI n'est pas valide.

otLinkRawGetTransmitBuffer

otRadioFrame * otLinkRawGetTransmitBuffer(
  otInstance *aInstance
)

Le signal radio passe de la transmission à la réception.

Cette méthode renvoie un pointeur vers le tampon de transmission.

L'appelant forme le frame IEEE 802.15.4 dans ce tampon, puis appelle otLinkRawTransmit() pour demander la transmission.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Pointeur vers le tampon de transmission ou la valeur NULL si la couche de lien brute n'est pas activée.

otLinkRawIsEnabled

bool otLinkRawIsEnabled(
  otInstance *aInstance
)

Cette fonction indique si la couche de liens brute est activée ou non.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
true
Le calque de liens bruts est activé.
false
Le calque de liens bruts est désactivé.

otLinkRawReceive

otError otLinkRawReceive(
  otInstance *aInstance
)

Je mets la radio en mode veille jusqu'à la réception.

Allume la radio.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
OT_ERROR_NONE
Passage à réception.
OT_ERROR_INVALID_STATE
La radio a été désactivée ou en cours de transmission.

otLinkRawSetMacFrameCounter

otError otLinkRawSetMacFrameCounter(
  otInstance *aInstance,
  uint32_t aMacFrameCounter
)

Permet de définir la valeur du compteur d'images MAC actuelle.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aMacFrameCounter
Valeur du compteur d'images MAC.
Valeurs renvoyées
OT_ERROR_NONE
Si l'opération réussit.
OT_ERROR_INVALID_STATE
Si la couche de liens brute n'est pas activée.

otLinkRawSetMacKey

otError otLinkRawSetMacKey(
  otInstance *aInstance,
  uint8_t aKeyIdMode,
  uint8_t aKeyId,
  const otMacKey *aPrevKey,
  const otMacKey *aCurrKey,
  const otMacKey *aNextKey
)

Mettre à jour les clés MAC et l'index des clés

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aKeyIdMode
Mode de l'ID de clé.
[in] aKeyId
L'index de clé.
[in] aPrevKey
Clé MAC précédente.
[in] aCurrKey
Clé MAC actuelle.
[in] aNextKey
Clé MAC suivante.
Valeurs renvoyées
OT_ERROR_NONE
Si l'opération réussit.
OT_ERROR_INVALID_STATE
Si la couche de liens brute n'est pas activée.

otLinkRawSetPromiscuous

otError otLinkRawSetPromiscuous(
  otInstance *aInstance,
  bool aEnable
)

Cette fonction permet d'activer ou de désactiver le mode provocant.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aEnable
Valeur permettant d'activer ou de désactiver le mode provocant.
Valeurs renvoyées
OT_ERROR_NONE
Si l'opération réussit.
OT_ERROR_INVALID_STATE
Si la couche de liens brute n'est pas activée.

otLinkRawSetReceiveDone

otError otLinkRawSetReceiveDone(
  otInstance *aInstance,
  otLinkRawReceiveDone aCallback
)

Cette fonction permet d'activer ou de désactiver la couche de liaison brute.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aCallback
Pointeur vers une fonction appelée lors de la réception d'une image IEEE 802.15.4. NULL pour désactiver la couche de lien brut.
Valeurs renvoyées
OT_ERROR_FAILED
Impossible d'activer ou de désactiver la radio.
OT_ERROR_INVALID_STATE
Si l'interface IPv6 OpenThread est déjà activée.
OT_ERROR_NONE
si l'état d'activation a bien été défini ;

otLinkRawSetShortAddress

otError otLinkRawSetShortAddress(
  otInstance *aInstance,
  uint16_t aShortAddress
)

Définissez l'adresse courte pour le filtrage d'adresses.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aShortAddress
Adresse courte de la norme IEEE 802.15.4.
Valeurs renvoyées
OT_ERROR_NONE
Si l'opération réussit.
OT_ERROR_INVALID_STATE
Si la couche de liens brute n'est pas activée.

otLinkRawSleep

otError otLinkRawSleep(
  otInstance *aInstance
)

Faire passer l'alarme de la réception au sommeil

Éteins la radio.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
OT_ERROR_NONE
Passage en veille réussi.
OT_ERROR_BUSY
La radio était en train de transmettre
OT_ERROR_INVALID_STATE
La radio a été désactivée

otLinkRawSrcMatchAddExtEntry

otError otLinkRawSrcMatchAddExtEntry(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Ajout d'adresse étendue au tableau de correspondance source.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aExtAddress
Adresse étendue à ajouter.
Valeurs renvoyées
OT_ERROR_NONE
L'adresse étendue a bien été ajoutée au tableau de correspondance source.
OT_ERROR_NO_BUFS
Aucune entrée disponible dans le tableau de correspondance source.
OT_ERROR_INVALID_STATE
Si la couche de liens brute n'est pas activée.

otLinkRawSrcMatchAddShortEntry

otError otLinkRawSrcMatchAddShortEntry(
  otInstance *aInstance,
  uint16_t aShortAddress
)

Ajout d'une adresse courte au tableau de correspondance source.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aShortAddress
Adresse courte à ajouter.
Valeurs renvoyées
OT_ERROR_NONE
L'adresse courte a bien été ajoutée au tableau de correspondance source.
OT_ERROR_NO_BUFS
Aucune entrée disponible dans le tableau de correspondance source.
OT_ERROR_INVALID_STATE
Si la couche de liens brute n'est pas activée.

otLinkRawSrcMatchClearExtEnries

otError otLinkRawSrcMatchClearExtEntries(
  otInstance *aInstance
)

Suppression de toutes les adresses étendues du tableau de correspondance source

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
OT_ERROR_NONE
Si l'opération réussit.
OT_ERROR_INVALID_STATE
Si la couche de liens brute n'est pas activée.

otLinkRawSrcMatchClearExtEntrée

otError otLinkRawSrcMatchClearExtEntry(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Suppression de l'adresse étendue du tableau de correspondance source de la radio

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aExtAddress
L'adresse étendue à supprimer.
Valeurs renvoyées
OT_ERROR_NONE
L'adresse étendue a bien été supprimée du tableau de correspondance source.
OT_ERROR_NO_ADDRESS
L'adresse étendue ne figure pas dans le tableau de correspondance source.
OT_ERROR_INVALID_STATE
Si la couche de liens brute n'est pas activée.

otLinkRawSrcMatchClearShortEntries

otError otLinkRawSrcMatchClearShortEntries(
  otInstance *aInstance
)

Supprimez toutes les adresses courtes du tableau de correspondance source.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Valeurs renvoyées
OT_ERROR_NONE
Si l'opération réussit.
OT_ERROR_INVALID_STATE
Si la couche de liens brute n'est pas activée.

otLinkRawSrcMatchEffacerl'entrée

otError otLinkRawSrcMatchClearShortEntry(
  otInstance *aInstance,
  uint16_t aShortAddress
)

Suppression de l'adresse courte du tableau de correspondance source...

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aShortAddress
Adresse courte à supprimer.
Valeurs renvoyées
OT_ERROR_NONE
L'adresse courte a bien été supprimée du tableau de correspondance source.
OT_ERROR_NO_ADDRESS
L'adresse courte ne figure pas dans le tableau de correspondance source.
OT_ERROR_INVALID_STATE
Si la couche de liens brute n'est pas activée.

otLinkRawSrcMatchEnable

otError otLinkRawSrcMatchEnable(
  otInstance *aInstance,
  bool aEnable
)

Active/Désactive la correspondance source pour le frame en attente.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aEnable
Active/Désactive la correspondance source pour le frame en attente.
Valeurs renvoyées
OT_ERROR_NONE
Si l'opération réussit.
OT_ERROR_INVALID_STATE
Si la couche de liens brute n'est pas activée.

otLinkRawTransmit

otError otLinkRawTransmit(
  otInstance *aInstance,
  otLinkRawTransmitDone aCallback
)

Cette méthode lance la séquence de transmission à la radio.

L'appelant doit former le frame IEEE 802.15.4 dans le tampon fourni par otLinkRawGetTransmitBuffer() avant de demander la transmission. Le canal et la puissance de transmission sont également inclus dans la structure otRadioFrame.

La séquence de transmission comprend:

  1. Envoi de la radio à la transmission depuis la réception.
  2. Transmet le PSDU au canal et à la puissance de transmission donnés.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aCallback
Pointeur vers une fonction appelée à la fin de la transmission.
Valeurs renvoyées
OT_ERROR_NONE
La transition a bien été effectuée.
OT_ERROR_INVALID_STATE
La radio n'était pas à l'état de réception.

Resources

Les rubriques de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou contribuer à notre documentation, consultez la page Ressources.