solax-py-library 1.0.0.24__py3-none-any.whl → 1.0.0.2501__py3-none-any.whl

solax_py_library/device/core/interver/__init__.py

@@ -1,36 +1,36 @@
-from .base import InverterProtocol
-
-
-inverter_protocol_map = {}
-
-
-def register_protocol(protocol_class: InverterProtocol):
-    if protocol_class.inverter_model is None:
-        raise RuntimeError("未找到对应的设备类型")
-    inverter_protocol_map[protocol_class.inverter_model] = protocol_class
-
-
-def ProtocolFactory(inverter_model: int, *args, **kwargs) -> InverterProtocol:
-    """
-    创建协议实例。
-    inverter_model: 逆变器类型
-    device_info: 设备信息。
-    data: 数据。
-    """
-    protocol_class = inverter_protocol_map.get(inverter_model)
-    if not protocol_class:
-        raise ValueError(f"未找到名为 '{str(inverter_model)}' 的协议")
-    return protocol_class(*args, **kwargs)
-
-
-def match_pcs(operate_queue, slave_num):
-    for device_model in inverter_protocol_map.keys():
-        client = ProtocolFactory(device_model)
-        sn_data = client.read_sn(operate_queue.modbus_rtu, slave_num)
-        if not sn_data:
-            continue
-        sn = get_char(sn_data)
-        inverter_model, _ = client.parse_sn(sn)
-        if inverter_model:
-            return inverter_model, sn
-    return None, None
+from .base import InverterProtocol
+
+
+inverter_protocol_map = {}
+
+
+def register_protocol(protocol_class: InverterProtocol):
+    if protocol_class.inverter_model is None:
+        raise RuntimeError("未找到对应的设备类型")
+    inverter_protocol_map[protocol_class.inverter_model] = protocol_class
+
+
+def ProtocolFactory(inverter_model: int, *args, **kwargs) -> InverterProtocol:
+    """
+    创建协议实例。
+    inverter_model: 逆变器类型
+    device_info: 设备信息。
+    data: 数据。
+    """
+    protocol_class = inverter_protocol_map.get(inverter_model)
+    if not protocol_class:
+        raise ValueError(f"未找到名为 '{str(inverter_model)}' 的协议")
+    return protocol_class(*args, **kwargs)
+
+
+def match_pcs(operate_queue, slave_num):
+    for device_model in inverter_protocol_map.keys():
+        client = ProtocolFactory(device_model)
+        sn_data = client.read_sn(operate_queue.modbus_rtu, slave_num)
+        if not sn_data:
+            continue
+        sn = get_char(sn_data)
+        inverter_model, _ = client.parse_sn(sn)
+        if inverter_model:
+            return inverter_model, sn
+    return None, None

solax_py_library/device/core/interver/base.py

