Github Mirror / telegraf-plugins: 2cb04d21

verified

Fetch property and tariff details from Octopus' API (utilities/telegraf-plugins#14)

Fetch property and tariff details from Octopus' API (utilities/telegraf-plugins#14)

This is going to need a tidy - I started it late last night shortly before I ran out of Southern Comfort.

But, it does work and fetch the details. The next stage will be build some logic to turn it into Line Protocol

Commit 2cb04d21.

Authored 2023-07-05T08:51:29.000+01:00 by B Tasker in project Github Mirror / telegraf-plugins

+92 lines -0 lines

Commit Signature

Changes

diff --git a/octopus-tariffs/octopus-tariffs.py b/octopus-tariffs/octopus-tariffs.py
--- a/octopus-tariffs/octopus-tariffs.py
+++ b/octopus-tariffs/octopus-tariffs.py
# @@ -0,0 +1,92 @@
# +#!/usr/bin/env python3
# +
# +import os
# +import requests
# +import base64
# +
# +
# +def getPricing(meter, session):
# + ''' Calculate the product code and fetch pricing info
# + '''
# + # We've got a tariff code (for example E-1R-VAR-22-11-01-A)
# + # the product code is embedded into it - VAR-22-11-01
# + # the A at the end of the example is the region code
# + #
# + # Split the tariff code up
# + tariff_split = meter['tariff-code'].split("-")
# + product_code = '-'.join(tariff_split[2:-1])
# + meter['region'] = tariff_split[-1]
# +
# + # We can now use this to retrieve pricing
# + result = session.get(f"https://api.octopus.energy/v1/products/{product_code}/electricity-tariffs/{meter['tariff-code']}/standard-unit-rates")
# +
# + for pricepoint in result.json()['results']:
# + meter['pricing'].append(pricepoint)
# +
# + return meter
# +
# +
# +def main(api_key, octo_account):
# + ''' Main entry point
# +
# + Fetch property details and identify meters
# + '''
# + if not api_key:
# + return False
# +
# + # Set up a session allowing KA
# + session = requests.session()
# + auth_val = base64.b64encode(f"{api_key}:".encode('utf-8')).decode()
# + headers = {
# + "User-Agent" : "telegraf plugin (https://github.com/bentasker/telegraf-plugins/tree/master/octopus-tariffs)",
# + "Authorization" : f"Basic {auth_val}"
# +
# + }
# + # Make these the default
# + session.headers = headers
# +
# + # Get Account info
# + #
# + # This gives us MPAN and tariff info
# + result = session.get(f"https://api.octopus.energy/v1/accounts/{octo_account}")
# + account = result.json()
# +
# + addresses = []
# + # Iterate through addresses
# + for prop in account['properties']:
# + prop_info = {
# + "id" : prop['id'],
# + "meters" : [],
# + "account_number" : octo_account,
# + "start_date" : prop['moved_in_at']
# + }
# + # Iterate through meter points
# + for meter_point in prop['electricity_meter_points']:
# + meter_info = {
# + "mpan" : meter_point['mpan'],
# + "pricing" : []
# + }
# + for meter in meter_point['meters']:
# + meter_info['serial'] = meter['serial_number']
# +
# + for agreement in meter_point['agreements']:
# + meter_info = meter_info | {
# +
# + "tariff-code" : agreement['tariff_code'],
# + "from" : agreement['valid_from'],
# + "to" : agreement['valid_to']
# + }
# +
# + # Get tariff info
# + meter_info = getPricing(meter_info, session)
# +
# + prop_info['meters'].append(meter_info)
# + addresses.append(prop_info)
# +
# + print(addresses)
# +
# +
# +if __name__ == "__main__":
# + api_key = os.getenv("OCTOPUS_KEY", False)
# + mpan = os.getenv("OCTOPUS_ACCOUNT", False)
# + main(api_key, mpan)
#