solax-py-library 1.0.0.28__py3-none-any.whl → 1.0.0.29__py3-none-any.whl

solax_py_library/smart_scene/constant/message_entry.py

@@ -156,8 +156,8 @@ MESSAGE_ENTRY = {
         "en_US": "PV power target is {}kW. Battery power target is {}kW. target SOC is {}%",
     },
     "DoControl": {"zh_CN": "DO{}: {};", "en_US": "DO{}: {};"},
-    "duration": {"zh_CN": "持续： {}秒", "en_US": "last: {} seconds"},
-    "systemSoc": {"zh_CN": "系统soc {} {}%", "en_US": "system soc {} {}%"},
+    "duration": {"zh_CN": "持续： {}秒", "en_US": "Last: {} seconds"},
+    "systemSoc": {"zh_CN": "系统soc {} {}%", "en_US": "System soc {} {}%"},
     "systemImportPower": {
         "zh_CN": "电网买电功率 {} {}KW",
         "en_US": "Grid import power {} {}KW",
@@ -166,7 +166,7 @@ MESSAGE_ENTRY = {
         "zh_CN": "电网馈电功率 {} {}KW",
         "en_US": "Grid export power {} {}KW",
     },
-    "cabinetSoc": {"zh_CN": "机柜soc {} {}%", "en_US": "cabinet soc {} {}%"},
+    "cabinetSoc": {"zh_CN": "机柜soc {} {}%", "en_US": "Cabinet soc {} {}%"},
     "EMERGENCY": {"zh_CN": "紧急告警", "en_US": "Emergency alarm"},
     "TIPS": {"zh_CN": "状态提醒", "en_US": "State Tips"},
     "NORMAL": {"zh_CN": "普通告警", "en_US": "Normal alarm"},

solax_py_library/smart_scene/core/service/check.py

@@ -0,0 +1,33 @@
+from typing import List, Dict, Any
+
+from solax_py_library.smart_scene.types.action import SmartSceneAction, ActionType
+from solax_py_library.smart_scene.types.condition import (
+    SmartSceneCondition,
+    ConditionType,
+)
+
+
+def action_param_check(actions: List[SmartSceneAction], ctx: Dict[str, Any]):
+    """动作里的参数范围判定"""
+    for action in actions:
+        if action.type != ActionType.system:
+            continue
+        for action_data in action.data:
+            ret = action_data.check_param(ctx)
+            if ret is not None:
+                return ret
+    return True
+
+
+def condition_param_check(condition: SmartSceneCondition, ctx: Dict[str, Any]):
+    for condition_data in condition.value:
+        if condition_data.type not in [
+            ConditionType.systemCondition,
+            ConditionType.cabinet,
+        ]:
+            continue
+        for data in condition_data.data:
+            ret = data.check_param(ctx)
+            if ret is not None:
+                return ret
+    return True

solax_py_library/smart_scene/types/action.py

@@ -1,10 +1,28 @@
-from enum import Enum
+from enum import Enum, IntEnum
 from typing import List, Union, Any
 
 from pydantic import BaseModel
 
 from solax_py_library.device.constant.cabinet import TRENE_CABINET_ENUM
 from solax_py_library.smart_scene.constant.message_entry import MESSAGE_ENTRY
+from solax_py_library.smart_scene.exceptions.smart_scene import (
+    ExportLimitNum,
+    ImportLimitNum,
+    ImportOnlyPositive,
+    PowerLimitNum,
+    SocLimit,
+    ActivePowerLimitNum,
+    ReactivePowerLimitNum,
+    EnergyLimit,
+    BatteryPowerLimitNum,
+    PvOnlyGe0,
+    ExportLimitPercent,
+)
+
+
+class SmartSceneUnit(IntEnum):
+    PERCENT = 1
+    NUM = 2
 
 
 class ActionType(str, Enum):
@@ -36,7 +54,12 @@ class SystemActionChildData(ActionChildData):
     ...
 
 
-class SystemActionItemData(BaseModel):
+class ActionItemData(BaseModel):
+    def check_param(self, ctx):
+        ...
+
+
+class SystemActionItemData(ActionItemData):
     childType: SystemActionType
     childData: SystemActionChildData
 
@@ -136,12 +159,159 @@ class SystemActionItemData(BaseModel):
             return MESSAGE_ENTRY[work_mode[value_data[0]]][lang]
         return ""
 
+    def check_param(self, ctx):
+        if self.childType == SystemActionType.exportControl:
+            export_power_top_limit = ctx.pop("export_power_top_limit")
+            switch = self.childData.data[0]
+            if not switch:
+                return
+            _, _, value, unit = self.childData.data
+            if unit == SmartSceneUnit.NUM:
+                if value > export_power_top_limit or value < 0:
+                    return ExportLimitNum, {"up_limit": export_power_top_limit}
+            else:
+                if value > 0 or value < 110:
+                    return ExportLimitPercent, {}
+        elif self.childType == SystemActionType.importControl:
+            import_power_top_limit = ctx.pop("import_power_top_limit", None)
+            switch = self.childData.data[0]
+            if not switch:
+                return
+            value = self.childData.data[-1]
+            if import_power_top_limit is not None:
+                if value > import_power_top_limit or value < 0:
+                    return (
+                        ImportLimitNum,
+                        {"up_limit": import_power_top_limit},
+                    )
+            else:
+                if value < 0:
+                    return ImportOnlyPositive, {}
+        elif self.childType == SystemActionType.workMode:
+            work_mode = self.childData.data[0]
+            total_power_top_limit = ctx.pop("total_power_top_limit")
+            total_energy_top_limit = ctx.pop("total_energy_top_limit")
+            soc_low_limit = ctx.pop("soc_low_limit")
+            if work_mode == 3:  # 手动模式
+                if self.childData.data[1] in [3, 4]:  # 强充或强放
+                    _, _, power, soc = self.childData.data
+                    if power <= 0 or power > total_power_top_limit:
+                        return PowerLimitNum, {
+                            "low_limit": 0,
+                            "up_limit": total_power_top_limit,
+                        }
+                    if soc > 100 or soc < soc_low_limit:
+                        return SocLimit, {"low_limit": soc_low_limit}
+            elif work_mode == 16:  # VPP模式
+                vpp_mode = self.childData.data[1]
+                if vpp_mode == 1:
+                    (
+                        _,
+                        _,
+                        active_power,
+                        reactive_power,
+                    ) = self.childData.data
+                    if (
+                        active_power < -total_power_top_limit
+                        or active_power > total_power_top_limit
+                    ):
+                        return (
+                            ActivePowerLimitNum,
+                            {
+                                "low_limit": -total_power_top_limit,
+                                "up_limit": total_power_top_limit,
+                            },
+                        )
+                    if (
+                        reactive_power < -total_power_top_limit
+                        or reactive_power > total_power_top_limit
+                    ):
+                        return (
+                            ReactivePowerLimitNum,
+                            {
+                                "low_limit": -total_power_top_limit,
+                                "up_limit": total_power_top_limit,
+                            },
+                        )
+                elif vpp_mode == 2:
+                    _, _, energy, power = self.childData.data
+                    if energy < 0 or energy > total_energy_top_limit:
+                        return (
+                            EnergyLimit,
+                            {"up_limit": total_energy_top_limit},
+                        )
+                    if power < -total_power_top_limit or power > total_power_top_limit:
+                        return (
+                            PowerLimitNum,
+                            {
+                                "low_limit": -total_power_top_limit,
+                                "up_limit": total_power_top_limit,
+                            },
+                        )
+                elif vpp_mode == 3:
+                    _, _, soc, power = self.childData.data
+                    if soc < soc_low_limit or soc > 100:
+                        return (
+                            SocLimit,
+                            {"low_limit": soc_low_limit},
+                        )
+                    if power < -total_power_top_limit or power > total_power_top_limit:
+                        return (
+                            PowerLimitNum,
+                            {
+                                "low_limit": -total_power_top_limit,
+                                "up_limit": total_power_top_limit,
+                            },
+                        )
+                elif vpp_mode == 4:
+                    _, _, power = self.childData.data
+                    if power < -total_power_top_limit or power > total_power_top_limit:
+                        return (
+                            BatteryPowerLimitNum,
+                            {
+                                "low_limit": -total_power_top_limit,
+                                "up_limit": total_power_top_limit,
+                            },
+                        )
+                elif vpp_mode == 8:
+                    _, _, pv_power, bms_power = self.childData.data
+                    if pv_power < 0:
+                        return PvOnlyGe0, {}
+                    elif (
+                        bms_power < -total_power_top_limit
+                        or bms_power > total_power_top_limit
+                    ):
+                        return (
+                            BatteryPowerLimitNum,
+                            {
+                                "low_limit": -total_power_top_limit,
+                                "up_limit": total_power_top_limit,
+                            },
+                        )
+                elif vpp_mode == 9:
+                    _, _, pv_power, bms_power, soc = self.childData.data
+                    if pv_power < 0:
+                        return PvOnlyGe0, {}
+                    if (
+                        bms_power < -total_power_top_limit
+                        or bms_power > total_power_top_limit
+                    ):
+                        return (
+                            BatteryPowerLimitNum,
+                            {
+                                "low_limit": -total_power_top_limit,
+                                "up_limit": total_power_top_limit,
+                            },
+                        )
+                    if soc < soc_low_limit or soc > 100:
+                        return SocLimit, {"low_limit": soc_low_limit}
+
 
 class EmsActionChildData(ActionChildData):
     data: List[DoControl]
 
 
-class EmsActionItemData(BaseModel):
+class EmsActionItemData(ActionItemData):
     childType: EmsActionType
     childData: EmsActionChildData
 

solax_py_library/smart_scene/types/condition.py

@@ -2,11 +2,12 @@ import operator
 from enum import IntEnum, Enum
 from typing import Optional, List, Union, Any
 
-from pydantic import BaseModel, validator, root_validator
+from pydantic import BaseModel, validator
 
 from solax_py_library.device.types.alarm import AlarmLevel
 from solax_py_library.device.types.device import DeviceType
 from solax_py_library.smart_scene.constant.message_entry import MESSAGE_ENTRY
+from solax_py_library.smart_scene.exceptions.smart_scene import SocLimit
 
 
 class LogicFunc(IntEnum):
@@ -83,7 +84,12 @@ class ConditionItemChildData(BaseModel):
     data: List[Any]
 
 
-class PriceConditionItemData(BaseModel):
+class ConditionItemData(BaseModel):
+    def check_param(self, ctx):
+        ...
+
+
+class PriceConditionItemData(ConditionItemData):
     childType: PriceConditionType
     childData: ConditionItemChildData
 
@@ -123,7 +129,7 @@ class PriceConditionItemData(BaseModel):
             return MESSAGE_ENTRY[self.childType][lang].format(data[0], data[1], data[2])
 
 
-class SystemConditionItemData(BaseModel):
+class SystemConditionItemData(ConditionItemData):
     childType: SystemConditionType
     childData: ConditionItemChildData
 
@@ -136,8 +142,6 @@ class SystemConditionItemData(BaseModel):
         }:
             assert 0 <= value.data[0] <= 100000, ValueError
             value.data[0] = round(value.data[0], 2)  # 功率保留两位小数
