Lien brut

Ce module inclut des fonctions qui contrôlent la configuration brute de la couche de liaison.

Résumé

Typedefs
otLinkRawEnergyScanDone)(otInstance *aInstance, int8_t aEnergyScanMaxRssi) typedef
void(*
Pointeur à la réception d'une trame IEEE 802.15.4.
otLinkRawReceiveDone)(otInstance *aInstance, otRadioFrame *aFrame, otError aError) typedef
void(*
Pointeur à la réception d'une trame IEEE 802.15.4.
otLinkRawTransmitDone)(otInstance *aInstance, otRadioFrame *aFrame, otRadioFrame *aAckFrame, otError aError) typedef
void(*
Pointeur à la réception d'une trame IEEE 802.15.4.

distantes
otLinkRawEnergyScan(otInstance *aInstance, uint8_t aScanChannel, uint16_t aScanDuration, otLinkRawEnergyScanDone aCallback)
Démarre la séquence de recherche d'énergie à la radio.
otLinkRawGetCaps(otInstance *aInstance)
Obtenez les fonctionnalités radio.
otLinkRawGetPromiscuous(otInstance *aInstance)
bool
Récupère l'état du mode promiscuité.
otLinkRawGetRadioTime(otInstance *aInstance)
uint64_t
Permet d'obtenir l'heure actuelle de la plate-forme (largeur de 64 bits) de la puce radio.
otLinkRawGetRssi(otInstance *aInstance)
int8_t
Obtenez la mesure RSSI la plus récente.
otLinkRawGetTransmitBuffer(otInstance *aInstance)
Passage de la radio de la transmission à la réception.
otLinkRawIsEnabled(otInstance *aInstance)
bool
Indique si la couche de lien brute est activée ou non.
otLinkRawReceive(otInstance *aInstance)
Passage de la radio du mode Veille à la réception.
otLinkRawSetMacFrameCounter(otInstance *aInstance, uint32_t aMacFrameCounter)
Définit la valeur actuelle du compteur de trames MAC.
otLinkRawSetMacFrameCounterIfLarger(otInstance *aInstance, uint32_t aMacFrameCounter)
Définit la valeur actuelle du compteur de trames MAC uniquement si la nouvelle valeur est supérieure à la valeur 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 de clé
otLinkRawSetPromiscuous(otInstance *aInstance, bool aEnable)
Active ou désactive le mode promiscuité.
otLinkRawSetReceiveDone(otInstance *aInstance, otLinkRawReceiveDone aCallback)
Active/désactive la couche de lien brute.
otLinkRawSetShortAddress(otInstance *aInstance, uint16_t aShortAddress)
Définissez l'adresse courte pour le filtrage des adresses.
otLinkRawSleep(otInstance *aInstance)
Faites passer la radio de "Recevoir" à "Veille".
otLinkRawSrcMatchAddExtEntry(otInstance *aInstance, const otExtAddress *aExtAddress)
Ajout de l'adresse étendue à la table des correspondances source.
otLinkRawSrcMatchAddShortEntry(otInstance *aInstance, uint16_t aShortAddress)
Ajouter l'adresse courte à la table des correspondances source.
otLinkRawSrcMatchClearExtEntries(otInstance *aInstance)
Supprimer toutes les adresses étendues de la table des correspondances source.
otLinkRawSrcMatchClearExtEntry(otInstance *aInstance, const otExtAddress *aExtAddress)
Suppression de l'adresse étendue de la table de correspondance source du signal radio.
otLinkRawSrcMatchClearShortEntries(otInstance *aInstance)
Supprimez toutes les adresses courtes de la table des correspondances source.
otLinkRawSrcMatchClearShortEntry(otInstance *aInstance, uint16_t aShortAddress)
Suppression de l'adresse courte de la table des correspondances source.
otLinkRawSrcMatchEnable(otInstance *aInstance, bool aEnable)
Activer/Désactiver la correspondance source pour l'image en attente.
otLinkRawTransmit(otInstance *aInstance, otLinkRawTransmitDone aCallback)
Commence la séquence de transmission sur la radio.

Typedefs

otLinkRawEnergyScanDone

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

Pointeur à la réception d'une trame IEEE 802.15.4.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aEnergyScanMaxRssi
Le RSSI maximal rencontré sur la chaîne analysée.

otLinkRawReceiveDone

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

Pointeur à la réception d'une trame IEEE 802.15.4.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aFrame
Pointeur vers le frame reçu ou valeur NULL si l'opération de réception a été annulée.
[in] aError
OT_ERROR_NONE lorsque la trame est reçue avec succès. OT_ERROR_ABORT lorsque la réception a été annulée et qu'une trame n'a pas été reçue.

otLinkRawTransmitDone

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

Pointeur à la réception d'une trame IEEE 802.15.4.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aFrame
Un pointeur vers la trame qui a été transmise.
[in] aAckFrame
Un pointeur vers la trame ACK.
[in] aError
OT_ERROR_NONE lors de la transmission de la trame. OT_ERROR_NO_ACK lorsque la trame a été transmise, mais qu’aucun ACK n’a été reçu, OT_ERROR_CHANNEL_ACCESS_FAILURE, lorsque la transmission n’a pas pu avoir lieu en raison d’une activité sur le canal. OT_ERROR_ABORT lorsque la transmission a été annulée pour d'autres raisons.

distantes

otLinkRawEnergyScan

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

Démarre la séquence de recherche d'énergie à la radio.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aScanChannel
Canal sur lequel effectuer la recherche d'énergie.
[in] aScanDuration
Durée, en millisecondes, de l'analyse de la chaîne.
[in] aCallback
Pointeur vers une fonction appelée à la fin d'un canal analysé.
Valeurs de retour
OT_ERROR_NONE
La recherche de la chaîne a bien été lancée.
OT_ERROR_BUSY
Le signal radio effectue un balayage de l'énergie.
OT_ERROR_NOT_IMPLEMENTED
Le signal radio ne prend pas en charge la numérisation de l'énergie.
OT_ERROR_INVALID_STATE
Si la couche de lien brute n'est pas activée

otLinkRawGetCaps

otRadioCaps otLinkRawGetCaps(
  otInstance *aInstance
)

Obtenez les fonctionnalités radio.

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

otLinkRawGetPromiscuous

bool otLinkRawGetPromiscuous(
  otInstance *aInstance
)

Récupère l'état du mode promiscuité.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
true
Le mode promiscuité est activé.
false
Le mode promiscuité est désactivé.

otLinkRawGetRadioTime

uint64_t otLinkRawGetRadioTime(
  otInstance *aInstance
)

Permet d'obtenir l'heure actuelle de la plate-forme (largeur de 64 bits) de la puce radio.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Durée radio actuelle en microsecondes.

otLinkRawGetRssi

int8_t otLinkRawGetRssi(
  otInstance *aInstance
)

Obtenez la mesure RSSI la plus récente.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
RSSI en dBm lorsqu'il est valide. 127 lorsque le RSSI n'est pas valide.

otLinkRawGetTransmitBuffer

otRadioFrame * otLinkRawGetTransmitBuffer(
  otInstance *aInstance
)

Passage de la radio de la transmission à la réception.

Renvoie un pointeur vers le tampon de transmission.

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

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

otLinkRawIsEnabled

bool otLinkRawIsEnabled(
  otInstance *aInstance
)

Indique si la couche de lien brute est activée ou non.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
true
La couche de lien brute est activée.
false
La couche de lien brute est désactivée.

otLinkRawReceive

otError otLinkRawReceive(
  otInstance *aInstance
)

Passage de la radio du mode Veille à la réception.

Allume la radio.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
Passage à l'état "Réception" réussi.
OT_ERROR_INVALID_STATE
Le signal radio a été désactivé ou en cours d'émission.

otLinkRawSetMacFrameCounter

otError otLinkRawSetMacFrameCounter(
  otInstance *aInstance,
  uint32_t aMacFrameCounter
)

Définit la valeur actuelle du compteur de trames MAC.

Définit toujours le compteur MAC sur la nouvelle valeur donnée aMacFrameCounter, indépendamment de la valeur actuelle.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aMacFrameCounter
Valeur du compteur de trame MAC.
Valeurs de retour
OT_ERROR_NONE
Si l'opération réussit.
OT_ERROR_INVALID_STATE
Si la couche de lien brute n'est pas activée

otLinkRawSetMacFrameCounterIfLarger

otError otLinkRawSetMacFrameCounterIfLarger(
  otInstance *aInstance,
  uint32_t aMacFrameCounter
)

Définit la valeur actuelle du compteur de trames MAC uniquement si la nouvelle valeur est supérieure à la valeur actuelle.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aMacFrameCounter
Valeur du compteur de trame MAC.
Valeurs de retour
OT_ERROR_NONE
Si l'opération réussit.
OT_ERROR_INVALID_STATE
Si la couche de lien 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 de clé

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

otLinkRawSetPromiscuous

otError otLinkRawSetPromiscuous(
  otInstance *aInstance,
  bool aEnable
)

Active ou désactive le mode promiscuité.

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

otLinkRawSetReceiveDone

otError otLinkRawSetReceiveDone(
  otInstance *aInstance,
  otLinkRawReceiveDone aCallback
)

Active/désactive la couche de lien brute.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aCallback
Pointeur vers une fonction appelée à la réception d'une trame IEEE 802.15.4. NULL pour désactiver la couche de liaison brute.
Valeurs de retour
OT_ERROR_FAILED
Impossible d'activer/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 des adresses.

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

otLinkRawSleep

otError otLinkRawSleep(
  otInstance *aInstance
)

Faites passer la radio de "Recevoir" à "Veille".

Éteins la radio.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
Passage au mode Sommeil réussi.
OT_ERROR_BUSY
Le signal radio transmettait
OT_ERROR_INVALID_STATE
La radio a été désactivée

otLinkRawSrcMatchAddExtEntry

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

Ajout de l'adresse étendue à la table des correspondances source.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aExtAddress
Adresse étendue à ajouter.
Valeurs de retour
OT_ERROR_NONE
L'adresse étendue a bien été ajoutée à la table des correspondances source.
OT_ERROR_NO_BUFS
Aucune entrée disponible dans le tableau des correspondances source.
OT_ERROR_INVALID_STATE
Si la couche de lien brute n'est pas activée

otLinkRawSrcMatchAddShortEntry

otError otLinkRawSrcMatchAddShortEntry(
  otInstance *aInstance,
  uint16_t aShortAddress
)

Ajouter l'adresse courte à la table des correspondances source.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aShortAddress
Adresse courte à ajouter.
Valeurs de retour
OT_ERROR_NONE
L'adresse courte a bien été ajoutée à la table des correspondances source.
OT_ERROR_NO_BUFS
Aucune entrée disponible dans le tableau des correspondances source.
OT_ERROR_INVALID_STATE
Si la couche de lien brute n'est pas activée

otLinkRawSrcMatchClearExtEntries

otError otLinkRawSrcMatchClearExtEntries(
  otInstance *aInstance
)

Supprimer toutes les adresses étendues de la table des correspondances source.

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

otLinkRawSrcMatchClearExtEntry

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

Suppression de l'adresse étendue de la table de correspondance source du signal radio.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aExtAddress
Adresse étendue à supprimer.
Valeurs de retour
OT_ERROR_NONE
L'adresse étendue a bien été supprimée de la table des correspondances 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 lien brute n'est pas activée

otLinkRawSrcMatchClearShortEntries

otError otLinkRawSrcMatchClearShortEntries(
  otInstance *aInstance
)

Supprimez toutes les adresses courtes de la table des correspondances source.

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

otLinkRawSrcMatchClearShortEntry

otError otLinkRawSrcMatchClearShortEntry(
  otInstance *aInstance,
  uint16_t aShortAddress
)

Suppression de l'adresse courte de la table des correspondances source.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aShortAddress
Adresse courte à supprimer.
Valeurs de retour
OT_ERROR_NONE
L'adresse courte a bien été supprimée de la table des correspondances source.
OT_ERROR_NO_ADDRESS
L'adresse courte ne figure pas dans le tableau des correspondances source.
OT_ERROR_INVALID_STATE
Si la couche de lien brute n'est pas activée

otLinkRawSrcMatchEnable

otError otLinkRawSrcMatchEnable(
  otInstance *aInstance,
  bool aEnable
)

Activer/Désactiver la correspondance source pour l'image en attente.

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

otLinkRawTransmit

otError otLinkRawTransmit(
  otInstance *aInstance,
  otLinkRawTransmitDone aCallback
)

Commence la séquence de transmission sur la radio.

L'appelant doit former la trame 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 les éléments suivants:

  1. Passage de la radio à la transmission à partir de la réception.
  2. Il transmet la PSDU sur le canal donné et à la puissance de transmission donnée.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aCallback
Un pointeur vers une fonction appelée à la fin de la transmission.
Valeurs de retour
OT_ERROR_NONE
Transition vers Transmit réussie.
OT_ERROR_INVALID_STATE
Le signal radio n'était pas à l'état de réception.

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.