Skip to content

Commit a22cc45

Browse files
Include resampling in readme (#78)
Addressing Issue #56
2 parents f4bd740 + b98db03 commit a22cc45

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ API_KEY = open('api_key.txt').read().strip()
4949
client = ReportingApiClient(service_address=SERVICE_ADDRESS, key=API_KEY)
5050
```
5151

52+
Besides the microgrid_id, component_ids, and metrics, start, and end time,
53+
you can also set the sampling period for resampling using the `resolution` parameter.
54+
For example, to resample data every 15 minutes, use a `resolution` of 900 seconds. The default is 1 second.
55+
5256
### Query metrics for a single microgrid and component:
5357

5458
```python

0 commit comments

Comments
 (0)