-        elif child_type == SystemConditionType.systemSoc:
-            assert 5 <= value.data[0] <= 100, ValueError
         return value
 
     def to_text(self, lang, unit):
@@ -155,8 +159,15 @@ class SystemConditionItemData(BaseModel):
                 MESSAGE_ENTRY[str(func.value)][lang], data[0]
             )
 
+    def check_param(self, ctx):
+        soc_low_limit = ctx.pop("soc_low_limit", 5)
+        if self.childType == SystemConditionType.systemSoc:
+            soc = self.childData.data[0]
+            if soc < soc_low_limit or soc > 100:
+                return SocLimit.message, {"low_limit": soc_low_limit}
+
 
-class CabinetConditionItemData(BaseModel):
+class CabinetConditionItemData(ConditionItemData):
     childType: CabinetConditionType
     childData: ConditionItemChildData
 
@@ -169,8 +180,6 @@ class CabinetConditionItemData(BaseModel):
                 AlarmLevel.NORMAL,
                 AlarmLevel.EMERGENCY,
             }, ValueError
-        if child_type == CabinetConditionType.cabinetSoc:
-            assert 0 <= value.data[0] <= 100, ValueError
         return value
 
     def to_text(self, lang, unit):
@@ -191,13 +200,20 @@ class CabinetConditionItemData(BaseModel):
                 MESSAGE_ENTRY[str(AlarmLevel(data[-1]))][lang],
             )
 
