Module lib.electricmeter.config

Function define the configuration of the electric meter

# Distributed under Pycameresp License
# Copyright (c) 2023 Remi BERTHOLET
""" Function define the configuration of the electric meter """
# pylint:disable=anomalous-unicode-escape-in-string
import tools.jsonconfig
import tools.strings

class RateConfig(tools.jsonconfig.JsonConfig):
        """ Kwh rate configuration """
        def __init__(self):
                """ Constructor """
                tools.jsonconfig.JsonConfig.__init__(self)

                self.name = b""
                self.price = 0.0
                self.currency = b""
                self.validity_date = 0


class RatesConfig(tools.jsonconfig.JsonConfig):
        """ Rates list per kwh """
        config = None
        def __init__(self):
                """ Constructor """
                tools.jsonconfig.JsonConfig.__init__(self)
                self.rates = []

        def append(self, rate):
                """ Add new rate in the list """
                found = False
                rate = tools.strings.tobytes(rate)
                for current in self.rates:
                        if current[b"name"] == tools.strings.tobytes(rate.name) and current[b"validity_date"] == tools.strings.tobytes(rate.validity_date):
                                found = True
                                current[b"currency"] = tools.strings.tobytes(rate.currency)
                                current[b"price"] = rate.price
                                break
                if found is False:
                        self.rates.append(tools.strings.tobytes(rate.__dict__))

        def get(self, index):
                """ Return the rate at the index """
                try:
                        return self.rates[int(index)]
                except:
                        return None

        def remove(self, index):
                """ Remove the rate at the index """
                try:
                        del self.rates[int(index)]
                except:
                        pass

        def search_rates(self, day):
                """ Find the current rate """
                result = {}
                day = int(day)
                for rate in self.rates:
                        # If the rate is valid for the current date
                        if day >= rate[b"validity_date"]:
                                # If the same rate already found
                                if rate[b"name"] in result:
                                        # If the rate already found is older than the current rate
                                        if result[rate[b"name"]][b"validity_date"] < rate[b"validity_date"]:
                                                # Replace by the current rate
                                                result[rate[b"name"]] = rate
                                else:
                                        # Keep the current rate
                                        result[rate[b"name"]] = rate
                return result

        @staticmethod
        def get_config():
                """ Return the singleton configuration """
                if RatesConfig.config is None:
                        RatesConfig.config = RatesConfig()
                        RatesConfig.config.load()
                return RatesConfig.config


class TimeSlotConfig(tools.jsonconfig.JsonConfig):
        """ Time slot configuration """
        def __init__(self):
                """ Constructor """
                tools.jsonconfig.JsonConfig.__init__(self)
                self.rate       = b""
                self.start_time = 0
                self.end_time   = 0
                self.color      = b""

class TimeSlotsConfig(tools.jsonconfig.JsonConfig):
        """ Time slots list """
        config = None
        def __init__(self):
                """ Constructor """
                tools.jsonconfig.JsonConfig.__init__(self)
                self.time_slots = []

        def append(self, time_slot):
                """ Add new time slot in the list """
                found = False
                time_slot = tools.strings.tobytes(time_slot)
                for current in self.time_slots:
                        if current[b"start_time"] == time_slot.start_time and current[b"end_time"]   == time_slot.end_time:
                                current[b"color"] = time_slot.color
                                current[b"rate"]  = time_slot.rate
                                found = True
                                break
                if found is False:
                        self.time_slots.append(tools.strings.tobytes(time_slot.__dict__))

        def get(self, index):
                """ Return the time slot at the index """
                try:
                        return self.time_slots[int(index)]
                except:
                        return None

        def remove(self, index):
                """ Remove the time slot at the index """
                try:
                        del self.time_slots[int(index)]
                except:
                        pass

        def get_prices(self, rates):
                """ Return the list of prices according to the day """
                if rates == {}:
                        result = [{b'rate': b'', b'start_time': 0, b'end_time': 86340, b'color': b'#5498e0', b'price': 0, b'currency': b'not initialized'}]
                else:
                        result = self.time_slots[:]
                        for time_slot in result:
                                time_slot[b"price"]    = rates[time_slot[b"rate"]][b"price"]
                                time_slot[b"currency"] = rates[time_slot[b"rate"]][b"currency"]
                return result

        @staticmethod
        def get_config():
                """ Return the singleton configuration """
                if TimeSlotsConfig.config is None:
                        TimeSlotsConfig.config = TimeSlotsConfig()
                        TimeSlotsConfig.config.load()
                return TimeSlotsConfig.config

        @staticmethod
        def get_cost(day):
                """ Get the cost according to the day selected """
                time_slots = TimeSlotsConfig.get_config()
                rates      = RatesConfig.get_config()
                return time_slots.get_prices(rates.search_rates(day))

        @staticmethod
        def create_empty_slot(size):
                """ Create empty time slot """
                time_slots = TimeSlotsConfig()
                time_slots.load()
                slot_pulses = {}
                index = 0
                while True:
                        time_slot = time_slots.get(index)
                        if time_slot is None:
                                break
                        slot_pulses[(time_slot[b"start_time"], time_slot[b"end_time"])] = [0]*size
                        index += 1
                if len(slot_pulses) == 0:
                        slot_pulses[(0,1439*60)] = [0]*size
                return slot_pulses


