Add scraping values from Fronius Smart Meter API #101

jheyduk · 2023-03-03T10:16:13Z

Summary

Added fetching most important values from /solar_api/v1/GetMeterRealtimeData.cgi

Checklist

Categorize the PR by setting a good title and adding one of the labels:
fix, enhancement, documentation, change, breaking, dependency
as they show up in the changelog
Update documentation.
Update tests.
Link this PR to related issues.

ccremer

Thanks for your contribution!
I have some minor issues that I would like to address before merging it.

ccremer · 2023-03-04T10:17:33Z

cfg/config.go

+	fs.Float64("symo.offset-consumed", config.Symo.OffsetConsumed, "Offset for consumed")
+	fs.Float64("symo.offset-produced", config.Symo.OffsetProduced, "Offset for produced")


Please describe the flags better. What does "offset for consumed/produced" mean? What unit (if there is)?
If the values are only relevant for the smart meter endpoint, maybe make it symo.smartmeter.offset-{consumed/produced}?

The offset is meant to make it possible to keep the metric in sync with the official electric meter. The unit is Wh.

Ok, thanks. I'd propose to update the desc accordingly (better description welcome).

Suggested change

fs.Float64("symo.offset-consumed", config.Symo.OffsetConsumed, "Offset for consumed")

fs.Float64("symo.offset-produced", config.Symo.OffsetProduced, "Offset for produced")

fs.Float64("symo.offset-consumed", config.Symo.OffsetConsumed, "Offset in Wh added to consumed energy to keep in sync with official meter. Only used if smart-meter endpoint is enabled.")

fs.Float64("symo.offset-produced", config.Symo.OffsetProduced, "Offset in Wh added to produced energy to keep in sync with official meter. Only used if smart-meter endpoint is enabled.")

metrics.go

cfg/types.go

ccremer · 2023-03-04T10:28:50Z

metrics.go

+		meterEnergyRealSumConsumedVec.WithLabelValues(key).Set(meter.EnergyRealSumConsumed + config.Symo.OffsetConsumed)
+		meterEnergyRealSumProducedVec.WithLabelValues(key).Set(meter.EnergyRealSumProduced + config.Symo.OffsetProduced)


I don't know the smart meter data...
Is this offset actually required or important here? What is the semantic of the offset? Or is this more relevant to your personal use case?

ccremer · 2023-03-04T10:30:44Z

