@sebbo2002/pyatv-mqtt-bridge 4.0.2 → 4.0.3-develop.2

package/README.md

@@ -7,14 +7,13 @@ MQTT Bridge allows you to remote control your Apple TV using the MQTT protocol.
 example, this protocol is supported, so Apple TV can be integrated into your existing automation system. In addition to
 simulating key presses, you can also query the current state of Apple TV.
 
-
 ## ☁ Installation
 
 Before you use this module you need to install `pyatv`. See FAQ section for installation tips.
 
 To install the javascript module via npm run:
 
-	npm install -g @sebbo2002/pyatv-mqtt-bridge
+    npm install -g @sebbo2002/pyatv-mqtt-bridge
 
 You can also use the provided Docker container to run `pyatv-mqtt-bridge` within docker:
 
@@ -30,31 +29,40 @@ You can also use the provided Docker container to run `pyatv-mqtt-bridge` within
 
 ```json
 {
-  "broker": "mqtt://192.168.1.1",
-  "devices": [
-    {
-      "name": "Any Name",
-      "topic": "home/livingroom/appletv",
-      "host": "192.168.1.2",
-      "id": "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
-      "airplayCredentials": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA:BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB:CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC:DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD"
-    }
-  ]
+    "broker": "mqtt://192.168.1.1",
+    "devices": [
+        {
+            "name": "Any Name",
+            "topic": "home/livingroom/appletv",
+            "host": "192.168.1.2",
+            "id": "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
+            "airplayCredentials": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA:BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB:CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC:DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD"
+        }
+    ]
 }
 ```
 
 3. Start pyatv
+
+-   By command line :
+
 ```bash
 pyatv-mqtt-bridge /home/eve/pyatv-mqtt-bridge.json
+```
 
-# or use the Docker container
+-   or use the Docker container :
 
+```bash
 docker run -d --restart=always --name=pyatv-mqtt-bridge \
     -v $(pwd)/config.json:/app/config.json:ro \
     sebbo2002/pyatv-mqtt-bridge
 ```
 
+-   or just run the Docker container from the [`docker-compose.yml`](docker-compose.yml) file with :
 
+```bash
+docker-compose up -d
+```
 
 ## 🤨 FAQ
 
@@ -64,25 +72,66 @@ docker run -d --restart=always --name=pyatv-mqtt-bridge \
 pip3 install pyatv
 ```
 
-#### How can I enable debugging mode?
+#### How can I enable debugging mode ?
+
+You just need to add the `--debug` option.
+
+-   In command line :
 
 ```bash
 pyatv-mqtt-bridge --debug /home/eve/pyatv-mqtt-bridge.json
+```
 
-# or if you use the Docker container
+-   or while using the Docker container :
 
+```bash
 docker run -d --restart=always --name=pyatv-mqtt-bridge \
     -v $(pwd)/config.json:/app/config.json:ro \
     sebbo2002/pyatv-mqtt-bridge \
     pyatv-mqtt-bridge --debug /app/config.json
 ```
 
+-   or while using the [`docker-compose.yml`](docker-compose.yml) file :
+
+```yaml
+command: pyatv-mqtt-bridge --debug /app/config.json
+```
+
+       then restart the container with :
+
+```bash
+   docker-compose up
+```
 
 #### How can I send commands to the Apple TV?
+
 To execute a command send any message to the topic `$device/$command`. `$device` is the configured topic of the device
 and `$command` is a command from [this list](https://github.com/sebbo2002/node-pyatv/blob/develop/src/lib/types.ts#L49).
 Example: `/home/living/appletv/menu`.
 
+#### How to check the current Apple TV power state and other status information ?
+
+You can listen to several subtopics from the root MQTT topic you've set on your `config.json` file
+(i.e. : `/home/living/appletv`), such as `/powerState` (on, off) and `/deviceState` (iddle, playing, etc...).
+
+#### When the Apple TV is off, the turnOff command turns it on instead, how to fix this ?
+
+Say you send an MQTT message to turn off your Apple TV each time you're leaving home,
+with the following MQTT topic : `/home/living/appletv/turnOff`.  
+... but when you are back home, sometimes your Apple TV is on ! 🤔
+
+Actually, if you press the power button in the right upper corner of your Apple TV remote iOS app, while your Apple TV
+is already off, it will switch it on as well, and this project only provides bridging between MQTT
+and PyATV / Apple TV APIs, with no additional data persistence.
+
+> (You could use the `/suspend` command instead of `/turnOff` to avoid this, but the `suspend` and `wakeup`
+> commands are deprecated and may lead to unexpected behaviors).
+
+So you just need to implement a listener for the powerState MQTT topic (i.e. : `/home/living/appletv/powerState`)
+in your own app, and store the payload value somewhere (DB, local file, Redis...).
+
+Then your app logic with some "standby apple TV" feature should trigger an MQTT `/turnOff` command ONLY when your
+powerState stored value is 'on'.
 
 ## Copyright and license
 

package/package.json

@@ -21,18 +21,18 @@
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^8.0.6",
     "@types/mocha": "^10.0.0",
-    "@types/node": "^18.8.3",
+    "@types/node": "^18.11.9",
     "@types/ws": "^8.5.3",
-    "@typescript-eslint/eslint-plugin": "^5.40.0",
-    "@typescript-eslint/parser": "^5.40.0",
-    "eslint": "^8.25.0",
-    "eslint-plugin-jsonc": "^2.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.42.0",
+    "@typescript-eslint/parser": "^5.42.0",
+    "eslint": "^8.26.0",
+    "eslint-plugin-jsonc": "^2.5.0",
     "esm": "^3.2.25",
     "license-checker": "^25.0.1",
     "semantic-release": "^19.0.5",
     "semantic-release-license": "^1.0.3",
     "ts-node": "^10.8.1",
-    "typedoc": "^0.23.16",
+    "typedoc": "^0.23.20",
     "typescript": "^4.8.4"
   },
   "engines": {
@@ -59,5 +59,5 @@
     "start": "node ./dist/bin/cli.js"
   },
   "type": "module",
-  "version": "4.0.2"
+  "version": "4.0.3-develop.2"
 }