Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/smartechru/n3rgy

This component is a Home Assistant custom sensor that provides access to historic energy consumption data and tariff information.
https://github.com/smartechru/n3rgy

energy hacs home-assistant homeassistant integration powerconsumption

Last synced: 14 days ago
JSON representation

This component is a Home Assistant custom sensor that provides access to historic energy consumption data and tariff information.

Host: GitHub
URL: https://github.com/smartechru/n3rgy
Owner: smartechru
License: mit
Created: 2021-02-03T03:55:00.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2021-02-24T10:46:59.000Z (almost 4 years ago)
Last Synced: 2024-01-28T16:09:09.642Z (11 months ago)
Topics: energy, hacs, home-assistant, homeassistant, integration, powerconsumption
Language: Python
Homepage: https://data.n3rgy.com
Size: 93.8 KB
Stars: 12
Watchers: 5
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Smart Energy Data

[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/custom-components/hacs)

[![GitHub](https://img.shields.io/github/license/smartechru/n3rgy)](LICENSE)

[![GitHub Release (latest by date)](https://img.shields.io/github/v/release/smartechru/n3rgy)](https://github.com/smartechru/n3rgy/releases)

![GitHub Release Date](https://img.shields.io/github/release-date/smartechru/n3rgy)

[![GitHub Issues](https://img.shields.io/github/issues/smartechru/n3rgy)](https://github.com/smartechru/n3rgy/issues)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-Yes-brightgreen.svg)](https://github.com/smartechru/n3rgy/graphs/commit-activity)

The **n3rgy** component is a Home Assistant custom sensor which provides access to historic energy consumption data and tariff information.

## TABLE OF CONTENTS

* [Installation](#installation)

* [Configuration](#configuration)

  * [Config Flow](#config-flow)

  * [Configuration Parameters](#configuration-parameters)

* [State](#state)

## INSTALLATION

This integration is able to install via HACS.

1. Ensure that [HACS](https://custom-components.github.io/hacs/) is installed.

2. Search for and install the **n3rgy** integration.

3. Configure the **n3rgy** sensor.

4. Restart Home Assistant.

## CONFIGURATION

**n3rgy** can be configured on the integrations menu or in configuration.yaml

### CONFIG FLOW

In Configuration/Integrations click on the **<+>** button, select **n3rgy** and configure the options on the form.

### configuration.yaml

Add **n3rgy** sensor in your `configuration.yaml`.

```yaml

# Example configuration.yaml entry

n3rgy:

  name: 'Consumption Data'

  host: !secret host_url

  api_key: !secret api_key

  property_id: !secret property_id

```

Optional arguments:

```yaml

n3rgy:

  name: 'Consumption Data'

  ...

  environment: true     # live environment enabled

  daily_update: true    # daily update flag

  utility: electricity  # utility type

  start: 202102080130   # start date/time (FORMAT: YYYYMMDDHHmm)

  end: 202102091125     # end date/time (FORMAT: YYYYMMDDHHmm)

```

### CONFIGURATION PARAMETERS

| Parameter | Optional | Description |

|:--------- | -------- | ----------- |

| `name` | Yes | Sensor name |

| `host` | No | The server URL used to call the SDK methods |

| `api_key` | No | The API key used for authentication with the server |

| `property_id` | No | The Property ID, which can be either an MPAN or MPRN |

| `environment` | Yes | Live environment flag (default: `false`) |

| `daily_update` | Yes | Daily update flag (default: `true`) |

| `utility` | Yes | Utility type (default: `electricity`) |

| `start` | Yes | Start date/time of the period in the format YYYYMMDDHHmm |

| `end` | Yes | End date/time of the period in the format YYYYMMDDHHmm |

## STATE

Returns values for the consumption of the specified utility (e.g. electricity, gas) at the property identified by the given MPxN. Unless otherwise specified using optional parameters, returns the consumption values for every half-hour of the previous day. Accepts as optional parameters a start date/time, an end date/time, live environment flag.