water

package

v0.0.0-...-ecde165 Latest Latest Go to latest Published: Mar 13, 2024 License: BSD-3-Clause Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func AnalyzeUsage(ctx context.Context, report *Report, twoDayAvgMax, oneDayMax int, alerter Alerter) error

AnalyzeUsage does a simple analysis of maximum and 2 day avg water usage and alert if thresholds are crossed.

type Alerter interface {
	Alert(ctx context.Context, msg string) error
}

Alerter notifies about alerts

type Record struct {
	Label string
	Value float64
}

type Report struct {
	LabelHeader string
	ValueHeader string
	Records     []Record
}

func DownloadDailyUsage(startDay, endDay time.Time, user, pass, acct string) (*Report, error)

DownloadDailyUsage returns a report of daily water usage data

func DownloadHourlyUsage(start, end time.Time, user, pass, acct string) (*Report, error)

DownloadHourlyUsage returns a report of hourly water usage data

func (r *Report) String() string