python-openevse-http 1.7.1__tar.gz → 1.8.0__tar.gz

{python_openevse_http-1.7.1 → python_openevse_http-1.8.0}/.agents/skills/openevse-api-guide/references/endpoints_matrix.md

@@ -29,9 +29,9 @@ This reference document compiles all known HTTP REST API endpoints, WebSocket pa
 | `/schedule/plan` | `GET` | ❌ | ❌ | ✅ (v4.1.0+) | N/A | ✅ Fully Supported |
 | `/time` | `GET`, `POST` | ❌ | ❌ (`/settime`) | ✅ (v4.0.0+) | `$S1` (RTC set) | ✅ Fully Supported |
 | `/settime` | `GET`, `POST` | ❌ | ✅ | ⚠️ Legacy alias | `$S1` | ✅ Fully Supported |
-| `/emeter` | `DELETE` | ❌ | ❌ | ✅ (v4.0.0+) | N/A | ❌ Not Implemented |
-| `/notifications` | `GET` | ❌ | ❌ | ✅ (v5.1.0+) | N/A | ❌ Not Implemented |
-| `/notifications/ack` | `POST` | ❌ | ❌ | ✅ (v5.1.0+) | N/A | ❌ Not Implemented |
+| `/emeter` | `DELETE` | ❌ | ❌ | ✅ (v4.0.0+) | N/A | ✅ Fully Supported |
+| `/notifications` | `GET` | ❌ | ❌ | ✅ (v5.1.0+) | N/A | ✅ Fully Supported |
+| `/notifications/ack` | `POST` | ❌ | ❌ | ✅ (v5.1.0+) | N/A | ✅ Fully Supported |
 | `/update` | `GET`, `POST` | `GET`, `POST` | `GET`, `POST` | `GET`, `POST` | N/A | ✅ Fully Supported |
 | `/logs` | `GET` | ❌ | ❌ | ✅ (v4.0.0+) | N/A | ✅ Fully Supported |
 | `/logs/export` | `GET` | ❌ | ❌ | ✅ (v4.0.0+) | N/A | ❌ Not Implemented |

