Refactor reach package

- Rename reach package to emlid
- Create generic Reach websocket client
- Add 2 new subpackages 'updater' and 'reachview' to provides specific
API

emlid/updater/client.go

@@ -0,0 +1,15 @@
+// Package updater provides an API to communicate with the ReachRS modules "Updater" application
+package updater
+
+import "forge.cadoles.com/Pyxis/orion/emlid"
+
+// Client is a ReachRS Updater client
+type Client struct {
+	*emlid.Client
+}
+
+// NewClient returns a new ReachRS Updater client
+func NewClient(opts ...emlid.OptionFunc) *Client {
+	client := emlid.NewClient(opts...)
+	return &Client{client}
+}

emlid/updater/example_test.go

@@ -0,0 +1,32 @@
+package updater
+
+import (
+	"log"
+
+	"forge.cadoles.com/Pyxis/orion/emlid"
+)
+
+func Example_usage() {
+	// Create a new Updater client instance
+	updater := NewClient(
+		emlid.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.WifiNetworks()
+	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()
+}

emlid/updater/reachview_version.go

@@ -0,0 +1,19 @@
+package updater
+
+const (
+	eventGetReachViewVersion     = "get reachview version"
+	eventReachViewVersionResults = "current reachview version"
+)
+
+type reachViewVersion struct {
+	Version string `json:"version"`
+}
+
+// ReachViewVersion returns the ReachRS module ReachView version
+func (c *Client) ReachViewVersion() (string, error) {
+	res := &reachViewVersion{}
+	if err := c.ReqResp(eventGetReachViewVersion, nil, eventReachViewVersionResults, res); err != nil {
+		return "", err
+	}
+	return res.Version, nil
+}

emlid/updater/reachview_version_test.go

@@ -0,0 +1,34 @@
+package updater
+
+import (
+	"testing"
+
+	"forge.cadoles.com/Pyxis/orion/emlid"
+)
+
+func TestClientReachViewVersion(t *testing.T) {
+
+	if !*runUpdaterIntegrationTests {
+		t.Skip("To run this test, use: go test -updater-integration")
+	}
+
+	client := NewClient(
+		emlid.WithStandardLogger(),
+		emlid.WithEndpoint(*reachHost, 80),
+	)
+	if err := client.Connect(); err != nil {
+		t.Fatal(err)
+	}
+
+	version, err := client.ReachViewVersion()
+	if err != nil {
+		t.Error(err)
+	}
+
+	if version == "" {
+		t.Error("version should not be empty")
+	}
+
+	defer client.Close()
+
+}

emlid/updater/reboot_now.go

@@ -0,0 +1,41 @@
+package updater
+
+import (
+	"sync"
+
+	"forge.cadoles.com/Pyxis/golang-socketio"
+	"github.com/pkg/errors"
+)
+
+const (
+	eventReboot = "reboot now"
+)
+
+// RebootNow asks the ReachRS module to reboot now
+func (c *Client) RebootNow(waitDisconnect bool) error {
+
+	var err error
+	var wg sync.WaitGroup
+
+	if waitDisconnect {
+		wg.Add(1)
+		err = c.On(gosocketio.OnDisconnection, func(h *gosocketio.Channel) {
+			c.Off(gosocketio.OnDisconnection)
+			wg.Done()
+		})
+		if err != nil {
+			return errors.Wrapf(err, "error while binding to '%s' event", gosocketio.OnDisconnection)
+		}
+	}
+
+	if err = c.Emit(eventReboot, nil); err != nil {
+		return err
+	}
+
+	if waitDisconnect {
+		wg.Wait()
+	}
+
+	return err
+
+}

emlid/updater/reboot_now_test.go

@@ -0,0 +1,33 @@
+package updater
+
+import (
+	"testing"
+
+	"forge.cadoles.com/Pyxis/orion/emlid"
+)
+
+func TestClientRebootNow(t *testing.T) {
+
+	if !*runUpdaterIntegrationTests {
+		t.Skip("To run this test, use: go test -updater-integration")
+	}
+
+	if !*runRebootTest {
+		t.Skip("To run this test, use: go test -updater-reboot-test")
+	}
+
+	client := NewClient(
+		emlid.WithStandardLogger(),
+		emlid.WithEndpoint(*reachHost, 80),
+	)
+	if err := client.Connect(); err != nil {
+		t.Fatal(err)
+	}
+
+	if err := client.RebootNow(true); err != nil {
+		t.Error(err)
+	}
+
+	defer client.Close()
+
+}

emlid/updater/receiver_upgrade.go

@@ -0,0 +1,21 @@
+package updater
+
+const (
+	eventIsReceiverUpgradeAvailable = "is receiver upgrade available"
+	eventReceiverUpgradeAvailable   = "receiver upgrade available"
+)
+
+type receiverUpgreAvailable struct {
+	Available bool `json:"available"`
+	Running   bool `json:"running"`
+}
+
+// ReceiverUpgradeAvailable checks if an upgrade is avaialable/running for the ReachRS module
+func (c *Client) ReceiverUpgradeAvailable() (bool, bool, error) {
+	res := &receiverUpgreAvailable{}
+	if err := c.ReqResp(eventIsReceiverUpgradeAvailable, nil, eventReceiverUpgradeAvailable, res); err != nil {
+		return false, false, err
+	}
+	c.Logf("receiver upgrade result: available: %v, running: %v", res.Available, res.Running)
+	return res.Available, res.Running, nil
+}

emlid/updater/receiver_upgrade_test.go

@@ -0,0 +1,30 @@
+package updater
+
+import (
+	"testing"
+
+	"forge.cadoles.com/Pyxis/orion/emlid"
+)
+
+func TestClientReceiverUpgradeAvailable(t *testing.T) {
+
+	if !*runUpdaterIntegrationTests {
+		t.Skip("To run this test, use: go test -updater-integration")
+	}
+
+	client := NewClient(
+		emlid.WithStandardLogger(),
+		emlid.WithEndpoint(*reachHost, 80),
+	)
+	if err := client.Connect(); err != nil {
+		t.Fatal(err)
+	}
+
+	_, _, err := client.ReceiverUpgradeAvailable()
+	if err != nil {
+		t.Error(err)
+	}
+
+	defer client.Close()
+
+}

emlid/updater/test.go

@@ -0,0 +1,23 @@
+package updater
+
+import "flag"
+
+var runUpdaterIntegrationTests = flag.Bool(
+	"updater-integration", false,
+	"Run the 'Updater' integration tests (in addition to the unit tests)",
+)
+
+var runRebootTest = flag.Bool(
+	"updater-reboot-test", false,
+	"Run the updater 'Reboot' test (in addition to the unit tests)",
+)
+
+var runJoinNetworkTest = flag.Bool(
+	"updater-join-network-test", false,
+	"Run the updater 'JoinWiFiNetwork' test (in addition to the unit tests)",
+)
+
+var reachHost = flag.String(
+	"reach-host", "192.168.42.1",
+	"The Reach module host to use in integration tests",
+)

emlid/updater/test_results.go

@@ -0,0 +1,25 @@
+package updater
+
+const (
+	eventGetTestResults = "get test results"
+	eventTestResults    = "test results"
+)
+
+// TestResults are the ReachRS module's test results
+//
+type TestResults struct {
+	Device string `json:"device"`
+	Lora   bool   `json:"lora"`
+	MPU    bool   `json:"mpu"`
+	STC    bool   `json:"stc"`
+	UBlox  bool   `json:"u-blox"`
+}
+
+// TestResults returns the ReachRS module tests results
+func (c *Client) TestResults() (*TestResults, error) {
+	res := &TestResults{}
+	if err := c.ReqResp(eventGetTestResults, nil, eventTestResults, res); err != nil {
+		return nil, err
+	}
+	return res, nil
+}

emlid/updater/test_results_test.go

@@ -0,0 +1,34 @@
+package updater
+
+import (
+	"testing"
+
+	"forge.cadoles.com/Pyxis/orion/emlid"
+)
+
+func TestClientTestResults(t *testing.T) {
+
+	if !*runUpdaterIntegrationTests {
+		t.Skip("To run this test, use: go test -updater-integration")
+	}
+
+	client := NewClient(
+		emlid.WithStandardLogger(),
+		emlid.WithEndpoint(*reachHost, 80),
+	)
+	if err := client.Connect(); err != nil {
+		t.Fatal(err)
+	}
+
+	results, err := client.TestResults()
+	if err != nil {
+		t.Error(err)
+	}
+
+	if g, e := results.Device, "ReachRS"; g != e {
+		t.Errorf("results.Device: got '%s', expected '%s'", g, e)
+	}
+
+	defer client.Close()
+
+}

emlid/updater/time_sync.go

@@ -0,0 +1,21 @@
+package updater
+
+const (
+	eventGetTimeSyncStatus = "get time sync status"
+	eventTimeSyncResults   = "time sync status"
+)
+
+type timeSyncStatus struct {
+	Status bool `json:"status"`
+}
+
+// TimeSynced returns the ReachRS module time synchronization status.
+// A true response means that the module has synchronized its clock.
+func (c *Client) TimeSynced() (bool, error) {
+	res := &timeSyncStatus{}
+	if err := c.ReqResp(eventGetTimeSyncStatus, nil, eventTimeSyncResults, res); err != nil {
+		return false, err
+	}
+	c.Logf("time sync result: %v", res.Status)
+	return res.Status, nil
+}

emlid/updater/time_sync_test.go

@@ -0,0 +1,30 @@
+package updater
+
+import (
+	"testing"
+
+	"forge.cadoles.com/Pyxis/orion/emlid"
+)
+
+func TestClientTimeSync(t *testing.T) {
+
+	if !*runUpdaterIntegrationTests {
+		t.Skip("To run this test, use: go test -updater-integration")
+	}
+
+	client := NewClient(
+		emlid.WithStandardLogger(),
+		emlid.WithEndpoint(*reachHost, 80),
+	)
+	if err := client.Connect(); err != nil {
+		t.Fatal(err)
+	}
+
+	_, err := client.TimeSynced()
+	if err != nil {
+		t.Error(err)
+	}
+
+	defer client.Close()
+
+}

emlid/updater/update.go

@@ -0,0 +1,26 @@
+package updater
+
+const (
+	eventUpdate           = "update"
+	eventOPKGUpdateResult = "opkg update result"
+)
+
+// UpdateStatus embeds informations about update status
+type UpdateStatus struct {
+	Active bool   `json:"active"`
+	Locked bool   `json:"locked"`
+	State  string `json:"state"`
+}
+
+// Update asks the ReachRS module to start an OPKG update
+func (c *Client) Update() (*UpdateStatus, error) {
+	res := &UpdateStatus{}
+	if err := c.ReqResp(eventUpdate, nil, eventOPKGUpdateResult, res); err != nil {
+		return nil, err
+	}
+	c.Logf(
+		"opkg update result: active: %v, state: %v, locked: %v",
+		res.Active, res.State, res.Locked,
+	)
+	return res, nil
+}

emlid/updater/update_test.go

@@ -0,0 +1,30 @@
+package updater
+
+import (
+	"testing"
+
+	"forge.cadoles.com/Pyxis/orion/emlid"
+)
+
+func TestClientOPKGUpdate(t *testing.T) {
+
+	if !*runUpdaterIntegrationTests {
+		t.Skip("To run this test, use: go test -updater-integration")
+	}
+
+	client := NewClient(
+		emlid.WithStandardLogger(),
+		emlid.WithEndpoint(*reachHost, 80),
+	)
+	if err := client.Connect(); err != nil {
+		t.Fatal(err)
+	}
+
+	_, err := client.Update()
+	if err != nil {
+		t.Error(err)
+	}
+
+	defer client.Close()
+
+}

emlid/updater/wifi_networks.go

@@ -0,0 +1,101 @@
+package updater
+
+import (
+	"sync"
+
+	"forge.cadoles.com/Pyxis/golang-socketio"
+	"github.com/pkg/errors"
+)
+
+const (
+	eventGetSavedWifiNetworks     = "get saved wifi networks"
+	eventSavedWifiNetworkResults  = "wifi saved networks results"
+	eventAddWifiNetwork           = "add new network"
+	eventAddWifiNetworkResults    = "add network results"
+	eventRemoveWifiNetwork        = "remove network"
+	eventRemoveWifiNetworkResults = "remove network results"
+	eventConnectToNetwork         = "connect to network"
+)
+
+// WifiSecurity is a WiFi network security algorithm
+type WifiSecurity string
+
+const (
+	// SecurityWEP WEP wifi network
+	SecurityWEP WifiSecurity = "wep"
+	// SecurityWPAPSK WPA(2)-PSK wifi network
+	SecurityWPAPSK WifiSecurity = "wpa-psk"
+	// SecurityOpen Open wifi network
+	SecurityOpen WifiSecurity = "open"
+)
+
+// WifiNetwork is a ReachRS module wifi network
+type WifiNetwork struct {
+	SSID      string       `json:"ssid"`
+	Password  string       `json:"password"`
+	Security  WifiSecurity `json:"security"`
+	Identity  string       `json:"identity"`
+	Visible   bool         `json:"is_visible"`
+	Connected bool         `json:"is_connected"`
+	Added     bool         `json:"is_added"`
+}
+
+// WifiNetworks returns the ReachRS module wifi networks
+func (c *Client) WifiNetworks() ([]WifiNetwork, error) {
+	res := make([]WifiNetwork, 0)
+	if err := c.ReqResp(eventGetSavedWifiNetworks, nil, eventSavedWifiNetworkResults, &res); err != nil {
+		return nil, err
+	}
+	return res, nil
+}
+
+// AddWifiNetwork asks the ReachRS module to save the given wifi network informations
+func (c *Client) AddWifiNetwork(ssid string, security WifiSecurity, password string) (bool, error) {
+	res := false
+	network := &WifiNetwork{
+		SSID:     ssid,
+		Security: security,
+		Password: password,
+	}
+	if err := c.ReqResp(eventAddWifiNetwork, network, eventAddWifiNetworkResults, &res); err != nil {
+		return false, err
+	}
+	return res, nil
+}
+
+// RemoveWifiNetwork asks the ReachRS module to remove the given WiFi network
+func (c *Client) RemoveWifiNetwork(ssid string) (bool, error) {
+	res := false
+	if err := c.ReqResp(eventRemoveWifiNetwork, ssid, eventRemoveWifiNetworkResults, &res); err != nil {
+		return false, err
+	}
+	return res, nil
+}
+
+// JoinWifiNetwork asks the ReachRS module to join the given WiFi network
+func (c *Client) JoinWifiNetwork(ssid string, waitDisconnect bool) error {
+
+	var err error
+	var wg sync.WaitGroup
+
+	if waitDisconnect {
+		wg.Add(1)
+		err = c.On(gosocketio.OnDisconnection, func(h *gosocketio.Channel) {
+			c.Off(gosocketio.OnDisconnection)
+			wg.Done()
+		})
+		if err != nil {
+			return errors.Wrapf(err, "error while binding to '%s' event", gosocketio.OnDisconnection)
+		}
+	}
+
+	if err := c.Emit(eventConnectToNetwork, ssid); err != nil {
+		return errors.Wrapf(err, "error while emitting '%s' event", eventConnectToNetwork)
+	}
+
+	if waitDisconnect {
+		wg.Wait()
+	}
+
+	return nil
+}

emlid/updater/wifi_networks_test.go

@@ -0,0 +1,127 @@
+package updater
+
+import (
+	"fmt"
+	"math/rand"
+	"testing"
+	"time"
+
+	"forge.cadoles.com/Pyxis/orion/emlid"
+)
+
+func TestClientSavedWiFiNetworks(t *testing.T) {
+
+	if !*runUpdaterIntegrationTests {
+		t.Skip("To run this test, use: go test -updater-integration")
+	}
+
+	client := NewClient(
+		emlid.WithStandardLogger(),
+		emlid.WithEndpoint(*reachHost, 80),
+	)
+	if err := client.Connect(); err != nil {
+		t.Fatal(err)
+	}
+
+	_, err := client.WifiNetworks()
+	if err != nil {
+		t.Error(err)
+	}
+
+	defer client.Close()
+
+}
+
+func TestClientCRUDWiFiNetwork(t *testing.T) {
+
+	if !*runUpdaterIntegrationTests {
+		t.Skip("To run this test, use: go test -updater-integration")
+	}
+
+	client := NewClient(
+		emlid.WithStandardLogger(),
+		emlid.WithEndpoint(*reachHost, 80),
+	)
+	if err := client.Connect(); err != nil {
+		t.Fatal(err)
+	}
+
+	ssid := fmt.Sprintf("wifi_test_%d", rand.Uint32())
+
+	done, err := client.AddWifiNetwork(ssid, SecurityOpen, "")
+	if err != nil {
+		t.Error(err)
+	}
+
+	if g, e := done, true; g != e {
+		t.Errorf("AddWifiNetwork() -> done: got '%v', expected '%v'", g, e)
+	}
+
+	networks, err := client.WifiNetworks()
+	if err != nil {
+		t.Error(err)
+	}
+
+	found := false
+	for _, n := range networks {
+		if n.SSID == ssid {
+			found = true
+			break
+		}
+	}
+
+	if g, e := found, true; g != e {
+		t.Errorf("wifi network '%s' should exists", ssid)
+	}
+
+	done, err = client.RemoveWifiNetwork(ssid)
+	if err != nil {
+		t.Error(err)
+	}
+
+	if g, e := done, true; g != e {
+		t.Errorf("RemoveWifiNetwork() -> done: got '%v', expected '%v'", g, e)
+	}
+
+	defer client.Close()
+
+}
+
+func TestClientWifiNetworkJoin(t *testing.T) {
+
+	if !*runUpdaterIntegrationTests {
+		t.Skip("To run this test, use: go test -updater-integration")
+	}
+
+	if !*runJoinNetworkTest {
+		t.Skip("To run this test, use: go test -updater-join-network-test")
+	}
+
+	client := NewClient(
+		emlid.WithStandardLogger(),
+		emlid.WithEndpoint(*reachHost, 80),
+	)
+	if err := client.Connect(); err != nil {
+		t.Fatal(err)
+	}
+
+	ssid := fmt.Sprintf("wifi_test_%d", rand.Uint32())
+
+	done, err := client.AddWifiNetwork(ssid, SecurityOpen, "")
+	if err != nil {
+		t.Error(err)
+	}
+
+	if g, e := done, true; g != e {
+		t.Errorf("AddWifiNetwork() -> done: got '%v', expected '%v'", g, e)
+	}
+
+	if err := client.JoinWifiNetwork(ssid, true); err != nil {
+		t.Error(err)
+	}
+
+	time.Sleep(5 * time.Second)
+
+	defer client.Close()
+
+}