initial version

Author: mampfes

.github/workflows/hacs.yaml

@@ -0,0 +1,18 @@
+name: HACS Action
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  hacs:
+    name: HACS Action
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v2"
+      - name: HACS Action
+        uses: "hacs/action@main"
+        with:
+          category: "integration"

.github/workflows/hassfest.yaml

@@ -0,0 +1,14 @@
+name: Validate with hassfest
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  validate:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v2"
+      - uses: home-assistant/actions/hassfest@master

.gitignore

@@ -0,0 +1,6 @@
+__pycache__
+*.swp
+*.swo
+.vscode/
+.mypy_cache/
+venv/

.pre-commit-config.yaml

@@ -0,0 +1,61 @@
+repos:
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.32.1
+    hooks:
+      - id: pyupgrade
+        args: [--py37-plus]
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+        args:
+          - --safe
+          - --quiet
+        files: ^((custom_components|script|tests)/.+)?[^/]+\.py$
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.1.0
+    hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list=hass,alot,datas,dof,dur,farenheit,hist,iff,ines,ist,lightsensor,mut,nd,pres,referer,ser,serie,te,technik,ue,uint,visability,wan,wanna,withing, Adresse, termine, adresse
+          - --skip="./.*,*.csv,*.json"
+          - --quiet-level=2
+        exclude_types: [csv, json]
+  - repo: https://github.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+        args:
+          - --ignore=D100,D101,D102,D103,D104,D105,D107,E501,W503
+        additional_dependencies:
+          - flake8-docstrings==1.5.0
+          - pydocstyle==5.0.2
+        files: ^(custom_components|script|tests)/.+\.py$
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.4
+    hooks:
+      - id: bandit
+        args:
+          - --quiet
+          - --format=custom
+          - --configfile=tests/bandit.yaml
+        files: ^(custom_components|script|tests)/.+\.py$
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.10.1
+    hooks:
+      - id: isort
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.2.0
+    hooks:
+      - id: check-executables-have-shebangs
+        stages: [manual]
+      - id: check-json
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.960
+    hooks:
+      - id: mypy
+        args:
+          - --pretty
+          - --show-error-codes
+          - --show-error-context
+          - --ignore-missing-imports

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Steffen Zimmermann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,56 @@
+# EPEX Spot
+
+This component adds electricity prices from stock exchange [EPEX Spot](https://www.epexspot.com) to Home Assistant. [EPEX Spot](https://www.epexspot.com) does not provide free access to the data, so this component uses different ways to retrieve the data.
+
+You can chose between multiple sources:
+
+1. Awattar
+
+   [Awattar](https://www.awattar.de/services/api) provides a free of charge service for their customers. Market price data is available for Germany and Austria. So far no user identifiation is required.
+
+2. EPEX Spot Web Scraper
+
+    This source uses web scraping technologies to retrieve publicly available data from its [website](https://www.epexspot.com/en/market-data).
+
+If you like this component, please give it a star on [github](https://github.com/mampfes/hacs_epex_spot_awattar).
+
+## Installation
+
+1. Ensure that [HACS](https://hacs.xyz) is installed.
+2. Install **EPEX Spot** integration via HACS.
+3. Add **EPEX Spot** integration to Home Assistant:
+
+   [![badge](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start?domain=epex_spot)
+
+In case you would like to install manually:
+
+1. Copy the folder `custom_components/epex_spot` to `custom_components` in your Home Assistant `config` folder.
+2. Add **EPEX Spot** integration to Home Assistant:
+
+    [![badge](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start?domain=epex_spot)
+
+## Sensors
+
+This component provides one sensor for market prices. The sensor state is the current price in EUR/MWh.
+
+Some sources (like EPEX Spot Web Scraper) provide additional sensors like buy volume, sell volume or volume.
+
+### Sensor Attributes
+
+In addition to the current market price, the price sensor also provides a list of upcoming prices per hour:
+
+```yaml
+unit_of_measurement: EUR/MWh
+icon: mdi:currency-eur
+friendly_name: EPEX Spot DE-LU Price
+data:
+  - start_time: '2022-12-15T23:00:00+00:00'
+    end_time: '2022-12-16T00:00:00+00:00'
+    price_eur_per_mwh: 296.3
+  - start_time: '2022-12-16T00:00:00+00:00'
+    end_time: '2022-12-16T01:00:00+00:00'
+    price_eur_per_mwh: 288.12
+  - start_time: '2022-12-16T01:00:00+00:00'
+    end_time: '2022-12-16T02:00:00+00:00'
+    price_eur_per_mwh: 280.19
+```

custom_components/epex_spot/EPEXSpot/Awattar/__init__.py

@@ -0,0 +1,82 @@
+import logging
+from datetime import datetime, timedelta, timezone
+
+import requests
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class Marketprice:
+    UOM_EUR_PER_MWh = "EUR/MWh"
+    UOM_CT_PER_KWh = "ct/KWh"
+
+    def __init__(self, data):
+        assert data["unit"].lower() == self.UOM_EUR_PER_MWh.lower()
+        self._start_time = datetime.fromtimestamp(
+            data["start_timestamp"] / 1000, tz=timezone.utc
+        )
+        self._end_time = datetime.fromtimestamp(
+            data["end_timestamp"] / 1000, tz=timezone.utc
+        )
+        self._price_eur_per_mwh = float(data["marketprice"])
+
+    def __repr__(self):
+        return f"{self.__class__.__name__}(start: {self._start_time.isoformat()}, end: {self._end_time.isoformat()}, marketprice: {self._price_eur_per_mwh} {self.UOM_EUR_PER_MWh})"
+
+    @property
+    def start_time(self):
+        return self._start_time
+
+    @property
+    def end_time(self):
+        return self._end_time
+
+    @property
+    def price_eur_per_mwh(self):
+        return self._price_eur_per_mwh
+
+    @property
+    def price_ct_per_kwh(self):
+        return self._price_eur_per_mwh / 10
+
+
+class Awattar:
+    URL = "https://api.awattar.{market_area}/v1/marketdata"
+
+    MARKET_AREAS = ("at", "de")
+
+    def __init__(self, market_area):
+        self._market_area = market_area
+        self._url = self.URL.format(market_area=market_area)
+        self._marketprices = []
+
+    @property
+    def name(self):
+        return "Awattar API V1"
+
+    @property
+    def market_area(self):
+        return self._market_area
+
+    @property
+    def marketprices(self):
+        return self._marketprices
+
+    def fetch(self):
+        data = self._fetch_data(self._url)
+        self._marketprices = self._extract_marketprices(data["data"])
+
+    def _fetch_data(self, url):
+        start = datetime.now(tz=timezone.utc).replace(
+            hour=0, minute=0, second=0, microsecond=0
+        )
+        end = start + timedelta(days=2)
+        r = requests.get(url, params={"start": start, "end": end})
+        r.raise_for_status()
+        return r.json()
+
+    def _extract_marketprices(self, data):
+        entries = []
+        for entry in data:
+            entries.append(Marketprice(entry))
+        return entries