Suggestion for correction

[Gugulator]

Thanks for a such great tool.
I made a couple changes.

1st: added all power tariffs from website kamaze.co.il
2nd: result now sorted by descending of discount, and separately displays top 3 best options.

Main file

import asyncio
import json
import websockets
import datetime
import logging
import os
import argparse
from dotenv import load_dotenv
from collections import defaultdict

load_dotenv()

logging.basicConfig(level=logging.INFO, format='%(message)s')
logger = logging.getLogger(__name__)

class EnergyPlan:
    def __init__(self, name, hours, days, discount):
        self.name = name
        self.hours = hours
        self.days = days
        self.discount = discount

class HomeAssistantClient:
    def __init__(self, url, access_token, sensor_ids):
        self.url = url
        self.access_token = access_token
        self.sensor_ids = sensor_ids
        self.message_id = 1

    async def connect(self):
        try:
            self.websocket = await websockets.connect(f"{self.url}/api/websocket")
            await self.authenticate()
        except Exception as e:
            logger.error(f"Connection failed: {str(e)}")
            raise

    async def authenticate(self):
        auth_required = await self.websocket.recv()
        auth_required_data = json.loads(auth_required)
        
        if auth_required_data["type"] != "auth_required":
            raise Exception("Unexpected first message")

        auth_message = {
            "type": "auth",
            "access_token": self.access_token
        }
        await self.websocket.send(json.dumps(auth_message))
        
        auth_ok = await self.websocket.recv()
        auth_ok_data = json.loads(auth_ok)
        
        if auth_ok_data["type"] != "auth_ok":
            error_msg = auth_ok_data.get("message", "Unknown error")
            raise Exception(f"Authentication failed: {error_msg}")

    async def get_energy_data(self, start_time, end_time):
        message = {
            "id": self.message_id,
            "type": "recorder/statistics_during_period",
            "start_time": start_time.isoformat(),
            "end_time": end_time.isoformat(),
            "statistic_ids": self.sensor_ids,
            "period": "hour",
            "types": ["change"],
            "units": {"energy": "kWh"}
        }
        
        await self.websocket.send(json.dumps(message))
        response = await self.websocket.recv()
        data = json.loads(response)
        
        if not data.get("success", False):
            error_msg = data.get("error", {}).get("message", "Unknown error")
            raise Exception(f"API request failed: {error_msg}")
        
        return data["result"]

    async def close(self):
        if hasattr(self, 'websocket'):
            await self.websocket.close()

def parse_timestamp(timestamp):
    if isinstance(timestamp, int):
        return datetime.datetime.fromtimestamp(timestamp / 1000)
    elif isinstance(timestamp, str):
        return datetime.datetime.fromisoformat(timestamp.rstrip('Z'))
    else:
        raise ValueError(f"Unexpected timestamp format: {timestamp}")

def calculate_discount(consumption, plans, universal_tariff):
    discounts = {}
    for plan in plans:
        plan_discount = 0
        for day, hourly_consumption in consumption.items():
            if day in plan.days:
                for hour, amount in hourly_consumption.items():
                    if hour in plan.hours:
                        plan_discount += amount * universal_tariff * plan.discount
        discounts[plan.name] = plan_discount
    return discounts

def parse_plan(plan_str):
    name, hours, days, discount = plan_str.split('|')
    hours = parse_hour_range(hours)
    days = parse_day_range(days)
    discount = float(discount)
    return EnergyPlan(name, hours, days, discount)

def parse_day_range(day_str):
    days_of_week = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']
    days = []
    for part in day_str.split(','):
        if '-' in part:
            start, end = part.split('-')
            start_index = days_of_week.index(start)
            end_index = days_of_week.index(end)
            if start_index <= end_index:
                days.extend(days_of_week[start_index:end_index+1])
            else:
                days.extend(days_of_week[start_index:] + days_of_week[:end_index+1])
        else:
            days.append(part)
    return days

def parse_hour_range(hour_str):
    hours = []
    for part in hour_str.split(','):
        if '-' in part:
            start, end = map(int, part.split('-'))
            hours.extend(range(start, end + 1))
        else:
            hours.append(int(part))
    return hours

def plot_ascii_bar_chart(data, max_width=50):
    max_value = max(data.values())
    scale = max_width / max_value if max_value > 0 else 1

    logger.info("")
    logger.info("Hourly consumption (kWh):")
    logger.info("Hour |   kWh | Chart")
    logger.info("-" * (11 + max_width))

    for hour in range(24):
        value = data.get(hour, 0)
        bar_width = int(value * scale)
        bar = '█' * bar_width
        logger.info(f"{hour:02d}:00 | {value:5.2f} | {bar}")

