README
¶
EnvoyCharts
A small data tracking/charting tool for envoy IQ solar systems
envoy-chart does two things
- runs in the background and polls the envoy every 10 minutes, putting that data into a database
- acts as a web server which displays the charts
Still a work-in-progress
I'm just getting started.
Right now it supports a single graph (past 24-hours). I will work on adding 7-day and monthly graphs as well, after I collect enough data from my own system.
Design decisions (or indecisions)
- 10 minute sampling frequency seems good enough. During initial testing I did every minute, but the graph isn't any more informative at this higher frequency, so I'll stick with 10 minutes for now. Eventually it will be configurable.
- go-echarts spits out Javascript Apache echarts (an older version at that). It seems nice enough for our purposes and is very simple to work with.
- ObjectBox database. I've done a lot with sqlite over the years. It's fine. I just wanted to try something else. ObjectBox seems cool for this kind of thing, and very fast.
- go, because I like go
To Do
- not have all the parameters hard coded, especially the hostname/ip address
- implement dns-sd in the go-envoy package so you don't have to set a hostname/ip at all
- more charts
- roll-up boxes (tables) for weekly/montly/yearly charts
Documentation
¶
Index ¶
- func Barchart(w io.Writer, samples []*Sample, title string, tz *time.Location)
- func Linechart(w io.Writer, samples []*Sample, title string, tz *time.Location)
- func LinechartDaily(w io.Writer, samples []*Daily, title string, tz *time.Location)
- type Client
- func (c *Client) Close()
- func (c *Client) Configured() bool
- func (c *Client) GetAllDaily() ([]*Daily, error)
- func (c *Client) GetAllSamples() ([]*Sample, error)
- func (c *Client) GetDay(t time.Time) ([]*Sample, error)
- func (c *Client) GetDayRange(start time.Time, end time.Time) ([]*Sample, error)
- func (c *Client) GetPastDay() ([]*Sample, error)
- func (c *Client) GetSamples(start, end time.Time) ([]*Sample, error)
- func (c *Client) PutDaily(d *Daily) error
- func (c *Client) PutSample(s *Sample) error
- func (c *Client) Reset() error
- func (c *Client) Sample() error
- type Daily
- type Sample
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Barchart ¶
Barchart takes a set of samples, and a title and writes the barchart to the specified writer
Types ¶
type Client ¶
type Client struct {
DB *sql.DB
Envoy *envoy.Envoy
TZ *time.Location
// contains filtered or unexported fields
}
Client is the primary handle for the EnvoyChart API
func (*Client) Configured ¶
func (*Client) GetAllDaily ¶
GetAllDaily gets every entry from the daily table
func (*Client) GetAllSamples ¶
GetAll returns all values from the database, probably not useful for anything other than testing
func (*Client) GetDay ¶
GetDay returns all the samples for the day which contains the parameter -- 24 hour window rounded to midnight
func (*Client) GetDayRange ¶
GetDayRange gets all values between the start and end days -- rounds to start/end of days
func (*Client) GetPastDay ¶
GetPastDay gets the samples for the previous 24 hours -- 24 hour window ending at Now()
Source Files
Directories