@@ -1,215 +1,215 @@
-import json
-from abc import ABCMeta, abstractmethod
-from collections import OrderedDict
-from datetime import datetime
-from typing import List, Union
-
-from pydantic.class_validators import Validator
-
-from solax_py_library.device.types.inverter_config import InverterConfig, InverterPoint
-from solax_py_library.device.types.modbus_point import WriteModbusPoint, ReadModbusPoint
-from solax_py_library.utils.common import round_value
-from solax_py_library.utils.struct_util import unpack
-
-
-class InverterProtocol(metaclass=ABCMeta):
-    inverter_model: None
-
-    def __init__(self, point_config):
-        self.col_name_index_map = OrderedDict()
-        self.col_index_name_map = OrderedDict()
-        self.col_id_index_map = {}
-        self.sn_config = None
-        self.shutdown_config = None
-        self.boot_up_config = None
-        self.time_config = None
-        self.version_config = None
-        self.error_map = None
-        self._prepare(point_config)
-
-    def _prepare(self, point_config: str):
-        point_config = json.loads(point_config)
-        self.real_data_start_address = None
-        self.real_data_end_address = None
-        try:
-            point_config = InverterConfig(**point_config)
-        except Validator as e:
-            print(e)
-        for index, real_point in enumerate(point_config.real_data):
-            point_key = real_point.point_key
-            point_id = real_point.point_id
-            self.col_name_index_map[point_key] = real_point
-            self.col_index_name_map[point_id] = real_point
-            self.col_id_index_map[point_id] = index
-            self.real_data_start_address = min(
-                self.real_data_start_address, real_point.starting_address
-            )
-            self.real_data_end_address = max(
-                self.real_data_end_address,
-                real_point.starting_address + real_point.quantity_of_x - 1,
-            )
-
-        self.sn_config = point_config.other_data.sn
-        self.shutdown_config = point_config.other_data.shutdown
-        self.boot_up_config = point_config.other_data.boot_up
-        self.time_config = point_config.other_data.time
-        self.version_config = point_config.other_data.version
-
-        self.error_map = point_config.error_map
-
-    def read_real_data(self, modbus_client, slave):
-        real_data = self._execute_modbus(
-            modbus_client,
-            slave,
-            ReadModbusPoint(
-                starting_address=self.real_data_start_address,
-                quantity_of_x=self.real_data_end_address
-                - self.real_data_start_address
-                + 1,
-                function_code=InverterPoint.function_code,
-            ),
-        )
-        ret_real_data = {}
-        for point_id, point_info in self.col_index_name_map.items():
-            offset = point_info.starting_address
-            data = real_data[offset : offset + point_info.quantity_of_x]
-            ret_real_data[point_id] = self._parse_point_data(point_info, data)
-        return ret_real_data
-
-    def read_real_data_to_list(self, modbus_client, slave):
-        real_data = self.read_real_data(modbus_client, slave)
-        return list(real_data.values())
-
-    def _parse_point_data(self, point_info: InverterPoint, point_data):
-        value = unpack(
-            point_data, data_format=point_info.register_dataformat, reversed=True
-        )
-        accuracy = point_info.accuracy
-        return round_value(value * accuracy, 3)
-
-    def get_data_by_point_id_from_list(self, point_id, real_data):
-        point_index = self.col_id_index_map[point_id]
-        return real_data[point_index]
-
-    @abstractmethod
-    def get_real_power(self, read_data):
-        raise NotImplementedError()
-
-    @abstractmethod
-    def get_error_data(self, read_data):
-        raise NotImplementedError()
-
-    @abstractmethod
-    def parse_pcs_status(self, read_data):
-        ...
-
-    @abstractmethod
-    def parse_error_code(self, error_data):
-        ...
-
-    def error_to_alarm_code(self, error_codes: List[int]):
-        if not self.error_map:
-            return error_codes
-        alarm_codes = []
-        for error_code in error_codes:
-            if alarm_code := self.error_map.get(error_code):
-                alarm_codes.append(alarm_code)
-        return alarm_codes
-
-    def pv_power_data(self, real_data):
-        ...
-
-    def get_pv_capacity(self, real_data, history_data):
-        ...
-
-    def get_active_power(self, read_data):
-        ...
-
-    def get_reactive_power(self, read_data):
-        ...
-
-    # ==============================  read or write =========================================
-
-    def _execute_modbus(
-        self,
-        modbus_client,
-        slave_num,
-        point_info: Union[WriteModbusPoint, ReadModbusPoint],
-        output_value=None,
-    ):
-        try:
-            ret = modbus_client.read_and_write(
-                slave_num,
-                **point_info.dict(
-                    include={"starting_address", "quantity_of_x", "function_code"}
-                ),
-                output_value=output_value,
-            )
-        except Exception as e:
-            print(e)
-        return ret
-
-    def shutdown(self, modbus_client, slave_num):
-        self._execute_modbus(
-            modbus_client,
-            slave_num,
-            self.shutdown_config,
-            output_value=self.shutdown_config.output_value,
-        )
-
-    def boot_up(self, modbus_client, slave_num):
-        self._execute_modbus(
-            modbus_client,
-            slave_num,
-            self.boot_up_config,
-            output_value=self.boot_up_config.output_value,
-        )
-
-    def read_sn(self, modbus_client, slave_num):
-        return self._execute_modbus(modbus_client, slave_num, self.sn_config)
-
-    def read_soft_version_and_hard_version(self, modbus_client, slave_num):
-        soft_inv_version = self.read_soft_version(modbus_client, slave_num)
-        hard_inv_version = self.read_hard_version(modbus_client, slave_num)
-        return soft_inv_version, hard_inv_version
-
-    def read_soft_version(self, modbus_client, slave_num):
-        return self._execute_modbus(
-            modbus_client, slave_num, self.version_config.software
-        )
-
-    def read_hard_version(self, modbus_client, slave_num):
-        return self._execute_modbus(
-            modbus_client, slave_num, self.version_config.hardware
-        )
-
-    def get_upgrade_value(self, crc, file_size):
-        crc_nums = [crc[1], crc[0]]
-        file_size = [file_size[1], file_size[0]]
-        value = (
-            [self.inverter_model]
-            + crc_nums
-            + [1, 0, 0, 0, 0, 0, 0]
-            + file_size
-            + [1, 0, 0]
-        )
-        return value
-
-    def write_pcs_time(self, modbus_client, slave_num):
-        self._execute_modbus(
-            modbus_client,
-            slave_num,
-            self.time_config,
-            output_value=self._build_pcs_time_value(),
-        )
-
-    def _build_pcs_time_value(self):
-        cur_time = datetime.now()
-        return [
-            cur_time.year,
-            cur_time.month,
-            cur_time.day,
-            cur_time.hour,
-            cur_time.minute,
-            cur_time.second,
-        ]
+import json
+from abc import ABCMeta, abstractmethod
+from collections import OrderedDict
+from datetime import datetime
+from typing import List, Union
+
+from pydantic.class_validators import Validator
+
+from solax_py_library.device.types.inverter_config import InverterConfig, InverterPoint
+from solax_py_library.device.types.modbus_point import WriteModbusPoint, ReadModbusPoint
+from solax_py_library.utils.common import round_value
+from solax_py_library.utils.struct_util import unpack
+
+
+class InverterProtocol(metaclass=ABCMeta):
+    inverter_model: None
+
+    def __init__(self, point_config):
+        self.col_name_index_map = OrderedDict()
+        self.col_index_name_map = OrderedDict()
+        self.col_id_index_map = {}
+        self.sn_config = None
+        self.shutdown_config = None
+        self.boot_up_config = None
+        self.time_config = None
+        self.version_config = None
+        self.error_map = None
+        self._prepare(point_config)
+
+    def _prepare(self, point_config: str):
+        point_config = json.loads(point_config)
+        self.real_data_start_address = None
+        self.real_data_end_address = None
+        try:
+            point_config = InverterConfig(**point_config)
+        except Validator as e:
+            print(e)
+        for index, real_point in enumerate(point_config.real_data):
+            point_key = real_point.point_key
+            point_id = real_point.point_id
+            self.col_name_index_map[point_key] = real_point
+            self.col_index_name_map[point_id] = real_point
+            self.col_id_index_map[point_id] = index
+            self.real_data_start_address = min(
+                self.real_data_start_address, real_point.starting_address
+            )
+            self.real_data_end_address = max(
+                self.real_data_end_address,
+                real_point.starting_address + real_point.quantity_of_x - 1,
+            )
+
+        self.sn_config = point_config.other_data.sn
+        self.shutdown_config = point_config.other_data.shutdown
+        self.boot_up_config = point_config.other_data.boot_up
+        self.time_config = point_config.other_data.time
+        self.version_config = point_config.other_data.version
+
+        self.error_map = point_config.error_map
+
+    def read_real_data(self, modbus_client, slave):
+        real_data = self._execute_modbus(
+            modbus_client,
+            slave,
+            ReadModbusPoint(
+                starting_address=self.real_data_start_address,
+                quantity_of_x=self.real_data_end_address
+                - self.real_data_start_address
+                + 1,
+                function_code=InverterPoint.function_code,
+            ),
+        )
+        ret_real_data = {}
+        for point_id, point_info in self.col_index_name_map.items():
+            offset = point_info.starting_address
+            data = real_data[offset : offset + point_info.quantity_of_x]
+            ret_real_data[point_id] = self._parse_point_data(point_info, data)
+        return ret_real_data
+
+    def read_real_data_to_list(self, modbus_client, slave):
+        real_data = self.read_real_data(modbus_client, slave)
+        return list(real_data.values())
+
+    def _parse_point_data(self, point_info: InverterPoint, point_data):
+        value = unpack(
+            point_data, data_format=point_info.register_dataformat, reversed=True
+        )
+        accuracy = point_info.accuracy
+        return round_value(value * accuracy, 3)
+
+    def get_data_by_point_id_from_list(self, point_id, real_data):
+        point_index = self.col_id_index_map[point_id]
+        return real_data[point_index]
+
+    @abstractmethod
+    def get_real_power(self, read_data):
+        raise NotImplementedError()
+
+    @abstractmethod
+    def get_error_data(self, read_data):
+        raise NotImplementedError()
+
+    @abstractmethod
+    def parse_pcs_status(self, read_data):
+        ...
+
+    @abstractmethod
+    def parse_error_code(self, error_data):
+        ...
+
+    def error_to_alarm_code(self, error_codes: List[int]):
+        if not self.error_map:
+            return error_codes
+        alarm_codes = []
+        for error_code in error_codes:
+            if alarm_code := self.error_map.get(error_code):
+                alarm_codes.append(alarm_code)
+        return alarm_codes
+
+    def pv_power_data(self, real_data):
+        ...
+
+    def get_pv_capacity(self, real_data, history_data):
+        ...
+
+    def get_active_power(self, read_data):
+        ...
+
+    def get_reactive_power(self, read_data):
+        ...
+
+    # ==============================  read or write =========================================
+
+    def _execute_modbus(
+        self,
+        modbus_client,
+        slave_num,
+        point_info: Union[WriteModbusPoint, ReadModbusPoint],
+        output_value=None,
+    ):
+        try:
+            ret = modbus_client.read_and_write(
+                slave_num,
+                **point_info.dict(
+                    include={"starting_address", "quantity_of_x", "function_code"}
+                ),
+                output_value=output_value,
+            )
+        except Exception as e:
+            print(e)
+        return ret
+
+    def shutdown(self, modbus_client, slave_num):
+        self._execute_modbus(
+            modbus_client,
+            slave_num,
+            self.shutdown_config,
+            output_value=self.shutdown_config.output_value,
+        )
+
+    def boot_up(self, modbus_client, slave_num):
+        self._execute_modbus(
+            modbus_client,
+            slave_num,
+            self.boot_up_config,
+            output_value=self.boot_up_config.output_value,
+        )
+
+    def read_sn(self, modbus_client, slave_num):
+        return self._execute_modbus(modbus_client, slave_num, self.sn_config)
+
+    def read_soft_version_and_hard_version(self, modbus_client, slave_num):
+        soft_inv_version = self.read_soft_version(modbus_client, slave_num)
+        hard_inv_version = self.read_hard_version(modbus_client, slave_num)
+        return soft_inv_version, hard_inv_version
+
+    def read_soft_version(self, modbus_client, slave_num):
+        return self._execute_modbus(
+            modbus_client, slave_num, self.version_config.software
+        )
+
+    def read_hard_version(self, modbus_client, slave_num):
+        return self._execute_modbus(
+            modbus_client, slave_num, self.version_config.hardware
+        )
+
+    def get_upgrade_value(self, crc, file_size):
+        crc_nums = [crc[1], crc[0]]
+        file_size = [file_size[1], file_size[0]]
+        value = (
+            [self.inverter_model]
+            + crc_nums
+            + [1, 0, 0, 0, 0, 0, 0]
+            + file_size
+            + [1, 0, 0]
+        )
+        return value
+
+    def write_pcs_time(self, modbus_client, slave_num):
+        self._execute_modbus(
+            modbus_client,
+            slave_num,
+            self.time_config,
+            output_value=self._build_pcs_time_value(),
+        )
+
+    def _build_pcs_time_value(self):
+        cur_time = datetime.now()
+        return [
+            cur_time.year,
+            cur_time.month,
+            cur_time.day,
+            cur_time.hour,
+            cur_time.minute,
+            cur_time.second,
+        ]