async def main(month=None, year=None):
    ha_url = os.getenv('HA_URL')
    access_token = os.getenv('HA_ACCESS_TOKEN')
    sensor_ids = os.getenv('HA_SENSOR_IDS').split(',')
    universal_tariff = float(os.getenv('UNIVERSAL_TARIFF', '0.15'))  # Default to 0.15 NIS per kWh if not specified

    if not all([ha_url, access_token, sensor_ids]):
        logger.error("Missing required environment variables. Please check your .env file.")
        return

    # Parse energy plans from environment variables
    plans = []
    plan_index = 1
    while True:
        plan_str = os.getenv(f'ENERGY_PLAN_{plan_index}')
        if not plan_str:
            break
        plans.append(parse_plan(plan_str))
        plan_index += 1

    if not plans:
        logger.error("No energy plans defined. Please check your .env file.")
        return

    client = HomeAssistantClient(
        url=ha_url,
        access_token=access_token,
        sensor_ids=sensor_ids
    )
    
    try:
        await client.connect()
        
        # Determine start and end dates based on input
        now = datetime.datetime.now()
        if month is None:
            start_date = now.replace(day=1, hour=0, minute=0, second=0, microsecond=0)
            end_date = now
        else:
            year = year or now.year
            start_date = datetime.datetime(year, month, 1)
            if month == 12:
                end_date = datetime.datetime(year + 1, 1, 1) - datetime.timedelta(seconds=1)
            else:
                end_date = datetime.datetime(year, month + 1, 1) - datetime.timedelta(seconds=1)
        
        energy_data = await client.get_energy_data(start_date, end_date)
        
        weekly_hourly_totals = defaultdict(float)
        consumption_by_day_hour = defaultdict(lambda: defaultdict(float))
        
        for sensor_id, sensor_data in energy_data.items():
            for entry in sensor_data:
                try:
                    timestamp = parse_timestamp(entry['start'])
                    day_of_week = timestamp.strftime('%A')
                    hour = timestamp.hour
                    consumption = entry['change']
                    
                    weekly_hourly_totals[hour] += consumption
                    consumption_by_day_hour[day_of_week][hour] += consumption
                except (KeyError, ValueError) as e:
                    logger.error(f"Error processing entry: {entry}. Error: {str(e)}")

        # Generate report
        logger.info(f"Energy consumption from {start_date.date()} to {end_date.date()}")
        logger.info(f"Number of days: {(end_date.date() - start_date.date()).days + 1}")
        
        plot_ascii_bar_chart(weekly_hourly_totals)

        total_consumption = sum(weekly_hourly_totals.values())
        logger.info(f"\nTotal energy consumption: {total_consumption:.3f} kWh")

        discounts = calculate_discount(consumption_by_day_hour, plans, universal_tariff)

        # Sorting discounts by descending
        sorted_discounts = sorted(discounts.items(), key=lambda x: x[1], reverse=True)

        # Output of 3 best tariffs
        logger.info("\nTop 3 Best Discounts (NIS):")
        for plan_name, discount in sorted_discounts[:3]:
            logger.info(f"{plan_name}: {discount:.2f}")

        # Output empty line as divider
        logger.info("\nOther Discounts (NIS):")

        # Output rest of tariffs
        for plan_name, discount in sorted_discounts[3:]:
            logger.info(f"{plan_name}: {discount:.2f}")

        best_discount = sorted_discounts[0][1]
        total_cost = total_consumption * universal_tariff - best_discount
        
        logger.info(f"Total cost before discount: {total_consumption * universal_tariff:.2f} NIS")
        logger.info(f"Best discount applied: {best_discount:.2f} NIS")
        logger.info(f"Total cost after best discount: {total_cost:.2f} NIS")
        
    except Exception as e:
        logger.error(f"An error occurred: {str(e)}")
    finally:
        await client.close()

if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="Generate energy consumption report.")
    parser.add_argument("--month", type=int, choices=range(1, 13), help="Month (1-12)")
    parser.add_argument("--year", type=int, help="Year (e.g., 2023)")
    args = parser.parse_args()

    asyncio.run(main(args.month, args.year))

Config File

HA_URL=ws://homeassistant.local:8123
HA_ACCESS_TOKEN=your_long_lived_access_token
HA_SENSOR_IDS=sensor.shellyem3_x_channel_a_energy,sensor.shellyem3_x_channel_b_energy,sensor.shellyem3_x_channel_c_energy
UNIVERSAL_TARIFF=0.6145
ENERGY_PLAN_1=Cellcom Flat|0-23|Sunday-Saturday|0.05
ENERGY_PLAN_2=Cellcom Day|7-16|Sunday-Thursday|0.15
ENERGY_PLAN_3=Cellcom Family|14-19|Sunday-Saturday|0.18
ENERGY_PLAN_4=Cellcom Night|23,0-6|Sunday-Saturday|0.20

# Electra Power - Hi-Tech plan
# 23:00 - 17:00, discount depends on the subscription year
ENERGY_PLAN_5=Electra Hi-Tech Year 1|23,0-17|Sunday-Saturday|0.08
ENERGY_PLAN_6=Electra Hi-Tech Year 2|23,0-17|Sunday-Saturday|0.09
ENERGY_PLAN_7=Electra Hi-Tech Year 3+|23,0-17|Sunday-Saturday|0.10