class GeolocationConfig(tools.jsonconfig.JsonConfig):
        """ Geolocation configuration """
        config = None
        def __init__(self):
                """ Constructor """
                tools.jsonconfig.JsonConfig.__init__(self)
                self.latitude  = 44.93
                self.longitude = 4.87

        @staticmethod
        def get_config():
                """ Return the singleton configuration """
                if GeolocationConfig.config is None:
                        GeolocationConfig.config = GeolocationConfig()
                        GeolocationConfig.config.load()
                return GeolocationConfig.config

Classes

class GeolocationConfig

Geolocation configuration

Constructor

Expand source code

class GeolocationConfig(tools.jsonconfig.JsonConfig):
        """ Geolocation configuration """
        config = None
        def __init__(self):
                """ Constructor """
                tools.jsonconfig.JsonConfig.__init__(self)
                self.latitude  = 44.93
                self.longitude = 4.87

        @staticmethod
        def get_config():
                """ Return the singleton configuration """
                if GeolocationConfig.config is None:
                        GeolocationConfig.config = GeolocationConfig()
                        GeolocationConfig.config.load()
                return GeolocationConfig.config

Ancestors

• tools.jsonconfig.JsonConfig

Class variables

var config

Static methods

def get_config()

Return the singleton configuration

Expand source code

@staticmethod
def get_config():
        """ Return the singleton configuration """
        if GeolocationConfig.config is None:
                GeolocationConfig.config = GeolocationConfig()
                GeolocationConfig.config.load()
        return GeolocationConfig.config

class RateConfig

Kwh rate configuration

Constructor

Expand source code

class RateConfig(tools.jsonconfig.JsonConfig):
        """ Kwh rate configuration """
        def __init__(self):
                """ Constructor """
                tools.jsonconfig.JsonConfig.__init__(self)

                self.name = b""
                self.price = 0.0
                self.currency = b""
                self.validity_date = 0

Ancestors

• tools.jsonconfig.JsonConfig

class RatesConfig

Rates list per kwh

Constructor

Expand source code

class RatesConfig(tools.jsonconfig.JsonConfig):
        """ Rates list per kwh """
        config = None
        def __init__(self):
                """ Constructor """
                tools.jsonconfig.JsonConfig.__init__(self)
                self.rates = []

        def append(self, rate):
                """ Add new rate in the list """
                found = False
                rate = tools.strings.tobytes(rate)
                for current in self.rates:
                        if current[b"name"] == tools.strings.tobytes(rate.name) and current[b"validity_date"] == tools.strings.tobytes(rate.validity_date):
                                found = True
                                current[b"currency"] = tools.strings.tobytes(rate.currency)
                                current[b"price"] = rate.price
                                break
                if found is False:
                        self.rates.append(tools.strings.tobytes(rate.__dict__))

        def get(self, index):
                """ Return the rate at the index """
                try:
                        return self.rates[int(index)]
                except:
                        return None

        def remove(self, index):
                """ Remove the rate at the index """
                try:
                        del self.rates[int(index)]
                except:
                        pass

        def search_rates(self, day):
                """ Find the current rate """
                result = {}
                day = int(day)
                for rate in self.rates:
                        # If the rate is valid for the current date
                        if day >= rate[b"validity_date"]:
                                # If the same rate already found
                                if rate[b"name"] in result:
                                        # If the rate already found is older than the current rate
                                        if result[rate[b"name"]][b"validity_date"] < rate[b"validity_date"]:
                                                # Replace by the current rate
                                                result[rate[b"name"]] = rate
                                else:
                                        # Keep the current rate
                                        result[rate[b"name"]] = rate
                return result

        @staticmethod
        def get_config():
                """ Return the singleton configuration """
                if RatesConfig.config is None:
                        RatesConfig.config = RatesConfig()
                        RatesConfig.config.load()
                return RatesConfig.config