+    def check_param(self, ctx):
+        soc_low_limit = ctx.pop("soc_low_limit", 5)
+        if self.childType == CabinetConditionType.cabinetSoc:
+            soc = self.childData.data[0]
+            if soc < soc_low_limit or soc > 100:
+                return SocLimit.message, {"low_limit": soc_low_limit}
+
 
-class DateConditionItemData(BaseModel):
+class DateConditionItemData(ConditionItemData):
     childType: DateConditionType
     childData: ConditionItemChildData
 
     @validator("childData", always=True)
-    def check_param(cls, value, values):
+    def _check_child_data(cls, value, values):
         child_type = values.get("childType")
         data = value.data
         if child_type == DateConditionType.time:
@@ -213,7 +229,7 @@ class DateConditionItemData(BaseModel):
             return MESSAGE_ENTRY[self.childType][lang] + "/" + self.childData.data[0]
 
 
-class WeatherConditionItemData(BaseModel):
+class WeatherConditionItemData(ConditionItemData):
     childType: WeatherConditionType
     childData: ConditionItemChildData
 
@@ -272,24 +288,6 @@ class SmartSceneCondition(BaseModel):
     operation: LogicFunc
     value: List[ConditionItem]
 
-    @root_validator
-    def _root_check(cls, values):
-        if values.get("operation") == LogicFunc.OR:
-            new_value = []
-            for item in values.get("value"):
-                if item.type != ConditionType.date:
-                    new_value.append(item)
-                    continue
-                new_data = []
-                for date_item in item.data:
-                    if date_item.childType != DateConditionType.duration:
-                        new_data.append(date_item)
-                item.data = new_data
-                if item.data:
-                    new_value.append(item)
-            values["value"] = new_value
-        return values
-
     def to_text(self, lang, unit):
         ret = {"operation": [MESSAGE_ENTRY[self.operation.name][lang]]}
         for v in self.value:

