Revamp Mariquita with more structure (#1)

Author: polldo

README.md

@@ -0,0 +1,56 @@
+# Mariquita
+
+Mariquita is a virtual device for Arduino IoT Cloud for testing.
+
+```
+$ mariquita ping -u "<deviceId>" -p "<secret>" -t <thing ID>>
+  Connected to Arduino IoT Cloud
+  Subscribed true
+  Property value sent successfully 81
+  Property value sent successfully 87
+```
+
+## Requirements
+
+This is all you need to use Mariquita:
+ * A "Generic ESP8266 Module" device in IoT Cloud (requires a Maker plan)
+ * A thing with a `counter` property connected to the "Generic ESP8266 Module" device 
+
+## How to set up the device and thing in IoT Cloud
+
+### Device
+
+ * Visit https://create.arduino.cc/iot/devices and select "Add device".
+ * Select "Set up a 3rd party device".
+ * Select "ESP8266". 
+ * From the drop down select "Generic ESP8266 Module", and click "Continue".
+ * Pick a nice and friendly device name.
+ * Save the "Device ID" and "Secret Key" is a safe place, because you will not be able to see them anymore.
+  
+### Thing ID
+
+ * Visit https://create.arduino.cc/iot/things and select "Create Thing".
+ * Select "Add Variable".
+ * Give the variable the name "counter", type "Integer Number" and leave the variable permission the value "Read & Write".
+ * Press the "Add Variable" button to confirm.
+ * Copy the "Thing ID" from the bottom right of the page.
+ 
+### Connect the device and the thing
+
+You should connect the new device to the new thing.
+
+### Testing
+
+```shell
+$ mariquita ping -u "<Device ID>" -p "<Secret Key>" -t <Thing ID>>
+```
+
+If every works as expected you should see something similar to this output:
+```
+Connected to Arduino IoT Cloud
+Subscribed true
+Property value sent successfully 81
+Property value sent successfully 87
+```
+
+If you visit https://create.arduino.cc/iot/devices the "Generic ESP8266 Module" device status should be "Online".

adapters/mqtt/adapter.go

@@ -0,0 +1,101 @@
+package mqtt
+
+import (
+	"crypto/tls"
+	"fmt"
+
+	paho "github.com/eclipse/paho.mqtt.golang"
+)
+
+type Adapter struct {
+	host          string
+	clientID      string
+	username      string
+	password      string
+	useSSL        bool
+	autoReconnect bool
+	client        paho.Client
+	qos           int
+}
+
+func NewAdapterWithAuth(host, clientID, username, password string) *Adapter {
+	return &Adapter{
+		host:          host,
+		clientID:      clientID,
+		username:      username,
+		password:      password,
+		useSSL:        true,
+		autoReconnect: true,
+	}
+}
+
+func (a *Adapter) Connect() (err error) {
+	a.client = paho.NewClient(a.createClientOptions())
+	if token := a.client.Connect(); token.Wait() && token.Error() != nil {
+		err = token.Error()
+	}
+	return
+}
+
+func (a *Adapter) Disconnect() (err error) {
+	if a.client != nil {
+		a.client.Disconnect(500)
+	}
+	return
+}
+
+func (a *Adapter) Publish(topic string, message []byte) error {
+	_, err := a.PublishWithQOS(topic, a.qos, message)
+	return err
+}
+
+func (a *Adapter) PublishWithQOS(topic string, qos int, message []byte) (paho.Token, error) {
+	if a.client == nil {
+		return nil, fmt.Errorf("MQTT client is nil")
+	}
+
+	token := a.client.Publish(topic, byte(qos), false, message)
+	return token, nil
+}
+
+
+func (a *Adapter) On(topic string, f func(message paho.Message)) (bool, error) {
+	_, err := a.OnWithQOS(topic, a.qos, f)
+	if err != nil {
+		return false, err
+	}
+	return true, err
+}
+
+func (a *Adapter) OnWithQOS(topic string, qos int, f func(message paho.Message)) (paho.Token, error) {
+	if a.client == nil {
+		return nil, fmt.Errorf("MQTT client is nil")
+	}
+	
+	token := a.client.Subscribe(topic, byte(qos), func(client paho.Client, msg paho.Message) {
+		f(msg)
+	})
+	return token, nil
+	
+}
+
+func (a *Adapter) createClientOptions() *paho.ClientOptions {
+	opts := paho.NewClientOptions()
+	opts.AddBroker(a.host)
+	opts.SetClientID(a.clientID)
+	opts.SetUsername(a.username)
+	opts.SetPassword(a.password)
+
+	if a.useSSL {
+		opts.SetTLSConfig(a.newTLSConfig())
+	}
+	return opts
+}
+
+func (a *Adapter) newTLSConfig() *tls.Config {
+	return &tls.Config{
+		MinVersion: tls.VersionTLS11,
+		MaxVersion: tls.VersionTLS12,
+		ClientAuth: tls.NoClientCert,
+	}
+}

command/ping.go

@@ -0,0 +1,104 @@
+package command
+
+import (
+	"fmt"
+	paho "github.com/eclipse/paho.mqtt.golang"
+	"github.com/spf13/cobra"
+	"github.com/zmoog/mariquita/adapters/mqtt"
+	"github.com/zmoog/mariquita/internal/properties"
+	"math/rand"
+	"os"
+	"os/signal"
+	"syscall"
+	"time"
+)
+
+var (
+	host     string
+	username string
+	password string
+	thingID  string
+)
+
+func init() {
+	pingCommand.Flags().StringVarP(&host, "host", "b", "tcps://mqtts-up.iot.arduino.cc:8884", "Broker endpoint (required)")
+	pingCommand.Flags().StringVarP(&username, "username", "u", "", "Username (required)")
+	pingCommand.Flags().StringVarP(&password, "password", "p", "", "Password (required)")
+	pingCommand.Flags().StringVarP(&thingID, "thing_id", "t", "", "Thing ID (required)")
+
+	pingCommand.MarkFlagRequired("username")
+	pingCommand.MarkFlagRequired("password")
+	pingCommand.MarkFlagRequired("thing_id")
+
+	RootCmd.AddCommand(pingCommand)
+}
+
+var pingCommand = &cobra.Command{
+	Use:   "ping",
+	Short: "Ping Arduino IoT Cloud",
+	Long:  "Ping Arduino IoT Cloud",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		mqttAdapter := mqtt.NewAdapterWithAuth(
+			host,
+			username,
+			username,
+			password,
+		)
+
+		err := mqttAdapter.Connect()
+		if err != nil {
+			return err
+		}
+		fmt.Println("Connected to Arduino IoT Cloud")
+
+		inboundTopic := fmt.Sprintf("/a/t/%s/e/i", thingID)
+		outboundTopic := fmt.Sprintf("/a/t/%s/e/o", thingID)
+
+		// Subscribing to the thing inbound topic to received new properties
+		// values from the cloud.
+		ok, _ := mqttAdapter.On(inboundTopic, func(msg paho.Message) {
+			fmt.Println("received a message", msg)
+		})
+		fmt.Println("Subscribed", ok)
+
+		// Sending new random values (in the 0-100 range) to the thing specified
+		// using the flags
+		go func() {
+			for {
+				randomValue := rand.Intn(100)
+
+				property, err := properties.NewInteger("counter", randomValue)
+				if err != nil {
+					fmt.Println("Failed to encode property value", err)
+				}
+
+				// Publishing a new random value to the outbound topic of the thing
+				err = mqttAdapter.Publish(outboundTopic, property)
+				if err != nil {
+					fmt.Println("Failed to send property to Arduino IoT Cloud", err)
+				}
+				fmt.Println("Property value sent successfully", randomValue)
+
+				wait := 3
+				time.Sleep(time.Duration(wait) * time.Second)
+			}
+		}()
+
+		// Wait for a sigterm signal (CTRL+C) to disconnect from the broker
+		// and say good bye
+		c := make(chan os.Signal, 1)
+		signal.Notify(c, os.Interrupt, syscall.SIGTERM, syscall.SIGINT)
+
+		// blocking here waiting for a signal from the terminal 😪
+		<-c
+
+		mqttAdapter.Disconnect()
+		if err != nil {
+			return err
+		}
+		fmt.Println("Disconnected from Arduino IoT Cloud.")
+		fmt.Println("Completed successfully.")
+
+		return nil
+	},
+}

command/root.go

@@ -0,0 +1,16 @@
+package command
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+var RootCmd = &cobra.Command{}
+
+func Execute() {
+	if err := RootCmd.Execute(); err != nil {
+		fmt.Fprintln(os.Stderr, err)
+	}
+}

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/eclipse/paho.mqtt.golang v1.3.2
 	github.com/juju/errors v0.0.0-20200330140219-3fe23663418f
 	github.com/sirupsen/logrus v1.8.1
+	github.com/spf13/cobra v1.1.3
 )
 
 replace github.com/cisco/senml => github.com/bcmi-labs/senml v0.1.0