Ancestors

• tools.jsonconfig.JsonConfig

Class variables

var config

Static methods

def get_config()

Return the singleton configuration

Expand source code

@staticmethod
def get_config():
        """ Return the singleton configuration """
        if RatesConfig.config is None:
                RatesConfig.config = RatesConfig()
                RatesConfig.config.load()
        return RatesConfig.config

Methods

def append(self, rate)

Add new rate in the list

Expand source code

def append(self, rate):
        """ Add new rate in the list """
        found = False
        rate = tools.strings.tobytes(rate)
        for current in self.rates:
                if current[b"name"] == tools.strings.tobytes(rate.name) and current[b"validity_date"] == tools.strings.tobytes(rate.validity_date):
                        found = True
                        current[b"currency"] = tools.strings.tobytes(rate.currency)
                        current[b"price"] = rate.price
                        break
        if found is False:
                self.rates.append(tools.strings.tobytes(rate.__dict__))

def get(self, index)

Return the rate at the index

Expand source code

def get(self, index):
        """ Return the rate at the index """
        try:
                return self.rates[int(index)]
        except:
                return None

def remove(self, index)

Remove the rate at the index

Expand source code

def remove(self, index):
        """ Remove the rate at the index """
        try:
                del self.rates[int(index)]
        except:
                pass

def search_rates(self, day)

Find the current rate

Expand source code

def search_rates(self, day):
        """ Find the current rate """
        result = {}
        day = int(day)
        for rate in self.rates:
                # If the rate is valid for the current date
                if day >= rate[b"validity_date"]:
                        # If the same rate already found
                        if rate[b"name"] in result:
                                # If the rate already found is older than the current rate
                                if result[rate[b"name"]][b"validity_date"] < rate[b"validity_date"]:
                                        # Replace by the current rate
                                        result[rate[b"name"]] = rate
                        else:
                                # Keep the current rate
                                result[rate[b"name"]] = rate
        return result

class TimeSlotConfig

Time slot configuration

Constructor

Expand source code

class TimeSlotConfig(tools.jsonconfig.JsonConfig):
        """ Time slot configuration """
        def __init__(self):
                """ Constructor """
                tools.jsonconfig.JsonConfig.__init__(self)
                self.rate       = b""
                self.start_time = 0
                self.end_time   = 0
                self.color      = b""

Ancestors

• tools.jsonconfig.JsonConfig

class TimeSlotsConfig

Time slots list

Constructor

Expand source code

