meteremail

Documentation

Overview

Package meteremail provides an automation that collects the instantaneous meter readings for a set of given devices. The automation uses the Meter API to fetch meter readings on a configurable fixed date, formats a summary email using html/template and sends it to some recipients using smtp with a CSV file for detailed readings. Test program for meter reading automation is in 'cmd/tools/test-meteremail/main.go'.

Index

• Constants
• Variables
• type Attrs
• type MeterReading
• type MeterType
• type Stats
• type SummaryReport

Constants

const AutoName = "meteremail"

const MeterTypeElectric = 2

const MeterTypeWater = 1

Variables

var Factory auto.Factory = factory{}

Types

type Attrs

type Attrs struct {
	Now                  time.Time
	Stats                []Stats
	ReadingsByFloorZone  map[string]map[string][]Stats // map floor -> zone -> reading
	EnergySummaryReports []SummaryReport
	WaterSummaryReports  []SummaryReport
	TemplateArgs         config.TemplateArgs
}

type MeterReading

type MeterReading struct {
	MeterType MeterType
	Date      time.Time
	Reading   float32
}

type MeterType

type MeterType uint8

type Stats

type Stats struct {
	Source       config.Source
	MeterReading MeterReading
}

type SummaryReport

type SummaryReport struct {
	Floor        string
	Zone         string
	TotalReading float32
}