Cette page a été traduite par l'API Cloud Translation.

Interface de ligne de commande

Ce module contient des fonctions qui contrôlent l'exécution de la pile Thread.

Résumé

Typedefs
`otCliOutputCallback)(void aContext, const char aFormat, va_list aArguments)`	typedef `int(*` Le pointeur est appelé pour avertir la sortie de la console.

Fonctions
`otCliAppendResult(otError aError)`	`void` Écrivez le code d'erreur dans la console CLI.
`otCliInit(otInstance aInstance, otCliOutputCallback aCallback, void aContext)`	`void` Initialisez le module CLI.
`otCliInputLine(char *aBuf)`	`void` Elle est appelée pour alimenter une ligne d'entrée de la console.
`otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)`	`void` Écrivez un nombre d'octets dans la console CLI sous forme de chaîne hexadécimale.
`otCliOutputFormat(const char *aFmt, ...)`	`void` Écrire une chaîne mise en forme dans la console CLI.
`otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)`	`void` Rappel pour écrire le journal OpenThread dans la console CLI.
`otCliSetUserCommands(const otCliCommand aUserCommands, uint8_t aLength, void aContext)`	`otError` Définissez une table de commande utilisateur.
`otCliVendorSetUserCommands(void)`	`void` Rappel permettant d'ajouter des commandes spécifiques aux fournisseurs dans la table des commandes utilisateur.

Typedefs

otCliOutputCallback

int(* otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments)

Le pointeur est appelé pour avertir la sortie de la console.

Détails

Paramètres

`[out] aContext`	Un pointeur de contexte utilisateur.
`[in] aFormat`	Chaîne de format.
`[in] aArguments`	Arguments de la chaîne de mise en forme.

Renvoie

Nombre d'octets écrits par le rappel.

Fonctions

otCliAppendResult

void otCliAppendResult(
  otError aError
)

Écrivez le code d'erreur dans la console CLI.

Si aError est défini sur OT_ERROR_PENDING, rien ne sera renvoyé.

Détails

Paramètres

[in] aError

Valeur du code d'erreur.

OTCliInit

void otCliInit(
  otInstance *aInstance,
  otCliOutputCallback aCallback,
  void *aContext
)

Initialisez le module CLI.

Détails

Paramètres

`[in] aInstance`	Structure d'instance OpenThread.
`[in] aCallback`	Une méthode de rappel appelée pour traiter la sortie de la CLI.
`[in] aContext`	Un pointeur de contexte utilisateur.

OTCliInputLine

void otCliInputLine(
  char *aBuf
)

Elle est appelée pour alimenter une ligne d'entrée de la console.

Détails

Paramètres

[in] aBuf

Un pointeur vers une chaîne se terminant par une valeur nulle.

otCliOutputBytes

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

Écrivez un nombre d'octets dans la console CLI sous forme de chaîne hexadécimale.

Détails

Paramètres

`[in] aBytes`	Un pointeur vers les données à imprimer.
`[in] aLength`	`aBytes` de longueur.

OTCliOutputFormat

void otCliOutputFormat(
  const char *aFmt,
  ...
)

Écrire une chaîne mise en forme dans la console CLI.

Détails

Paramètres

`[in] aFmt`	Un pointeur vers la chaîne de format.
`[in] ...`	Liste d'arguments correspondante.

OTCliPlatLogv

void otCliPlatLogv(
  otLogLevel aLogLevel,
  otLogRegion aLogRegion,
  const char *aFormat,
  va_list aArgs
)

Rappel pour écrire le journal OpenThread dans la console CLI.

Détails

Paramètres

`[in] aLogLevel`	Niveau de journalisation.
`[in] aLogRegion`	Région du journal.
`[in] aFormat`	Un pointeur vers la chaîne de format.
`[in] aArgs`	va_list correspondant à aFormat.

OTCliSetUserCommands

otError otCliSetUserCommands(
  const otCliCommand *aUserCommands,
  uint8_t aLength,
  void *aContext
)

Définissez une table de commande utilisateur.

Détails

Paramètres

`[in] aUserCommands`	Un pointeur vers un tableau avec des commandes utilisateur.
`[in] aLength`	`aUserCommands` de longueur.
`[in] aContext`	Contexte `The` transmis au gestionnaire.

Valeurs renvoyées

`OT_ERROR_NONE`	La table de commande avec les commandes de `aUserCommands` a bien été mise à jour.
`OT_ERROR_FAILED`	Le nombre maximal d'entrées de commande a déjà été défini.

otCliVendorSetUserCommands

void otCliVendorSetUserCommands(
  void
)

Rappel permettant d'ajouter des commandes spécifiques aux fournisseurs dans la table des commandes utilisateur.

Disponible lorsque OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE est activé et que OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES est supérieur à 1.

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 Ressources.