class TimeSlotsConfig(tools.jsonconfig.JsonConfig):
        """ Time slots list """
        config = None
        def __init__(self):
                """ Constructor """
                tools.jsonconfig.JsonConfig.__init__(self)
                self.time_slots = []

        def append(self, time_slot):
                """ Add new time slot in the list """
                found = False
                time_slot = tools.strings.tobytes(time_slot)
                for current in self.time_slots:
                        if current[b"start_time"] == time_slot.start_time and current[b"end_time"]   == time_slot.end_time:
                                current[b"color"] = time_slot.color
                                current[b"rate"]  = time_slot.rate
                                found = True
                                break
                if found is False:
                        self.time_slots.append(tools.strings.tobytes(time_slot.__dict__))

        def get(self, index):
                """ Return the time slot at the index """
                try:
                        return self.time_slots[int(index)]
                except:
                        return None

        def remove(self, index):
                """ Remove the time slot at the index """
                try:
                        del self.time_slots[int(index)]
                except:
                        pass

        def get_prices(self, rates):
                """ Return the list of prices according to the day """
                if rates == {}:
                        result = [{b'rate': b'', b'start_time': 0, b'end_time': 86340, b'color': b'#5498e0', b'price': 0, b'currency': b'not initialized'}]
                else:
                        result = self.time_slots[:]
                        for time_slot in result:
                                time_slot[b"price"]    = rates[time_slot[b"rate"]][b"price"]
                                time_slot[b"currency"] = rates[time_slot[b"rate"]][b"currency"]
                return result

        @staticmethod
        def get_config():
                """ Return the singleton configuration """
                if TimeSlotsConfig.config is None:
                        TimeSlotsConfig.config = TimeSlotsConfig()
                        TimeSlotsConfig.config.load()
                return TimeSlotsConfig.config

        @staticmethod
        def get_cost(day):
                """ Get the cost according to the day selected """
                time_slots = TimeSlotsConfig.get_config()
                rates      = RatesConfig.get_config()
                return time_slots.get_prices(rates.search_rates(day))

        @staticmethod
        def create_empty_slot(size):
                """ Create empty time slot """
                time_slots = TimeSlotsConfig()
                time_slots.load()
                slot_pulses = {}
                index = 0
                while True:
                        time_slot = time_slots.get(index)
                        if time_slot is None:
                                break
                        slot_pulses[(time_slot[b"start_time"], time_slot[b"end_time"])] = [0]*size
                        index += 1
                if len(slot_pulses) == 0:
                        slot_pulses[(0,1439*60)] = [0]*size
                return slot_pulses

Ancestors

• tools.jsonconfig.JsonConfig

Class variables

var config

Static methods

def create_empty_slot(size)

Create empty time slot

Expand source code

@staticmethod
def create_empty_slot(size):
        """ Create empty time slot """
        time_slots = TimeSlotsConfig()
        time_slots.load()
        slot_pulses = {}
        index = 0
        while True:
                time_slot = time_slots.get(index)
                if time_slot is None:
                        break
                slot_pulses[(time_slot[b"start_time"], time_slot[b"end_time"])] = [0]*size
                index += 1
        if len(slot_pulses) == 0:
                slot_pulses[(0,1439*60)] = [0]*size
        return slot_pulses

def get_config()

Return the singleton configuration

Expand source code

@staticmethod
def get_config():
        """ Return the singleton configuration """
        if TimeSlotsConfig.config is None:
                TimeSlotsConfig.config = TimeSlotsConfig()
                TimeSlotsConfig.config.load()
        return TimeSlotsConfig.config

def get_cost(day)

Get the cost according to the day selected

Expand source code

@staticmethod
def get_cost(day):
        """ Get the cost according to the day selected """
        time_slots = TimeSlotsConfig.get_config()
        rates      = RatesConfig.get_config()
        return time_slots.get_prices(rates.search_rates(day))

Methods

def append(self, time_slot)

Add new time slot in the list

Expand source code

def append(self, time_slot):
        """ Add new time slot in the list """
        found = False
        time_slot = tools.strings.tobytes(time_slot)
        for current in self.time_slots:
                if current[b"start_time"] == time_slot.start_time and current[b"end_time"]   == time_slot.end_time:
                        current[b"color"] = time_slot.color
                        current[b"rate"]  = time_slot.rate
                        found = True
                        break
        if found is False:
                self.time_slots.append(tools.strings.tobytes(time_slot.__dict__))

def get(self, index)

Return the time slot at the index

Expand source code

def get(self, index):
        """ Return the time slot at the index """
        try:
                return self.time_slots[int(index)]
        except:
                return None

def get_prices(self, rates)

Return the list of prices according to the day

Expand source code

def get_prices(self, rates):
        """ Return the list of prices according to the day """
        if rates == {}:
                result = [{b'rate': b'', b'start_time': 0, b'end_time': 86340, b'color': b'#5498e0', b'price': 0, b'currency': b'not initialized'}]
        else:
                result = self.time_slots[:]
                for time_slot in result:
                        time_slot[b"price"]    = rates[time_slot[b"rate"]][b"price"]
                        time_slot[b"currency"] = rates[time_slot[b"rate"]][b"currency"]
        return result

def remove(self, index)

Remove the time slot at the index

Expand source code

def remove(self, index):
        """ Remove the time slot at the index """
        try:
                del self.time_slots[int(index)]
        except:
                pass