{python_openevse_http-1.7.1/python_openevse_http.egg-info → python_openevse_http-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python_openevse_http
-Version: 1.7.1
+Version: 1.8.0
 Summary: Python wrapper for OpenEVSE HTTP API
 Home-page: https://github.com/firstof9/python-openevse-http
 Download-URL: https://github.com/firstof9/python-openevse-http
@@ -54,6 +54,11 @@ A Python library for communicating with [OpenEVSE](https://www.openevse.com/) ch
     - **Time Synchronization & RTC**: Manage time, timezone, and NTP sync (requires firmware 4.0.0+).
     - **Event Logs**: Retrieve diagnostic log blocks and log event history (requires firmware 4.0.0+).
     - **Certificates**: Manage SSL/TLS Root CA and client certificates (requires firmware 4.0.0+).
+    - **RFID Management**: RFID tag pairing mode and tag-to-user mappings (requires firmware 4.0.0+ / 5.0.0+).
+    - **Relay Diagnostics**: Stuck relay recovery cycle and contact-life estimation reset (requires firmware 5.1.0+).
+    - **Cable Temperature Monitoring**: Cable temperature sensor configuration and monitoring (requires firmware 5.1.0+).
+    - **Energy Meter Reset**: Reset the energy meter counters with soft/hard options (requires firmware 4.0.0+).
+    - **Advisory Notifications**: Retrieve gateway advisory notifications and acknowledge/mute active advisories (requires firmware 5.1.0+).
 
 ## Installation
 
@@ -156,7 +161,9 @@ When performing firmware update checks (`charger.firmware_check()`) or automatic
 | `/time` | GET, POST | ✅ | RTC and NTP time settings (v4.0.0+) |
 | `/settime` | POST | ✅ | Legacy time setting interface (v3.x / fallback to `$S1` on v2.x) |
 | `/logs` | GET | ✅ | Event log block bounds and block events (v4.0.0+) |
-| `/emeter` | DELETE | ❌ | Energy meter reset |
+| `/emeter` | DELETE | ✅ | Energy meter reset (v4.0.0+) |
+| `/notifications` | GET | ✅ | Gateway advisory notifications list (v5.1.0+) |
+| `/notifications/ack` | POST | ✅ | Acknowledge/mute active advisory notification (v5.1.0+) |
 | `/wifi` | GET, POST | ❌ | Network scanning and AP configuration |
 | `/tesla` | GET | ❌ | Tesla vehicle integration |
 | `/certificates`| GET, POST, DELETE | ✅ | SSL/TLS certificate management (v4.0.0+) |

{python_openevse_http-1.7.1 → python_openevse_http-1.8.0}/README.md

@@ -21,6 +21,11 @@ A Python library for communicating with [OpenEVSE](https://www.openevse.com/) ch
     - **Time Synchronization & RTC**: Manage time, timezone, and NTP sync (requires firmware 4.0.0+).
     - **Event Logs**: Retrieve diagnostic log blocks and log event history (requires firmware 4.0.0+).
     - **Certificates**: Manage SSL/TLS Root CA and client certificates (requires firmware 4.0.0+).
+    - **RFID Management**: RFID tag pairing mode and tag-to-user mappings (requires firmware 4.0.0+ / 5.0.0+).
+    - **Relay Diagnostics**: Stuck relay recovery cycle and contact-life estimation reset (requires firmware 5.1.0+).
+    - **Cable Temperature Monitoring**: Cable temperature sensor configuration and monitoring (requires firmware 5.1.0+).
+    - **Energy Meter Reset**: Reset the energy meter counters with soft/hard options (requires firmware 4.0.0+).
+    - **Advisory Notifications**: Retrieve gateway advisory notifications and acknowledge/mute active advisories (requires firmware 5.1.0+).
 
 ## Installation
 
@@ -123,7 +128,9 @@ When performing firmware update checks (`charger.firmware_check()`) or automatic
 | `/time` | GET, POST | ✅ | RTC and NTP time settings (v4.0.0+) |
 | `/settime` | POST | ✅ | Legacy time setting interface (v3.x / fallback to `$S1` on v2.x) |
 | `/logs` | GET | ✅ | Event log block bounds and block events (v4.0.0+) |
-| `/emeter` | DELETE | ❌ | Energy meter reset |
+| `/emeter` | DELETE | ✅ | Energy meter reset (v4.0.0+) |
+| `/notifications` | GET | ✅ | Gateway advisory notifications list (v5.1.0+) |
+| `/notifications/ack` | POST | ✅ | Acknowledge/mute active advisory notification (v5.1.0+) |
 | `/wifi` | GET, POST | ❌ | Network scanning and AP configuration |
 | `/tesla` | GET | ❌ | Tesla vehicle integration |
 | `/certificates`| GET, POST, DELETE | ✅ | SSL/TLS certificate management (v4.0.0+) |

{python_openevse_http-1.7.1 → python_openevse_http-1.8.0}/openevsehttp/commands_diagnostics.py

@@ -227,3 +227,107 @@ class DiagnosticsCommandsMixin(BaseCommandMixin):
             raise CommandFailedError(f"Invalid response from /logs: {response}")
 
         return dict(response)
+
+    async def get_notifications(self) -> dict[str, Any]:
+        """Retrieve the advisory notifications list from the gateway.
+
+        Queries 'GET /notifications'.
+        Requires gateway firmware 5.1.0 or higher.
+
+        Expected response shape:
+            {
+                "count": int,
+                "max_severity": "info" | "warning" | "critical" | None,
+                "notifications": [
+                    {
+                        "id": str,
+                        "category": str,
+                        "severity": str,
+                        "sticky": bool,
+                        "acked": bool,
+                        "first_seen": int,
+                        "last_seen": int,
+                    },
+                    ...
+                ]
+            }
+
+        :return: Dict containing 'count', 'max_severity', and 'notifications' list.
+        :raises UnsupportedFeature: If gateway firmware is older than 5.1.0.
+        :raises CommandFailedError: If response is invalid.
+        """
+        self._require_firmware("5.1.0", "get_notifications")
+
+        url = f"{self.url}notifications"
+        _LOGGER.debug("Querying notifications: %s", url)
+        response = await self.process_request(url=url, method="get")
+
+        if not isinstance(response, Mapping):
+            _LOGGER.error("Invalid response from /notifications: %s", response)
+            raise CommandFailedError(
+                f"Invalid response from /notifications: {response}"
+            )
+
+        return dict(response)
+
+    async def acknowledge_notification(self, notification_id: str) -> None:
+        """Acknowledge (mute) an active advisory notification by ID.
+
+        Issues 'POST /notifications/ack' with the notification ID.
+        Requires gateway firmware 5.1.0 or higher.
+
+        :param notification_id: The identifier of the advisory (e.g. 'safety.ground_check').
+        :raises UnsupportedFeature: If gateway firmware is older than 5.1.0.
+        :raises ValueError: If notification_id is empty or not a string.
+        :raises CommandFailedError: If the acknowledgment fails or returns an error.
+        """
+        self._require_firmware("5.1.0", "acknowledge_notification")
+
+        if not isinstance(notification_id, str) or not notification_id.strip():
+            raise ValueError("notification_id must be a non-empty string.")
+
+        url = f"{self.url}notifications/ack"
+        data = {"id": notification_id.strip()}
+
+        _LOGGER.debug(
+            "Acknowledging notification %s at %s", notification_id.strip(), url
+        )
+        response = await self.process_request(url=url, method="post", data=data)
+        response = self._normalize_response(response)
+
+        msg = response.get("msg") if isinstance(response, Mapping) else response
+        if msg not in SUCCESS_ANSWERS:
+            _LOGGER.error("Problem acknowledging notification: %s", response)
+            raise CommandFailedError(f"Problem acknowledging notification: {response}")
+
+    async def reset_energy_meter(
+        self, hard: bool = False, import_from_evse: bool = False
+    ) -> None:
+        """Reset the charger energy meter.
+
+        Issues DELETE /emeter with hard and import flags.
+
+        :param hard: If True, sets total energy and switch counter to 0 (hard reset).
+                     If False, performs a soft reset.
+        :param import_from_evse: If True, allows re-importing total energy counters from EVSE.
+        :raises UnsupportedFeature: If gateway firmware is older than 4.0.0.
+        :raises CommandFailedError: If the reset operation fails.
+        """
+        self._require_firmware("4.0.0", "reset_energy_meter")
+
+        url = f"{self.url}emeter"
+        data = {"hard": bool(hard), "import": bool(import_from_evse)}
+
+        _LOGGER.debug(
+            "Resetting energy meter: %s (hard=%s, import=%s)",
+            url,
+            hard,
+            import_from_evse,
+        )
+        response = await self.process_request(url=url, method="delete", data=data)
+        response = self._normalize_response(response)
+
+        msg = response.get("msg") if isinstance(response, Mapping) else None
+        if msg not in SUCCESS_ANSWERS:
+            _LOGGER.error("Problem resetting energy meter: %s", response)
+            raise CommandFailedError(f"Problem resetting energy meter: {response}")

{python_openevse_http-1.7.1 → python_openevse_http-1.8.0}/openevsehttp/const.py

@@ -72,6 +72,8 @@ SUCCESS_ANSWERS = [
     "Deleted",
     "User name saved",
     "User name removed",
+    "acknowledged",
+    "Reset done",
 ]
 
 ERROR_SESSION_REQUIRED = (

{python_openevse_http-1.7.1 → python_openevse_http-1.8.0}/openevsehttp/properties.py

@@ -671,3 +671,21 @@ class PropertiesMixin:
         self._github_token = (
             token.strip() if isinstance(token, str) and token.strip() else None
         )
+
+    @property
+    def notifications_count(self) -> int | None:
+        """Return unmuted notification advisories count from status summary."""
+        notifications = self._status.get("notifications")
+        if isinstance(notifications, Mapping):
+            return notifications.get("count")
+        return None
+
+    @property
+    def notifications_severity(self) -> str | None:
+        """Return max severity ('info', 'warning', 'critical') from status summary."""
+        notifications = self._status.get("notifications")
+        if isinstance(notifications, Mapping):
+            severity = notifications.get("severity")
+            if severity is not None:
+                return str(severity)
+        return None

{python_openevse_http-1.7.1 → python_openevse_http-1.8.0/python_openevse_http.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python_openevse_http
-Version: 1.7.1
+Version: 1.8.0
 Summary: Python wrapper for OpenEVSE HTTP API
 Home-page: https://github.com/firstof9/python-openevse-http
 Download-URL: https://github.com/firstof9/python-openevse-http
@@ -54,6 +54,11 @@ A Python library for communicating with [OpenEVSE](https://www.openevse.com/) ch
     - **Time Synchronization & RTC**: Manage time, timezone, and NTP sync (requires firmware 4.0.0+).
     - **Event Logs**: Retrieve diagnostic log blocks and log event history (requires firmware 4.0.0+).
     - **Certificates**: Manage SSL/TLS Root CA and client certificates (requires firmware 4.0.0+).
+    - **RFID Management**: RFID tag pairing mode and tag-to-user mappings (requires firmware 4.0.0+ / 5.0.0+).
+    - **Relay Diagnostics**: Stuck relay recovery cycle and contact-life estimation reset (requires firmware 5.1.0+).
+    - **Cable Temperature Monitoring**: Cable temperature sensor configuration and monitoring (requires firmware 5.1.0+).
+    - **Energy Meter Reset**: Reset the energy meter counters with soft/hard options (requires firmware 4.0.0+).
+    - **Advisory Notifications**: Retrieve gateway advisory notifications and acknowledge/mute active advisories (requires firmware 5.1.0+).
 
 ## Installation
 
@@ -156,7 +161,9 @@ When performing firmware update checks (`charger.firmware_check()`) or automatic
 | `/time` | GET, POST | ✅ | RTC and NTP time settings (v4.0.0+) |
 | `/settime` | POST | ✅ | Legacy time setting interface (v3.x / fallback to `$S1` on v2.x) |
 | `/logs` | GET | ✅ | Event log block bounds and block events (v4.0.0+) |
-| `/emeter` | DELETE | ❌ | Energy meter reset |
+| `/emeter` | DELETE | ✅ | Energy meter reset (v4.0.0+) |
+| `/notifications` | GET | ✅ | Gateway advisory notifications list (v5.1.0+) |
+| `/notifications/ack` | POST | ✅ | Acknowledge/mute active advisory notification (v5.1.0+) |
 | `/wifi` | GET, POST | ❌ | Network scanning and AP configuration |
 | `/tesla` | GET | ❌ | Tesla vehicle integration |
 | `/certificates`| GET, POST, DELETE | ✅ | SSL/TLS certificate management (v4.0.0+) |

{python_openevse_http-1.7.1 → python_openevse_http-1.8.0}/python_openevse_http.egg-info/scm_version.json

@@ -1,7 +1,7 @@
 {
-  "tag": "1.7.1",
+  "tag": "1.8.0",
   "distance": 0,
-  "node": "g5bd22bb9dfe02ab480daf3c8d674dc07ee9dc59e",
+  "node": "g04dabda43669113f1d304c4ecd69a7ab8e0fc923",
   "dirty": false,
   "branch": "HEAD",
   "node_date": "2026-09-29"

{python_openevse_http-1.7.1 → python_openevse_http-1.8.0}/requirements_test.txt

@@ -6,5 +6,5 @@ pytest-timeout==2.4.0
 pytest-asyncio
 requests_mock
 aiohttp
-tox==4.64.2
+tox==4.64.3
 freezegun

{python_openevse_http-1.7.1 → python_openevse_http-1.8.0}/tests/test_commands.py

@@ -38,6 +38,9 @@ TEST_URL_RFID_ADD = "http://openevse.test.tld/rfid/add"
 TEST_URL_RFID_USERS = "http://openevse.test.tld/rfid/users"
 TEST_URL_SCHEDULE = "http://openevse.test.tld/schedule"
 TEST_URL_SCHEDULE_PLAN = "http://openevse.test.tld/schedule/plan"
+TEST_URL_NOTIFICATIONS = "http://openevse.test.tld/notifications"
+TEST_URL_NOTIFICATIONS_ACK = "http://openevse.test.tld/notifications/ack"
+TEST_URL_EMETER = "http://openevse.test.tld/emeter"
 SERVER_URL = "openevse.test.tld"
 
 
@@ -2773,3 +2776,163 @@ async def test_get_schedule_plan(test_charger, test_charger_v2, mock_aioclient,
         CommandFailedError, match="Invalid response format for /schedule/plan: invalid"
     ):
         await test_charger.get_schedule_plan()
+
+
+# ── notifications ────────────────────────────────────────────────────
+
+
+async def test_get_notifications(test_charger, test_charger_v2, mock_aioclient, caplog):
+    """Test get_notifications command."""
+    await test_charger.update()
+
+    # 1. Version check failure on older firmware
+    with pytest.raises(
+        UnsupportedFeature, match="get_notifications requires gateway firmware 5.1.0"
+    ):
+        await test_charger_v2.get_notifications()
+
+    # Force test_charger gateway version to 5.1.0
+    test_charger._config["version"] = "5.1.0"
+
+    # 2. Successful GET /notifications
+    notif_data = {
+        "count": 1,
+        "max_severity": "warning",
+        "notifications": [
+            {
+                "id": "safety.ground_check",
+                "category": "safety",
+                "severity": "warning",
+                "sticky": False,
+                "acked": False,
+                "first_seen": 1726050000,
+                "last_seen": 1726050005,
+            }
+        ],
+    }
+    mock_aioclient.get(
+        TEST_URL_NOTIFICATIONS,
+        status=200,
+        body=json.dumps(notif_data),
+    )
+    with caplog.at_level(logging.DEBUG):
+        result = await test_charger.get_notifications()
+    assert result == notif_data
+    assert (
+        "Querying notifications: http://openevse.test.tld/notifications" in caplog.text
+    )
+
+    # 3. Invalid non-mapping response
+    mock_aioclient.get(
+        TEST_URL_NOTIFICATIONS,
+        status=200,
+        body="invalid",
+    )
+    with pytest.raises(
+        CommandFailedError, match="Invalid response from /notifications: invalid"
+    ):
+        await test_charger.get_notifications()
+
+
+async def test_acknowledge_notification(
+    test_charger, test_charger_v2, mock_aioclient, caplog
+):
+    """Test acknowledge_notification command."""
+    await test_charger.update()
+
+    # 1. Version check failure on older firmware
+    with pytest.raises(
+        UnsupportedFeature,
+        match="acknowledge_notification requires gateway firmware 5.1.0",
+    ):
+        await test_charger_v2.acknowledge_notification("safety.ground_check")
+
+    # Force test_charger gateway version to 5.1.0
+    test_charger._config["version"] = "5.1.0"
+
+    # 2. Invalid empty ID
+    with pytest.raises(ValueError, match="notification_id must be a non-empty string"):
+        await test_charger.acknowledge_notification("")
+
+    # 3. Successful POST /notifications/ack
+    mock_aioclient.post(
+        TEST_URL_NOTIFICATIONS_ACK,
+        status=200,
+        body="acknowledged",
+    )
+    with caplog.at_level(logging.DEBUG):
+        await test_charger.acknowledge_notification("safety.ground_check")
+    assert (
+        "Acknowledging notification safety.ground_check at http://openevse.test.tld/notifications/ack"
+        in caplog.text
+    )
+
+    # 4. Failure response from firmware
+    mock_aioclient.post(
+        TEST_URL_NOTIFICATIONS_ACK,
+        status=200,
+        body="no such active notification",
+    )
+    with pytest.raises(CommandFailedError, match="Problem acknowledging notification"):
+        await test_charger.acknowledge_notification("safety.ground_check")
+
+
+# ── reset_energy_meter ───────────────────────────────────────────────
+
+
+async def test_reset_energy_meter(
+    test_charger, test_charger_v2, mock_aioclient, caplog
+):
+    """Test reset_energy_meter command."""
+    await test_charger.update()
+
+    # 1. Version check failure on older firmware
+    with pytest.raises(
+        UnsupportedFeature, match="reset_energy_meter requires gateway firmware 4.0.0"
+    ):
+        await test_charger_v2.reset_energy_meter()
+
+    # 2. Successful reset with default params (hard=False, import=False)
+    mock_aioclient.delete(
+        TEST_URL_EMETER,
+        status=200,
+        body='{"msg": "Reset done"}',
+    )
+    with caplog.at_level(logging.DEBUG):
+        await test_charger.reset_energy_meter()
+    assert (
+        "Resetting energy meter: http://openevse.test.tld/emeter (hard=False, import=False)"
+        in caplog.text
+    )
+
+    # 3. Successful reset with hard=True, import_from_evse=True
+    caplog.clear()
+    mock_aioclient.delete(
+        TEST_URL_EMETER,
+        status=200,
+        body='{"msg": "Reset done"}',
+    )
+    with caplog.at_level(logging.DEBUG):
+        await test_charger.reset_energy_meter(hard=True, import_from_evse=True)
+    assert (
+        "Resetting energy meter: http://openevse.test.tld/emeter (hard=True, import=True)"
+        in caplog.text
+    )
+
+    # 4. Failure response from firmware
+    mock_aioclient.delete(
+        TEST_URL_EMETER,
+        status=200,
+        body='{"msg": "Reset failed"}',
+    )
+    with pytest.raises(CommandFailedError, match="Problem resetting energy meter"):
+        await test_charger.reset_energy_meter()
+
+    # 5. Non-mapping / error response
+    mock_aioclient.delete(
+        TEST_URL_EMETER,
+        status=200,
+        body="invalid response",
+    )
+    with pytest.raises(CommandFailedError, match="Problem resetting energy meter"):
+        await test_charger.reset_energy_meter()

{python_openevse_http-1.7.1 → python_openevse_http-1.8.0}/tests/test_properties.py

@@ -611,3 +611,20 @@ async def test_time_properties():
     assert charger.time_offset == "+0000"
     assert charger.sntp_enabled is True
     assert charger.sntp_hostname == "pool.ntp.org"
+
+
+async def test_notification_properties():
+    """Test notification summary properties."""
+    charger = OpenEVSE(SERVER_URL)
+    charger._status = {}
+
+    assert charger.notifications_count is None
+    assert charger.notifications_severity is None
+
+    charger._status = {"notifications": {"count": 2, "severity": "warning"}}
+    assert charger.notifications_count == 2
+    assert charger.notifications_severity == "warning"
+
+    charger._status = {"notifications": "invalid"}
+    assert charger.notifications_count is None
+    assert charger.notifications_severity is None