From 4d81d2a9c12acc32cf31ab3b62e838a7cb77effc Mon Sep 17 00:00:00 2001
From: Marko Oldenburg <marko@noreply@cooltux.net>
Date: Tue, 30 Nov 2021 12:42:22 +0100
Subject: [PATCH] =?UTF-8?q?=E2=80=9ENUKI=20DEVELOPER=20|=20Nuki=20Bridge?=
 =?UTF-8?q?=20HTTP=20API=E2=80=9C=20=C3=A4ndern?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 NUKI-DEVELOPER-%7C-Nuki-Bridge-HTTP-API.md | 96 ++++++++++++++++++++++
 1 file changed, 96 insertions(+)

diff --git a/NUKI-DEVELOPER-%7C-Nuki-Bridge-HTTP-API.md b/NUKI-DEVELOPER-%7C-Nuki-Bridge-HTTP-API.md
index 7c7e8e2..81739f7 100644
--- a/NUKI-DEVELOPER-%7C-Nuki-Bridge-HTTP-API.md
+++ b/NUKI-DEVELOPER-%7C-Nuki-Bridge-HTTP-API.md
@@ -234,4 +234,100 @@ http://192.168.1.50:8080/configAuth?enable=0&ts=2019-03-05T01:06:53Z&rnr=4711&ha
         <th>Example-Response</th>
         <td colspan="2">{"success": true}</td>
     </tr>
+</table>
+
+### /list
+<table>
+    <tr>
+        <th>URL</th>
+        <td colspan="3">http://192.168.1.50:8080/list</td>
+    </tr>
+    <tr>
+        <th>Usage</th>
+        <td colspan="3">Returns a list of all paired Nuki devices</td>
+    </tr>
+    <tr>
+        <th>URL-Parameters</th>
+        <th>Token</th>
+        <td colspan="2">The api token configured via the Nuki app when enabling the API</td>
+    </tr>
+    <tr>
+        <th rowspan="17">Response</th>
+        <td colspan="3">JSON array. One item of the following per Nuki device</td>
+    </tr>
+    <tr>
+        <th>nukiid</th>
+        <td>ID of the Nuki device</td>
+    </tr>
+    <tr>
+        <th>deviceType</th>
+        <td colspan="2">Nuki device type</br>
+          <ul>
+            <li>0 => smartlock (Nuki Smart Lock 1.0/2.0)</li>
+            <li>2 => opener (Nuki Opener)</li>
+            <li>3 => smartdoor (Nuki Smart Door)</li>
+            <li>4 => smartlock 3 (Nuki Smart Lock 3.0 (Pro))</li>
+          </ul></td>
+    </tr>
+    <tr>
+        <th>name</th>
+        <td colspan="2">Name of the Nuki device</td>
+    </tr>
+    <tr>
+        <th rowspan="13">lastKnownState</th>
+        <td colspan="2">JSON list containing the last known lock state of the Nuki device</td>
+    </tr>
+    <tr>
+        <th>mode</th>
+        <td>ID of the lock mode (see Modes)</td>
+    </tr>
+    <tr>
+        <th>state</th>
+        <td>ID of the lock state (see Lock States)</td>
+    </tr>
+    <tr>
+        <th>stateName</th>
+        <td>Name of the lock state (see Lock States)</td>
+    </tr>
+    <tr>
+        <th>batteryCritical</th>
+        <td>Flag indicating if the batteries of the Nuki device are at critical level</td>
+    </tr>
+    <tr>
+        <th>batteryCharging</th>
+        <td>Flag indicating if the batteries of the Nuki device are charging at the moment</td>
+    </tr>
+    <tr>
+        <th>batteryChargeState</th>
+        <td>Value representing the current charge status in %</td>
+    </tr>
+    <tr>
+        <th>keypadBatteryCritical</th>
+        <td>Flag indicating if the batteries of the paired Nuki Keypad are at critical level</td>
+    </tr>
+    <tr>
+        <th>doorsensorState</th>
+        <td>ID of the door sensor state</td>
+    </tr>
+    <tr>
+        <th>doorsensorStateName</th>
+        <td>Name of the door sensor state</td>
+    </tr>
+    <tr>
+        <th>ringactionTimestamp</th>
+        <td>Timestamp of the last ring-action</td>
+    </tr>
+    <tr>
+        <th>ringactionState</th>
+        <td>Flag indicating if a ring-action is currently occuring or not (reset after 30 seconds)</td>
+    </tr>
+    <tr>
+        <th>timestamp</th>
+        <td>Timestamp of the retrieval of this lock state</td>
+    </tr>
+    <tr>
+        <th>Errors</th>
+        <th>HTTP 401</th>
+        <td colspan="2">Returned if the given token is invalid or a hashed token parameter is missing.</td>
+    </tr>
 </table>
\ No newline at end of file