add json tags

TODO.md

@@ -2,6 +2,7 @@
 - [x] Redis recorder panic
 
 # TODO
+- [ ] Make lightning distance unit configurable (kph|mph)
 - [ ] Set TTL on redis key
 - [ ] Add json schema to CI and README
 - [ ] Update README

api/v1alpha1/weather/weather.pb.go

@@ -296,6 +296,8 @@ type WeatherUpdate struct {
 	WindChillF          *float64               `protobuf:"fixed64,26,opt,name=wind_chill_f,json=windChillF,proto3,oneof" json:"wind_chill_f,omitempty"`
 	TempHumiditySensors []*TempHumiditySensor  `protobuf:"bytes,27,rep,name=temp_humidity_sensors,json=tempHumiditySensors,proto3" json:"temp_humidity_sensors,omitempty"`
 	UpdateTimestamp     *timestamppb.Timestamp `protobuf:"bytes,28,opt,name=update_timestamp,json=updateTimestamp,proto3" json:"update_timestamp,omitempty"`
+	LightningDay        *int32                 `protobuf:"varint,29,opt,name=lightning_day,json=lightningDay,proto3,oneof" json:"lightning_day,omitempty"`
+	LightningDistance   *int32                 `protobuf:"varint,30,opt,name=lightning_distance,json=lightningDistance,proto3,oneof" json:"lightning_distance,omitempty"`
 	unknownFields       protoimpl.UnknownFields
 	sizeCache           protoimpl.SizeCache
 }
@@ -526,6 +528,20 @@ func (x *WeatherUpdate) GetUpdateTimestamp() *timestamppb.Timestamp {
 	return nil
 }
 
+func (x *WeatherUpdate) GetLightningDay() int32 {
+	if x != nil && x.LightningDay != nil {
+		return *x.LightningDay
+	}
+	return 0
+}
+
+func (x *WeatherUpdate) GetLightningDistance() int32 {
+	if x != nil && x.LightningDistance != nil {
+		return *x.LightningDistance
+	}
+	return 0
+}
+
 // Represents a temperature and humidity sensor
 type TempHumiditySensor struct {
 	state         protoimpl.MessageState `protogen:"open.v1"`
@@ -660,7 +676,7 @@ const file_weather_weather_proto_rawDesc = "" +
 	"\fstation_name\x18\x01 \x01(\tH\x00R\vstationName\x88\x01\x01\x12&\n" +
 	"\fstation_type\x18\x02 \x01(\tH\x01R\vstationType\x88\x01\x01B\x0f\n" +
 	"\r_station_nameB\x0f\n" +
-	"\r_station_type\"\xfe\f\n" +
+	"\r_station_type\"\x85\x0e\n" +
 	"\rWeatherUpdate\x12!\n" +
 	"\fstation_name\x18\x01 \x01(\tR\vstationName\x12!\n" +
 	"\fstation_type\x18\x02 \x01(\tR\vstationType\x12\x1d\n" +
@@ -693,7 +709,9 @@ const file_weather_weather_proto_rawDesc = "" +
 	"\fwind_chill_f\x18\x1a \x01(\x01H\x15R\n" +
 	"windChillF\x88\x01\x01\x12W\n" +
 	"\x15temp_humidity_sensors\x18\x1b \x03(\v2#.ambient.weather.TempHumiditySensorR\x13tempHumiditySensors\x12E\n" +
-	"\x10update_timestamp\x18\x1c \x01(\v2\x1a.google.protobuf.TimestampR\x0fupdateTimestampB\x11\n" +
+	"\x10update_timestamp\x18\x1c \x01(\v2\x1a.google.protobuf.TimestampR\x0fupdateTimestamp\x12(\n" +
+	"\rlightning_day\x18\x1d \x01(\x05H\x16R\flightningDay\x88\x01\x01\x122\n" +
+	"\x12lightning_distance\x18\x1e \x01(\x05H\x17R\x11lightningDistance\x88\x01\x01B\x11\n" +
 	"\x0f_temp_outdoor_fB\x10\n" +
 	"\x0e_temp_indoor_fB\x13\n" +
 	"\x11_humidity_outdoorB\x12\n" +
@@ -715,7 +733,9 @@ const file_weather_weather_proto_rawDesc = "" +
 	"\x12_barom_relative_inB\x14\n" +
 	"\x12_barom_absolute_inB\x0e\n" +
 	"\f_dew_point_fB\x0f\n" +
-	"\r_wind_chill_f\"}\n" +
+	"\r_wind_chill_fB\x10\n" +
+	"\x0e_lightning_dayB\x15\n" +
+	"\x13_lightning_distance\"}\n" +
 	"\x12TempHumiditySensor\x12\x12\n" +
 	"\x04name\x18\x01 \x01(\tR\x04name\x12\x1a\n" +
 	"\x06temp_f\x18\x02 \x01(\x01H\x00R\x05tempF\x88\x01\x01\x12\x1f\n" +

api/v1alpha1/weather/weather_service.swagger.json

@@ -308,6 +308,14 @@
         "updateTimestamp": {
           "type": "string",
           "format": "date-time"
+        },
+        "lightningDay": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "lightningDistance": {
+          "type": "integer",
+          "format": "int32"
         }
       }
     }