solax_py_library/device/types/inverter_config.py

@@ -1,41 +1,41 @@
-from typing import List, Optional, Dict
-from modbus_tk import defines
-
-from pydantic import BaseModel
-from enum import IntEnum
-
-from solax_py_library.device.types.modbus_point import ReadModbusPoint, WriteModbusPoint
-
-
-class InverterModel(IntEnum):
-    ...
-
-    def __str__(self):
-        ...
-
-
-class InverterPoint(ReadModbusPoint):
-    description: Optional[str]
-    point_key: str
-    point_id: int
-    accuracy: Optional[float]
-    function_code: int = defines.READ_INPUT_REGISTERS
-
-
-class InverterVersionConfig(BaseModel):
-    software: ReadModbusPoint
-    hardware: ReadModbusPoint
-
-
-class InverterSystemConfig(BaseModel):
-    sn: ReadModbusPoint
-    shutdown: WriteModbusPoint
-    boot_up: WriteModbusPoint
-    time: WriteModbusPoint
-    version: InverterVersionConfig
-
-
-class InverterConfig(BaseModel):
-    real_data: List[InverterPoint]
-    other_data: InverterSystemConfig
-    error_map: Dict[int, int]
+from typing import List, Optional, Dict
+from modbus_tk import defines
+
+from pydantic import BaseModel
+from enum import IntEnum
+
+from solax_py_library.device.types.modbus_point import ReadModbusPoint, WriteModbusPoint
+
+
+class InverterModel(IntEnum):
+    ...
+
+    def __str__(self):
+        ...
+
+
+class InverterPoint(ReadModbusPoint):
+    description: Optional[str]
+    point_key: str
+    point_id: int
+    accuracy: Optional[float]
+    function_code: int = defines.READ_INPUT_REGISTERS
+
+
+class InverterVersionConfig(BaseModel):
+    software: ReadModbusPoint
+    hardware: ReadModbusPoint
+
+
+class InverterSystemConfig(BaseModel):
+    sn: ReadModbusPoint
+    shutdown: WriteModbusPoint
+    boot_up: WriteModbusPoint
+    time: WriteModbusPoint
+    version: InverterVersionConfig
+
+
+class InverterConfig(BaseModel):
+    real_data: List[InverterPoint]
+    other_data: InverterSystemConfig
+    error_map: Dict[int, int]