solax_py_library/test/test_smart_scene/test_check_func.py

@@ -0,0 +1,83 @@
+from unittest import TestCase
+
+from solax_py_library.smart_scene.core.service.check import (
+    condition_param_check,
+    action_param_check,
+)
+from solax_py_library.smart_scene.types.action import (
+    SmartSceneAction,
+    ActionType,
+    SystemActionType,
+    SystemActionItemData,
+    SystemActionChildData,
+)
+from solax_py_library.smart_scene.types.condition import (
+    SmartSceneCondition,
+    ConditionItem,
+    ConditionType,
+    SystemConditionItemData,
+    LogicFunc,
+    SystemConditionType,
+    ConditionItemChildData,
+    CabinetConditionItemData,
+    CabinetConditionType,
+    ConditionFunc,
+)
+
+
+class TestCheckFunc(TestCase):
+    def test_check_condition_func(self):
+        con = SmartSceneCondition(
+            operation=LogicFunc.AND,
+            value=[
+                ConditionItem(
+                    type=ConditionType.systemCondition,
+                    data=[
+                        SystemConditionItemData(
+                            childType=SystemConditionType.systemSoc,
+                            childData=ConditionItemChildData(
+                                data=[101], function=ConditionFunc.EQ
+                            ),
+                        ),
+                    ],
+                    cabinet=None,
+                ),
+                ConditionItem(
+                    type=ConditionType.cabinet,
+                    data=[
+                        CabinetConditionItemData(
+                            childType=CabinetConditionType.cabinetSoc,
+                            childData=ConditionItemChildData(
+                                data=[4], function=ConditionFunc.EQ
+                            ),
+                        )
+                    ],
+                    cabinet=["1", "2"],
+                ),
+            ],
+        )
+        ret = condition_param_check(con, ctx={"soc_low_limit": 10})
+        assert ret is not None
+
+    def test_check_action_func(self):
+        action = [
+            SmartSceneAction(
+                type=ActionType.system,
+                data=[
+                    SystemActionItemData(
+                        childType=SystemActionType.importControl,
+                        childData=SystemActionChildData(data=[1, -10]),
+                    )
+                ],
+            )
+        ]
+        ret = action_param_check(
+            actions=action,
+            ctx={
+                "cabinet_type": 3,
+                "total_power": 1,
+                "total_power_except_solar_inv": 1,
+                "total_energy": 1,
+            },
+        )
+        assert ret is not None

