aiorexense 0.1.1__py3-none-any.whl

aiorexense/__init__.py

@@ -0,0 +1,86 @@
+"""
+Rexense WS client library init.
+"""
+
+__version__ = "0.1.1"
+
+from .api import get_basic_info
+from .const import (
+    DEFAULT_PORT,
+    VENDOR_CODE,
+    API_VERSION,
+    FUNCTION_GET_BASIC_INFO,
+    FUNCTION_NOTIFY_STATUS,
+    FUNCTION_INVOKE_CMD,
+    REXENSE_SENSOR_CURRENT,
+    REXENSE_SENSOR_VOLTAGE,
+    REXENSE_SENSOR_POWER_FACTOR,
+    REXENSE_SENSOR_ACTIVE_POWER,
+    REXENSE_SENSOR_APPARENT_POWER,
+    REXENSE_SENSOR_B_CURRENT,
+    REXENSE_SENSOR_B_VOLTAGE,
+    REXENSE_SENSOR_B_POWER_FACTOR,
+    REXENSE_SENSOR_B_ACTIVE_POWER,
+    REXENSE_SENSOR_B_APPARENT_POWER,
+    REXENSE_SENSOR_C_CURRENT,
+    REXENSE_SENSOR_C_VOLTAGE,
+    REXENSE_SENSOR_C_POWER_FACTOR,
+    REXENSE_SENSOR_C_ACTIVE_POWER,
+    REXENSE_SENSOR_C_APPARENT_POWER,
+    REXENSE_SENSOR_TOTAL_ACTIVE_POWER,
+    REXENSE_SENSOR_TOTAL_APPARENT_POWER,
+    REXENSE_SENSOR_CEI,
+    REXENSE_SENSOR_CEE,
+    REXENSE_SENSOR_A_CEI,
+    REXENSE_SENSOR_A_CEE,
+    REXENSE_SENSOR_B_CEI,
+    REXENSE_SENSOR_B_CEE,
+    REXENSE_SENSOR_C_CEI,
+    REXENSE_SENSOR_C_CEE,
+    REXENSE_SENSOR_TEMPERATURE,
+    REXENSE_SENSOR_BATTERY_PERCENTAGE,
+    REXENSE_SENSOR_BATTERY_VOLTAGE,
+    REXENSE_SWITCH_ONOFF,
+)
+from .ws_client import RexenseWebsocketClient
+
+__all__ = [
+    "get_basic_info",
+    "RexenseWebsocketClient",
+    # constants
+    "DEFAULT_PORT",
+    "VENDOR_CODE",
+    "API_VERSION",
+    "FUNCTION_GET_BASIC_INFO",
+    "FUNCTION_NOTIFY_STATUS",
+    "FUNCTION_INVOKE_CMD",
+    "REXENSE_SENSOR_CURRENT",
+    "REXENSE_SENSOR_VOLTAGE",
+    "REXENSE_SENSOR_POWER_FACTOR",
+    "REXENSE_SENSOR_ACTIVE_POWER",
+    "REXENSE_SENSOR_APPARENT_POWER",
+    "REXENSE_SENSOR_B_CURRENT",
+    "REXENSE_SENSOR_B_VOLTAGE",
+    "REXENSE_SENSOR_B_POWER_FACTOR",
+    "REXENSE_SENSOR_B_ACTIVE_POWER",
+    "REXENSE_SENSOR_B_APPARENT_POWER",
+    "REXENSE_SENSOR_C_CURRENT",
+    "REXENSE_SENSOR_C_VOLTAGE",
+    "REXENSE_SENSOR_C_POWER_FACTOR",
+    "REXENSE_SENSOR_C_ACTIVE_POWER",
+    "REXENSE_SENSOR_C_APPARENT_POWER",
+    "REXENSE_SENSOR_TOTAL_ACTIVE_POWER",
+    "REXENSE_SENSOR_TOTAL_APPARENT_POWER",
+    "REXENSE_SENSOR_CEI",
+    "REXENSE_SENSOR_CEE",
+    "REXENSE_SENSOR_A_CEI",
+    "REXENSE_SENSOR_A_CEE",
+    "REXENSE_SENSOR_B_CEI",
+    "REXENSE_SENSOR_B_CEE",
+    "REXENSE_SENSOR_C_CEI",
+    "REXENSE_SENSOR_C_CEE",
+    "REXENSE_SENSOR_TEMPERATURE",
+    "REXENSE_SENSOR_BATTERY_PERCENTAGE",
+    "REXENSE_SENSOR_BATTERY_VOLTAGE",
+    "REXENSE_SWITCH_ONOFF",
+]

aiorexense/api.py

