Concept plugin layout
This commit is contained in:
Nicholas Thompson
committed by
ncthompson
ncthompson
parent
d02de285d9
commit
47e73a4eff
180
plugins/webui/webgui.go
Normal file
180
plugins/webui/webgui.go
Normal file
@@ -0,0 +1,180 @@
|
||||
/*
|
||||
Copyright (c) 2015, 2017 Hendrik van Wyk
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
* Neither the name of invertergui nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
package webui
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"net/http"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/diebietse/invertergui/mk2driver"
|
||||
"github.com/diebietse/invertergui/websocket"
|
||||
)
|
||||
|
||||
const (
|
||||
LedOff = "dot-off"
|
||||
LedRed = "dot-red"
|
||||
BlinkRed = "blink-red"
|
||||
LedGreen = "dot-green"
|
||||
BlinkGreen = "blink-green"
|
||||
)
|
||||
|
||||
type WebGui struct {
|
||||
mk2driver.Mk2
|
||||
stopChan chan struct{}
|
||||
|
||||
wg sync.WaitGroup
|
||||
hub *websocket.Hub
|
||||
}
|
||||
|
||||
func NewWebGui(source mk2driver.Mk2) *WebGui {
|
||||
w := &WebGui{
|
||||
stopChan: make(chan struct{}),
|
||||
Mk2: source,
|
||||
hub: websocket.NewHub(),
|
||||
}
|
||||
w.wg.Add(1)
|
||||
go w.dataPoll()
|
||||
return w
|
||||
}
|
||||
|
||||
type templateInput struct {
|
||||
Error []error `json:"errors"`
|
||||
|
||||
Date string `json:"date"`
|
||||
|
||||
OutCurrent string `json:"output_current"`
|
||||
OutVoltage string `json:"output_voltage"`
|
||||
OutPower string `json:"output_power"`
|
||||
|
||||
InCurrent string `json:"input_current"`
|
||||
InVoltage string `json:"input_voltage"`
|
||||
InPower string `json:"input_power"`
|
||||
|
||||
InMinOut string
|
||||
|
||||
BatVoltage string `json:"battery_voltage"`
|
||||
BatCurrent string `json:"battery_current"`
|
||||
BatPower string `json:"battery_power"`
|
||||
BatCharge string `json:"battery_charge"`
|
||||
|
||||
InFreq string `json:"input_frequency"`
|
||||
OutFreq string `json:"output_frequency"`
|
||||
|
||||
LedMap map[string]string `json:"led_map"`
|
||||
}
|
||||
|
||||
func (w *WebGui) ServeHub(rw http.ResponseWriter, r *http.Request) {
|
||||
w.hub.ServeHTTP(rw, r)
|
||||
}
|
||||
|
||||
func ledName(led mk2driver.Led) string {
|
||||
name, ok := mk2driver.LedNames[led]
|
||||
if !ok {
|
||||
return "Unknown led"
|
||||
}
|
||||
return name
|
||||
}
|
||||
|
||||
func buildTemplateInput(status *mk2driver.Mk2Info) *templateInput {
|
||||
outPower := status.OutVoltage * status.OutCurrent
|
||||
inPower := status.InCurrent * status.InVoltage
|
||||
|
||||
tmpInput := &templateInput{
|
||||
Error: status.Errors,
|
||||
Date: status.Timestamp.Format(time.RFC1123Z),
|
||||
OutCurrent: fmt.Sprintf("%.2f", status.OutCurrent),
|
||||
OutVoltage: fmt.Sprintf("%.2f", status.OutVoltage),
|
||||
OutPower: fmt.Sprintf("%.2f", outPower),
|
||||
InCurrent: fmt.Sprintf("%.2f", status.InCurrent),
|
||||
InVoltage: fmt.Sprintf("%.2f", status.InVoltage),
|
||||
InFreq: fmt.Sprintf("%.2f", status.InFrequency),
|
||||
OutFreq: fmt.Sprintf("%.2f", status.OutFrequency),
|
||||
InPower: fmt.Sprintf("%.2f", inPower),
|
||||
|
||||
InMinOut: fmt.Sprintf("%.2f", inPower-outPower),
|
||||
|
||||
BatCurrent: fmt.Sprintf("%.2f", status.BatCurrent),
|
||||
BatVoltage: fmt.Sprintf("%.2f", status.BatVoltage),
|
||||
BatPower: fmt.Sprintf("%.2f", status.BatVoltage*status.BatCurrent),
|
||||
BatCharge: fmt.Sprintf("%.2f", status.ChargeState*100),
|
||||
|
||||
LedMap: map[string]string{},
|
||||
}
|
||||
for k, v := range status.LEDs {
|
||||
if k == mk2driver.LedOverload || k == mk2driver.LedTemperature || k == mk2driver.LedLowBattery {
|
||||
switch v {
|
||||
case mk2driver.LedOn:
|
||||
tmpInput.LedMap[ledName(k)] = LedRed
|
||||
case mk2driver.LedBlink:
|
||||
tmpInput.LedMap[ledName(k)] = BlinkRed
|
||||
default:
|
||||
tmpInput.LedMap[ledName(k)] = LedOff
|
||||
}
|
||||
} else {
|
||||
switch v {
|
||||
case mk2driver.LedOn:
|
||||
tmpInput.LedMap[ledName(k)] = LedGreen
|
||||
case mk2driver.LedBlink:
|
||||
tmpInput.LedMap[ledName(k)] = BlinkGreen
|
||||
default:
|
||||
tmpInput.LedMap[ledName(k)] = LedOff
|
||||
}
|
||||
}
|
||||
}
|
||||
return tmpInput
|
||||
}
|
||||
|
||||
func (w *WebGui) Stop() {
|
||||
close(w.stopChan)
|
||||
w.wg.Wait()
|
||||
}
|
||||
|
||||
// dataPoll waits for data from the w.poller channel. It will send its currently stored status
|
||||
// to respChan if anything reads from it.
|
||||
func (w *WebGui) dataPoll() {
|
||||
for {
|
||||
select {
|
||||
case s := <-w.C():
|
||||
if s.Valid {
|
||||
err := w.hub.Broadcast(buildTemplateInput(s))
|
||||
if err != nil {
|
||||
log.Printf("Could not send update to clients: %v", err)
|
||||
}
|
||||
}
|
||||
case <-w.stopChan:
|
||||
w.wg.Done()
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
98
plugins/webui/webgui_test.go
Normal file
98
plugins/webui/webgui_test.go
Normal file
@@ -0,0 +1,98 @@
|
||||
/*
|
||||
Copyright (c) 2015, Hendrik van Wyk
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
* Neither the name of invertergui nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
package webui
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"reflect"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/diebietse/invertergui/mk2driver"
|
||||
)
|
||||
|
||||
func TestWebGui(t *testing.T) {
|
||||
t.Skip("Not yet implimented")
|
||||
//TODO figure out how to test template output.
|
||||
}
|
||||
|
||||
type templateTest struct {
|
||||
input *mk2driver.Mk2Info
|
||||
output *templateInput
|
||||
}
|
||||
|
||||
var fakenow = time.Date(2017, 1, 2, 3, 4, 5, 6, time.UTC)
|
||||
var templateInputTests = []templateTest{
|
||||
{
|
||||
input: &mk2driver.Mk2Info{
|
||||
OutCurrent: 2.0,
|
||||
InCurrent: 2.3,
|
||||
OutVoltage: 230.0,
|
||||
InVoltage: 230.1,
|
||||
BatVoltage: 25,
|
||||
BatCurrent: -10,
|
||||
InFrequency: 50,
|
||||
OutFrequency: 50,
|
||||
ChargeState: 1,
|
||||
LEDs: map[mk2driver.Led]mk2driver.LEDstate{mk2driver.LedMain: mk2driver.LedOn},
|
||||
Errors: nil,
|
||||
Timestamp: fakenow,
|
||||
},
|
||||
output: &templateInput{
|
||||
Error: nil,
|
||||
Date: fakenow.Format(time.RFC1123Z),
|
||||
OutCurrent: "2.00",
|
||||
OutVoltage: "230.00",
|
||||
OutPower: "460.00",
|
||||
InCurrent: "2.30",
|
||||
InVoltage: "230.10",
|
||||
InPower: "529.23",
|
||||
InMinOut: "69.23",
|
||||
BatVoltage: "25.00",
|
||||
BatCurrent: "-10.00",
|
||||
BatPower: "-250.00",
|
||||
InFreq: "50.00",
|
||||
OutFreq: "50.00",
|
||||
BatCharge: "100.00",
|
||||
LedMap: map[string]string{"led_mains": "dot-green"},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
func TestTemplateInput(t *testing.T) {
|
||||
for i := range templateInputTests {
|
||||
templateInput := buildTemplateInput(templateInputTests[i].input)
|
||||
if !reflect.DeepEqual(templateInput, templateInputTests[i].output) {
|
||||
t.Errorf("buildTemplateInput not producing expected results")
|
||||
fmt.Printf("%v\n%v\n", templateInput, templateInputTests[i].output)
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user