Fix retained otp messages bug

README.md

@@ -87,8 +87,36 @@ The following steps are required for authentication in exactly this order:
 ```etc ...```
 4. Now, open your mailbox and copy your OTP Code
 5. Open HomeAssistant and search for the entity ID ```text.volvo_otp```
-6. Paste your OTP into the text entity and press Enter
-7. If everything has worked, your addon is now authenticated. In the future, OTP authentication only needs to be done when updating, not when restarting the container.
+6. Paste your OTP into the text entity and **<ins>press Enter</ins>**<br>
+   6a. (optional) If your OTP cannot be safed, try to paste your OTP code via MQTT to the following topic: `volvoAAOS2mqtt/otp_code` <p>
+       <details>
+             <summary>OTP Post Script</summary>
+             <div>
+                <p>
+                1. Safe the following script in your script section <br>
+                2. Go to https://yourHAUrl/developer-tools/service<br>
+                3. Search for "Post Volvo OTP"<br>
+                4. Tick "OTP" and fill in your OTP<br>
+                5. Run this service<br>
+             </div>
+       
+            alias: Post Volvo OTP
+            sequence:
+              - service: mqtt.publish
+                metadata: {}
+                data:
+                  topic: volvoAAOS2mqtt/otp_code
+                  payload: "{{ otp }}"
+            mode: single
+            fields:
+              otp:
+                selector:
+                  text: null
+                name: OTP
+                description: Volvo OTP
+   
+   </details>
+8. If everything has worked, your addon is now authenticated. In the future, OTP authentication only needs to be done when updating, not when restarting the container.
 
 ## Setup
 <b>Docker:</b>

requirements.txt

@@ -1,4 +1,4 @@
-requests~=2.31.0
+requests~=2.32.0
 dynaconf~=3.1.12
 paho-mqtt~=1.6.1
 Babel~=2.12.1

src/CHANGELOG.md

@@ -1,3 +1,44 @@
+## v1.9.3
+### 🐛 Bug Fixes:
+
+- Ignore retained OTP messages #193
+
+## v1.9.2
+### 🐛 Bug Fixes:
+
+- Try to fix OTP Input
+- Fix `SyntaxWarning: invalid escape sequence '\d'` #196 
+
+## v1.9.1
+### 🚀 Features:
+
+- The token file now survives an HA addon update/restart
+
+### 🐛 Bug Fixes:
+
+- Extend OTP retry time to 120 seconds
+
+## v1.9.0
+### ⚠️ Breaking change 
+### 🚀 Features:
+
+- Add "Battery Capacity" sensor. Thanks to @gurtjun!
+- OTP Auth
+        This addon uses the same OTP authentication as the Volvo app, now. 
+        The following steps are required for authentication in exactly this order:
+        
+        1. Setup volvo2Mqtt, either via Docker, or via HA addon (take a look at the "Setup" section)
+        2. Fill in your settings and start volvo2Mqtt
+        3. Your log will show the following lines
+        Waiting for otp code... Please check your mailbox and post your otp code to the following mqtt topic "volvoAAOS2mqtt/otp_code". Retry 0/15
+        Waiting for otp code... Please check your mailbox and post your otp code to the following mqtt topic "volvoAAOS2mqtt/otp_code". Retry 1/15
+        etc ...
+        4. Now, open your mailbox and copy your OTP Code
+        5. Open HomeAssistant and search for the entity ID text.volvo_otp
+        6. Paste your OTP into the text entity and press Enter
+        7. If everything has worked, your addon is now authenticated. In the future, OTP authentication only needs to be done when updating, not when restarting the container.
+
+
 ## v1.8.27
 ### 🚀 Features:
 

src/config.yaml

@@ -1,6 +1,6 @@
 name: "Volvo2Mqtt"
 description: "Volvo AAOS MQTT bridge"
-version: "1.9.0"
+version: "1.9.3"
 slug: "volvo2mqtt"
 init: false
 url: "https://github.com/Dielee/volvo2mqtt"

src/const.py

@@ -1,6 +1,6 @@
 from config import settings
 
-VERSION = "v1.9.0"
+VERSION = "v1.9.3"
 
 OAUTH_TOKEN_URL = "https://volvoid.eu.volvocars.com/as/token.oauth2"
 OAUTH_AUTH_URL = "https://volvoid.eu.volvocars.com/as/authorization.oauth2"
@@ -139,5 +139,5 @@ supported_entities = [
 ]
 
 old_entity_ids = ["months_to_service", "service_warning_trigger", "distance_to_empty"]
-otp_max_loops = 15
+otp_max_loops = 24
 otp_mqtt_topic = "volvoAAOS2mqtt/otp_code"

src/mqtt.py

@@ -47,25 +47,37 @@ def connect():
 
 
 def create_otp_input():
