Add package documentation and usage example of UpdaterClient

This commit is contained in:
wpetit 2018-09-19 17:45:38 +02:00
parent 582e362aae
commit ee3113ed80
2 changed files with 34 additions and 0 deletions

30
reach/example_test.go Normal file
View File

@ -0,0 +1,30 @@
package reach
import "log"
// ReachRS modules provides an Updater application when reset in factory mode.
// This package provides an API to communicate with this application.
func Example_updaterClientUsage() {
// Create a new Updater client instance
updater := NewUpdaterClient(
WithEndpoint("192.168.42.1", 80), // Define the module endpoint
)
// Connect to the ReachRS Updater endpoint
if err := updater.Connect(); err != nil {
log.Fatal(err)
}
networks, err := updater.SavedWifiNetworks()
if err != nil {
log.Fatal(err)
}
// Do something with network
for _, n := range networks {
log.Printf("Save WiFi network: SSID: '%s', Security: '%s'", n.SSID, n.Security)
}
// Dont forget to close the connection when you are done
defer updater.Close()
}

4
reach/reach.go Normal file
View File

@ -0,0 +1,4 @@
// Package reach is a package to configure EMLID ReachRS modules in Go.
//
// It aims to provide a simple interface to common ReachRS modules management operations.
package reach