ciaran97 / esb-smart-meter-reading-automation

Automated Smart Meter readings data collection from ESB Ireland registred account (regardless of your current supply provider)

esb-smart-meter-reading-automation

How to read your Smart Meter data automatically?

Since I've got smart meter installed, I was looking for a way to automatically collect my meter data to track electricity usage (and solar export) with corresponding pricing as per current supplier rates.

While searching on internet I found this post https://www.boards.ie/discussion/2058292506/esb-smart-meter-data-script as potential candidate to start with.
Unfortunatelly linked script is broken - ESB have chnaged some URL's and file structure since then and I had to spend some time and tinker with code to make it working with new (as of writing it is 21-JUL-2023) URL structure.

End result - code is fixed and runs just fine now, I am able to read all smart meter readings from my account in JSON format and push it further to my InfluxDB and Home Assistant for analysis/reporting.

# Requirements
* You need to create account with ESB here https://myaccount.esbnetworks.ie
* In your account, link your electricity meter MPRN

# Script setup
* In script - update MPRN, user and password at the bottom of the code

I hope this will be usefull, cheers!

# #!/usr/bin/env python3

# https://www.boards.ie/discussion/2058292506/esb-smart-meter-data-script
# https://gist.github.com/schlan/f72d823dd5c1c1d19dfd784eb392dded

# Modified by badger707
# it works as of 21-JUL-2023

import requests
from bs4 import BeautifulSoup
import re
import json
import csv
from datetime import datetime, timedelta, timezone

def load_esb_data(user, password, mpnr, start_date):
  print("[+] open session ...")
  s = requests.Session()
  s.headers.update({
    'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36',
  })    
  print("[+] calling login page. ..")
  login_page = s.get('https://myaccount.esbnetworks.ie/', allow_redirects=True)
  result = re.findall(r"(?<=var SETTINGS = )\S*;", str(login_page.content))
  settings = json.loads(result[0][:-1])
  print("[+] sending credentials ...")
  s.post(
    'https://login.esbnetworks.ie/esbntwkscustportalprdb2c01.onmicrosoft.com/B2C_1A_signup_signin/SelfAsserted?tx=' + settings['transId'] + '&p=B2C_1A_signup_signin', 
    data={
      'signInName': user, 
      'password': password, 
      'request_type': 'RESPONSE'
    },
    headers={
      'x-csrf-token': settings['csrf'],
    },
    allow_redirects=False)
  print("[+] passing AUTH ...")
  confirm_login = s.get(
    'https://login.esbnetworks.ie/esbntwkscustportalprdb2c01.onmicrosoft.com/B2C_1A_signup_signin/api/CombinedSigninAndSignup/confirmed',
    params={
      'rememberMe': False,
      'csrf_token': settings['csrf'],
      'tx': settings['transId'],
      'p': 'B2C_1A_signup_signin',
    }
  )
  print("[+] confirm_login: ",confirm_login)
  print("[+] doing some BeautifulSoup ...")
  soup = BeautifulSoup(confirm_login.content, 'html.parser')
  form = soup.find('form', {'id': 'auto'})
  s.post(
    form['action'],
    allow_redirects=False,
    data={
      'state': form.find('input', {'name': 'state'})['value'],
      'client_info': form.find('input', {'name': 'client_info'})['value'],
      'code': form.find('input', {'name': 'code'})['value'],
    }, 
  )
  
  #data = s.get('https://myaccount.esbnetworks.ie/datadub/GetHdfContent?mprn=' + mpnr + '&startDate=' + start_date.strftime('%Y-%m-%d'))
  print("[+] getting CSV file for MPRN ...")
  data = s.get('https://myaccount.esbnetworks.ie/DataHub/DownloadHdf?mprn=' + mpnr + '&startDate=' + start_date.strftime('%Y-%m-%d'))

  print("[+] CSV file received !!!")
  data_decoded = data.content.decode('utf-8').splitlines()
  print("[+] data decoded from Binary format")
  json_data = csv_response_to_json(data_decoded)
  return json_data

def csv_response_to_json(csv_file):
  print("[+] creating JSON file from CSV ...")
  my_json = []
  csv_reader = csv.DictReader(csv_file)
  for row in csv_reader:
    my_json.append(row)
  with open("json_data.json","w",encoding="utf-8") as jsonf:
     json_out = json.dumps(my_json, indent=2)
     jsonf.write(json_out)
  print("[+] end of JSON OUT.",json_out)
  print("[+] end of JSON OUT, returning value ...")
  return json_out

def parse_date(date_str):
  print("[+] parsing some data fields ...")
  if len(date_str) == 19:
      return datetime.strptime(date_str, '%Y-%m-%dT%H:%M:%S')
  else:
      dt = datetime.strptime(date_str[:19], '%Y-%m-%dT%H:%M:%S')
      tz_offset = int(date_str[-6:-3])
      tz = timezone(timedelta(hours=tz_offset))
      return dt.replace(tzinfo=tz)

def load_smart_meter_stats_v2(user, password, mpnr):
  #last_month = datetime.today() - timedelta(days=30)
  today_ = datetime.today()
  #smart_meter_data = load_esb_data(user, password, mpnr, last_month)
  smart_meter_data = load_esb_data(user, password, mpnr, today_)
  print("[+] smart_meter_data: ",smart_meter_data)
  print("[++] end of smart_meter_data")
  return smart_meter_data

meter_mprn = "your-meter-mprn-number"
esb_user_name = "[email protected]"
esb_password = "your-esb-account-password"

xoxo = load_smart_meter_stats_v2(esb_user_name, esb_password, meter_mprn)
print("[XOXO]: ",xoxo)
print("[END] XOXO")