Merge pull request #83 from sh00t2kill/develop

Replaced `store debug data` switch and the feature of storing debug data to `/config/.storage` with debug API

Author: elad-bar

.github/workflows/hassfest.yaml

@@ -12,5 +12,5 @@ jobs:
   validate:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v2"
+      - uses: "actions/checkout@v3.1.0"
       - uses: home-assistant/actions/hassfest@master

.github/workflows/pre-commit.yaml

@@ -13,26 +13,14 @@ jobs:
     runs-on: ubuntu-latest
     name: pre-commit
     steps:
-      - uses: actions/checkout@v2.3.4
-      - uses: actions/setup-python@v2.2.1
+      - uses: actions/checkout@v3.1.0
+      - uses: actions/setup-python@v4.3.0
         with:
           python-version: "3.10"
       - run: |
           pip install --constraint=.github/workflows/constraints.txt pip
           pip install --constraint=.github/workflows/constraints.txt pre-commit
-      - name: Compute cache key prefix
-        if: matrix.os != 'windows-latest'
-        id: cache_key_prefix
-        shell: python
-        run: |
-          import hashlib
-          import sys
-          python = "py{}.{}".format(*sys.version_info[:2])
-          payload = sys.version.encode() + sys.executable.encode()
-          digest = hashlib.sha256(payload).hexdigest()
-          result = "${{ runner.os }}-{}-{}-pre-commit".format(python, digest)
-          print("::set-output name=result::{}".format(result))
-      - uses: actions/cache@v2.1.3
+      - uses: actions/cache@v3.0.11
         if: matrix.os != 'windows-latest'
         with:
           path: ~/.cache/pre-commit

.pre-commit-config.yaml

@@ -2,36 +2,32 @@
 
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.32.1
+    rev: v3.2.2
     hooks:
       - id: pyupgrade
         args: [ --py310 ]
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 22.10.0
     hooks:
       - id: black
         args:
           - --safe
           - --quiet
-          - --exclude="robot\.py"
         files: ^((homeassistant|script|tests)/.+)?[^/]+\.py$
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.1.0
+    rev: v2.2.2
     hooks:
       - id: codespell
         args:
           - --ignore-words-list=hass,alot,datas,dof,dur,ether,farenheit,hist,iff,ines,ist,lightsensor,mut,nd,pres,referer,ser,serie,te,technik,ue,uint,visability,wan,wanna,withing,iam,incomfort
-          - --skip="./.*,*.csv,*.json,*.pem"
+          - --skip="./.*,*.csv,*.json"
           - --quiet-level=2
-        exclude_types: [csv, json, svg, pem, json]
+        exclude_types: [csv, json, svg]
         exclude: ^tests/fixtures/
   - repo: https://github.com/pycqa/flake8
-    rev: 3.8.4
+    rev: 5.0.4
     hooks:
       - id: flake8
-        additional_dependencies:
-          - flake8-docstrings==1.5.0
-          - pydocstyle==5.1.1
         files: ^(homeassistant|script|tests)/.+\.py$
   - repo: https://github.com/PyCQA/bandit
     rev: 1.7.4
@@ -40,22 +36,20 @@ repos:
         args:
           - --quiet
           - --format=custom
-          - --configfile=tests/bandit.yaml
-        files: ^(homeassistant|script)/.+\.py$
+        files: ^(homeassistant|script|tests)/.+\.py$
   - repo: https://github.com/PyCQA/isort
     rev: 5.10.1
     hooks:
       - id: isort
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.2.0
+    rev: v4.3.0
     hooks:
       - id: check-executables-have-shebangs
         stages: [manual]
       - id: check-json
         exclude: (.vscode|.devcontainer)
       - id: check-yaml
       - id: end-of-file-fixer
-        exclude: (.pem)
       - id: trailing-whitespace
       - id: check-added-large-files
   - repo: https://github.com/pre-commit/mirrors-prettier

CHANGELOG.md

@@ -2,12 +2,26 @@
 
 ## v0.3.2
 
-- Core alignment
-- Constants cleanup
-- Add retry mechanism for AWS token encryption process
+- Fix Filter Bag sensor
+- Core fix: wrongfully reported logs of entities getting updated when no update perform
+- Replaced `store debug data` switch and the feature of storing debug data to `/config/.storage` with debug API
+
+**Endpoints**
+
+| Endpoint Name                      | Method | Description                                                                                         |
+|------------------------------------|--------|-----------------------------------------------------------------------------------------------------|
+| /api/mydolphin_plus/list           | GET    | List all the endpoints available (supporting multiple integrations), available once for integration |
+| /api/mydolphin_plus/{ENTRY_ID}/api | GET    | JSON of all raw data from the MyDolphin Plus API, per integration                                   |
+| /api/mydolphin_plus/{ENTRY_ID}/ws  | GET    | JSON of all raw data from the MyDolphin Plus WebSocket, per integration                             |
+
+**Authentication: Requires long-living token from HA**
+
 
 ## v0.3.1
 
