https://github.com/energychain/discovergy-export
Data dump for Discovergy Metering
https://github.com/energychain/discovergy-export
Last synced: 4 months ago
JSON representation
Data dump for Discovergy Metering
- Host: GitHub
- URL: https://github.com/energychain/discovergy-export
- Owner: energychain
- License: apache-2.0
- Created: 2022-05-27T08:54:27.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-10T00:27:11.000Z (over 1 year ago)
- Last Synced: 2025-01-11T15:20:39.047Z (5 months ago)
- Language: JavaScript
- Size: 25.4 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# discovergy-export
**Data dump for Discovergy Metering.**
[](https://www.npmjs.com/package/discovergy-export)
[](https://www.npmjs.com/package/discovergy-export)
[](https://co2offset.io/badge.html?host=discovergy-export)
[](https://gitter.im/stromdao/tydids-p2p?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Exporter retrieves data via [Discovergy API](https://api.discovergy.com/docs/#/Readings/getReadings) and outputs it as CSV or JSON format.
```
npm install -g discovergy-export
Usage: discovergy-export [options]
Options:
-u --username [discovergy_account] Discovergy Portal User - Email
-p --password [discovergy_password] Discovergy Portal Password
-m --meterId [meterId] API MeterId (this is not the administration number!)
--from [timestamp] Timestamp start readings with
--to [timestamp] Timestamp to end readings with
--resolution [resolution] Resolution of aggregated data
--save [basename] Save output to filesystem using given basename (if not print on console)
--split Split into seperate files (only with --save option)
--format [format] Output format (eq. csv, json)
--fields [fieldlist] Comma seperated list of fields. If not specified all fields of first meter are used.
--all Retrieve all data of meter (no timeframe). Check resolution option against API limits!
-h, --help display help for command
```
## Samples
Dump all meter, on screen, json format, resolution fifteen minutes, last 24 hours
```
discovergy-export -u [email protected] -p demo
```
Dump all meter, on screen, json format, resolution one month, full history
```
discovergy-export -u [email protected] -p demo --all --resolution one_month
```
Dump all meter, on screen, csv format, resolution one month, full history
```
discovergy-export -u [email protected] -p demo --format csv --all --resolution one_month
```
Dump all meter, in one file, json format, resolution fifteen minutes, last 24 hours
```
discovergy-export -u [email protected] -p demo --save
```
Dump all meter, in seperate files, json format, resolution fifteen minutes, last 24 hours
```
discovergy-export -u [email protected] -p demo --save --split
```
## Usage Hints
### Supported date formats
discovergy-export uses [moment.js](https://momentjs.com/) to parse dates. So any [format supported](https://momentjs.com/docs/#/parsing/) is possible as from/to format.
### Possible resolutions and limits
| resolution | maximum time span (to - from) |
|----------|:-------------:|
| raw | 1 day |
| three_minutes | 10 days |
| fifteen_minutes | 31 days |
| one_hour | 93 days |
| one_day | 10 years |
| one_week | 20 years |
| one_month | 50 years |
## Maintainer / Imprint
STROMDAO GmbH
Gerhard Weiser Ring 29
69256 Mauer
Germany
+49 6226 968 009 0
[email protected]
Handelsregister: HRB 728691 (Amtsgericht Mannheim)
## [CONTRIBUTING](https://github.com/energychain/tydids-p2p/blob/main/CONTRIBUTING.md)
## [CODE OF CONDUCT](https://github.com/energychain/tydids-p2p/blob/main/CODE_OF_CONDUCT.md)