consumer modules

docs/samples/sample_consumer/sample_consumer/config.py

@@ -0,0 +1,30 @@
+from typing import List, Optional
+
+from control.consumer.consumer_data import ConsumerUsage
+from helpermodules.auto_str import auto_str
+from modules.common.consumer_setup import ConsumerSetup
+from ..vendor import vendor_descriptor
+
+
+@auto_str
+class SampleConsumerConfiguration:
+    def __init__(self,
+                 ip_address: Optional[str] = None,
+                 port: Optional[int] = 502,
+                 modbus_id: Optional[int] = 1):
+        self.ip_address = ip_address
+        self.port = port
+        self.modbus_id = modbus_id
+
+
+@auto_str
+class SampleConsumer(ConsumerSetup[SampleConsumerConfiguration]):
+    def __init__(self,
+                 name: str = "Sample Consumer",
+                 type: str = "sample_consumer",
+                 id: int = 0,
+                 configuration: SampleConsumerConfiguration = None,
+                 usage: List[ConsumerUsage] = [ConsumerUsage.SUSPENDABLE_TUNABLE,
+                                               ConsumerUsage.METER_ONLY]) -> None:
+        super().__init__(name, type, id, vendor=vendor_descriptor.configuration_factory(
+        ).type, configuration=configuration or SampleConsumerConfiguration(), usage=usage)

docs/samples/sample_consumer/sample_consumer/consumer.py

@@ -0,0 +1,88 @@
+#!/usr/bin/env python3
+from enum import IntEnum
+import logging
+from modules.common.abstract_consumer import CurrentValues
+from modules.common.abstract_device import DeviceDescriptor
+from modules.common.component_state import ConsumerState
+from modules.common.component_type import ComponentType
+from modules.common.configurable_consumer import ConfigurableConsumer, SetLimitData
+from modules.common.modbus import ModbusDataType, ModbusTcpClient_
+from modules.common.simcount._simcounter import SimCounterConsumer
+from modules.consumers.sample.sample.config import SampleConsumer
+
+log = logging.getLogger(__name__)
+
+
+class Register(IntEnum):
+    POWER = 1000
+    TEMP0 = 1001
+    TEMP1 = 1030
+    TEMP2 = 1031
+    STATUS = 1003
+
+
+REG_MAPPING = (
+    (Register.POWER, [ModbusDataType.INT_16]),
+    (Register.TEMP0, [ModbusDataType.INT_16]),
+    (Register.TEMP1, [ModbusDataType.INT_16]),
+    (Register.TEMP2, [ModbusDataType.INT_16]),
+    (Register.STATUS, ModbusDataType.INT_16),
+)
+
+
+def create_consumer(config: SampleConsumer):
+    client = None
+    sim_counter = None
+
+    def initializer():
+        nonlocal client, sim_counter
+        client = ModbusTcpClient_(config.configuration.ip_address, config.configuration.port)
+        sim_counter = SimCounterConsumer(config.id, ComponentType.CONSUMER)
+
+    def error_handler() -> None:
+        initializer()
+
+    def update() -> ConsumerState:
+        nonlocal client, sim_counter
+        resp = client.read_holding_registers_bulk(
+            Register.POWER, 35, mapping=REG_MAPPING, unit=config.configuration.modbus_id)
+        imported, exported = sim_counter.sim_count(resp[Register.POWER])
+        return ConsumerState(
+            power=resp[Register.POWER],
+            imported=imported,
+            exported=exported,
+            temperatures=[resp[Register.TEMP0]/10, resp[Register.TEMP1]/10, resp[Register.TEMP2]/10]
+        )
+
+    # ConsumerUsage.SUSPENDABLE_TUNABLE
+    def set_power_limit(power_limit: float, data: SetLimitData) -> None:
+        nonlocal client
+        client.write_registers(1000, power_limit, unit=config.configuration.modbus_id)
+
+    # ODER
+    # ConsumerUsage.SUSPENDABLE_ONOFF
+    # ConsumerUsage.CONTINUOUS
+    def switch_on() -> None:
+        nonlocal client
+        client.write_registers(1000, 1, unit=config.configuration.modbus_id)
+
+    def switch_off() -> None:
+        nonlocal client
+        client.write_registers(1000, 0, unit=config.configuration.modbus_id)
+
+    # ODER
+    # ConsumerUsage.SELF_CONTROLLED
+    def send_values(values: CurrentValues) -> None:
+        client.write_registers(1000, values.evu_power, unit=config.configuration.modbus_id)
+
+    return ConfigurableConsumer(consumer_config=config,
+                                initializer=initializer,
+                                error_handler=error_handler,
+                                update=update,
+                                send_values=send_values,
+                                set_power_limit=set_power_limit,
+                                switch_on=switch_on,
+                                switch_off=switch_off)
+
+
+device_descriptor = DeviceDescriptor(configuration_factory=SampleConsumer)

docs/samples/sample_consumer/vendor.py

@@ -0,0 +1,14 @@
+from pathlib import Path
+
+from modules.common.abstract_device import DeviceDescriptor
+from modules.devices.vendors import VendorGroup
+
+
+class Vendor:
+    def __init__(self):
+        self.type = Path(__file__).parent.name
+        self.vendor = "Sample"
+        self.group = VendorGroup.VENDORS.value
+
+
+vendor_descriptor = DeviceDescriptor(configuration_factory=Vendor)