helm/ambient-local-exporter/Chart.yaml

@@ -15,13 +15,13 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.8
+version: 0.1.9
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "v0.14.0"
+appVersion: "v0.15.4"
 
 dependencies:
   - name: hull

pkg/ambient/ambientgrpc/mapupdate.go

@@ -59,6 +59,8 @@ func UpdateToPbUpdate(u *weather.WeatherUpdate) *pb.WeatherUpdate {
 		WindChillF:          u.WindChillF,
 		TempHumiditySensors: thSensorsToPbSensors(u.TempHumiditySensors),
 		UpdateTimestamp:     timestamppb.New(*u.DateUTC),
+		LightningDay:        util.Int32ptr(u.LightningDay),
+		LightningDistance:   util.Int32ptr(u.LightningDistance),
 	}
 }
 

pkg/ambient/ambientgrpc/mapupdate_test.go

@@ -52,6 +52,10 @@ var mockUpdate = &weather.WeatherUpdate{
 	TempHumiditySensors: []*weather.TempHumiditySensor{
 		{Name: "sensor1", TempF: ptr.To(99.999), Humidity: nil},
 	},
+	LightningData: &weather.LightningData{
+		LightningDay:      ptr.To(1),
+		LightningDistance: ptr.To(20),
+	},
 }
 
 func TestUpdateToPbUpdate(t *testing.T) {
@@ -103,7 +107,9 @@ func TestUpdateToPbUpdate(t *testing.T) {
 						Humidity: nil,
 					},
 				},
-				UpdateTimestamp: timestamppb.New(now),
+				UpdateTimestamp:   timestamppb.New(now),
+				LightningDay:      ptr.To(int32(1)),
+				LightningDistance: ptr.To(int32(20)),
 			},
 		},
 	}

pkg/weather/metrics.go

