Skip to content

Commit 04cc67f

Browse files
committed
update readme with --csv-file info
1 parent 42331d7 commit 04cc67f

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ In prior versions of SmartHub, it was possible to download CSV exports of 15-min
88
specifying an "hourly" interval, but since January 2024 only hourly data has been available via CSV. That's
99
why I reverse engineered the API instead of automating a download of the CSV as I had previously done.
1010

11-
Data can be imported into InfluxDB or VictoriaMetrics.
11+
Data can be imported into InfluxDB or VictoriaMetrics, or exported as a CSV file.
1212

1313
## Config
1414

@@ -25,15 +25,17 @@ Download [config.example.yaml](config.example.yaml) and fill in your own values.
2525
- `timezone` needs to be set to the timezone used by your utility. For some reason,
2626
the SmartHub API decided to return unix timestamps, but in the utility's timezone
2727
instead of in UTC, which would be the normal choice for an API.
28+
- `influxdb` section does not need to be configured if you are only using the `--csv-file` option.
2829
- `influxdb.insecure` allows connecting to a server with certificate issues.
2930
- The other fields should be fairly self-explanatory.
3031

3132
## Running
3233

33-
- To download and insert the last `extract_days`, run like this arguments: `electric-usage-downloader --config config.yaml`
34+
- To download and insert the last `extract_days` of data, run like this arguments: `electric-usage-downloader --config config.yaml`
3435
- To download and insert a specific date range, run with arguments:
3536
`electric-usage-downloader --config config.yaml --start 2024-01-16 --end 2024-01-17`
3637
- The `--debug` flag can be used to log responses from the API for assistance debugging issues.
38+
- The `--csv-file` flag will write the data to a CSV file instead of Influx/VictoriaMetrics.
3739

3840
## Details
3941

0 commit comments

Comments
 (0)