# Electra Power - POWER plan
# 24/7, discount depends on the subscription year
ENERGY_PLAN_8=Electra Power Year 1|0-23|Sunday-Saturday|0.05
ENERGY_PLAN_9=Electra Power Year 2|0-23|Sunday-Saturday|0.06
ENERGY_PLAN_10=Electra Power Year 3+|0-23|Sunday-Saturday|0.07

# Electra Power - Night plan
# 23:00 - 07:00, fixed 20% discount
ENERGY_PLAN_11=Electra Night|23,0-7|Sunday-Saturday|0.20

# HOT Energy - Save Constant NEXT plan
# For NEXT Double customers only, 24/7 coverage
# Fixed 6% discount
ENERGY_PLAN_12=HOT Save Constant NEXT|0-23|Sunday-Saturday|0.06

# HOT Energy - e-Triple plan
# Discount for HOT Triple and HOT Mobile customers only
# Applies 24/7, fixed 10% discount
ENERGY_PLAN_13=HOT e-Triple|0-23|Sunday-Saturday|0.10

# HOT Energy - Save at Night plan
# Applies from 23:00 to 07:00, Sunday-Thursday
# Fixed 20% discount during nighttime
ENERGY_PLAN_14=HOT Save at Night|23,0-7|Sunday-Thursday|0.20

# HOT Energy - Save 24/7 plan
# 24/7, discount depends on the subscription year
ENERGY_PLAN_15=HOT Save 24/7 Year 1|0-23|Sunday-Saturday|0.05
ENERGY_PLAN_16=HOT Save 24/7 Year 2|0-23|Sunday-Saturday|0.06
ENERGY_PLAN_17=HOT Save 24/7 Year 3+|0-23|Sunday-Saturday|0.07

# HOT Energy - Save at Day plan
# Applies from 07:00 to 17:00, Sunday-Thursday
# Fixed 15% discount during daytime
ENERGY_PLAN_18=HOT Save at Day|7-17|Sunday-Thursday|0.15

# HOT Energy - Save Constant HOT plan
# For HOT Triple customers only, applies 24/7
# Fixed 7% discount
ENERGY_PLAN_19=HOT Save Constant HOT|0-23|Sunday-Saturday|0.07

# AmIsraGas - Constant Savings plan
# Fixed 6.5% discount, applies 24/7
ENERGY_PLAN_20=AmIsraGas Constant Savings|0-23|Sunday-Saturday|0.065

# AmIsraGas - Constant Savings for AmIsraGas Customers plan
# Fixed 7% discount for AmIsraGas customers, applies 24/7
ENERGY_PLAN_21=AmIsraGas Constant Savings (AmIsraGas Customers)|0-23|Sunday-Saturday|0.07

# Bezeq Energy - Smart Savings 24/7 plan
# Fixed 7% discount, applies 24/7
ENERGY_PLAN_22=Bezeq Smart Savings 24/7|0-23|Sunday-Saturday|0.07

# Bezeq Energy - Smart Savings at Night plan
# Fixed 20% discount during nighttime from 23:00 to 07:00, Sunday-Thursday
ENERGY_PLAN_23=Bezeq Smart Savings Night|23,0-7|Sunday-Thursday|0.20

# Bezeq Energy - Smart Savings at Day plan
# Fixed 15% discount during daytime from 07:00 to 17:00, Sunday-Thursday
ENERGY_PLAN_24=Bezeq Smart Savings Day|7-17|Sunday-Thursday|0.15

# PazGas - Discount 24/7 plan
# Fixed 7% discount, applies 24/7
ENERGY_PLAN_25=PazGas Discount 24/7|0-23|Sunday-Saturday|0.07

# PazGas - Accumulation to Yellow Wallet plan
# 10% of the payment accumulates to the Yellow Wallet app, applies 24/7
# Maximum accumulation: 50 NIS per month and 600 NIS per year
ENERGY_PLAN_26=PazGas Yellow Wallet|0-23|Sunday-Saturday|0.10

# Partner Power - Constant Discount All Day plan
# Discount depends on the subscription year, applies 24/7
ENERGY_PLAN_27=Partner Constant Discount Year 1|0-23|Sunday-Saturday|0.05
ENERGY_PLAN_28=Partner Constant Discount Year 2|0-23|Sunday-Saturday|0.06
ENERGY_PLAN_29=Partner Constant Discount Year 3+|0-23|Sunday-Saturday|0.07

# Partner Power - Night Owls plan
# Fixed 20% discount during nighttime from 23:00 to 07:00, Sunday-Thursday
ENERGY_PLAN_30=Partner Night Owls|23,0-7|Sunday-Thursday|0.20

# Partner Power - Work from Home plan
# Fixed 15% discount during daytime from 07:00 to 17:00, Sunday-Thursday
ENERGY_PLAN_31=Partner Work from Home|7-17|Sunday-Thursday|0.15