pkg/fronius/symo.go

 )

 type (
-	symoPowerFlow struct {
+	SymoPowerFlow struct {


Why expose this type? It's not meant to be public (i.e. usable by other Go packages), but is merely a struct to parse the JSON

Suggested change

SymoPowerFlow struct {

symoPowerFlow struct {

ccremer · 2023-03-04T10:30:52Z

pkg/fronius/symo.go

@@ -64,7 +66,7 @@ type (
 	}

 	// SymoArchive holds the parsed archive data from Symo API
-	symoArchive struct {
+	SymoArchive struct {


Suggested change

SymoArchive struct {

symoArchive struct {

pkg/fronius/symo.go

ccremer · 2023-03-04T10:33:14Z

pkg/fronius/symo.go

+		OffsetConsumed    float64
+		OffsetProduced    float64


From this naming alone it's not clear to me what it means or when it's relevant. Please either try to find a better name, or add field comments describing its effects.

ccremer · 2023-03-04T10:34:08Z

pkg/fronius/symo_test.go

+func Test_Symo_GetMeterData_GivenUrl_WhenRequestData_ThenParseStruct(t *testing.T) {
+	server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
+		payload, err := os.ReadFile("testdata/test_meter.json")
+		require.NoError(t, err)
+		_, _ = rw.Write(payload)


Thanks for providing a test + testfile 👍

Co-authored-by: Chris <github.account@chrigel.net>

ccremer

Apologies for the delayed response, I'm busy with work lately.

ccremer · 2023-03-10T11:48:55Z

cfg/config.go

+	fs.Float64("symo.offset-consumed", config.Symo.OffsetConsumed, "Offset for consumed")
+	fs.Float64("symo.offset-produced", config.Symo.OffsetProduced, "Offset for produced")


Ok, thanks. I'd propose to update the desc accordingly (better description welcome).

Suggested change

fs.Float64("symo.offset-consumed", config.Symo.OffsetConsumed, "Offset for consumed")

fs.Float64("symo.offset-produced", config.Symo.OffsetProduced, "Offset for produced")

fs.Float64("symo.offset-consumed", config.Symo.OffsetConsumed, "Offset in Wh added to consumed energy to keep in sync with official meter. Only used if smart-meter endpoint is enabled.")

fs.Float64("symo.offset-produced", config.Symo.OffsetProduced, "Offset in Wh added to produced energy to keep in sync with official meter. Only used if smart-meter endpoint is enabled.")

ccremer · 2023-03-10T11:54:37Z

pkg/fronius/symo.go

+		OffsetConsumed    float64
+		OffsetProduced    float64


Suggested change

OffsetConsumed float64

OffsetProduced float64

// OffsetConsumed in Wh is added to consumed energy to keep in sync with official meter (only used if smart meter endpoint enabled).

OffsetConsumed float64

// OffsetProduced in Wh is added to consumed energy to keep in sync with official meter (only used if smart meter endpoint enabled).

OffsetProduced float64

ccremer · 2023-03-10T11:55:02Z

pkg/fronius/symo.go

@@ -64,7 +66,7 @@ type (
 	}

 	// SymoArchive holds the parsed archive data from Symo API
-	symoArchive struct {
+	SymoArchive struct {


Suggested change

SymoArchive struct {

symoArchive struct {

ccremer · 2023-03-10T11:55:09Z

pkg/fronius/symo.go

 )

 type (
-	symoPowerFlow struct {
+	SymoPowerFlow struct {


Suggested change

SymoPowerFlow struct {

symoPowerFlow struct {

ccremer · 2023-03-10T11:55:21Z

pkg/fronius/symo.go

@@ -159,7 +177,33 @@ func (c *SymoClient) GetArchiveData() (map[string]InverterArchive, error) {
 		return nil, err
 	}
 	defer response.Body.Close()
-	p := symoArchive{}
+	p := SymoArchive{}


Suggested change

p := SymoArchive{}

p := symoArchive{}

ccremer · 2023-03-10T11:55:27Z

pkg/fronius/symo.go

@@ -126,7 +144,7 @@ func (c *SymoClient) GetPowerFlowData() (*SymoData, error) {
 		return nil, err
 	}
 	defer response.Body.Close()
-	p := symoPowerFlow{}
+	p := SymoPowerFlow{}


Suggested change

p := SymoPowerFlow{}

p := symoPowerFlow{}

hkuehl · 2023-09-21T19:51:18Z

Will this PR eventually get merged?

ccremer · 2023-09-22T08:15:19Z

Will this PR eventually get merged?

I don't know. I have requested changes from the author @jheyduk but never heard anything since.

Add scraping for Fronius Smart Meter API

51e18cb

ccremer requested changes Mar 4, 2023

View reviewed changes

ccremer added the enhancement New feature or request label Mar 4, 2023

ccremer changed the title ~~enhancement: Add scraping values from Fronius Smart Meter API~~ Add scraping values from Fronius Smart Meter API Mar 4, 2023

jheyduk and others added 4 commits March 4, 2023 13:41

Update metrics.go

a227dcf

Co-authored-by: Chris <github.account@chrigel.net>

Update metrics.go

277e7cc

Co-authored-by: Chris <github.account@chrigel.net>

Update pkg/fronius/symo.go

0f54e92

Co-authored-by: Chris <github.account@chrigel.net>

Update cfg/types.go

9fc9571

Co-authored-by: Chris <github.account@chrigel.net>

ccremer requested changes Mar 10, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add scraping values from Fronius Smart Meter API #101

Add scraping values from Fronius Smart Meter API #101

jheyduk commented Mar 3, 2023

ccremer left a comment

ccremer Mar 4, 2023

jheyduk Mar 4, 2023

ccremer Mar 10, 2023

ccremer Mar 4, 2023

jheyduk Mar 4, 2023

ccremer Mar 4, 2023

jheyduk Mar 4, 2023

ccremer Mar 10, 2023

ccremer Mar 4, 2023

jheyduk Mar 4, 2023

ccremer Mar 10, 2023

ccremer Mar 4, 2023

ccremer Mar 4, 2023

ccremer left a comment

ccremer Mar 10, 2023

ccremer Mar 10, 2023

ccremer Mar 10, 2023

ccremer Mar 10, 2023

ccremer Mar 10, 2023

ccremer Mar 10, 2023

hkuehl commented Sep 21, 2023

ccremer commented Sep 22, 2023

		fs.Float64("symo.offset-consumed", config.Symo.OffsetConsumed, "Offset for consumed")
		fs.Float64("symo.offset-produced", config.Symo.OffsetProduced, "Offset for produced")

		meterEnergyRealSumConsumedVec.WithLabelValues(key).Set(meter.EnergyRealSumConsumed + config.Symo.OffsetConsumed)
		meterEnergyRealSumProducedVec.WithLabelValues(key).Set(meter.EnergyRealSumProduced + config.Symo.OffsetProduced)

Add scraping values from Fronius Smart Meter API #101

Are you sure you want to change the base?

Add scraping values from Fronius Smart Meter API #101

Conversation

jheyduk commented Mar 3, 2023

Summary

Checklist

ccremer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ccremer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hkuehl commented Sep 21, 2023

ccremer commented Sep 22, 2023