{solax_py_library-1.0.0.28.dist-info → solax_py_library-1.0.0.29.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: solax-py-library
-Version: 1.0.0.28
+Version: 1.0.0.29
 Summary: some common tool
 Author: shenlvyu
 Author-email: 13296718439@163.com

{solax_py_library-1.0.0.28.dist-info → solax_py_library-1.0.0.29.dist-info}/RECORD

@@ -14,7 +14,7 @@ solax_py_library/device/types/modbus_point.py,sha256=YmXe92gWXL_voVXDJE5zzNzr6dp
 solax_py_library/exception.py,sha256=ygAccdTqJctRrdt9bu6-vqZP5KadfKVS_1tjt4KcRn8,257
 solax_py_library/smart_scene/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 solax_py_library/smart_scene/constant/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-solax_py_library/smart_scene/constant/message_entry.py,sha256=4dItLHwgYjSvEb-UbhjT1l8BIbNGk9EyTNhrqD4HEBY,9667
+solax_py_library/smart_scene/constant/message_entry.py,sha256=_dhu8fjojnIrYr3w68joIJytCQu2x7IYakggmQJpUco,9667
 solax_py_library/smart_scene/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 solax_py_library/smart_scene/core/action/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 solax_py_library/smart_scene/core/action/base.py,sha256=GlZQTi7ub0fREV5BUZQUTARw3mleWWsKHOA7eFPVoJs,319
@@ -28,14 +28,15 @@ solax_py_library/smart_scene/core/condition/price_condition.py,sha256=IkgoB5YhpM
 solax_py_library/smart_scene/core/condition/system_condition.py,sha256=q5KDQdK6wjEvq0__WwBR4Sk-59yA2aIAgxTf1xjxJQk,1338
 solax_py_library/smart_scene/core/condition/weather_condition.py,sha256=ZoP5QM0kswQCrb1N22_W358BnhgDc6eXp9XPR5WKAgs,2363
 solax_py_library/smart_scene/core/service/__init__.py,sha256=wWzHSN2XaHnI-TNtCJWWRHnNC7s3-2GNQo9y0K_PC4Q,69
+solax_py_library/smart_scene/core/service/check.py,sha256=qoNixyjgwHRdb0HnU3UcZDEOeI9t0PxvjZcbgvB79Vs,1031
 solax_py_library/smart_scene/core/service/runner.py,sha256=SwQ6jb5yFPcyHyfU-THyGDjPEMcNFUOHkvVYA9wB1EE,6201
 solax_py_library/smart_scene/exceptions/__init__.py,sha256=0hDgr70fFLQB14uorVCwbBhl1yQmZ-uBYGH5XtGm_dg,147
 solax_py_library/smart_scene/exceptions/price.py,sha256=3bnY6JzeEskUoXVzEs8bpg6hQzgbinBKY4GP4hBITWU,152
 solax_py_library/smart_scene/exceptions/smart_scene.py,sha256=69khvoFm1Eki4NBT45gVnsyWubEzF7dqnhU-unqT20g,1701
 solax_py_library/smart_scene/exceptions/weather.py,sha256=bJl1VwiIXEpLQ9VjlVrDoTAIMFqVZdRCas7dtR7eAJc,133
 solax_py_library/smart_scene/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-solax_py_library/smart_scene/types/action.py,sha256=cYICnxLfLRWFAlOGWpS2HBw-PyaB6TNlNuEmSsme26k,5723
-solax_py_library/smart_scene/types/condition.py,sha256=K6XVaXLyqQfSLeq7m14vvS0KP-jN-13rmAfC0XfiAQk,9837
+solax_py_library/smart_scene/types/action.py,sha256=l2OITe3098-5zrYZSI64yL_YdSXn_FhbMh8h_8wRYBU,12934
+solax_py_library/smart_scene/types/condition.py,sha256=etBD6hQHxyhtYucvIhKp0F1rTnaC6D2IEwQyzyuTzgY,9730
 solax_py_library/smart_scene/types/condition_value.py,sha256=by5R3sVNOJCrghLLaNT54jiTqZYT7YvQQ4q9ovIXkqQ,1242
 solax_py_library/smart_scene/types/smart_scene_content.py,sha256=C8H17QEicmDBbxN-m550njwaZyUhAL2hUhlLg3Qj1zM,6061
 solax_py_library/snap_shot/__init__.py,sha256=Ex12q6BCkdU-3OP-f-ehGCetJJWnoZ7KxhEDd_lXh6M,81
@@ -52,6 +53,7 @@ solax_py_library/snap_shot/types/__init__.py,sha256=g9ybB88TntvAMGIhLgJ31Xxn26zl
 solax_py_library/snap_shot/types/address.py,sha256=JhyB-t2OnKuE8akKk120sojCNXv4_OlLLuWsl5ChFZ8,1148
 solax_py_library/test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 solax_py_library/test/test_smart_scene/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+solax_py_library/test/test_smart_scene/test_check_func.py,sha256=mVZedGT2OocqX1-qtVlVHRlimwyR3xtRwxcOGzREZAE,2584
 solax_py_library/test/test_smart_scene/test_condition.py,sha256=du1vqtwmDFPY__SNqQ-RcDjrDO6e2ZnBjNbPxWpihI4,2209
 solax_py_library/test/test_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 solax_py_library/test/test_utils/test_cloud_client.py,sha256=gOrHGXkFXpFV4kXTnjhmyJGem8VaGKw8OmXyW884oJ0,395
@@ -77,6 +79,6 @@ solax_py_library/utils/cloud_client.py,sha256=5dZrc5fzrNFSXqTPZd7oHt-Y9Jj6RCigB7
 solax_py_library/utils/common.py,sha256=bfnZcX9uM-PjJrYAFv1UMmZgt6bGR7MaOd7jRPNHGxw,1238
 solax_py_library/utils/struct_util.py,sha256=pL6L80GXIHasy1ZDIj89-5BzXW1BWI3TPitH7thGGIE,1577
 solax_py_library/utils/time_util.py,sha256=bY5kj9dmyOuLEQ6uYGQK7jU7y1RMiHZgevEKnkcQcSU,1461
-solax_py_library-1.0.0.28.dist-info/METADATA,sha256=SK4GdaqSse0JGUsUpDZtTN8VutvN0rlg2gDh2ksDxsY,1825
-solax_py_library-1.0.0.28.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-solax_py_library-1.0.0.28.dist-info/RECORD,,
+solax_py_library-1.0.0.29.dist-info/METADATA,sha256=4jVVYgos5GjqYl6S09nOz8zK2dh08mxJBg3O7w9dRjU,1825
+solax_py_library-1.0.0.29.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+solax_py_library-1.0.0.29.dist-info/RECORD,,