doc: add utilities basic usage informations

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

View File

@ -1,4 +1,4 @@
GOTEST_ARGS ?= -v -count=1 GOTEST_ARGS ?= -count=1
test: test:
go test $(GOTEST_ARGS) ./... go test $(GOTEST_ARGS) ./...

View File

@ -4,6 +4,11 @@
Librairie Golang d'interaction avec les produits [Emlid](https://emlid.com/). Librairie Golang d'interaction avec les produits [Emlid](https://emlid.com/).
## Utilitaires
- [`cmd/broadcast`](./cmd/broadcast) - Affichage en flux continu des évènements transmis par un module Reach
- [`cmd/configuration](./cmd/configuration) - Affichage de la configuration d'un module Reach
## Licence ## Licence
[AGPL-3.0](./LICENSE) [AGPL-3.0](./LICENSE)

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.

46
example/discovery_test.go Normal file
View File

@ -0,0 +1,46 @@
package example_test
import (
"context"
"fmt"
"os"
"testing"
"time"
"forge.cadoles.com/cadoles/go-emlid/reach/discovery"
"github.com/pkg/errors"
)
// Exemple d'utilisation du package "discovery" pour identifier
// les modules Reach présents sur le réseau
func ExampleDiscovery() {
timeout := 10 * time.Second
// Création d'un context avec un timeout de 10 secondes
// pour limiter le temps de recherche des modules
ctx, cancel := context.WithTimeout(context.Background(), timeout)
defer cancel()
// Recherche des modules annoncés sur le réseau
// La recherche durerera 10 secondes, conformément au
// timeout associé au context.Context
services, err := discovery.Discover(ctx)
if err != nil {
fmt.Printf("could not discover reach modules: %+v\n", errors.WithStack(err))
os.Exit(1)
}
// Affichage des différents services Reach identifiés
// sur le réseau
for idx, srv := range services {
fmt.Printf("Module #%d: %s:%d\n", idx, srv.AddrV4, srv.Port)
}
}
func TestExampleDiscovery(t *testing.T) {
if !testing.Verbose() {
return
}
ExampleDiscovery()
}

View File

@ -23,6 +23,7 @@ func AssertIntegrationTests(t *testing.T) {
} }
if !skipIntegrationTests { if !skipIntegrationTests {
t.Logf("Running integration tests. To disable, set environment variable %s=true", skipIntegrationTestsEnv)
return return
} }