feat: initial code (#1)

Author: nrwiersma

.gitignore

@@ -0,0 +1,44 @@
+run:
+  tests: false
+  timeout: 5m
+
+linters-settings:
+  cyclop:
+    max-complexity: 20
+    skip-tests: true
+  funlen:
+    lines: 80
+  gofumpt:
+    extra-rules: true
+
+linters:
+  enable-all: true
+  disable:
+    - interfacer # deprecated
+    - scopelint # deprecated
+    - maligned # deprecated
+    - golint # deprecated
+    - durationcheck
+    - exhaustive
+    - exhaustivestruct
+    - forcetypeassert
+    - funlen
+    - gochecknoglobals
+    - gochecknoinits
+    - goerr113
+    - gomnd
+    - nlreturn
+    - nilerr
+    - noctx
+    - tagliatelle
+    - wrapcheck
+    - wsl
+
+issues:
+  exclude-use-default: false
+  exclude:
+    - 'ST1000: at least one file in a package should have a package comment'
+  exclude-rules:
+    - path: module/client.go
+      linters:
+        - noctx

.golangci.yml

@@ -0,0 +1,58 @@
+![Logo](http://svg.wiersma.co.za/glasslabs/module?title=HASS-FLOORPLAN&tag=a%20home%20assistant%20floorplan%20module)
+
+Hass-floorplan is a home assistant floorplan module for [looking glass](http://github.com/glasslabs/looking-glass)
+
+![Screenshot](.readme/screenshot.png)
+
+## Usage
+
+Clone the hass-floorplan into a path under your modules path and add the module path
+to under modules in your configuration.
+
+```yaml
+modules:
+ - name: floorplan
+    path: github.com/glasslabs/hass-floorplan
+    position: top:right
+    config:
+      url: http://my-hass-instance:8123/
+      token: <your-hass-token>
+      floorplan: {{ .ConfigPath }}/assets/floorplan.svg
+      mapping:
+        your-entity: your-svg-element
+```
+
+## Configuration
+
+### URL (url)
+
+*Required*
+
+Your home assistant instance URL, in the form of `http://home.assistant:8123/`.
+
+### Token (token)
+
+*Required*
+
+You home assistant API token.
+
+### Floorplan (floorplan)
+
+*Required*
+
+The path to your floor plan SVG file.
+
+### Custom CSS (customCss)
+
+*Optional*
+
+The custom CSS file to style the SVG states. The element states are `on`, `off` and `unavailable`, although `off` should
+be the default state and not relied on to be set.
+
+The default stylesheet uses classes `light` and `door` to style different elements.
+
+### Entity Mapping (mapping)
+
+*Optional*
+
+An optional mapping from home assistant entity name to SVG element name.

.readme/screenshot.png

@@ -0,0 +1,19 @@
+.hass-floorplan .light.on {
+    fill: #ffd400;
+    stroke: #ffd400;
+}
+
+.hass-floorplan .light.unavailable {
+    fill: #c00000;
+    stroke: #c00000;
+}
+
+.hass-floorplan .door.on {
+    fill: #42a2dd;
+    stroke: #42a2dd;
+}
+
+.hass-floorplan .door.unavailable {
+    fill: #c00000;
+    stroke: #c00000;
+}

README.md

@@ -0,0 +1,168 @@
+package floorplan
+
+import (
+	"bufio"
+	"context"
+	"encoding/json"
+	"fmt"
+	"io"
+	"net/http"
+	"net/url"
+)
+
+// State is the state of an entity.
+type State struct {
+	ID    string
+	State *bool
+}
+
+// Client is a home assistant client.
+type Client struct {
+	baseURL *url.URL
+	token   string
+	client  *http.Client
+}
+
+// NewClient returns a home assistant client.
+func NewClient(baseURL *url.URL, token string) Client {
+	return Client{
+		baseURL: baseURL,
+		token:   token,
+		client:  &http.Client{},
+	}
+}
+
+type eventState struct {
+	EntityID string `json:"entity_id"`
+	State    string `json:"state"`
+}
+
+func stateToBool(state string) *bool {
+	switch {
+	case state == "on" || state == "open":
+		return boolPtr(true)
+	case state == "off" || state == "closed":
+		return boolPtr(false)
+	}
+
+	return nil
+}
+
+func boolPtr(b bool) *bool {
+	return &b
+}
+
+// States returns the states of all entities.
+func (c Client) States(ctx context.Context) ([]State, error) {
+	u, err := c.baseURL.Parse("api/states")
+	if err != nil {
+		return nil, fmt.Errorf("parsing state url: %w", err)
+	}
+
+	req, err := http.NewRequestWithContext(ctx, http.MethodGet, u.String(), nil)
+	if err != nil {
+		return nil, fmt.Errorf("creating request: %w", err)
+	}
+	req.Header.Set("Authorization", "Bearer "+c.token)
+
+	resp, err := c.client.Do(req)
+	if err != nil {
+		return nil, fmt.Errorf("sending request: %w", err)
+	}
+	defer func() {
+		_, _ = io.Copy(io.Discard, resp.Body)
+		_ = resp.Body.Close()
+	}()
+
+	if resp.StatusCode != 200 {
+		return nil, fmt.Errorf("unexpected response code: %d", resp.StatusCode)
+	}
+
+	var eventStates []eventState
+	err = json.NewDecoder(resp.Body).Decode(&eventStates)
+	if err != nil {
+		return nil, fmt.Errorf("parsing response data: %w", err)
+	}
+
+	states := make([]State, 0, len(eventStates))
+	for _, state := range eventStates {
+		states = append(states, State{
+			ID:    state.EntityID,
+			State: stateToBool(state.State),
+		})
+	}
+
+	return states, nil
+}
+
+type eventChanged struct {
+	EventType string `json:"event_type"`
+	Data      struct {
+		NewState eventState `json:"new_state"`
+	} `json:"data"`
+}
+
+// Events returns a stream of state changes.
+func (c Client) Events(ctx context.Context, done chan struct{}) (<-chan State, error) {
+	u, err := c.baseURL.Parse("api/stream")
+	if err != nil {
+		return nil, fmt.Errorf("parsing state url: %w", err)
+	}
+
+	req, err := http.NewRequestWithContext(ctx, http.MethodGet, u.String(), nil)
+	if err != nil {
+		return nil, fmt.Errorf("creating request: %w", err)
+	}
+	req.Header.Set("Authorization", "Bearer "+c.token)
+
+	resp, err := c.client.Do(req) //nolint: bodyclose
+	if err != nil {
+		return nil, fmt.Errorf("sending request: %w", err)
+	}
+
+	if resp.StatusCode != 200 {
+		return nil, fmt.Errorf("unexpected response code: %d", resp.StatusCode)
+	}
+
+	ch := make(chan State, 10)
+	go func() {
+		defer func() {
+			_ = resp.Body.Close()
+
+			close(ch)
+		}()
+
+		buf := bufio.NewReader(resp.Body)
+		for {
+			line, err := buf.ReadBytes('\n')
+			if err != nil {
+				return
+			}
+
+			if len(line) < 6 || string(line[:6]) != "data: " {
+				continue
+			}
+
+			if string(line[6:]) == "ping\n" {
+				continue
+			}
+
+			var event eventChanged
+			err = json.Unmarshal(line[6:], &event)
+			if err != nil {
+				return
+			}
+
+			if event.EventType != "state_changed" {
+				continue
+			}
+
+			ch <- State{
+				ID:    event.Data.NewState.EntityID,
+				State: stateToBool(event.Data.NewState.State),
+			}
+		}
+	}()
+
+	return ch, nil
+}

assets/default.svg

@@ -0,0 +1,5 @@
+module github.com/glasslabs/floorplan
+
+go 1.16
+
+require github.com/glasslabs/looking-glass v0.1.0-alpha1

assets/style.css

@@ -0,0 +1,25 @@
+github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/glasslabs/looking-glass v0.1.0-alpha1 h1:cfqUVMSy0trnPDUqugS74ClF063zQ/IEN7sZyhIGLvs=
+github.com/glasslabs/looking-glass v0.1.0-alpha1/go.mod h1:uZHdBnmcltBmrCHBIrmoKxskSMAmli6/1lOcIS5PoMs=
+github.com/hamba/logger v1.0.1/go.mod h1:rpB9y29AN0sHvhc7QfzJZxgJFqh536/nZIFiVhqLkuE=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/traefik/yaegi v0.9.2/go.mod h1:FAYnRlZyuVlEkvnkHq3bvJ1lW5be6XuwgLdkYgYG6Lk=
+github.com/urfave/cli/v2 v2.2.0/go.mod h1:SE9GqnLQmjVa0iPEY0f1w3ygNIYcIJ0OKPMoW2caLfQ=
+github.com/vincent-petithory/dataurl v0.0.0-20191104211930-d1553a71de50/go.mod h1:FHafX5vmDzyP+1CQATJn7WFKc9CvnvxyvZy6I1MrG/U=
+github.com/zserge/lorca v0.1.9/go.mod h1:bVmnIbIRlOcoV285KIRSe4bUABKi7R7384Ycuum6e4A=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/net v0.0.0-20200222125558-5a598a2470a0/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=