Diagnostic d'usine – Plate-forme

Ce module inclut l'abstraction de la plate-forme pour les fonctionnalités de diagnostic.

Résumé

Énumérations
otGpioMode{   OT_GPIO_MODE_INPUT = 0,   OT_GPIO_MODE_OUTPUT = 1 }	enum Définit les modes gpio.

distantes
otPlatDiagAlarmCallback(otInstance *aInstance)	void Traite l'événement d'alarme.
otPlatDiagChannelSet(uint8_t aChannel)	void Définit le canal à utiliser pour les diagnostics d'usine.
otPlatDiagGpioGet(uint32_t aGpio, bool *aValue)	otError Récupère la valeur gpio.
otPlatDiagGpioGetMode(uint32_t aGpio, otGpioMode *aMode)	otError Récupère le mode gpio.
otPlatDiagGpioSet(uint32_t aGpio, bool aValue)	otError Définit la valeur gpio.
otPlatDiagGpioSetMode(uint32_t aGpio, otGpioMode aMode)	otError Définit le mode gpio.
otPlatDiagModeGet(void)	bool Indique si le mode de diagnostic d'usine est activé.
otPlatDiagModeSet(bool aMode)	void Active/désactive le mode de diagnostic d'usine.
otPlatDiagProcess(otInstance *aInstance, uint8_t aArgsLength, char *aArgs[], char *aOutput, size_t aOutputMaxLen)	otError Traite une ligne de commande de diagnostics d'usine.
otPlatDiagRadioGetPowerSettings(otInstance *aInstance, uint8_t aChannel, int16_t *aTargetPower, int16_t *aActualPower, uint8_t *aRawPowerSetting, uint16_t *aRawPowerSettingLength)	otError Permet d'obtenir les paramètres d'alimentation d'un canal donné.
otPlatDiagRadioGetRawPowerSetting(otInstance *aInstance, uint8_t *aRawPowerSetting, uint16_t *aRawPowerSettingLength)	otError Obtenez le paramètre d'alimentation brute de la radio pour le module de diagnostic.
otPlatDiagRadioRawPowerSettingEnable(otInstance *aInstance, bool aEnable)	otError Activez/Désactivez la couche de plate-forme pour utiliser le paramètre d'alimentation brute défini par otPlatDiagRadioSetRawPowerSetting().
otPlatDiagRadioReceived(otInstance *aInstance, otRadioFrame *aFrame, otError aError)	void Traite la trame radio reçue.
otPlatDiagRadioSetRawPowerSetting(otInstance *aInstance, const uint8_t *aRawPowerSetting, uint16_t aRawPowerSettingLength)	otError Définissez le paramètre d'alimentation brute radio pour le module de diagnostic.
otPlatDiagRadioTransmitCarrier(otInstance *aInstance, bool aEnable)	otError Démarrer/Arrêter la couche de plate-forme pour transmettre une ondes porteuse en continu
otPlatDiagRadioTransmitStream(otInstance *aInstance, bool aEnable)	otError Démarrer/Arrêter la couche de plate-forme pour transmettre un flux de caractères.
otPlatDiagTxPowerSet(int8_t aTxPower)	void Définit la puissance de transmission à utiliser pour les diagnostics d'usine.

Énumérations

otGpioMode

 otGpioMode

Définit les modes gpio.

Propriétés
OT_GPIO_MODE_INPUT	Mode de saisie sans résistance de traction.
OT_GPIO_MODE_OUTPUT	Mode de sortie

distantes

otPlatDiagAlarmCallback

void otPlatDiagAlarmCallback(
  otInstance *aInstance
)

Traite l'événement d'alarme.

Détails
Paramètres	[in] aInstance Instance OpenThread pour la requête actuelle.

otPlatDiagChannelSet

void otPlatDiagChannelSet(
  uint8_t aChannel
)

Définit le canal à utiliser pour les diagnostics d'usine.

Détails
Paramètres	[in] aChannel Valeur du canal.

otPlatDiagGpioGet

otError otPlatDiagGpioGet(
  uint32_t aGpio,
  bool *aValue
)

Récupère la valeur gpio.

Détails
Paramètres	[in] aGpio Numéro gpio. [out] aValue Pointeur où placer la valeur gpio.
Valeurs de retour	OT_ERROR_NONE La valeur gpio a bien été obtenue. OT_ERROR_FAILED Une erreur de plate-forme s'est produite lors de l'obtention de la valeur gpio. OT_ERROR_INVALID_ARGS aGpio n'est pas compatible ou aValue est NULL. OT_ERROR_INVALID_STATE Le mode de diagnostic n'était pas activé, ou aGpio n'est pas configuré comme entrée. OT_ERROR_NOT_IMPLEMENTED Cette fonction n'est ni implémentée ni configurée sur la plate-forme.

otPlatDiagGpioGetMode

otError otPlatDiagGpioGetMode(
  uint32_t aGpio,
  otGpioMode *aMode
)

Récupère le mode gpio.

