Interface de ligne de commande

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

Résumé

Typedefs
`otCliConsoleOutputCallback )(const char aBuf, uint16_t aBufLength, void aContext)`	typedef `int(*` Ce pointeur de fonction est appelé pour notifier la sortie de la console.

Les fonctions
`otCliAppendResult ( otError aError)`	`void` Écrivez le code d'erreur sur la console CLI.
`otCliConsoleInit ( otInstance aInstance, otCliConsoleOutputCallback aCallback, void aContext)`	`void` Initialisez le module CLI CONSOLE.
`otCliConsoleInputLine (char *aBuf, uint16_t aBufLength)`	`void` Cette méthode est appelée pour alimenter une ligne d'entrée de console.
`otCliOutput (const char *aString, uint16_t aLength)`	`void` Écrivez la chaîne dans la console CLI.
`otCliOutputBytes (const uint8_t *aBytes, uint8_t aLength)`	`void` Ecrivez un nombre d'octets dans la console CLI sous forme de chaîne hexadécimale.
`otCliOutputFormat (const char *aFmt, ...)`	`void` Ecrivez une 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 sur la console CLI.
`otCliSetUserCommands (const otCliCommand *aUserCommands, uint8_t aLength)`	`void` Définissez une table de commandes utilisateur.
`otCliUartInit ( otInstance *aInstance)`	`void` Initialisez le module CLI UART.

Typedefs

otCliConsoleOutputCallback

int(* otCliConsoleOutputCallback)(const char *aBuf, uint16_t aBufLength, void *aContext)

Ce pointeur de fonction est appelé pour notifier la sortie de la console.

Détails

Paramètres

`[in] aBuf`	Un pointeur vers un tampon avec une sortie.
`[in] aBufLength`	Une longueur des données de sortie stockées dans le tampon.
`[out] aContext`	Un pointeur de contexte utilisateur.

Retour

Nombre d'octets traités par le rappel.

Les fonctions

otCliAppendResult

void otCliAppendResult(
  otError aError
)

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

Détails

Paramètres

[in] aError

Valeur du code d'erreur.

otCliConsoleInit

void otCliConsoleInit(
  otInstance *aInstance,
  otCliConsoleOutputCallback aCallback,
  void *aContext
)

Initialisez le module CLI CONSOLE.

Détails

Paramètres

`[in] aInstance`	La structure de l'instance OpenThread.
`[in] aCallback`	Une méthode de rappel appelée pour traiter la sortie de la console.
`[in] aContext`	Un pointeur de contexte utilisateur.

otCliConsoleInputLine

void otCliConsoleInputLine(
  char *aBuf,
  uint16_t aBufLength
)

Cette méthode est appelée pour alimenter une ligne d'entrée de console.

Détails

Paramètres

`[in] aBuf`	Un pointeur vers un tampon avec une entrée.
`[in] aBufLength`	Une longueur des données d'entrée stockées dans le tampon.

otCliOutput

void otCliOutput(
  const char *aString,
  uint16_t aLength
)

Écrivez la chaîne dans la console CLI.

Détails

Paramètres

`[in] aString`	Un pointeur vers la chaîne, qui ne peut pas être terminée par un nul.
`[in] aLength`	Nombre d'octets.

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 qui doivent être imprimées.
`[in] aLength`	`aBytes` length.

otCliOutputFormat

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

Ecrivez une chaîne formatée dans la console CLI.

Détails

Paramètres

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

otCliPlatLogv

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

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

Détails

Paramètres

`[in] aLogLevel`	Le niveau de journalisation.
`[in] aLogRegion`	La région du journal.
`[in] aFormat`	Un pointeur vers la chaîne de format.
`[in] aArgs`	va_list correspondant à un format.

otCliSetUserCommands

void otCliSetUserCommands(
  const otCliCommand *aUserCommands,
  uint8_t aLength
)

Définissez une table de commandes utilisateur.

Détails

Paramètres

`[in] aUserCommands`	Un pointeur vers un tableau avec des commandes utilisateur.
`[in] aLength`	`aUserCommands` length.

otCliUartInit

void otCliUartInit(
  otInstance *aInstance
)

Initialisez le module CLI UART.

Détails

Paramètres

[in] aInstance

La structure de l'instance OpenThread.