packages/modules/consumers/askoma/askoheat/config.py

@@ -0,0 +1,31 @@
+from typing import Optional, Tuple
+
+from control.consumer.consumer_data import ConsumerUsage
+from helpermodules.auto_str import auto_str
+from modules.common.consumer_setup import ConsumerSetup
+from ..vendor import vendor_descriptor
+
+
+@auto_str
+class AskoheatConfiguration:
+    def __init__(self,
+                 ip_address: Optional[str] = None,
+                 port: int = 502,
+                 modbus_id: int = 1):
+        self.ip_address = ip_address
+        self.port = port
+        self.modbus_id = modbus_id
+
+
+@auto_str
+class Askoheat(ConsumerSetup[AskoheatConfiguration]):
+    def __init__(self,
+                 name: str = "Askoheat+",
+                 type: str = "askoheat",
+                 id: int = 0,
+                 configuration: Optional[AskoheatConfiguration] = None,
+                 usage: Tuple[ConsumerUsage, ...] = (ConsumerUsage.SUSPENDABLE_TUNABLE,
+                                                     ConsumerUsage.METER_ONLY),
+                 **kwargs) -> None:
+        super().__init__(name, type, id, vendor=vendor_descriptor.configuration_factory(
+        ).type, configuration=configuration or AskoheatConfiguration(), usage=usage, **kwargs)

packages/modules/consumers/askoma/askoheat/consumer.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python3
+import logging
+from typing import Optional
+from modules.common.abstract_device import DeviceDescriptor
+from modules.common.component_state import ConsumerState
+from modules.common.component_type import ComponentType
+from modules.common.configurable_consumer import ConfigurableConsumer, SetLimitData
+from modules.common.modbus import ModbusDataType, ModbusTcpClient_
+from modules.common.simcount._simcounter import SimCounterConsumer
+from modules.consumers.askoma.askoheat.config import Askoheat
+
+log = logging.getLogger(__name__)
+
+
+def create_consumer(config: Askoheat):
+    client: Optional[ModbusTcpClient_] = None
+    sim_counter: Optional[SimCounterConsumer] = None
+
+    def initializer():
+        nonlocal client, sim_counter
+        client = ModbusTcpClient_(config.configuration.ip_address, config.configuration.port)
+        sim_counter = SimCounterConsumer(config.id, ComponentType.CONSUMER)
+
+    def error_handler() -> None:
+        initializer()
+
+    def update() -> ConsumerState:
+        power = client.read_input_registers(110, ModbusDataType.INT_16, unit=config.configuration.modbus_id)
+        imported, exported = sim_counter.sim_count(power)
+        return ConsumerState(
+            power=power,
+            imported=imported,
+            exported=exported,
+            temperatures=[client.read_input_registers(638, ModbusDataType.INT_16, unit=config.configuration.modbus_id)]
+        )
+
+    def set_power_limit(power_limit: float, data: SetLimitData) -> None:
+        client.write_register(201, power_limit, unit=config.configuration.modbus_id)
+
+    return ConfigurableConsumer(consumer_config=config,
+                                initializer=initializer,
+                                error_handler=error_handler,
+                                update=update,
+                                set_power_limit=set_power_limit,)
+
+
+device_descriptor = DeviceDescriptor(configuration_factory=Askoheat)

packages/modules/consumers/askoma/vendor.py

@@ -0,0 +1,14 @@
+from pathlib import Path
+
+from modules.common.abstract_device import DeviceDescriptor
+from modules.devices.vendors import VendorGroup
+
+
+class Vendor:
+    def __init__(self):
+        self.type = Path(__file__).parent.name
+        self.vendor = "ASKOMA"
+        self.group = VendorGroup.VENDORS.value
+
+
+vendor_descriptor = DeviceDescriptor(configuration_factory=Vendor)

packages/modules/consumers/avm/avm/config.py

@@ -0,0 +1,36 @@
+from typing import Optional, Tuple
+from control.consumer.consumer_data import ConsumerUsage
+from helpermodules.auto_str import auto_str
+from modules.common.consumer_setup import ConsumerSetup
+from ..vendor import vendor_descriptor
+
+
+@auto_str
+class AvmConfiguration:
+    def __init__(self,
+                 ip_address: Optional[str] = None,
+                 username: Optional[str] = None,
+                 password: Optional[str] = None,
+                 session_id: Optional[str] = None,
+                 session_mtime: Optional[float] = None,
+                 name: Optional[str] = None) -> None:
+        self.ip_address = ip_address
+        self.username = username
+        self.password = password
+        self.session_id = session_id  # don't show in UI
+        self.session_mtime = session_mtime  # don't show in UI
+        self.name = name
+
+
+@auto_str
+class Avm(ConsumerSetup[AvmConfiguration]):
+    def __init__(self,
+                 name: str = "AVM Fritz!Box",
+                 type: str = "avm",
+                 id: int = 0,
+                 configuration: Optional[AvmConfiguration] = None,
+                 usage: Tuple[ConsumerUsage, ...] = (ConsumerUsage.SUSPENDABLE_TUNABLE,
+                                                     ConsumerUsage.METER_ONLY),
+                 **kwargs) -> None:
+        super().__init__(name, type, id, vendor=vendor_descriptor.configuration_factory(
+        ).type, configuration=configuration or AvmConfiguration(), usage=usage, **kwargs)