+- Core alignment
+- Constants cleanup
+- Add retry mechanism for AWS token encryption process
 - Fix get token API (API changed and new one requires encryption of data) [#76](https://github.com/sh00t2kill/dolphin-robot/issues/76)
 - Add generate AWS token test file
 - Store encrypted data within config file to avoid re-generating the file on every startup

README.md

@@ -70,8 +70,8 @@ Please remove the integration and re-add it to make it work again.
 ###### Environment variables
 | Environment Variable | Type    | Default | Description                                                                                                               |
 |----------------------|---------|---------|---------------------------------------------------------------------------------------------------------------------------|
-| TEST_USERNANE        | String  | -       | Username used for MyDolphin Plus                                                                                          |
-| TEST_PASSWORD        | String  | -       | Password used for MyDolphin Plus                                                                                          |
+| Username             | String  | -       | Username used for MyDolphin Plus                                                                                          |
+| Password             | String  | -       | Password used for MyDolphin Plus                                                                                          |
 | DEBUG                | Boolean | False   | Setting to True will present DEBUG log level message while testing the code, False will set the minimum log level to INFO |
 
 ## HA Components
@@ -87,7 +87,6 @@ Please remove the integration and re-add it to make it work again.
 | {Robot Name} Cycle Time          | Sensor         | Indicates the time the robot is cleaning                          |                                                                                                                                     |
 | {Robot Name} Cycle Time Left     | Sensor         | Indicates the time left for the robot to complete the cycle       |                                                                                                                                     |
 | {Robot Name}                     | Vacuum         | Provides functionality of vacuum to the robot                     | Features: State, Fan Speed (Cleaning Mode), Return Home (Pickup), Turn On, Turn Off, Send Command (Navigate, Schedule, Delay Clean) |
-| {Robot Name} Store Debug Data    | Switch         | Sets whether to store API and WebSocket latest data for debugging |                                                                                                                                     |
 
 ### Cleaning Modes
 
@@ -159,6 +158,44 @@ data:
       mode: all
 ```
 
+## API
+
+| Endpoint Name                      | Method | Description                                                                                         |
+|------------------------------------|--------|-----------------------------------------------------------------------------------------------------|
+| /api/mydolphin_plus/list           | GET    | List all the endpoints available (supporting multiple integrations), available once for integration |
+| /api/mydolphin_plus/{ENTRY_ID}/api | GET    | JSON of all raw data from the MyDolphin Plus API, per integration                                   |
+| /api/mydolphin_plus/{ENTRY_ID}/ws  | GET    | JSON of all raw data from the MyDolphin Plus WebSocket, per integration                             |
+
+**Authentication: Requires long-living token from HA**
+
+### Examples
+
+#### List
+
+*Request*
+```bash
+curl https://ha_url:8123/api/mydolphin_plus/list
+   -H "Accept: application/json"
+   -H "Authorization: Bearer {token}"
+```
+
+#### WebSockets Data
+
+*Request*
+```bash
+curl https://ha_url:8123/api/mydolphin_plus/{ENTRY_ID}/ws
+   -H "Accept: application/json"
+   -H "Authorization: Bearer {token}"
+```
+
+#### API Data
+
+```bash
+curl https://ha_url:8123/api/mydolphin_plus/{ENTRY_ID}/api
+   -H "Accept: application/json"
+   -H "Authorization: Bearer {token}"
+```
+
 ## Troubleshooting
 
 Before opening an issue, please provide logs related to the issue,

custom_components/mydolphin_plus/component/api/aws_iot_websocket.py

@@ -1,12 +1,12 @@
 from __future__ import annotations
 
 import asyncio
+from collections.abc import Awaitable, Callable
 from datetime import datetime
 import json
 import logging
 import os
 import sys
-from typing import Awaitable, Callable
 import uuid
 
 from AWSIoTPythonSDK.MQTTLib import AWSIoTMQTTClient

custom_components/mydolphin_plus/component/api/mydolphin_plus_api.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
 from base64 import b64encode
+from collections.abc import Awaitable, Callable
 import hashlib
 import logging
 import secrets
 import sys
-from typing import Awaitable, Callable
 
 from aiohttp import ClientResponseError
 from cryptography.hazmat.backends import default_backend