+    state_topic = otp_mqtt_topic + "/state"
     config = {
         "name": "Volvo OTP",
         "object_id": f"volvo_otp",
         "schema": "state",
         "command_topic": otp_mqtt_topic,
-        "unique_id": f"volvoAAOS2mqtt_otp",
-        "pattern": "\d{6}",
-        "icon": "mdi:two-factor-authentication"
+        "state_topic": state_topic,
+        "unique_id": "volvoAAOS2mqtt_otp",
+        "pattern": r"\d{6}",
+        "icon": "mdi:two-factor-authentication",
+        "mode": "text"
     }
 
     mqtt_client.publish(
-        f"homeassistant/text/volvoAAOS2mqtt/volvo_otp/config",
+        "homeassistant/text/volvoAAOS2mqtt/volvo_otp/config",
         json.dumps(config),
         retain=True
     )
 
-def delete_otp_input():
-    topic = "homeassistant/text/volvoAAOS2mqtt/volvo_otp/config"
-    mqtt_client.publish(topic, payload="", retain=True)
+    mqtt_client.publish(
+        state_topic,
+        "000000",
+        retain=True
+    )
+
+def set_otp_state():
+    mqtt_client.publish(
+        otp_mqtt_topic + "/state",
+        otp_code,
+        retain=True
+    )
 
 
 def send_car_images(vin, data, device):
@@ -119,8 +131,12 @@ def on_disconnect(client, userdata, rc):
 def on_message(client, userdata, msg):
     payload = msg.payload.decode("UTF-8")
     if msg.topic == otp_mqtt_topic:
-        global otp_code
-        otp_code = payload
+        if msg.retain == 0:
+            global otp_code
+            otp_code = payload
+            set_otp_state()
+        else:
+            logging.warning("Found retained OTP, this can't work! Pleas clean retained messages!")
         return None
     else:
         try:

src/util.py

@@ -42,8 +42,16 @@ def get_volvo_app_version():
     else:
         return "5.37.0"
 
-def save_to_json(data):
-    with open('.token', 'w', encoding='utf-8') as f:
+def get_token_path():
+    token_path = ".token"
+    if os.environ.get("IS_HA_ADDON"):
+        check_existing_folder("/addons/volvo2mqtt/token/")
+        token_path = "/addons/volvo2mqtt/token/.token"
+
+    return token_path
+
+def save_to_json(data, token_path):
+    with open(token_path, 'w', encoding='utf-8') as f:
         json.dump(data, f, ensure_ascii=False, indent=4)
 
 def get_icon_between(icon_list, state):
@@ -57,7 +65,7 @@ def get_icon_between(icon_list, state):
 def setup_logging():
     log_location = "volvo2mqtt.log"
     if os.environ.get("IS_HA_ADDON"):
-        check_existing_folder()
+        check_existing_folder("/addons/volvo2mqtt/log/")
         log_location = "/addons/volvo2mqtt/log/volvo2mqtt.log"
 
     logging.Formatter.converter = lambda *args: datetime.now(tz=TZ).timetuple()
@@ -90,8 +98,8 @@ def setup_logging():
             logger.setLevel(logging.ERROR)
 
 
-def check_existing_folder():
-    Path("/addons/volvo2mqtt/log/").mkdir(parents=True, exist_ok=True)
+def check_existing_folder(path):
+    Path(path).mkdir(parents=True, exist_ok=True)
 
 
 def keys_exists(element, *keys):

src/volvo.py

@@ -35,9 +35,11 @@ backend_status = ""
 
 def authorize(renew_tokenfile=False):
     global refresh_token
-    if os.path.isfile(".token") and not renew_tokenfile:
+
+    token_path = util.get_token_path()
+    if os.path.isfile(token_path) and not renew_tokenfile:
         logging.info("Using login from token file")
-        f = open('.token')
+        f = open(token_path)
         data = json.load(f)
         refresh_token = data["refresh_token"]
         refresh_auth()
@@ -91,7 +93,7 @@ def authorize(renew_tokenfile=False):
             token_expires_at = datetime.now(util.TZ) + timedelta(seconds=(token_data["expires_in"] - 30))
             refresh_token = token_data["refresh_token"]
 
-            util.save_to_json(token_data)
+            util.save_to_json(token_data, token_path)
         else:
             message = auth.json()
             raise Exception(message["details"][0]["userMessage"])
@@ -154,7 +156,6 @@ def send_otp(auth_session, data):
     if not mqtt.otp_code:
         raise Exception ("No OTP found, exting...")
 
-    mqtt.delete_otp_input()
     auth = auth_session.post(next_url, data=json.dumps(body))
     if auth.status_code == 200:
         return auth.json()
@@ -184,8 +185,9 @@ def refresh_auth():
         return None
 
     if auth.status_code == 200:
+        token_path = util.get_token_path()
         data = auth.json()
-        util.save_to_json(data)
+        util.save_to_json(data, token_path)
         session.headers.update({"authorization": "Bearer " + data["access_token"]})
 
         global token_expires_at