Détails
Paramètres	[in] aGpio Numéro gpio. [out] aMode Pointeur où placer le mode Gpio.
Valeurs de retour	OT_ERROR_NONE Le mode gpio a bien été obtenu. OT_ERROR_FAILED Le mode renvoyé par la plate-forme n'est pas implémenté dans OpenThread ou une erreur de plate-forme s'est produite lors de l'obtention du mode gpio. OT_ERROR_INVALID_ARGS aGpio n'est pas compatible ou aMode est NULL. OT_ERROR_INVALID_STATE Le mode de diagnostic n'était pas activé. OT_ERROR_NOT_IMPLEMENTED Cette fonction n'est ni implémentée ni configurée sur la plate-forme.

otPlatDiagGpioSet

otError otPlatDiagGpioSet(
  uint32_t aGpio,
  bool aValue
)

Définit la valeur gpio.

Détails
Paramètres	[in] aGpio Numéro gpio. [in] aValue "true" pour définir la valeur "gpio" sur le niveau élevé, ou "false" dans le cas contraire.
Valeurs de retour	OT_ERROR_NONE L'interface gpio a bien été définie. OT_ERROR_FAILED Une erreur de plate-forme s'est produite lors de la configuration du gpio. OT_ERROR_INVALID_ARGS L'aGpio n'est pas accepté. OT_ERROR_INVALID_STATE Le mode de diagnostic n'était pas activé, ou aGpio n'est pas configuré en tant que sortie. OT_ERROR_NOT_IMPLEMENTED Cette fonction n'est ni implémentée ni configurée sur la plate-forme.

otPlatDiagGpioSetMode

otError otPlatDiagGpioSetMode(
  uint32_t aGpio,
  otGpioMode aMode
)

Définit le mode gpio.

Détails
Paramètres	[in] aGpio Numéro gpio. [out] aMode Mode gpio
Valeurs de retour	OT_ERROR_NONE Le mode gpio a bien été défini. OT_ERROR_FAILED Une erreur de plate-forme s'est produite lors du paramétrage du mode gpio. OT_ERROR_INVALID_ARGS aGpio ou aMode n'est pas compatible. OT_ERROR_INVALID_STATE Le mode de diagnostic n'était pas activé. OT_ERROR_NOT_IMPLEMENTED Cette fonction n'est ni implémentée ni configurée sur la plate-forme.

otPlatDiagModeGet

bool otPlatDiagModeGet(
  void
)

Indique si le mode de diagnostic d'usine est activé.

Détails
Renvoie	TRUE si le mode de diagnostic d'usine est activé, FALSE dans le cas contraire.

otPlatDiagModeSet

void otPlatDiagModeSet(
  bool aMode
)

Active/désactive le mode de diagnostic d'usine.

Détails
Paramètres	[in] aMode TRUE pour activer le mode de diagnostic, FALSE dans le cas contraire.

otPlatDiagProcess

otError otPlatDiagProcess(
  otInstance *aInstance,
  uint8_t aArgsLength,
  char *aArgs[],
  char *aOutput,
  size_t aOutputMaxLen
)

Traite une ligne de commande de diagnostics d'usine.

Le résultat de cette fonction (le contenu écrit dans aOutput) DOIT se terminer par \0, et \0 se trouve dans le tampon de sortie.

Détails
Paramètres	[in] aInstance Instance OpenThread pour la requête actuelle. [in] aArgsLength Nombre d'arguments dans aArgs. [in] aArgs Arguments de la ligne de commande de diagnostic. [out] aOutput Résultat de l'exécution des diagnostics. [in] aOutputMaxLen Taille du tampon de sortie.
Valeurs de retour	OT_ERROR_INVALID_ARGS La commande est prise en charge, mais des arguments non valides ont été fournis. OT_ERROR_NONE La commande a bien été traitée. OT_ERROR_INVALID_COMMAND La commande n'est pas valide ou n'est pas prise en charge.

otPlatDiagRadioGetPowerSettings

otError otPlatDiagRadioGetPowerSettings(
  otInstance *aInstance,
  uint8_t aChannel,
  int16_t *aTargetPower,
  int16_t *aActualPower,
  uint8_t *aRawPowerSetting,
  uint16_t *aRawPowerSettingLength
)

Permet d'obtenir les paramètres d'alimentation d'un canal donné.

Détails
Paramètres	[in] aInstance Structure de l'instance OpenThread. [in] aChannel Canal de radio. [out] aTargetPower Puissance cible en 0,01 dBm. [out] aActualPower Puissance réelle en 0,01 dBm. [out] aRawPowerSetting Pointeur vers le tableau d'octets du paramètre de puissance brute. [in,out] aRawPowerSettingLength À l'entrée, un pointeur indiquant la taille de aRawPowerSetting. En sortie, pointeur vers la longueur des données brutes de paramétrage de l'alimentation.
Valeurs de retour	OT_ERROR_NONE Puissance cible obtenue. OT_ERROR_INVALID_ARGS La valeur aChannel n'est pas valide, , aActualPower, aRawPowerSetting ou aRawPowerSettingLength est NULL ou trop courte. OT_ERROR_NOT_FOUND Les paramètres d'alimentation de aChannel sont introuvables. OT_ERROR_NOT_IMPLEMENTED Cette méthode n'est pas implémentée.

