https://github.com/adriankumpf/discovergy
A simple wrapper for the Discovergy REST API
https://github.com/adriankumpf/discovergy
api-wrapper discovergy elixir smartmeter
Last synced: about 1 year ago
JSON representation
A simple wrapper for the Discovergy REST API
- Host: GitHub
- URL: https://github.com/adriankumpf/discovergy
- Owner: adriankumpf
- License: mit
- Created: 2020-07-04T22:12:47.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-10T19:21:23.000Z (about 1 year ago)
- Last Synced: 2025-03-10T20:29:17.287Z (about 1 year ago)
- Topics: api-wrapper, discovergy, elixir, smartmeter
- Language: Elixir
- Homepage:
- Size: 136 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Discovergy
[](https://github.com/adriankumpf/discovergy/actions)
[](https://hexdocs.pm/discovergy)
[](http://hex.pm/packages/discovergy)
> A client for the [Discovergy REST API](https://api.discovergy.com/docs/), providing access to meters and measurements.
## Installation
Add `:discovergy` and `:finch` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:discovergy, "~> 0.6"},
{:finch, "~> 0.16"}
]
end
```
## Usage
Create a `Discovergy.Client` and authenticate with the Discovergy API using your email address and password.
```elixir
iex> {:ok, client} = Discovergy.Client.new() |> Discovergy.Client.login(email, password)
{:ok, %Discovergy.Client{}}
```
Then pass the `client` to the respective endpoint function. For example, to list all meters the user has access to:
```elixir
iex> Discovergy.Metadata.get_meters(client)
{:ok, [%Discovergy.Meter{
administration_number: "",
current_scaling_factor: 1,
first_measurement_time: 1563286659367,
full_serial_number: "1ESY1161229886",
internal_meters: 1,
last_measurement_time: 1593949473598,
load_profile_type: "SLP",
location: %Discovergy.Location{
city: "Greven",
country: "DE",
street: "Sedanstr.",
street_number: "8",
zip: "48268"
},
manufacturer_id: "ESY",
measurement_type: "ELECTRICITY",
meter_id: "c1972a89ce3a4d58aadcb7908a1d31c7",
scaling_factor: 1,
serial_number: "61229886",
type: "EASYMETER",
voltage_scaling_factor: 1
}]}
```
Or to obtain the last measurement of a particular meter:
```elixir
iex> Discovergy.Measurements.get_last_reading(client, "c1972a89ce3a4d58aadcb7908a1d31c7")
{:ok, %Discovergy.Measurement{
time: ~U[2019-07-16 22:00:00.000Z],
values: %{
"energy" => 441576730000,
"energyOut" => 2154853000,
"power" => 205980,
"power1" => 63090,
"power2" => 53780,
"power3" => 89100,
"voltage1" => 234100,
"voltage2" => 234000,
"voltage3" => 233800
}
}}
```
## License
This project is Licensed under the [MIT License](LICENSE).