Merge pull request #3 from ww24/fix-device

Fix bug

Author: ww24

.gitignore

@@ -15,5 +15,9 @@
 vendor/
 
 hems
-hems_linux_arm
+hems_linux_armv6
+hems_linux_armv7
 hems_linux_arm64
+
+.*
+!.gitignore

Makefile

@@ -1,7 +1,11 @@
 
-.PHONY: build-rpi
-build-rpi:
-	GOOS=linux GOARM=7 GOARCH=arm go build -o hems_linux_arm .
+.PHONY: build-rpi0
+build-rpi0:
+	GOOS=linux GOARM=6 GOARCH=arm go build -o hems_linux_armv6 .
+
+.PHONY: build-rpi2
+build-rpi2:
+	GOOS=linux GOARM=7 GOARCH=arm go build -o hems_linux_armv7 .
 
 .PHONY: build-rpi4
 build-rpi4:

README.md

@@ -15,6 +15,42 @@ B ルート対応 Wi-SUN デバイスにシリアル通信で接続し、消費
 
 ※ 本アプリケーションは、日本の電波法に準拠しているデバイスで、新たに免許等が必要ないものを接続して、利用する事を想定しています。
 
+### Installation (Ubuntu)
+
+#### Deploy binary
+
+armv7 用のバイナリを使う場合は次のようになります。
+
+```sh
+sudo cp ./hems_linux_armv7 /usr/local/bin/
+```
+
+#### Deploy service and udev rule
+
+`hems.service` で設定されている以下の項目は適切な値に変更してください。
+
+```
+Environment=HEMS_ROUTEB_ID=xxx
+Environment=HEMS_PASSWORD=xxx
+Environment=HEMS_DEVICE=/dev/udg-1-wsne
+ExecStart=/usr/local/bin/hems_linux_armv7
+```
+
+```sh
+sudo cp ./example/etc/systemd/system/hems.service /etc/systemd/system/hems.service
+sudo systemctl daemon-reload
+```
+
+`UDG-1-WSNE` 以外を使う場合は `99-hems.rules` を修正する必要があります。
+
+```sh
+sudo cp ./example/etc/udev/rules.d/99-hems.rules /etc/udev/rules.d/99-hems.rules
+sudo udevadm control --reload
+```
+
+USB ドングルを接続すると自動的に hems service が起動します。
+USB ドングルを外すと自動的に停止します。
+
 ## Build
 
 ### Raspberry Pi 4
@@ -23,10 +59,16 @@ B ルート対応 Wi-SUN デバイスにシリアル通信で接続し、消費
 make build-rpi4
 ```
 
-### Raspberry Pi 2, 3 or Zero
+### Raspberry Pi 2, 3
+
+```sh
+make build-rpi2
+```
+
+### Raspberry Pi 1, Zero
 
 ```sh
