doc: add utilities basic usage informations

This commit is contained in:
2024-08-02 10:37:19 +02:00
parent 4729c54076
commit 8f89ed7e77
6 changed files with 94 additions and 1 deletions

26
cmd/broadcast/README.md Normal file
View File

@ -0,0 +1,26 @@
# `broadcast`
Utilitaire permettant d'afficher en flux continu les messages de type `broadcast` transmis par un module Reach au format JSON.
## Utilisation
```shell
go run ./cmd/broadcast -host <HOST> -filter <FILTER>
```
Où:
- `<HOST>` est l'adresse IP du module Reach sur le réseau (par défaut `192.168.42.1`) ;
- `<FILTER>` est un filtre permettant d'afficher uniquement certains types de messages (par défaut vide).
> **Info** Utiliser le flag `-h` pour voir les autres options disponibles.
### Exemples
#### Afficher les messages de type `navigation`
```shell
go run ./cmd/broadcast -filter navigation
```
> **Info** Il est possible d'envoyer la sortie de la commande dans `jq` afin de sélectionner plus finement les données à afficher. Par exemple: `go run ./cmd/broadcast -filter navigation | jq '.payload.satellites'`.

View File

@ -0,0 +1,15 @@
# `configuration`
Utilitaire permettant d'afficher la configuration d'un module Reach au format JSON.
## Utilisation
```shell
go run ./cmd/configuration -host <HOST>
```
Où:
- `<HOST>` est l'adresse IP du module Reach sur le réseau (par défaut `192.168.42.1`).
> **Info** Utiliser le flag `-h` pour voir les autres options disponibles.