Fix typos, update TODO

TODO.md

@@ -1,11 +1,15 @@
 # TODO
-- [ ] Fix shutdown
 - [ ] Configuration for app
 - [ ] Helm Chart
 - [ ] Update README
-- [ ] Add new fields from WS-2192
+- [ ] Add Grafana dashboard
+- [ ] Add device name field with ID/Key mappings
+- [ ] Add device type field with ID/Key mappings
 
 ## Done
+- [x] Consolidate battery status into one metric with device label
+- [x] Fix shutdown
+- [x] Add new fields from WS-2192
 - [x] Gitea CI
 - [x] Version flag
 - [x] Makefile

go.mod

@@ -3,7 +3,7 @@ module gitea.libretechconsulting.com/rmcguire/ambient-weather-local-exporter
 go 1.23.4
 
 require (
-	gitea.libretechconsulting.com/rmcguire/go-app v0.2.0
+	gitea.libretechconsulting.com/rmcguire/go-app v0.3.0
 	github.com/gorilla/schema v1.4.1
 	github.com/rs/zerolog v1.33.0
 	go.opentelemetry.io/otel v1.33.0

go.sum

@@ -2,6 +2,8 @@ gitea.libretechconsulting.com/rmcguire/go-app v0.1.3 h1:EwmEJLpN+rQjJ5stGEkZsqED
 gitea.libretechconsulting.com/rmcguire/go-app v0.1.3/go.mod h1:wHOWh4O4AMDATQ3WEUYjq5a5bnICPBpu5G6BsNxqN38=
 gitea.libretechconsulting.com/rmcguire/go-app v0.2.0 h1:pOm/PysC0IWPuEbmEjNSHHa8Qc5OhuoksYExcuJMFE4=
 gitea.libretechconsulting.com/rmcguire/go-app v0.2.0/go.mod h1:wHOWh4O4AMDATQ3WEUYjq5a5bnICPBpu5G6BsNxqN38=
+gitea.libretechconsulting.com/rmcguire/go-app v0.3.0 h1:TSR6oEDBX+83975gmgGgU/cTFgfG999+9N/1h4RAXq0=
+gitea.libretechconsulting.com/rmcguire/go-app v0.3.0/go.mod h1:wHOWh4O4AMDATQ3WEUYjq5a5bnICPBpu5G6BsNxqN38=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
 github.com/caarlos0/env/v11 v11.3.1 h1:cArPWC15hWmEt+gWk7YBi7lEXTXCvpaSdCiZE2X5mCA=

main.go

@@ -16,10 +16,10 @@ func main() {
 	ctx, cncl := signal.NotifyContext(context.Background(), os.Kill, unix.SIGTERM)
 	defer cncl()
 
+	// Read config and environment, set up logging, load up
+	// an appCtx, and prepare ambient weather local exporter
 	ctx = app.MustSetupConfigAndLogging(ctx)
-
-	aw := ambient.New(ctx)
-	aw.MustInit()
+	aw := ambient.New(ctx).Init()
 
 	awApp := app.App{
 		AppContext: ctx,

pkg/ambient/ambient.go

@@ -37,10 +37,12 @@ func New(appCtx context.Context) *AmbientWeather {
 	}
 }
 
-func (aw *AmbientWeather) MustInit() {
+// Initialize with defaults, set logger from context
+func (aw *AmbientWeather) Init() *AmbientWeather {
 	aw.awnProvider = &awn.AWNProvider{}
 	aw.wuProvider = &wunderground.WUProvider{}
 	aw.l = zerolog.Ctx(aw.appCtx)
+	return aw
 }
 
 func (aw *AmbientWeather) GetAWNHandlerFunc(appCtx context.Context) func(http.ResponseWriter, *http.Request) {
@@ -55,7 +57,7 @@ func (aw *AmbientWeather) GetWundergroundHandlerFunc(appCtx context.Context) fun
 	}
 }
 
-// Takes an HTTP requests and convers it to a
+// Takes an HTTP requests and converts it to a
 // stable type. Enrich is called on the type to complete
 // any missing fields as the two providers supported by Ambient
 // devices (awn/wunderground) produce different fields

pkg/provider/awn/provider.go

@@ -39,32 +39,46 @@ func MapAwnUpdate(awnUpdate *AmbientWeatherUpdate) *weather.WeatherUpdate {
 	}
 
 	return &weather.WeatherUpdate{
-		StationType:       awnUpdate.StationType,
-		DateUTC:           &updateTime,
-		TempOutdoorF:      awnUpdate.TempF,
-		HumidityOudoor:    awnUpdate.Humidity,
-		WindSpeedMPH:      awnUpdate.WindGustMPH,
-		WindGustMPH:       awnUpdate.WindGustMPH,
-		MaxDailyGust:      awnUpdate.MaxDailyGust,
-		WindDir:           awnUpdate.WindDir,
-		WindDirAvg10m:     awnUpdate.WindDirAVG10m,
-		UV:                awnUpdate.UV,
-		SolarRadiation:    awnUpdate.SolarRadiation,
-		HourlyRainIn:      awnUpdate.HourlyRainIn,
-		EventRainIn:       awnUpdate.EventRainIn,
-		DailyRainIn:       awnUpdate.DailyRainIn,
-		WeeklyRainIn:      awnUpdate.WeeklyRainIn,
-		MonthlyRainIn:     awnUpdate.MonthlyRainIn,
-		YearlyRainIn:      awnUpdate.YearlyRainIn,
-		TotalRainIn:       awnUpdate.TotalRainIn,
-		BattOutdoorSensor: awnUpdate.BattOut,
-		BattIndoorSensor:  awnUpdate.BattIn,
-		BattRainSensor:    awnUpdate.BattRain,
-		BattCO2Sensor:     awnUpdate.BattCO2,
-		TempIndoorF:       awnUpdate.TempInF,
-		HumidityIndoor:    awnUpdate.HumidityIn,
-		BaromRelativeIn:   awnUpdate.BaromRelIn,
-		BaromAbsoluteIn:   awnUpdate.BaromAbsIn,
+		StationType:    awnUpdate.StationType,
+		DateUTC:        &updateTime,
+		TempOutdoorF:   awnUpdate.TempF,
+		HumidityOudoor: awnUpdate.Humidity,
+		WindSpeedMPH:   awnUpdate.WindGustMPH,
+		WindGustMPH:    awnUpdate.WindGustMPH,
+		MaxDailyGust:   awnUpdate.MaxDailyGust,
+		WindDir:        awnUpdate.WindDir,
+		WindDirAvg10m:  awnUpdate.WindDirAVG10m,
+		UV:             awnUpdate.UV,
+		SolarRadiation: awnUpdate.SolarRadiation,
+		HourlyRainIn:   awnUpdate.HourlyRainIn,
+		EventRainIn:    awnUpdate.EventRainIn,
+		DailyRainIn:    awnUpdate.DailyRainIn,
+		WeeklyRainIn:   awnUpdate.WeeklyRainIn,
+		MonthlyRainIn:  awnUpdate.MonthlyRainIn,
+		YearlyRainIn:   awnUpdate.YearlyRainIn,
+		TotalRainIn:    awnUpdate.TotalRainIn,
+		Batteries: []weather.BatteryStatus{
+			{
+				Component: "OutdoorSensor",
+				Status:    awnUpdate.BattOut,
+			},
+			{
+				Component: "IndoorSensor",
+				Status:    awnUpdate.BattIn,
+			},
+			{
+				Component: "RainSensor",
+				Status:    awnUpdate.BattRain,
+			},
+			{
+				Component: "CO2Sensor",
+				Status:    awnUpdate.BattCO2,
+			},
+		},
+		TempIndoorF:     awnUpdate.TempInF,
+		HumidityIndoor:  awnUpdate.HumidityIn,
+		BaromRelativeIn: awnUpdate.BaromRelIn,
+		BaromAbsoluteIn: awnUpdate.BaromAbsIn,
 	}
 }
 

pkg/weather/metrics.go

@@ -12,31 +12,29 @@ import (
 
 type WeatherMetrics struct {
 	// Weather Metrics
-	TempOutdoorF      metric.Float64Gauge
-	TempIndoorF       metric.Float64Gauge
-	HumidityOudoor    metric.Int64Gauge
-	HumidityIndoor    metric.Int64Gauge
-	WindSpeedMPH      metric.Float64Gauge
-	WindGustMPH       metric.Float64Gauge
-	MaxDailyGust      metric.Float64Gauge
-	WindDir           metric.Int64Gauge
-	WindDirAvg10m     metric.Int64Gauge
-	UV                metric.Int64Gauge
-	SolarRadiation    metric.Float64Gauge
-	HourlyRainIn      metric.Float64Gauge
-	EventRainIn       metric.Float64Gauge
-	DailyRainIn       metric.Float64Gauge
-	WeeklyRainIn      metric.Float64Gauge
-	MonthlyRainIn     metric.Float64Gauge
-	YearlyRainIn      metric.Float64Gauge
-	TotalRainIn       metric.Float64Gauge
-	BattOutdoorSensor metric.Int64Gauge
-	BattIndoorSensor  metric.Int64Gauge
-	BattRainSensor    metric.Int64Gauge
-	BaromRelativeIn   metric.Float64Gauge
-	BaromAbsoluteIn   metric.Float64Gauge
-	DewPointF         metric.Float64Gauge
-	WindChillF        metric.Float64Gauge
+	TempOutdoorF    metric.Float64Gauge
+	TempIndoorF     metric.Float64Gauge
+	HumidityOudoor  metric.Int64Gauge
+	HumidityIndoor  metric.Int64Gauge
+	WindSpeedMPH    metric.Float64Gauge
+	WindGustMPH     metric.Float64Gauge
+	MaxDailyGust    metric.Float64Gauge
+	WindDir         metric.Int64Gauge
+	WindDirAvg10m   metric.Int64Gauge
+	UV              metric.Int64Gauge
+	SolarRadiation  metric.Float64Gauge
+	HourlyRainIn    metric.Float64Gauge
+	EventRainIn     metric.Float64Gauge
+	DailyRainIn     metric.Float64Gauge
+	WeeklyRainIn    metric.Float64Gauge
+	MonthlyRainIn   metric.Float64Gauge
+	YearlyRainIn    metric.Float64Gauge
+	TotalRainIn     metric.Float64Gauge
+	BatteryStatus   metric.Int64Gauge
+	BaromRelativeIn metric.Float64Gauge
+	BaromAbsoluteIn metric.Float64Gauge
+	DewPointF       metric.Float64Gauge
+	WindChillF      metric.Float64Gauge
 
 	// Internal Telemetry
 	UpdatesReceived metric.Int64Counter
@@ -58,7 +56,7 @@ func MustInitMetrics(appCtx context.Context) *WeatherMetrics {
 		metric.WithDescription("Outdoor Temperature in Faherenheit"))
 	wm.TempIndoorF, _ = wm.meter.Float64Gauge("weather_temp_indoor_f",
 		metric.WithDescription("Indoor Temperature in Faherenheit"))
-	wm.HumidityOudoor, _ = wm.meter.Int64Gauge("weather_humidity_oudoor",
+	wm.HumidityOudoor, _ = wm.meter.Int64Gauge("weather_humidity_outdoor",
 		metric.WithDescription("Outdoor Humidity %"))
 	wm.HumidityIndoor, _ = wm.meter.Int64Gauge("weather_humidity_indoor",
 		metric.WithDescription("Indoor Humidity %"))
@@ -90,12 +88,8 @@ func MustInitMetrics(appCtx context.Context) *WeatherMetrics {
 		metric.WithDescription("Yearly Rain in Inches"))
 	wm.TotalRainIn, _ = wm.meter.Float64Gauge("weather_total_rain_in",
 		metric.WithDescription("Total Rain in Inches"))
-	wm.BattOutdoorSensor, _ = wm.meter.Int64Gauge("weather_batt_outdoor_sensor",
-		metric.WithDescription("Outdoor Equipment Battery"))
-	wm.BattIndoorSensor, _ = wm.meter.Int64Gauge("weather_batt_indoor_sensor",
-		metric.WithDescription("Indoor Equipmenet Battery"))
-	wm.BattRainSensor, _ = wm.meter.Int64Gauge("weather_batt_rain_sensor",
-		metric.WithDescription("Rain Sensor Battery"))
+	wm.BatteryStatus, _ = wm.meter.Int64Gauge("battery_status",
+		metric.WithDescription("Per-component battery status"))
 	wm.BaromRelativeIn, _ = wm.meter.Float64Gauge("weather_barometric_pressure_relative_in",
 		metric.WithDescription("Relative Pressure in Inches of Mercury"))
 	wm.BaromAbsoluteIn, _ = wm.meter.Float64Gauge("weather_barometric_pressure_absolute_in",
@@ -136,13 +130,18 @@ func (wm *WeatherMetrics) Update(u *WeatherUpdate) {
 	wm.MonthlyRainIn.Record(wm.appCtx, u.MonthlyRainIn, metric.WithAttributeSet(attributes))
 	wm.YearlyRainIn.Record(wm.appCtx, u.YearlyRainIn, metric.WithAttributeSet(attributes))
 	wm.TotalRainIn.Record(wm.appCtx, u.TotalRainIn, metric.WithAttributeSet(attributes))
-	wm.BattOutdoorSensor.Record(wm.appCtx, int64(u.BattOutdoorSensor), metric.WithAttributeSet(attributes))
-	wm.BattIndoorSensor.Record(wm.appCtx, int64(u.BattIndoorSensor), metric.WithAttributeSet(attributes))
-	wm.BattRainSensor.Record(wm.appCtx, int64(u.BattRainSensor), metric.WithAttributeSet(attributes))
 	wm.BaromRelativeIn.Record(wm.appCtx, u.BaromRelativeIn, metric.WithAttributeSet(attributes))
 	wm.BaromAbsoluteIn.Record(wm.appCtx, u.BaromAbsoluteIn, metric.WithAttributeSet(attributes))
 	wm.DewPointF.Record(wm.appCtx, u.DewPointF, metric.WithAttributeSet(attributes))
 	wm.WindChillF.Record(wm.appCtx, u.WindChillF, metric.WithAttributeSet(attributes))
 
+	// Batteries
+	for _, battery := range u.Batteries {
+		wm.BatteryStatus.Record(wm.appCtx, int64(battery.Status),
+			metric.WithAttributeSet(attributes),
+			metric.WithAttributes(attribute.String("component", battery.Component)),
+		)
+	}
+
 	wm.UpdatesReceived.Add(wm.appCtx, 1)
 }

pkg/weather/types.go

@@ -7,34 +7,40 @@ import (
 // Stable intermediate struct containing superset of fields
 // between AWN and Wunderground style updates from Ambient devices
 type WeatherUpdate struct {
-	DateUTC           *time.Time
-	StationType       string
-	TempOutdoorF      float64
-	TempIndoorF       float64
-	HumidityOudoor    int
-	HumidityIndoor    int
-	WindSpeedMPH      float64
-	WindGustMPH       float64
-	MaxDailyGust      float64
-	WindDir           int
-	WindDirAvg10m     int
-	UV                int
-	SolarRadiation    float64
-	HourlyRainIn      float64
-	EventRainIn       float64
-	DailyRainIn       float64
-	WeeklyRainIn      float64
-	MonthlyRainIn     float64
-	YearlyRainIn      float64
-	TotalRainIn       float64
-	BattOutdoorSensor int
-	BattIndoorSensor  int
-	BattRainSensor    int
-	BattCO2Sensor     int
-	BaromRelativeIn   float64
-	BaromAbsoluteIn   float64
+	DateUTC        *time.Time
+	StationType    string
+	TempOutdoorF   float64
+	TempIndoorF    float64
+	HumidityOudoor int
+	HumidityIndoor int
+	WindSpeedMPH   float64
+	WindGustMPH    float64
+	MaxDailyGust   float64
+	WindDir        int
+	WindDirAvg10m  int
+	UV             int
+	SolarRadiation float64
+	HourlyRainIn   float64
+	EventRainIn    float64
+	DailyRainIn    float64
+	WeeklyRainIn   float64
+	MonthlyRainIn  float64
+	YearlyRainIn   float64
+	TotalRainIn    float64
+	Batteries      []BatteryStatus
+	// BattOutdoorSensor int
+	// BattIndoorSensor  int
+	// BattRainSensor    int
+	// BattCO2Sensor     int
+	BaromRelativeIn float64
+	BaromAbsoluteIn float64
 	// These fields may be calculated
 	// if not otherwise set
 	DewPointF  float64
 	WindChillF float64
 }
+
+type BatteryStatus struct {
+	Component string
+	Status    int
+}