otPlatDiagRadioGetRawPowerSetting

otError otPlatDiagRadioGetRawPowerSetting(
  otInstance *aInstance,
  uint8_t *aRawPowerSetting,
  uint16_t *aRawPowerSettingLength
)

Obtenez le paramètre d'alimentation brute de la radio pour le module de diagnostic.

Détails
Paramètres	[in] aInstance Structure de l'instance OpenThread. [out] aRawPowerSetting Pointeur vers le tableau d'octets du paramètre de puissance brute. [in,out] aRawPowerSettingLength À l'entrée, un pointeur indiquant la taille de aRawPowerSetting. En sortie, pointeur vers la longueur des données brutes de paramétrage de l'alimentation.
Valeurs de retour	OT_ERROR_NONE Le paramètre de consommation d'énergie brute a bien été défini. OT_ERROR_INVALID_ARGS La valeur aRawPowerSetting ou aRawPowerSettingLength est NULL ou trop courte. OT_ERROR_NOT_FOUND Le paramètre d'alimentation brute n'est pas défini. OT_ERROR_NOT_IMPLEMENTED Cette méthode n'est pas implémentée.

otPlatDiagRadioRawPowerSettingEnable

otError otPlatDiagRadioRawPowerSettingEnable(
  otInstance *aInstance,
  bool aEnable
)

Activez/Désactivez la couche de plate-forme pour utiliser le paramètre d'alimentation brute défini par otPlatDiagRadioSetRawPowerSetting().

Détails
Paramètres	[in] aInstance Structure de l'instance OpenThread. [in] aEnable TRUE pour activer ou FALSE pour désactiver le paramètre d'alimentation brute.
Valeurs de retour	OT_ERROR_NONE Le paramètre d'alimentation brute a bien été activé/désactivé. OT_ERROR_NOT_IMPLEMENTED Cette méthode n'est pas implémentée.

otPlatDiagRadioReceived

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

Traite la trame radio reçue.

Détails
Paramètres	[in] aInstance Instance OpenThread pour la requête actuelle. [in] aFrame Trame radio reçue. [in] aError État de la trame radio reçue.

otPlatDiagRadioSetRawPowerSetting

otError otPlatDiagRadioSetRawPowerSetting(
  otInstance *aInstance,
  const uint8_t *aRawPowerSetting,
  uint16_t aRawPowerSettingLength
)

Définissez le paramètre d'alimentation brute radio pour le module de diagnostic.

Détails
Paramètres	[in] aInstance Structure de l'instance OpenThread. [in] aRawPowerSetting Pointeur vers le tableau d'octets du paramètre de puissance brute. [in] aRawPowerSettingLength Longueur du aRawPowerSetting.
Valeurs de retour	OT_ERROR_NONE Le paramètre de consommation d'énergie brute a bien été défini. OT_ERROR_INVALID_ARGS L'élément aRawPowerSetting est NULL ou aRawPowerSettingLength trop long. OT_ERROR_NOT_IMPLEMENTED Cette méthode n'est pas implémentée.

otPlatDiagRadioTransmitCarrier

otError otPlatDiagRadioTransmitCarrier(
  otInstance *aInstance,
  bool aEnable
)

Démarrer/Arrêter la couche de plate-forme pour transmettre une ondes porteuse en continu

Détails
Paramètres	[in] aInstance Structure de l'instance OpenThread. [in] aEnable TRUE pour activer ou FALSE pour désactiver la couche de plate-forme afin qu'elle transmette une ondes de trafic continue.
Valeurs de retour	OT_ERROR_NONE Activation/Désactivation réussie . OT_ERROR_INVALID_STATE Le signal radio n'était pas à l'état de réception. OT_ERROR_NOT_IMPLEMENTED Cette méthode n'est pas implémentée.

otPlatDiagRadioTransmitStream

otError otPlatDiagRadioTransmitStream(
  otInstance *aInstance,
  bool aEnable
)

Démarrer/Arrêter la couche de plate-forme pour transmettre un flux de caractères.

Détails
Paramètres	[in] aInstance Structure de l'instance OpenThread. [in] aEnable TRUE pour activer ou FALSE pour désactiver la couche de plate-forme afin de transmettre un flux.
Valeurs de retour	OT_ERROR_NONE Activation/Désactivation réussie. OT_ERROR_INVALID_STATE Le signal radio n'était pas à l'état de réception. OT_ERROR_NOT_IMPLEMENTED Cette fonction n'est pas implémentée.

otPlatDiagTxPowerSet

void otPlatDiagTxPowerSet(
  int8_t aTxPower
)

Définit la puissance de transmission à utiliser pour les diagnostics d'usine.

Détails
Paramètres	[in] aTxPower Valeur de la puissance de transmission.

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.