1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
|
from __future__ import annotations
import logging
from abc import ABC, abstractmethod
from dataclasses import dataclass
from enum import Enum, IntEnum
from typing import Any, Callable, Dict, Tuple, Optional
from .exceptions import MaxRetriesException, RequestFailedException
from .protocol import InverterProtocol, ProtocolCommand, ProtocolResponse, TcpInverterProtocol, UdpInverterProtocol
logger = logging.getLogger(__name__)
class SensorKind(Enum):
"""
Enumeration of sensor kinds.
Possible values are:
PV - inverter photo-voltaic (e.g. dc voltage of pv panels)
AC - inverter grid output (e.g. ac voltage of grid connected output)
UPS - inverter ups/eps/backup output (e.g. ac voltage of backup/off-grid connected output)
BAT - battery (e.g. dc voltage of connected battery pack)
GRID - power grid/smart meter (e.g. active power exported to grid)
BMS - BMS direct data (e.g. dc voltage of)
"""
PV = 1
AC = 2
UPS = 3
BAT = 4
GRID = 5
BMS = 6
@dataclass
class Sensor:
"""Definition of inverter sensor and its attributes"""
id_: str
offset: int
name: str
size_: int
unit: str
kind: Optional[SensorKind]
def read_value(self, data: ProtocolResponse) -> Any:
"""Read the sensor value from data at current position"""
raise NotImplementedError()
def read(self, data: ProtocolResponse) -> Any:
"""Read the sensor value from data (at sensor offset)"""
data.seek(self.offset)
return self.read_value(data)
def encode_value(self, value: Any, register_value: bytes = None) -> bytes:
"""Encode the (setting mostly) value to (usually) 2 bytes raw register value"""
raise NotImplementedError()
class OperationMode(IntEnum):
"""
Enumeration of sensor kinds.
Possible values are:
GENERAL - General mode
OFF_GRID - Off grid mode
BACKUP - Backup mode
ECO - Eco mode
PEAK_SHAVING - Peak shaving mode
ECO_CHARGE - Eco mode with a single "Charge" group valid all the time (from 00:00-23:59, Mon-Sun)
ECO_DISCHARGE - Eco mode with a single "Discharge" group valid all the time (from 00:00-23:59, Mon-Sun)
"""
GENERAL = 0
OFF_GRID = 1
BACKUP = 2
ECO = 3
PEAK_SHAVING = 4
SELF_USE = 5
ECO_CHARGE = 98
ECO_DISCHARGE = 99
class Inverter(ABC):
"""
Common superclass for various inverter models implementations.
Represents the inverter state and its basic behavior
"""
def __init__(self, host: str, port: int, comm_addr: int = 0, timeout: int = 1, retries: int = 3):
self._protocol: InverterProtocol = self._create_protocol(host, port, comm_addr, timeout, retries)
self._consecutive_failures_count: int = 0
self.model_name: str | None = None
self.serial_number: str | None = None
self.rated_power: int = 0
self.ac_output_type: int | None = None
self.firmware: str | None = None
self.arm_firmware: str | None = None
self.modbus_version: int | None = None
self.dsp1_version: int = 0
self.dsp2_version: int = 0
self.dsp_svn_version: int | None = None
self.arm_version: int = 0
self.arm_svn_version: int | None = None
def _read_command(self, offset: int, count: int) -> ProtocolCommand:
"""Create read protocol command."""
return self._protocol.read_command(offset, count)
def _write_command(self, register: int, value: int) -> ProtocolCommand:
"""Create write protocol command."""
return self._protocol.write_command(register, value)
def _write_multi_command(self, offset: int, values: bytes) -> ProtocolCommand:
"""Create write multiple protocol command."""
return self._protocol.write_multi_command(offset, values)
async def _read_from_socket(self, command: ProtocolCommand) -> ProtocolResponse:
try:
result = await command.execute(self._protocol)
self._consecutive_failures_count = 0
return result
except MaxRetriesException:
self._consecutive_failures_count += 1
raise RequestFailedException(f'No valid response received even after {self._protocol.retries} retries',
self._consecutive_failures_count) from None
except RequestFailedException as ex:
self._consecutive_failures_count += 1
raise RequestFailedException(ex.message, self._consecutive_failures_count) from None
def set_keep_alive(self, keep_alive: bool) -> None:
self._protocol.keep_alive = keep_alive
@abstractmethod
async def read_device_info(self):
"""
Request the device information from the inverter.
The inverter instance variables will be loaded with relevant data.
"""
raise NotImplementedError()
@abstractmethod
async def read_runtime_data(self) -> Dict[str, Any]:
"""
Request the runtime data from the inverter.
Answer dictionary of individual sensors and their values.
List of supported sensors (and their definitions) is provided by sensors() method.
"""
raise NotImplementedError()
@abstractmethod
async def read_setting(self, setting_id: str) -> Any:
"""
Read the value of specific inverter setting/configuration parameter.
Setting must be in list provided by settings() method, otherwise ValueError is raised.
"""
raise NotImplementedError()
@abstractmethod
async def write_setting(self, setting_id: str, value: Any):
"""
Set the value of specific inverter settings/configuration parameter.
Setting must be in list provided by settings() method, otherwise ValueError is raised.
BEWARE !!!
This method modifies inverter operational parameter (usually accessible to installers only).
Use with caution and at your own risk !
"""
raise NotImplementedError()
@abstractmethod
async def read_settings_data(self) -> Dict[str, Any]:
"""
Request the settings data from the inverter.
Answer dictionary of individual settings and their values.
List of supported settings (and their definitions) is provided by settings() method.
"""
raise NotImplementedError()
async def send_command(
self, command: bytes, validator: Callable[[bytes], bool] = lambda x: True
) -> ProtocolResponse:
"""
Send low level command (as bytes).
Answer ProtocolResponse with command's raw response data.
"""
return await self._read_from_socket(ProtocolCommand(command, validator))
@abstractmethod
async def get_grid_export_limit(self) -> int:
"""
Get the current grid export limit in W
"""
raise NotImplementedError()
@abstractmethod
async def set_grid_export_limit(self, export_limit: int) -> None:
"""
BEWARE !!!
This method modifies inverter operational parameter accessible to installers only.
Use with caution and at your own risk !
Set the grid export limit in W
"""
raise NotImplementedError()
@abstractmethod
async def get_operation_modes(self, include_emulated: bool) -> Tuple[OperationMode, ...]:
"""
Answer list of supported inverter operation modes
"""
return ()
@abstractmethod
async def get_operation_mode(self) -> OperationMode:
"""
Get the inverter operation mode
"""
raise NotImplementedError()
@abstractmethod
async def set_operation_mode(self, operation_mode: OperationMode, eco_mode_power: int = 100,
eco_mode_soc: int = 100) -> None:
"""
BEWARE !!!
This method modifies inverter operational parameter accessible to installers only.
Use with caution and at your own risk !
Set the inverter operation mode
The modes ECO_CHARGE and ECO_DISCHARGE are not real inverter operation modes, but a convenience
shortcuts to enter Eco Mode with a single group valid all the time (from 00:00-23:59, Mon-Sun)
charging or discharging with optional charging power and SoC (%) parameters.
"""
raise NotImplementedError()
@abstractmethod
async def get_ongrid_battery_dod(self) -> int:
"""
Get the On-Grid Battery DoD
0% - 89%
"""
raise NotImplementedError()
@abstractmethod
async def set_ongrid_battery_dod(self, dod: int) -> None:
"""
BEWARE !!!
This method modifies On-Grid Battery DoD parameter accessible to installers only.
Use with caution and at your own risk !
Set the On-Grid Battery DoD
0% - 89%
"""
raise NotImplementedError()
@abstractmethod
def sensors(self) -> Tuple[Sensor, ...]:
"""
Return tuple of sensor definitions
"""
raise NotImplementedError()
@abstractmethod
def settings(self) -> Tuple[Sensor, ...]:
"""
Return tuple of settings definitions
"""
raise NotImplementedError()
@staticmethod
def _create_protocol(host: str, port: int, comm_addr: int, timeout: int, retries: int) -> InverterProtocol:
if port == 502:
return TcpInverterProtocol(host, port, comm_addr, timeout, retries)
else:
return UdpInverterProtocol(host, port, comm_addr, timeout, retries)
@staticmethod
def _map_response(response: ProtocolResponse, sensors: Tuple[Sensor, ...]) -> Dict[str, Any]:
"""Process the response data and return dictionary with runtime values"""
result = {}
for sensor in sensors:
try:
result[sensor.id_] = sensor.read(response)
except ValueError:
logger.exception("Error reading sensor %s.", sensor.id_)
result[sensor.id_] = None
return result
@staticmethod
def _decode(data: bytes) -> str:
"""Decode the bytes to ascii string"""
try:
if any(x < 32 for x in data):
return data.decode("utf-16be").rstrip().replace('\x00', '')
return data.decode("ascii").rstrip()
except ValueError:
return data.hex()
|