@@ -78,8 +78,10 @@ func (wm *WeatherMetrics) Update(u *WeatherUpdate) {
 	wm.recorder.Record(&RecordOpts{Float64Gauge: wm.BaromAbsoluteIn, FloatVal: u.BaromAbsoluteIn, Field: FieldBaromAbsoluteIn, Attributes: attributes, Station: u.StationConfig})
 	wm.recorder.Record(&RecordOpts{Float64Gauge: wm.DewPointF, FloatVal: u.DewPointF, Field: FieldDewPointF, Attributes: attributes, Station: u.StationConfig})
 	wm.recorder.Record(&RecordOpts{Float64Gauge: wm.WindChillF, FloatVal: u.WindChillF, Field: FieldWindChillF, Attributes: attributes, Station: u.StationConfig})
+
+	lightningAttributes := append(attributes, attribute.String("unit", "km"))
+	wm.recorder.Record(&RecordOpts{Int64Gauge: wm.LightningLastDistance, IntVal: u.LightningDistance, Field: FieldLightningDistance, Attributes: lightningAttributes, Station: u.StationConfig})
 	wm.recorder.Record(&RecordOpts{Int64Gauge: wm.LightningCountDay, IntVal: u.LightningDay, Field: FieldLightningDay, Attributes: attributes, Station: u.StationConfig})
-	wm.recorder.Record(&RecordOpts{Int64Gauge: wm.LightningLastDistance, IntVal: u.LightningDistance, Field: FieldLightningDistance, Attributes: attributes, Station: u.StationConfig})
 
 	wm.RecordBatteries(u, attributes)
 	wm.RecordTempHumiditySensors(u, attributes)

pkg/weather/metrics_record.go

@@ -3,6 +3,7 @@ package weather
 import (
 	"context"
 	"errors"
+	"slices"
 
 	"github.com/rs/zerolog"
 	"go.opentelemetry.io/otel/attribute"
@@ -64,20 +65,10 @@ func (r *MetricRecorder) Record(opts *RecordOpts) {
 func (o *RecordOpts) keep() bool {
 	// If keep fields are given, only check keep fields
 	if len(o.Station.KeepMetrics) > 0 {
-		for _, f := range o.Station.KeepMetrics {
-			if f == o.Field {
-				return true
-			}
-		}
-		return false
+		return slices.Contains(o.Station.KeepMetrics, o.Field)
 	}
 
-	for _, f := range o.Station.DropMetrics {
-		if f == o.Field {
-			return false
-		}
-	}
-	return true
+	return !slices.Contains(o.Station.DropMetrics, o.Field)
 }
 
 func (r *MetricRecorder) recordInt(

pkg/weather/types.go

@@ -9,56 +9,56 @@ import (
 // Stable intermediate struct containing superset of fields
 // between AWN and Wunderground style updates from Ambient devices
 type WeatherUpdate struct {
-	DateUTC         *time.Time
-	StationConfig   *config.WeatherStation
-	StationID       *string
-	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
-	BaromRelativeIn *float64
-	BaromAbsoluteIn *float64
+	DateUTC         *time.Time             `json:"dateUTC,omitempty"`
+	StationConfig   *config.WeatherStation `json:"stationConfig,omitempty"`
+	StationID       *string                `json:"stationID,omitempty"`
+	StationType     *string                `json:"stationType,omitempty"`
+	TempOutdoorF    *float64               `json:"tempOutdoorF,omitempty"`
+	TempIndoorF     *float64               `json:"tempIndoorF,omitempty"`
+	HumidityOudoor  *int                   `json:"humidityOudoor,omitempty"`
+	HumidityIndoor  *int                   `json:"humidityIndoor,omitempty"`
+	WindSpeedMPH    *float64               `json:"windSpeedMPH,omitempty"`
+	WindGustMPH     *float64               `json:"windGustMPH,omitempty"`
+	MaxDailyGust    *float64               `json:"maxDailyGust,omitempty"`
+	WindDir         *int                   `json:"windDir,omitempty"`
+	WindDirAvg10m   *int                   `json:"windDirAvg10M,omitempty"`
+	UV              *int                   `json:"uv,omitempty"`
+	SolarRadiation  *float64               `json:"solarRadiation,omitempty"`
+	HourlyRainIn    *float64               `json:"hourlyRainIn,omitempty"`
+	EventRainIn     *float64               `json:"eventRainIn,omitempty"`
+	DailyRainIn     *float64               `json:"dailyRainIn,omitempty"`
+	WeeklyRainIn    *float64               `json:"weeklyRainIn,omitempty"`
+	MonthlyRainIn   *float64               `json:"monthlyRainIn,omitempty"`
+	YearlyRainIn    *float64               `json:"yearlyRainIn,omitempty"`
+	TotalRainIn     *float64               `json:"totalRainIn,omitempty"`
+	Batteries       []BatteryStatus        `json:"batteries,omitempty"`
+	BaromRelativeIn *float64               `json:"baromRelativeIn,omitempty"`
+	BaromAbsoluteIn *float64               `json:"baromAbsoluteIn,omitempty"`
 	// These fields may be calculated
 	// if not otherwise set
-	DewPointF  *float64
-	WindChillF *float64
+	DewPointF  *float64 `json:"dewPointF,omitempty"`
+	WindChillF *float64 `json:"windChillF,omitempty"`
 	// Extra Temp+Humidity Sensors
-	TempHumiditySensors []*TempHumiditySensor
+	TempHumiditySensors []*TempHumiditySensor `json:"tempHumiditySensors,omitempty"`
 	// Lightning Data
 	*LightningData
 }
 
 type LightningData struct {
-	LightningDay      *int // Count of detections
-	LightningDistance *int // Last detection distance [kilometers]
-	LightningTime     *int // Last detection time
+	LightningDay      *int `json:"lightningDay,omitempty"`      // Count of detections
+	LightningDistance *int `json:"lightningDistance,omitempty"` // Last detection distance [kilometers]
+	LightningTime     *int `json:"lightningTime,omitempty"`     // Last detection time
 }
 
 type TempHumiditySensor struct {
-	Name     string
-	TempF    *float64
-	Humidity *int
+	Name     string   `json:"name,omitempty"`
+	TempF    *float64 `json:"tempF,omitempty"`
+	Humidity *int     `json:"humidity,omitempty"`
 }
 
 type BatteryStatus struct {
-	Component string
-	Status    *int
+	Component string `json:"component,omitempty"`
+	Status    *int   `json:"status,omitempty"`
 }
 
 // CHORE: Maintain this, used to check against

proto/weather/weather.proto

@@ -6,68 +6,70 @@ import "google/protobuf/timestamp.proto";
 option go_package = "gitea.libretechconsulting.com/rmcguire/ambient-local-exporter/api/v1alpha1/weather";
 
 message CountWeatherUpdatesRequest {
-	GetWeatherOpts opts = 1;
+  GetWeatherOpts opts = 1;
 }
 
 message CountWeatherUpdatesResponse {
-	int32 count = 1;
+  int32 count = 1;
 }
 
 message GetWeatherRequest {
-	GetWeatherOpts opts = 1;
-	optional int32 limit = 2;
+  GetWeatherOpts opts = 1;
+  optional int32 limit = 2;
 }
 
-message GetWeatherResponse{
-	google.protobuf.Timestamp last_updated = 1;
-	repeated WeatherUpdate weather_updates = 2;
+message GetWeatherResponse {
+  google.protobuf.Timestamp last_updated = 1;
+  repeated WeatherUpdate weather_updates = 2;
 }
 
 message GetWeatherOpts {
-	optional string station_name = 1;
-	optional string station_type = 2;
+  optional string station_name = 1;
+  optional string station_type = 2;
 }
 
 message WeatherUpdate {
-	string station_name = 1;
-	string station_type = 2;
-	string station_id = 3;
-	optional double temp_outdoor_f = 4;
-	optional double temp_indoor_f = 5;
-	optional int32 humidity_outdoor = 6;
-	optional int32 humidity_indoor = 7;
-	optional double wind_speed_mph = 8;
-	optional double wind_gust_mph = 9;
-	optional double max_daily_gust = 10;
-	optional int32 wind_dir = 11;
-	optional int32 wind_dir_avg_10m = 12;
-	optional int32 uv = 13;
-	optional double solar_radiation = 14;
-	optional double hourly_rain_in = 15;
-	optional double event_rain_in = 16;
-	optional double daily_rain_in = 17;
-	optional double weekly_rain_in = 18;
-	optional double monthly_rain_in = 19;
-	optional double yearly_rain_in = 20;
-	optional double total_rain_in = 21;
-	repeated BatteryStatus batteries = 22;
-	optional double barom_relative_in = 23;
-	optional double barom_absolute_in = 24;
-	optional double dew_point_f = 25;
-	optional double wind_chill_f = 26;
-	repeated TempHumiditySensor temp_humidity_sensors = 27;
-	google.protobuf.Timestamp update_timestamp = 28;
+  string station_name = 1;
+  string station_type = 2;
+  string station_id = 3;
+  optional double temp_outdoor_f = 4;
+  optional double temp_indoor_f = 5;
+  optional int32 humidity_outdoor = 6;
+  optional int32 humidity_indoor = 7;
+  optional double wind_speed_mph = 8;
+  optional double wind_gust_mph = 9;
+  optional double max_daily_gust = 10;
+  optional int32 wind_dir = 11;
+  optional int32 wind_dir_avg_10m = 12;
+  optional int32 uv = 13;
+  optional double solar_radiation = 14;
+  optional double hourly_rain_in = 15;
+  optional double event_rain_in = 16;
+  optional double daily_rain_in = 17;
+  optional double weekly_rain_in = 18;
+  optional double monthly_rain_in = 19;
+  optional double yearly_rain_in = 20;
+  optional double total_rain_in = 21;
+  repeated BatteryStatus batteries = 22;
+  optional double barom_relative_in = 23;
+  optional double barom_absolute_in = 24;
+  optional double dew_point_f = 25;
+  optional double wind_chill_f = 26;
+  repeated TempHumiditySensor temp_humidity_sensors = 27;
+  google.protobuf.Timestamp update_timestamp = 28;
+  optional int32 lightning_day = 29;
+  optional int32 lightning_distance = 30;
 }
 
 // Represents a temperature and humidity sensor
 message TempHumiditySensor {
-	string name = 1;
-	optional double temp_f = 2;
-	optional int32 humidity = 3;
+  string name = 1;
+  optional double temp_f = 2;
+  optional int32 humidity = 3;
 }
 
 // Represents battery status for different components
 message BatteryStatus {
-	string component = 1;
-	optional int32 status = 2;
+  string component = 1;
+  optional int32 status = 2;
 }