solax_py_library/device/types/modbus_point.py

@@ -1,30 +1,30 @@
-from typing import Union, List
-
-from pydantic import BaseModel
-from enum import StrEnum
-
-
-class ModbusPoint(BaseModel):
-    starting_address: int
-    quantity_of_x: int
-    function_code: int
-
-
-class RegisterDataformat(StrEnum):
-    int8 = "int8"
-    uint8 = "uint8"
-    int16 = "int16"
-    uint16 = "uint16"
-    int32 = "int32"
-    uint32 = "uint32"
-    int64 = "int64"
-    uint64 = "uint64"
-    float = "float"
-
-
-class ReadModbusPoint(ModbusPoint):
-    register_dataformat: RegisterDataformat
-
-
-class WriteModbusPoint(ModbusPoint):
-    output_value: Union[int, List[int], None]
+from typing import Union, List
+
+from pydantic import BaseModel
+from enum import StrEnum
+
+
+class ModbusPoint(BaseModel):
+    starting_address: int
+    quantity_of_x: int
+    function_code: int
+
+
+class RegisterDataformat(StrEnum):
+    int8 = "int8"
+    uint8 = "uint8"
+    int16 = "int16"
+    uint16 = "uint16"
+    int32 = "int32"
+    uint32 = "uint32"
+    int64 = "int64"
+    uint64 = "uint64"
+    float = "float"
+
+
+class ReadModbusPoint(ModbusPoint):
+    register_dataformat: RegisterDataformat
+
+
+class WriteModbusPoint(ModbusPoint):
+    output_value: Union[int, List[int], None]

solax_py_library/exception.py

@@ -1,10 +1,10 @@
-class SolaxBaseError(Exception):
-    code = 0x1000
-    message = "upload error"
-
-    def __init__(self, *args, message=None):
-        super().__init__(*args)
-        self.message = message or self.message
-
-    def __str__(self):
-        return self.message
+class SolaxBaseError(Exception):
+    code = 0x1000
+    message = "upload error"
+
+    def __init__(self, *args, message=None):
+        super().__init__(*args)
+        self.message = message or self.message
+
+    def __str__(self):
+        return self.message