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

Interface de ligne de commande

Ce module inclut 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(*` Ce pointeur de fonction est appelé pour envoyer une notification au sujet de la sortie de la console.

Functions
`otCliAppendResult(otError aError)`	`void` Écrire le code d'erreur dans la console CLI
`otCliInit(otInstance aInstance, otCliOutputCallback aCallback, void aContext)`	`void` Initialisez le module CLI.
`otCliInputLine(char *aBuf)`	`void` Cette méthode est appelée pour insérer un flux dans 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 la forme d'une chaîne hexadécimale.
`otCliOutputFormat(const char *aFmt, ...)`	`void` Écrivez la chaîne formatée 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)`	`void` Définir une table de commandes utilisateur

Typedefs

otCliOutputCallback

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

Ce pointeur de fonction est appelé pour envoyer une notification au sujet de la sortie de la console.

Détails

Paramètres

`[out] aContext`	Pointeur de contexte de l'utilisateur.
`[in] aFormat`	Chaîne de format.
`[in] aArguments`	Arguments de la chaîne de format.

Renvoie

Nombre d'octets écrits par le rappel.

Functions

otCliAppendResult

void otCliAppendResult(
  otError aError
)

Écrire le code d'erreur dans la console CLI

Si la valeur de aError est définie sur OT_ERROR_PENDING, aucun résultat n'est 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 de l'instance OpenThread.
`[in] aCallback`	Méthode de rappel appelée pour traiter la sortie CLI.
`[in] aContext`	Pointeur de contexte de l'utilisateur.

otCliInputLine

void otCliInputLine(
  char *aBuf
)

Cette méthode est appelée pour insérer un flux dans une ligne d'entrée de la console.

Détails

Paramètres

[in] aBuf

Pointeur vers une chaîne terminée par une valeur nulle.

OTCliOutputBytes

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

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

Détails

Paramètres

`[in] aBytes`	Pointeur sur les données à imprimer.
`[in] aLength`	Longueur : `aBytes`.

OTCliOutputFormat

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

Écrivez la chaîne formatée dans la console CLI.

Détails

Paramètres

`[in] aFmt`	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`	Pointeur vers la chaîne de format.
`[in] aArgs`	va_list correspondant à aFormat.

otCliSetUserCommands

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

Définir une table de commandes utilisateur

Détails

Paramètres

`[in] aUserCommands`	Pointeur vers un tableau avec des commandes utilisateur
`[in] aLength`	Longueur : `aUserCommands`.
`[in] aContext`	Contexte `The` transmis au gestionnaire.

Resources

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