@@ -0,0 +1,61 @@
+"""
+HTTP API for Rexense device basic info
+"""
+import asyncio
+import logging
+from typing import Any, Tuple
+
+from aiohttp import ClientSession, ClientError
+
+from .const import (
+    API_VERSION,
+    VENDOR_CODE,
+    FUNCTION_GET_BASIC_INFO,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+
+async def get_basic_info(
+    host: str,
+    port: int,
+    session: ClientSession,
+    timeout: int = 5,
+) -> Tuple[str, str, str, list[dict[str, Any]]]:
+    """
+    Send an HTTP request to the device, query device_id, model, sw_build_id, feature_map。
+    """
+    url = f"http://{host}:{port}/rex/device/v1/operate"
+    payload = {
+        "Version": API_VERSION,
+        "VendorCode": VENDOR_CODE,
+        "Timestamp": "0",
+        "Seq": "0",
+        "DeviceId": "",
+        "FunctionCode": FUNCTION_GET_BASIC_INFO,
+        "Payload": {},
+    }
+    try:
+        async with asyncio.timeout(timeout):
+            resp = await session.get(url, json=payload)
+    except (asyncio.TimeoutError, ClientError) as err:
+        _LOGGER.error("HTTP get_basic_info failed: %s", err)
+        raise
+
+    if resp.status != 200:
+        _LOGGER.error("Device %s:%s HTTP status %s", host, port, resp.status)
+        raise ClientError(f"Status {resp.status}")
+
+    data = await resp.json()
+
+    if data.get("FunctionCode") != FUNCTION_GET_BASIC_INFO.replace("GetBasic", "ReportBasic") or not data.get("Payload"):
+        _LOGGER.error("Invalid response format: %s", data)
+        raise ClientError("Invalid response format")
+
+    device_id = data.get("DeviceId", "")
+    payload = data["Payload"]
+    model = payload.get("ModelId", "")
+    sw_build_id = payload.get("SwBuildId", "")
+    feature_map = payload.get("FeatureMap", [])
+
+    return device_id, model, sw_build_id, feature_map

aiorexense/const.py

@@ -0,0 +1,42 @@
+"""
+Rexense const & sensor config
+"""
+
+DEFAULT_PORT = 80
+
+API_VERSION = "1.0"
+VENDOR_CODE = "Rexense"
+FUNCTION_GET_BASIC_INFO = "GetBasicInfo"
+FUNCTION_NOTIFY_STATUS = "NotifyStatus"
+FUNCTION_INVOKE_CMD = "InvokeCmd"
+
+REXENSE_SENSOR_CURRENT = {"name":"Current","unit":"A"}
+REXENSE_SENSOR_VOLTAGE = {"name":"Voltage","unit":"V"}
+REXENSE_SENSOR_POWER_FACTOR = {"name":"PowerFactor","unit":"%"}
+REXENSE_SENSOR_ACTIVE_POWER = {"name":"ActivePower","unit":"W"}
+REXENSE_SENSOR_APPARENT_POWER = {"name":"AprtPower","unit":"VA"}
+REXENSE_SENSOR_B_CURRENT = {"name":"B_Current","unit":"A"}
+REXENSE_SENSOR_B_VOLTAGE = {"name":"B_Voltage","unit":"V"}
+REXENSE_SENSOR_B_POWER_FACTOR = {"name":"B_PowerFactor","unit":"%"}
+REXENSE_SENSOR_B_ACTIVE_POWER = {"name":"B_ActivePower","unit":"W"}
+REXENSE_SENSOR_B_APPARENT_POWER = {"name":"B_AprtPower","unit":"VA"}
+REXENSE_SENSOR_C_CURRENT = {"name":"C_Current","unit":"A"}
+REXENSE_SENSOR_C_VOLTAGE = {"name":"C_Voltage","unit":"V"}
+REXENSE_SENSOR_C_POWER_FACTOR = {"name":"C_PowerFactor","unit":"%"}
+REXENSE_SENSOR_C_ACTIVE_POWER = {"name":"C_ActivePower","unit":"W"}
+REXENSE_SENSOR_C_APPARENT_POWER = {"name":"C_AprtPower","unit":"VA"}
+REXENSE_SENSOR_TOTAL_ACTIVE_POWER = {"name":"TotalActivePower","unit":"W"}
+REXENSE_SENSOR_TOTAL_APPARENT_POWER = {"name":"TotalAprtPower","unit":"VA"}
+REXENSE_SENSOR_CEI = {"name":"CEI","unit":"Wh"}
+REXENSE_SENSOR_CEE = {"name":"CEE","unit":"Wh"}
+REXENSE_SENSOR_A_CEI = {"name":"A_CEI","unit":"Wh"}
+REXENSE_SENSOR_A_CEE = {"name":"A_CEE","unit":"Wh"}
+REXENSE_SENSOR_B_CEI = {"name":"B_CEI","unit":"Wh"}
+REXENSE_SENSOR_B_CEE = {"name":"B_CEE","unit":"Wh"}
+REXENSE_SENSOR_C_CEI = {"name":"C_CEI","unit":"Wh"}
+REXENSE_SENSOR_C_CEE = {"name":"C_CEE","unit":"Wh"}
+REXENSE_SENSOR_TEMPERATURE = {"name":"Temperature","unit":"°C"}
+REXENSE_SENSOR_BATTERY_PERCENTAGE = {"name":"BatteryPercentage","unit":"%"}
+REXENSE_SENSOR_BATTERY_VOLTAGE = {"name":"BatteryVoltage","unit":"V"}
+
+REXENSE_SWITCH_ONOFF = {"name":"PowerSwitch","unit":""}

aiorexense/ws_client.py

@@ -0,0 +1,197 @@
+"""
+WebSocket client for Rexense devices, independent of Home Assistant.
+"""
+import asyncio
+import logging
+from typing import Any, Callable, Optional
+
+from aiohttp import ClientSession, ClientWebSocketResponse, ClientWSTimeout, WSMsgType
+from .const import REXENSE_SWITCH_ONOFF
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class RexenseWebsocketClient:
+    """
+    Manages WebSocket connection to a Rexense device.
+    """
+
+    def __init__(
+        self,
+        device_id: str,
+        model: str,
+        url: str,
+        sw_build_id: str,
+        feature_map: list[dict[str, Any]],
+        session: Optional[ClientSession] = None,
+        on_update: Optional[Callable[[], None]] = None,
+    ) -> None:
+        """Initialize the WebSocket client."""
+        self.device_id = device_id
+        self.model = model
+        self.sw_build_id = sw_build_id
+        self.feature_map = feature_map
+        self.url = url
+        self.ws: Optional[ClientWebSocketResponse] = None
+        self.connected: bool = False
+        self._running: bool = False
+        self._task: Optional[asyncio.Task] = None
+        self.last_values: dict[str, Any] = {}
+        self.switch_state: Optional[bool] = None
+        self.ping_interval: int = 30
+
+        self.on_update = on_update
+        self._session = session
+        self.signal_update = f"{device_id}_update"
+
+    async def connect(self) -> None:
+        """Connect to the device and start listening."""
+        if self._running:
+            return
+        # Prepare session
+        if self._session is None:
+            self._session = ClientSession()
+
+        _LOGGER.debug("Attempting WebSocket connection to %s", self.url)
+        try:
+            ws = await self._session.ws_connect(
+                self.url,
+                timeout=ClientWSTimeout(ws_close=10),
+                heartbeat=self.ping_interval,
+                autoping=True,
+            )
+        except Exception as err:
+            _LOGGER.error(
+                "Initial WebSocket connect failed for %s: %s", self.device_id, err
+            )
+            self._running = False
+            raise
+        else:
+            self._running = True
+            self.ws = ws
+            self.connected = True
+            _LOGGER.info("WebSocket connected to device %s", self.device_id)
+            self._task = asyncio.create_task(self._run_loop())
+
+    async def _run_loop(self) -> None:
+        """Run the WebSocket listen and auto-reconnect loop."""
+        first_try = True
+        while self._running:
+            try:
+                if not first_try:
+                    _LOGGER.info("Reconnecting to device %s", self.device_id)
+                    ws = await self._session.ws_connect(
+                        self.url,
+                        timeout=ClientWSTimeout(ws_close=10),
+                        heartbeat=self.ping_interval,
+                        autoping=True,
+                    )
+                    self.ws = ws
+                    self.connected = True
+                    _LOGGER.info("WebSocket reconnected to device %s", self.device_id)
+                else:
+                    first_try = False
+
+                assert self.ws is not None
+                async for msg in self.ws:
+                    if msg.type == WSMsgType.TEXT:
+                        try:
+                            data = msg.json()
+                        except ValueError as e:
+                            _LOGGER.error("Received invalid JSON: %s, data: %s", e, msg.data)
+                            continue
+                        _LOGGER.debug("Received message: %s", data)
+                        self._handle_message(data)
+                    elif msg.type == WSMsgType.ERROR:
+                        assert self.ws is not None
+                        _LOGGER.error(
+                            "WebSocket error for %s: %s",
+                            self.device_id,
+                            self.ws.exception(),
+                        )
+                        break
+                    elif msg.type in (WSMsgType.CLOSED, WSMsgType.CLOSING):
+                        _LOGGER.warning(
+                            "WebSocket connection closed for %s", self.device_id
+                        )
+                        break
+            except Exception as err:
+                _LOGGER.error(
+                    "WebSocket connection failed for %s: %s", self.device_id, err
+                )
+            # Clean up and maybe reconnect
+            self.connected = False
+            if self.ws is not None:
+                try:
+                    await self.ws.close()
+                except Exception:
+                    pass
+                finally:
+                    self.ws = None
+
+            if self._running:
+                await asyncio.sleep(5)
+                continue
+
+    def _handle_message(self, data: dict[str, Any]) -> None:
+        """Process incoming message from WebSocket."""
+        func = (data.get("FunctionCode") or data.get("function") or data.get("func"))
+        if isinstance(func, str):
+            func = func.lower()
+
+        if func == "notifystatus":
+            payload = data.get("Payload") or {}
+            _LOGGER.debug("Received payload: %s", payload)
+            for k, v in payload.items():
+                key = k.replace("_1", "")
+                if key == REXENSE_SWITCH_ONOFF['name']:
+                    self.switch_state = v not in ("0", False)
+                    _LOGGER.debug("Update switch state: %s", self.switch_state)
+                else:
+                    _LOGGER.debug("Update sensor %s: %s", key, v)
+                    self.last_values[key] = v
+            # Trigger update callback
+            if self.on_update:
+                try:
+                    self.on_update()
+                except Exception as e:
+                    _LOGGER.error("Error in on_update callback: %s", e)
+        else:
+            _LOGGER.debug("Unhandled function %s: %s", func, data)
+
+    async def async_set_switch(self, on: bool) -> None:
+        """Send ON/OFF command to device via WebSocket."""
+        if not self.connected or self.ws is None:
+            raise RuntimeError("WebSocket is not connected.")
+        control = "On" if on else "Off"
+        payload = {
+            "FunctionCode": "InvokeCmd",
+            "Payload": {control: {}},
+        }
+        try:
+            await self.ws.send_json(payload)
+        except Exception as err:
+            _LOGGER.error("Failed to send switch command: %s", err)
+            raise
+
+    async def disconnect(self) -> None:
+        """Disconnect and stop the WebSocket client."""
+        _LOGGER.info("Disconnecting WebSocket for device %s", self.device_id)
+        self._running = False
+        if self.ws is not None:
+            await self.ws.close()
+        if self._task:
+            await self._task
+        self.ws = None
+        self.connected = False
+
+    async def disconnect(self) -> None:
+        """Disconnect and stop the WebSocket client."""
+        _LOGGER.info("Disconnecting WebSocket for device %s", self.device_id)
+        self._running = False
+        if self.ws is not None:
+            await self.ws.close()
+        if self._task:
+            await self._task
+        self.ws = None
+        self.connected = False

aiorexense-0.1.1.dist-info/METADATA

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: aiorexense
+Version: 0.1.1
+Summary: Rexense device client library: HTTP API + WebSocket
+Home-page: https://github.com/RexenseIoT/aiorexense.git
+Author: Zhejiang Rexense IoT Technology Co., Ltd
+Author-email: RexenseIoT <yuxiaoqiang@rexense.com>
+License: MIT License
+        
+        Copyright (c) 2025 Zhejiang Rexense IoT Technology Co., Ltd
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the “Software”), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/RexenseIoT/aiorexense.git
+Project-URL: Repository, https://github.com/RexenseIoT/aiorexense.git
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.0
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# aiorexense
+
+A Rexense device client library featuring an HTTP API for retrieving basic information and WebSocket-based status push functionality.
+
+## Install
+```bash
+pip install aiorexense

aiorexense-0.1.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+aiorexense/__init__.py,sha256=PSsMF6Ub1HJ5uyxbkTme2Cqt0UQe5e4fcxaA7lAZPL8,2486
+aiorexense/api.py,sha256=h4ZcySrbgoul5gtd7k6FDF0Ph5S-SZFBd18h5rRnaKw,1817
+aiorexense/const.py,sha256=fzU3gjbKKNR9zDlhmkA4Qua89NNkeIh5jWu1K8Mg3_s,2036
+aiorexense/ws_client.py,sha256=IkZX6vd3HDTn0xFjVw_Q2lYJtfPtuLapjCgYzkpM6Cw,7453
+aiorexense-0.1.1.dist-info/licenses/LICENSE,sha256=BAzGiyUG1qUIc93Ns3z14Ttl2wCHtUortRWIP_rU_Wg,1126
+aiorexense-0.1.1.dist-info/METADATA,sha256=Zuo8HPKFgCRRDbUzPzgzuBBqX-z3ThS5WGeYEvPSrlo,2128
+aiorexense-0.1.1.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
+aiorexense-0.1.1.dist-info/top_level.txt,sha256=G9Xrl6LXJ6WXbprRvKbytk3-bbNQSwHoK0p0yYXBs5I,31
+aiorexense-0.1.1.dist-info/RECORD,,

aiorexense-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (79.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

aiorexense-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Zhejiang Rexense IoT Technology Co., Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aiorexense-0.1.1.dist-info/top_level.txt

@@ -0,0 +1,4 @@
+aiorexense
+api
+const
+ws_client