-make build-rpi
+make build-rpi0
 ```
 
 ## Example

dongle/bp35c2.go

@@ -4,8 +4,11 @@ import (
 	"bufio"
 	"errors"
 	"fmt"
+	"io"
+	"io/ioutil"
 	"strings"
 	"sync"
+	"time"
 
 	"github.com/pkg/term"
 )
@@ -21,18 +24,20 @@ var (
 )
 
 // NewBP35C2 returns command wrapper for BP35C2.
-func NewBP35C2(serialDevice string, baudrate int) *BP35C2 {
+func NewBP35C2(serialDevice string, baudrate int, readTimeout time.Duration) *BP35C2 {
 	return &BP35C2{
-		SerialDevice: serialDevice,
-		Baudrate:     baudrate,
+		serialDevice: serialDevice,
+		baudrate:     baudrate,
+		readTimeout:  readTimeout,
 	}
 }
 
 // BP35C2 is BP35C0/BP35C2 client implementation.
 type BP35C2 struct {
 	m            sync.Mutex
-	SerialDevice string
-	Baudrate     int
+	serialDevice string
+	baudrate     int
+	readTimeout  time.Duration
 	term         *term.Term
 	localIP      string
 	remoteIP     string
@@ -50,17 +55,32 @@ func (d *BP35C2) SetRemoteIP(ip string) {
 
 // Connect connects serial device.
 func (d *BP35C2) Connect() error {
-	t, err := term.Open(d.SerialDevice,
-		term.Speed(d.Baudrate), term.RawMode, term.ReadTimeout(readTimeout))
+	t, err := term.Open(d.serialDevice,
+		term.Speed(d.baudrate), term.RawMode, term.ReadTimeout(d.readTimeout))
 	if err != nil {
 		return err
 	}
 	d.term = t
+	return d.clear()
+}
+
+func (d *BP35C2) clear() error {
+	// Discard data before first command.
+	if err := d.term.Flush(); err != nil {
+		return err
+	}
+	if _, err := io.Copy(ioutil.Discard, d.term); err != nil {
+		return err
+	}
+	if err := d.SKTERM(); err != nil {
+		return err
+	}
 	return nil
 }
 
 // Close closes serial device.
 func (d *BP35C2) Close() {
+	d.SKTERM()
 	d.term.Close()
 }
 
@@ -168,14 +188,18 @@ type PAN struct {
 func (d *BP35C2) SKSCAN() (*PAN, error) {
 	d.m.Lock()
 	defer d.m.Unlock()
+
 	// SKSCAN <MODE> <CHANNEL_MASK> <DURATION> <SIDE><CRLF>
 	err := d.write("SKSCAN 2 FFFFFFFF 6 0\r\n")
 	if err != nil {
 		return nil, err
 	}
-	d.term.Flush()
+
 	reader := bufio.NewReader(d.term)
 	scanner := bufio.NewScanner(reader)
+	if err := d.term.Flush(); err != nil {
+		return nil, err
+	}
 	pan := &PAN{}
 	for scanner.Scan() {
 		l := scanner.Text()
@@ -254,9 +278,11 @@ func (d *BP35C2) SKJOIN(ipv6Addr string) error {
 	if err != nil {
 		return err
 	}
-	d.term.Flush()
 	reader := bufio.NewReader(d.term)
 	scanner := bufio.NewScanner(reader)
+	if err := d.term.Flush(); err != nil {
+		return err
+	}
 	for scanner.Scan() {
 		l := scanner.Text()
 		fmt.Println(l)
@@ -281,7 +307,6 @@ func (d *BP35C2) SKSENDTO(handle, ipAddr, port, sec string, data []byte) (string
 	s := fmt.Sprintf("SKSENDTO %s %s %s %s 0 %.4X ", handle, ipAddr, port, sec, len(data))
 	b := append([]byte(s), data[:]...)
 	b = append(b, []byte("\r\n")...)
-	defer d.term.Flush()
 	_, err := d.term.Write(b)
 	if err != nil {
 		return "", err
@@ -307,8 +332,42 @@ func (d *BP35C2) SKSENDTO(handle, ipAddr, port, sec string, data []byte) (string
 	return "", errors.New("SKSENDTO failed")
 }
 
+// SKTERM terminates PANA session.
+func (d *BP35C2) SKTERM() error {
+	d.m.Lock()
+	defer d.m.Unlock()
+	// SKJOIN<CRLF>
+	err := d.write("SKTERM\r\n")
+	if err != nil {
+		return err
+	}
+	reader := bufio.NewReader(d.term)
+	scanner := bufio.NewScanner(reader)
+	if err := d.term.Flush(); err != nil {
+		return err
+	}
+	for scanner.Scan() {
+		l := scanner.Text()
+		fmt.Println(l)
+		if strings.Contains(l, respFail+"ER10") {
+			// session is not established
+			return nil
+		}
+		if strings.Contains(l, respFail) {
+			return fmt.Errorf("Failed to SKTERM. %s", l)
+		}
+		if strings.Contains(l, "EVENT 28 ") {
+			// session timeout (session is terminated)
+			return nil
+		}
+		if strings.Contains(l, respOk) {
+			return nil
+		}
+	}
+	return nil
+}
+
 func (d *BP35C2) write(s string) error {
-	defer d.term.Flush()
 	_, err := d.term.Write([]byte(s))
 	if err != nil {
 		return err
@@ -317,14 +376,19 @@ func (d *BP35C2) write(s string) error {
 }
 
 func (d *BP35C2) readUntil(symbol string) ([]string, error) {
-	d.term.Flush()
 	reader := bufio.NewReader(d.term)
 	scanner := bufio.NewScanner(reader)
+	if err := d.term.Flush(); err != nil {
+		return nil, err
+	}
 	rs := make([]string, 0, 1)
 	for scanner.Scan() {
 		l := strings.TrimSpace(scanner.Text())
 		fmt.Println("[RESPONSE] >>", l) // DEBUG
 		rs = append(rs, l)
+		if strings.Contains(l, "EVENT 29 ") {
+			return nil, errors.New("session lifetime exceeded")
+		}
 		if strings.Contains(l, respFail) {
 			return nil, errors.New(l)
 		}

dongle/dongle.go

@@ -11,10 +11,6 @@ import (
 	"go.uber.org/zap"
 )
 
-const (
-	readTimeout = 5 * time.Second
-)
-
 var (
 	// ErrFatal is not retriable error.
 	ErrFatal = errors.New("Fatal error")
@@ -58,6 +54,7 @@ type Dongle interface {
 	SKSENDTO(handle, ipAddr, port, sec string, data []byte) (string, error)
 }
 
+// Init initialises connection.
 func (du *Client) Init() error {
 	logger := du.Logger
 
@@ -141,10 +138,12 @@ func (du *Client) Init() error {
 	return nil
 }
 
+// Close closes connection.
 func (du *Client) Close() {
 	du.Dongle.Close()
 }
 
+// Fetch fetches electric energy consumption [watt].
 func (du *Client) Fetch(ctx context.Context, f func(time time.Time, watt int64)) error {
 	logger := du.Logger
 
@@ -184,7 +183,7 @@ func (du *Client) fetch() (time.Time, int64, error) {
 	}
 	if a[8] != "0012" {
 		fmt.Println(fmt.Sprintf("%s is not 0012. ", a[7]))
-		return t, 0, err
+		return t, 0, errors.New("unexpected response")
 	}
 	o := a[9]
 	w, err := strconv.ParseInt(o[len(o)-8:], 16, 0)

example/datadog/dashboard.json

@@ -8,7 +8,7 @@
                 "type": "query_value",
                 "requests": [
                     {
-                        "q": "max:go_expvar.hems.watt{host:hems}",
+                        "q": "max:go_expvar.hems.watt{$host}",
                         "aggregator": "max",
                         "conditional_formats": [
                             {
@@ -48,16 +48,23 @@
                 "type": "timeseries",
                 "requests": [
                     {
-                        "q": "avg:go_expvar.hems.watt{host:hems}",
+                        "q": "avg:go_expvar.hems.watt{$host}.rollup(max)",
                         "display_type": "area",
                         "style": {
                             "palette": "dog_classic",
                             "line_type": "solid",
                             "line_width": "normal"
-                        }
+                        },
+                        "on_right_yaxis": false
                     }
                 ],
-                "custom_links": [],
+                "yaxis": {
+                    "label": "",
+                    "scale": "linear",
+                    "min": "auto",
+                    "max": "auto",
+                    "include_zero": true
+                },
                 "title": "瞬間消費電力推移(4h)",
                 "title_size": "16",
                 "title_align": "left",
@@ -80,7 +87,7 @@
                 "type": "query_value",
                 "requests": [
                     {
-                        "q": "max:go_expvar.hems.watt{host:hems}",
+                        "q": "max:go_expvar.hems.watt{$host}",
                         "aggregator": "last",
                         "conditional_formats": [
                             {
@@ -120,7 +127,7 @@
                 "type": "timeseries",
                 "requests": [
                     {
-                        "q": "avg:go_expvar.hems.watt{host:hems}",
+                        "q": "avg:go_expvar.hems.watt{$host}.rollup(max)",
                         "display_type": "area",
                         "style": {
                             "palette": "dog_classic",
@@ -129,7 +136,13 @@
                         }
                     }
                 ],
-                "custom_links": [],
+                "yaxis": {
+                    "label": "",
+                    "scale": "linear",
+                    "min": "auto",
+                    "max": "auto",
+                    "include_zero": true
+                },
                 "title": "瞬間消費電力推移(24h)",
                 "title_size": "16",
                 "title_align": "left",
@@ -147,7 +160,13 @@
             }
         }
     ],
-    "template_variables": [],
+    "template_variables": [
+        {
+            "name": "host",
+            "default": "raspberrypi",
+            "prefix": "host"
+        }
+    ],
     "layout_type": "free",
     "is_read_only": false,
     "notify_list": [],