FHEM/mod-NUKI
1
0
Fork 0
Code Issues Pull Requests Releases 3 Wiki Activity

„NUKI DEVELOPER | Nuki Bridge HTTP API“ ändern

Marko Oldenburg 2021-11-30 12:42:22 +01:00
parent f7d8021f20
commit 4d81d2a9c1
1 changed files with 96 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
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>