2
0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-03-03 16:56:54 +00:00

73_DoorBird: Feature - Meta Data completed

git-svn-id: https://svn.fhem.de/fhem/trunk@23668 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
Sailor 2021-02-03 17:54:53 +00:00
parent a9e9c9b7bf
commit 4bd9b382a4

View File

@ -4605,7 +4605,7 @@ sub DoorBird_findNewestFWVersion($$$)
<td>
The DoorBird module establishes the communication between the DoorBird - door intercommunication unit and the fhem home automation based on the official API, published by the manufacturer.<BR>
Please make sure, that the user has been enabled the API-Operator button in the DoorBird Android/iPhone APP under "Administration -> User -> Edit -> Permission -> API-Operator".
The following packet - installations are pre-requisite if not already installed by other modules (Examples below tested on Raspberry JESSIE):<BR>
The following packet - installations are pre-requisite if not already installed by other modules (Examples below tested on Raspbian):<BR>
<BR>
<code>
<li>sudo apt-get install sox </li>
@ -4622,166 +4622,56 @@ sub DoorBird_findNewestFWVersion($$$)
</table>
<BR>
<table>
<tr>
<td>
<a name="DoorBirddefine"></a><b>Define</b>
</td>
</tr>
<tr><td><a name="DoorBirddefine"></a><b>Define</b></td></tr>
<tr><td><ul><code>define &lt;name&gt; DoorBird &lt;IPv4-address&gt; &lt;Username&gt; &lt;Password&gt;</code> <BR> </ul></td></tr>
<tr><td><ul><ul><code>&lt;name&gt; </code> : The name of the device. Recommendation: "myDoorBird". <BR> </ul></ul></td></tr>
<tr><td><ul><ul><code>&lt;IPv4-address&gt; </code> : A valid IPv4 address of the KMxxx. You might look into your router which DHCP address has been given to the DoorBird unit. <BR> </ul></ul></td></tr>
<tr><td><ul><ul><code>&lt;Username&gt; </code> : The username which is required to sign on the DoorBird. <BR> </ul></ul></td></tr>
<tr><td><ul><ul><code>&lt;Password&gt; </code> : The password which is required to sign on the DoorBird. <BR> </ul></ul></td></tr>
</table>
<table>
<tr>
<td>
<ul>
<code>define &lt;name&gt; DoorBird &lt;IPv4-address&gt; &lt;Username&gt; &lt;Password&gt;</code>
</ul>
</td>
</tr>
</table>
<ul>
<ul>
<table>
<tr><td><code>&lt;name&gt; </code> : </td><td>The name of the device. Recommendation: "myDoorBird". </td></tr>
<tr><td><code>&lt;IPv4-address&gt; </code> : </td><td>A valid IPv4 address of the KMxxx. You might look into your router which DHCP address has been given to the DoorBird unit. </td></tr>
<tr><td><code>&lt;Username&gt; </code> : </td><td>The username which is required to sign on the DoorBird. </td></tr>
<tr><td><code>&lt;Password&gt; </code> : </td><td>The password which is required to sign on the DoorBird. </td></tr>
</table>
</ul>
</ul>
<BR>
<table>
<tr><td><a name="DoorBirdSet"></a><b>Set</b></td></tr>
<tr><td><ul>The set function is able to change or activate the following features as follows:</ul></td></tr>
</table>
<table>
<tr><td><ul><code>set Light_On </code></ul></td><td> : Activates the IR lights of the DoorBird unit. The IR - light deactivates automatically by the default time within the Doorbird unit </td></tr>
<tr><td><ul><code>set Live_Audio &lt;on:off&gt; </code></ul></td><td> : Activate/Deactivate the Live Audio Stream of the DoorBird on or off and toggles the direct link in the <b>hidden</b> Reading <code>.AudioURL</code> </td></tr>
<tr><td><ul><code>set Live_Video &lt;on:off&gt; </code></ul></td><td> : Activate/Deactivate the Live Video Stream of the DoorBird on or off and toggles the direct link in the <b>hidden</b> Reading <code>.VideoURL</code> </td></tr>
<tr><td><ul><code>set Open Door &lt;Value&gt; </code></ul></td><td> : Activates the Relay of the DoorBird unit with the given address. The list of installed relay addresses are imported with the initialization of parameters. </td></tr>
<tr><td><ul><code>set Restart </code></ul></td><td> : Sends the command to restart (reboot) the Doorbird unit </td></tr>
<tr><td><ul><code>set Transmit_Audio &lt;Path&gt; </code></ul></td><td> : Converts a given audio file and transmits the stream to the DoorBird speaker. Requires a datapath to audio file to be converted and send. The user "fhem" needs to have write access to this directory.<BR> </td></tr>
</table>
<table>
<tr><td><a name="DoorBirdGet"></a><b>Get</b></td></tr>
<tr><td>
<ul>
The get function is able to obtain the following information from the DoorBird unit:<BR><BR>
</ul>
</td></tr>
</table>
<table>
<tr><td><ul><code>get History_Request </code></ul></td><td> : Downloads the pictures of the last events of the doorbell and motion sensor. (Refer to attribute <code>MaxHistory</code>) </td></tr>
<tr><td><ul><code>get Image_Request </code></ul></td><td> : Downloads the current Image of the camera of DoorBird unit. </td></tr>
<tr><td><ul><code>get Video_Request &lt;Value&gt; </code></ul></td><td> : Downloads the current Video of the camera of DoorBird unit for th etime in seconds given. </td></tr>
<tr><td><ul><code>get Info_Request </code></ul></td><td> : Downloads the current internal setup such as relay configuration, firmware version etc. of the DoorBird unit. The obtained relay adresses will be used as options for the <code>Open_Door</code> command. </td></tr>
<tr><td><ul>The set function is able to change or activate the following features as follows: <BR> </ul> </td></tr>
<tr><td><ul><a name="Light_On" ></a><li><b><u><code>set Light_On </code></u></b> : Activates the IR lights of the DoorBird unit. The IR - light deactivates automatically by the default time within the Doorbird unit <BR></li></ul> </td></tr>
<tr><td><ul><a name="Live_Audio" ></a><li><b><u><code>set Live_Audio &lt;on:off&gt; </code></u></b> : Activate/Deactivate the Live Audio Stream of the DoorBird on or off and toggles the direct link in the <b>hidden</b> Reading <code>.AudioURL</code> <BR></li></ul> </td></tr>
<tr><td><ul><a name="Live_Video" ></a><li><b><u><code>set Live_Video &lt;on:off&gt; </code></u></b> : Activate/Deactivate the Live Video Stream of the DoorBird on or off and toggles the direct link in the <b>hidden</b> Reading <code>.VideoURL</code> <BR></li></ul> </td></tr>
<tr><td><ul><a name="Open Door" ></a><li><b><u><code>set Open Door &lt;Value&gt; </code></u></b> : Activates the Relay of the DoorBird unit with the given address. The list of installed relay addresses are imported with the initialization of parameters. <BR></li></ul> </td></tr>
<tr><td><ul><a name="Restart" ></a><li><b><u><code>set Restart </code></u></b> : Sends the command to restart (reboot) the Doorbird unit <BR></li></ul> </td></tr>
<tr><td><ul><a name="Transmit_Audio" ></a><li><b><u><code>set Transmit_Audio &lt;Path&gt; </code></u></b> : Converts a given audio file and transmits the stream to the DoorBird speaker. Requires a datapath to audio file to be converted and send. The user "fhem" needs to have write access to this directory. <BR></li></ul> </td></tr>
</table>
<BR>
<table>
<tr><td><a name="DoorBirdGet"></a><b>Get</b></td></tr>
<tr><td><ul>The get function is able to obtain the following information from the DoorBird unit:<BR></ul></td></tr>
<tr><td><ul><a name="History_Request" ></a><li><b><u><code>get History_Request </code></u></b> : Downloads the pictures of the last events of the doorbell and motion sensor. (Refer to attribute <code>MaxHistory</code>) <BR></li></ul> </td></tr>
<tr><td><ul><a name="Image_Request" ></a><li><b><u><code>get Image_Request </code></u></b> : Downloads the current Image of the camera of DoorBird unit. <BR></li></ul> </td></tr>
<tr><td><ul><a name="Video_Request" ></a><li><b><u><code>get Video_Request &lt;Value&gt; </code></u></b> : Downloads the current Video of the camera of DoorBird unit for th etime in seconds given. <BR></li></ul> </td></tr>
<tr><td><ul><a name="Info_Request" ></a><li><b><u><code>get Info_Request </code></u></b> : Downloads the current internal setup such as relay configuration, firmware version etc. of the DoorBird unit. The obtained relay adresses will be used as options for the <code>Open_Door</code> command. <BR></li></ul> </td></tr>
</table>
<BR>
<table>
<tr><td><a name="DoorBirdAttr"></a><b>Attributes</b></td></tr>
<tr><td>
<ul>
The following user attributes can be used with the DoorBird module in addition to the global ones e.g. <a href="#room">room</a>.<BR>
</ul>
</td></tr>
<tr><td><ul>The following user attributes can be used with the DoorBird module in addition to the global ones e.g. <a href="#room">room</a>.<BR></ul></td></tr>
</table>
<table>
<tr><td><ul><ul><a name="disable" ></a><li><b><u><code>disable </code></u></b> : Stops the device from further reacting on UDP datagrams sent by the DoorBird unit.<BR>The default value is 0 = activated <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="KeepAliveTimeout" ></a><li><b><u><code>KeepAliveTimeout </code></u></b> : Timeout in seconds without still-alive UDP datagrams before state of device will be set to "disconnected".<BR>The default value is 30s <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="MaxHistory" ></a><li><b><u><code>MaxHistory </code></u></b> : Number of pictures to be downloaded from history for both - doorbell and motion sensor events.<BR>The default value is "50" which is the maximum possible. <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="PollingTimeout" ></a><li><b><u><code>PollingTimeout </code></u></b> : Timeout in seconds before download requests are terminated in cause of no reaction by DoorBird unit. Might be required to be adjusted due to network speed.<BR>The default value is 10s. <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="UdpPort" ></a><li><b><u><code>UdpPort </code></u></b> : Port number to be used to receice UDP datagrams. Ports are pre-defined by firmware.<BR>The default value is port 6524 <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="SessionIdSec" ></a><li><b><u><code>SessionIdSec </code></u></b> : Time in seconds for how long the session Id shall be valid, which is required for secure Video and Audio transmission. The DoorBird kills the session Id after 10min = 600s automatically. In case of use with CCTV recording units, this function must be disabled by setting to 0.<BR>The default value is 540s = 9min. <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="AudioFileDir" ></a><li><b><u><code>AudioFileDir </code></u></b> : The relative (e.g. "audio") or absolute (e.g. "/mnt/NAS/audio") with or without trailing "/" directory path to which the audio files supposed to be stored.<BR>The default value is <code>""</code> = disabled <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="ImageFileDir" ></a><li><b><u><code>ImageFileDir </code></u></b> : The relative (e.g. "images") or absolute (e.g. "/mnt/NAS/images") with or without trailing "/" directory path to which the image files supposed to be stored.<BR>The default value is <code>""</code> = disabled <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="VideoFileDir" ></a><li><b><u><code>VideoFileDir </code></u></b> : The relative (e.g. "images") or absolute (e.g. "/mnt/NAS/images") with or without trailing "/" directory path to which the video files supposed to be stored.<BR>The default value is <code>""</code> = disabled <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="VideoFileFormat" ></a><li><b><u><code>VideoFileFormat </code></u></b> : The file format for the video file to be stored<BR>The default value is <code>"mpeg"</code> <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="VideoDurationDoorbell" ></a><li><b><u><code>VideoDurationDoorbell </code></u></b> : Time in seconds for how long the video shall be recorded in case of an doorbbell event.<BR>The default value is <code>0</code> = disabled <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="VideoDurationMotion" ></a><li><b><u><code>VideoDurationMotion </code></u></b> : Time in seconds for how long the video shall be recorded in case of an motion sensor event.<BR>The default value is <code>0</code> = disabled <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="EventReset" ></a><li><b><u><code>EventReset </code></u></b> : Time in seconds after wich the Readings for the Events Events (e.g. "doorbell_button", "motions sensor", "keypad") shal be reset to "idle".<BR>The default value is 5s <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="WaitForHistory" ></a><li><b><u><code>WaitForHistory </code></u></b> : Time in seconds after wich the module shall wait for an history image triggered by an event is ready for download. Might be adjusted if fhem-Server and Doorbird unit have large differences in system time.<BR>The default value is 7s <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="OpsModeList" ></a><li><b><u><code>OpsModeList </code></u></b> : A space separated list of names for operational modes (e.g. "Normal Party Fire") on which the DoorBird reacts automatically on events.<BR>The default value is <code>""</code> = disabled <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="HistoryFilePath" ></a><li><b><u><code>HistoryFilePath </code></u></b> : Creates relative datapaths to the last pictures, and videos in order to indicate them directly (e.g. fhem ftui widget "image")<BR>The default value is <code>"0"</code> = disabled <BR></li></ul></ul></td></tr>
</table>
<ul>
<table>
<tr>
<td>
<code>disable</code> : </td><td>Stops the device from further reacting on UDP datagrams sent by the DoorBird unit.<BR>
The default value is 0 = activated<BR>
</td>
</tr>
<tr>
<td>
<code>KeepAliveTimeout</code> : </td><td>Timeout in seconds without still-alive UDP datagrams before state of device will be set to "disconnected".<BR>
The default value is 30s<BR>
</td>
</tr>
<tr>
<td>
<code>MaxHistory</code> : </td><td>Number of pictures to be downloaded from history for both - doorbell and motion sensor events.<BR>
The default value is "50" which is the maximum possible.<BR>
</td>
</tr>
<tr>
<td>
<code>PollingTimeout</code> : </td><td>Timeout in seconds before download requests are terminated in cause of no reaction by DoorBird unit. Might be required to be adjusted due to network speed.<BR>
The default value is 10s.<BR>
</td>
</tr>
<tr>
<td>
<code>UdpPort</code> : </td><td>Port number to be used to receice UDP datagrams. Ports are pre-defined by firmware.<BR>
The default value is port 6524<BR>
</td>
</tr>
<tr>
<td>
<code>SessionIdSec</code> : </td><td>Time in seconds for how long the session Id shall be valid, which is required for secure Video and Audio transmission. The DoorBird kills the session Id after 10min = 600s automatically. In case of use with CCTV recording units, this function must be disabled by setting to 0.<BR>
The default value is 540s = 9min.<BR>
</td>
</tr>
<tr>
<td>
<code>AudioFileDir</code> : </td><td>The relative (e.g. "audio") or absolute (e.g. "/mnt/NAS/audio") with or without trailing "/" directory path to which the audio files supposed to be stored.<BR>
The default value is <code>""</code> = disabled<BR>
</td>
</tr>
<tr>
<td>
<code>ImageFileDir</code> : </td><td>The relative (e.g. "images") or absolute (e.g. "/mnt/NAS/images") with or without trailing "/" directory path to which the image files supposed to be stored.<BR>
The default value is <code>""</code> = disabled<BR>
</td>
</tr>
<tr>
<td>
<code>VideoFileDir</code> : </td><td>The relative (e.g. "images") or absolute (e.g. "/mnt/NAS/images") with or without trailing "/" directory path to which the video files supposed to be stored.<BR>
The default value is <code>""</code> = disabled<BR>
</td>
</tr>
<tr>
<td>
<code>VideoFileFormat</code> : </td><td>The file format for the video file to be stored<BR>
The default value is <code>"mpeg"</code><BR>
</td>
</tr>
<tr>
<td>
<code>VideoDurationDoorbell</code> : </td><td>Time in seconds for how long the video shall be recorded in case of an doorbbell event.<BR>
The default value is <code>0</code> = disabled<BR>
</td>
</tr>
<tr>
<td>
<code>VideoDurationMotion</code> : </td><td>Time in seconds for how long the video shall be recorded in case of an motion sensor event.<BR>
The default value is <code>0</code> = disabled<BR>
</td>
</tr>
<tr>
<td>
<code>EventReset</code> : </td><td>Time in seconds after wich the Readings for the Events Events (e.g. "doorbell_button", "motions sensor", "keypad") shal be reset to "idle".<BR>
The default value is 5s<BR>
</td>
</tr>
<tr>
<td>
<code>WaitForHistory</code> : </td><td>Time in seconds after wich the module shall wait for an history image triggered by an event is ready for download. Might be adjusted if fhem-Server and Doorbird unit have large differences in system time.<BR>
The default value is 7s<BR>
</td>
</tr>
<tr>
<td>
<code>OpsModeList</code> : </td><td>A space separated list of names for operational modes (e.g. "Normal Party Fire") on which the DoorBird reacts automatically on events.<BR>
The default value is <code>""</code> = disabled<BR>
</td>
</tr>
<tr>
<td>
<code>HistoryFilePath</code> : </td><td>Creates relative datapaths to the last pictures, and videos in order to indicate them directly (e.g. fhem ftui widget "image")<BR>
The default value is <code>"0"</code> = disabled<BR>
</td>
</tr>
</table>
</ul>
</ul>
=end html
=begin html_DE
@ -4811,229 +4701,141 @@ sub DoorBird_findNewestFWVersion($$$)
</table>
<BR>
<table>
<tr>
<td>
<a name="DoorBirddefine"></a><b>Define</b>
</td>
</tr>
<tr><td><a name="DoorBirddefine"></a><b>Define</b></td></tr>
<tr><td><ul><code>define &lt;name&gt; DoorBird &lt;IPv4-address&gt; &lt;Username&gt; &lt;Passwort&gt;</code> <BR> </ul></td></tr>
<tr><td><ul><ul><code>&lt;name&gt; </code> : </td><td>Der Name des Device unter fhem. Beispiel: "myDoorBird". <BR> </ul></ul></td></tr>
<tr><td><ul><ul><code>&lt;IPv4-Addresse&gt; </code> : </td><td>Eine g&uuml;ltige IPv4 - Addresse der DoorBird-Anlage. Ggf. muss man im Router nach der entsprechenden DHCP Addresse suchen, die der DoorBird Anlage vergeben wurde. <BR> </ul></ul></td></tr>
<tr><td><ul><ul><code>&lt;Username&gt; </code> : </td><td>Der Username zum einloggen auf der DoorBird Anlage. <BR> </ul></ul></td></tr>
<tr><td><ul><ul><code>&lt;Passwort&gt; </code> : </td><td>Das Passwort zum einloggen auf der DoorBird Anlage. <BR> </ul></ul></td></tr>
</table>
<table>
<tr>
<td>
<ul>
<code>define &lt;name&gt; DoorBird &lt;IPv4-address&gt; &lt;Username&gt; &lt;Passwort&gt;</code>
</ul>
</td>
</tr>
</table>
<ul>
<ul>
<table>
<tr><td><code>&lt;name&gt; </code> : </td><td>Der Name des Device unter fhem. Beispiel: "myDoorBird". </td></tr>
<tr><td><code>&lt;IPv4-Addresse&gt; </code> : </td><td>Eine g&uuml;ltige IPv4 - Addresse der DoorBird-Anlage. Ggf. muss man im Router nach der entsprechenden DHCP Addresse suchen, die der DoorBird Anlage vergeben wurde.</td></tr>
<tr><td><code>&lt;Username&gt; </code> : </td><td>Der Username zum einloggen auf der DoorBird Anlage. </td></tr>
<tr><td><code>&lt;Passwort&gt; </code> : </td><td>Das Passwort zum einloggen auf der DoorBird Anlage. </td></tr>
</table>
</ul>
</ul>
<BR>
<table>
<tr><td><a name="DoorBirdSet"></a><b>Set</b></td></tr>
<tr><td><ul>Die Set - Funktion ist in der lage auf der DoorBird - Anlage die folgenden Einstellungen vorzunehmen bzw. zu de-/aktivieren:</ul><BR></td></tr>
</table>
<table>
<tr><td><ul><code>set Light_On </code></ul></td><td> : Schaltet das IR lichht der DoorBird Anlage ein. Das IR Licht schaltet sich automatisch nach der in der DoorBird - Anlage vorgegebenen Default Zeit wieder aus. </td></tr>
<tr><td><ul><code>set Live_Audio &lt;on:off&gt; </code></ul></td><td> : Aktiviert/Deaktiviert den Live Audio Stream der DoorBird - Anlage Ein oder Aus und wechselt den direkten link in dem <b>versteckten</b> Reading <code>.AudioURL.</code> </td></tr>
<tr><td><ul><code>set Live_Video &lt;on:off&gt; </code></ul></td><td> : Aktiviert/Deaktiviert den Live Video Stream der DoorBird - Anlage Ein oder Aus und wechselt den direkten link in dem <b>versteckten</b> Reading <code>.VideoURL.</code> </td></tr>
<tr><td><ul><code>set Open Door &lt;Value&gt; </code></ul></td><td> : Aktiviert das Relais der DoorBird - Anlage mit dessen Adresse. Die Liste der installierten Relais werden mit der Initialisierung der Parameter importiert. </td></tr>
<tr><td><ul><code>set Restart </code></ul></td><td> : Sendet das Kommando zum rebooten der DoorBird - Anlage. </td></tr>
<tr><td><ul><code>set Transmit_Audio &lt;Path&gt; </code></ul></td><td> : Konvertiert die angegebene Audio-Datei und sendet diese zur Ausgabe an die DoorBird - Anlage. Es ben&ouml;tigt einen Dateipfad zu der Audio-Datei zu dem der User "fhem" Schreibrechte braucht (z.B.: /opt/fhem/audio). </td></tr>
<tr><td><ul>Die Set - Funktion ist in der lage auf der DoorBird - Anlage die folgenden Einstellungen vorzunehmen bzw. zu de-/aktivieren: <BR> </ul></td></tr>
<tr><td><ul><a name="Light_On" ></a><li><b><u><code>set Light_On </code></u></b> : Schaltet das IR lichht der DoorBird Anlage ein. Das IR Licht schaltet sich automatisch nach der in der DoorBird - Anlage vorgegebenen Default Zeit wieder aus. <BR></li> </ul></td></tr>
<tr><td><ul><a name="Live_Audio" ></a><li><b><u><code>set Live_Audio &lt;on:off&gt; </code></u></b> : Aktiviert/Deaktiviert den Live Audio Stream der DoorBird - Anlage Ein oder Aus und wechselt den direkten link in dem <b>versteckten</b> Reading <code>.AudioURL.</code> <BR></li> </ul></td></tr>
<tr><td><ul><a name="Live_Video" ></a><li><b><u><code>set Live_Video &lt;on:off&gt; </code></u></b> : Aktiviert/Deaktiviert den Live Video Stream der DoorBird - Anlage Ein oder Aus und wechselt den direkten link in dem <b>versteckten</b> Reading <code>.VideoURL.</code> <BR></li> </ul></td></tr>
<tr><td><ul><a name="Open Door" ></a><li><b><u><code>set Open Door &lt;Value&gt; </code></u></b> : Aktiviert das Relais der DoorBird - Anlage mit dessen Adresse. Die Liste der installierten Relais werden mit der Initialisierung der Parameter importiert. <BR></li> </ul></td></tr>
<tr><td><ul><a name="Restart" ></a><li><b><u><code>set Restart </code></u></b> : Sendet das Kommando zum rebooten der DoorBird - Anlage. <BR></li> </ul></td></tr>
<tr><td><ul><a name="Transmit_Audio" ></a><li><b><u><code>set Transmit_Audio &lt;Path&gt; </code></u></b> : Konvertiert die angegebene Audio-Datei und sendet diese zur Ausgabe an die DoorBird - Anlage. Es ben&ouml;tigt einen Dateipfad zu der Audio-Datei zu dem der User "fhem" Schreibrechte braucht (z.B.: /opt/fhem/audio). <BR></li> </ul></td></tr>
</table>
<BR>
<table>
<tr><td><a name="DoorBirdGet"></a><b>Get</b></td></tr>
<tr><td><ul>Die Get - Funktion ist in der lage von der DoorBird - Anlage die folgenden Informationen und Daten zu laden:<BR><BR></ul></td></tr>
</table>
<table>
<tr><td><ul><code>get History_Request </code></ul></td><td> : L&auml;dt die Bilder der letzten Ereignisse durch die T&uuml;rklingel und dem Bewegungssensor herunter. (Siehe auch Attribut <code>MaxHistory</code>)</td></tr>
<tr><td><ul><code>get Image_Request </code></ul></td><td> : L&auml;dt das gegenw&auml;rtige Bild der DoorBird - Kamera herunter.</td></tr>
<tr><td><ul><code>get Video_Request &lt;Value&gt; </code></ul></td><td> : L&auml;dt das gegenw&auml;rtige Video der DoorBird - Kamera f&uumlr die gegebene Zeit in Sekunden herunter.</td></tr>
<tr><td><ul><code>get Info_Request </code></ul></td><td> : L&auml;dt das interne Setup (Firmware Version, Relais Konfiguration etc.) herunter. Die &uuml;bermittelten Relais-Adressen werden als Option f&uuml;r das Kommando <code>Open_Door</code> verwendet.</td></tr>
<tr><td><ul>Die Get - Funktion ist in der lage von der DoorBird - Anlage die folgenden Informationen und Daten zu laden: <BR> </ul></td></tr>
<tr><td><ul><a name="History_Request" ></a><li><b><u><code>get History_Request </code></u></b> : L&auml;dt die Bilder der letzten Ereignisse durch die T&uuml;rklingel und dem Bewegungssensor herunter. (Siehe auch Attribut <code>MaxHistory</code>) <BR></li> </ul></td></tr>
<tr><td><ul><a name="Image_Request" ></a><li><b><u><code>get Image_Request </code></u></b> : L&auml;dt das gegenw&auml;rtige Bild der DoorBird - Kamera herunter. <BR></li> </ul></td></tr>
<tr><td><ul><a name="Video_Request" ></a><li><b><u><code>get Video_Request &lt;Value&gt; </code></u></b> : L&auml;dt das gegenw&auml;rtige Video der DoorBird - Kamera f&uumlr die gegebene Zeit in Sekunden herunter. <BR></li> </ul></td></tr>
<tr><td><ul><a name="Info_Request" ></a><li><b><u><code>get Info_Request </code></u></b> : L&auml;dt das interne Setup (Firmware Version, Relais Konfiguration etc.) herunter. Die &uuml;bermittelten Relais-Adressen werden als Option f&uuml;r das Kommando <code>Open_Door</code> verwendet. <BR></li> </ul></td></tr>
</table>
<BR>
<table>
<tr><td><a name="DoorBirdAttr"></a><b>Attributes</b></td></tr>
<tr><td>
<ul>
Die folgenden Attribute k&ouml;nnen mit dem DoorBird Module neben den globalen Attributen wie <a href="#room">room</a> verwednet werden.<BR>
</ul>
</td></tr>
<tr><td><ul>Die folgenden Attribute k&ouml;nnen mit dem DoorBird Module neben den globalen Attributen wie <a href="#room">room</a> verwednet werden.<BR></ul></td></tr>
</table>
<table>
<tr><td><ul><ul><a name="disable" ></a><li><b><u><code>disable </code></u></b> : Stoppt das Ger&auml;t von weiteren Reaktionen auf die von der DoorBird ß Anlage ausgesendeten UDP - Datageramme<BR>Der Default Wert ist 0 = aktiviert <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="KeepAliveTimeout" ></a><li><b><u><code>KeepAliveTimeout </code></u></b> : Timeout in Sekunden ohne "still-alive" - UDP Datagramme bevor der Status des Ger&auml;tes auf "disconnected" gesetzt wird.<BR>Der Default Wert ist 30s <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="MaxHistory" ></a><li><b><u><code>MaxHistory </code></u></b> : Anzahl der herunterzuladenden Bilder aus dem Historien-Archiv sowohl f&uuml;r Ereignisse seitens der T&uuml;rklingel als auch f&uuml;r den Bewegungssensor.<BR>Der Default Wert ist "50" = Maximum. <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="PollingTimeout" ></a><li><b><u><code>PollingTimeout </code></u></b> : Timeout in Sekunden before der Download-Versuch aufgrund fehlender Antwort seitens der DoorBird-Anlage terminiert wird. Eine Adjustierung mag notwendig sein, sobald Netzwerk-Latenzen aufteten.<BR>Der Default-Wert ist 10s. <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="UdpPort" ></a><li><b><u><code>UdpPort </code></u></b> : Port Nummer auf welcher das DoorBird - Modul nach den UDP Datagrammen der DoorBird - Anlage h&ouml;ren soll. Die Ports sind von der Firmware vorgegeben.<BR>Der Default Port ist 6524 <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="SessionIdSec" ></a><li><b><u><code>SessionIdSec </code></u></b> : Zeit in Sekunden nach welcher die Session Id erneuert werden soll. Diese ist f&uuml;r die sichere &Uuml;bertragung der Video und Audio Verbindungsdaten notwendig. Die DoorBird-Unit devalidiert die Session Id automatisch nach 10min. F&uuml;r den Fall, dass die DoorBird Kamera an ein &Uuml;berwachungssystem angebunden werden soll, muss diese Funktion ausser Betrieb genommen werden indem man den Wert auf 0 setzt 0.<BR>Der Default Wert ist 540s = 9min. <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="AudioFileDir" ></a><li><b><u><code>AudioFileDir </code></u></b> : Der relative (z.B. "audio") oder absolute (z.B. "/mnt/NAS/audio") Verzeichnispfad mit oder ohne nachfolgendem Pfadzeichen "/" in welchen die Audio-Dateien abgelegt sind.<BR>Der Default Wert ist <code>0</code> = deaktiviert <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="ImageFileDir" ></a><li><b><u><code>ImageFileDir </code></u></b> : Das Dateiformat f&uuml;r die Videodatei<BR>Der Default Wert ist <code>"mpeg"</code> <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="VideoFileDir" ></a><li><b><u><code>VideoFileDir </code></u></b> : Der relative (z.B. "images") oder absolute (z.B. "/mnt/NAS/images") Verzeichnispfad mit oder ohne nachfolgendem Pfadzeichen "/" in welchen die Bild-Dateien gespeichert werden sollen.<BR>Der Default Wert ist <code>0</code> = deaktiviert <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="VideoFileFormat" ></a><li><b><u><code>VideoFileFormat </code></u></b> : Der relative (z.B. "images") oderr absolute (z.B. "/mnt/NAS/images") Verzeichnispfad mit oder ohne nachfolgendem Pfadzeichen "/" in welchen die Video-Dateien gespeichert werden sollen.<BR>Der Default Wert ist <code>""</code> = deaktiviert <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="VideoDurationDoorbell" ></a><li><b><u><code>VideoDurationDoorbell </code></u></b> : Zeit in Sekunden für wie lange das Video im Falle eines Klingel Events aufgenommen werden soll.<BR>Der Default Wert ist <code>0</code> = deaktiviert <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="VideoDurationMotion" ></a><li><b><u><code>VideoDurationMotion </code></u></b> : Zeit in Sekunden für wie lange das Video im Falle eines Bewegungssensor Events aufgenommen werden soll.<BR>Der Default Wert ist <code>0</code> = deaktiviert <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="EventReset" ></a><li><b><u><code>EventReset </code></u></b> : Zeit in Sekunden nach welcher die Readings f&uuml;r die Events (z.B. "doorbell_button", "motions sensor", "keypad")wieder auf "idle" gesetzt werden sollen.<BR>Der Default Wert ist 5s <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="WaitForHistory" ></a><li><b><u><code>WaitForHistory </code></u></b> : Zeit in Sekunden die das Modul auf das Bereitstellen eines korrespondierenden History Bildes zu einem Event warten soll. Muss ggf. adjustiert werden, sobald deutliche Unterschiede in der Systemzeit zwischen fhemßServer und DoorBird Station vorliegen.<BR>Der Default Wert ist 7s <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="OpsModeList" ></a><li><b><u><code>OpsModeList </code></u></b> : Eine durch Leerzeichen getrennte Liste von Namen für Operationszust&auml;nde (e.g. "Normal Party Feuer" auf diese der DoorBird automatisch bei Events reagiert.<BR>Der Default Wert ist "" = deaktiviert <BR></li></ul></ul></td></tr>
<tr><td><ul><ul><a name="HistoryFilePath" ></a><li><b><u><code>HistoryFilePath </code></u></b> : Erstellt Dateipfade zu den letzten Bildern und Videos um sie in den User Interfaces direkt anzuzeigen (e.g. fhem ftui Widget "Image")<BR>Der Default Wert ist <code>"0"</code> = disabled <BR></li></ul></ul></td></tr>
</table>
<ul>
<table>
<tr>
<td>
<code>disable </code> : </td><td>Stoppt das Ger&auml;t von weiteren Reaktionen auf die von der DoorBird ß Anlage ausgesendeten UDP - Datageramme<BR> Der Default Wert ist 0 = aktiviert<BR>
</td>
</tr>
<tr>
<td>
<code>KeepAliveTimeout</code> : </td><td>Timeout in Sekunden ohne "still-alive" - UDP Datagramme bevor der Status des Ger&auml;tes auf "disconnected" gesetzt wird.<BR>
Der Default Wert ist 30s<BR>
</td>
</tr>
<tr>
<td>
<code>MaxHistory</code> : </td><td>Anzahl der herunterzuladenden Bilder aus dem Historien-Archiv sowohl f&uuml;r Ereignisse seitens der T&uuml;rklingel als auch f&uuml;r den Bewegungssensor.<BR>
Der Default Wert ist "50" = Maximum.<BR>
</td>
</tr>
<tr>
<td>
<code>PollingTimeout</code> : </td><td>Timeout in Sekunden before der Download-Versuch aufgrund fehlender Antwort seitens der DoorBird-Anlage terminiert wird. Eine Adjustierung mag notwendig sein, sobald Netzwerk-Latenzen aufteten.<BR>
Der Default-Wert ist 10s.<BR>
</td>
</tr>
<tr>
<td>
<code>UdpPort</code> : </td><td>Port Nummer auf welcher das DoorBird - Modul nach den UDP Datagrammen der DoorBird - Anlage h&ouml;ren soll. Die Ports sind von der Firmware vorgegeben.<BR>
Der Default Port ist 6524<BR>
</td>
</tr>
<tr>
<td>
<code>SessionIdSec</code> : </td><td>Zeit in Sekunden nach welcher die Session Id erneuert werden soll. Diese ist f&uuml;r die sichere &Uuml;bertragung der Video und Audio Verbindungsdaten notwendig. Die DoorBird-Unit devalidiert die Session Id automatisch nach 10min. F&uuml;r den Fall, dass die DoorBird Kamera an ein &Uuml;berwachungssystem angebunden werden soll, muss diese Funktion ausser Betrieb genommen werden indem man den Wert auf 0 setzt 0.<BR>
Der Default Wert ist 540s = 9min.<BR>
</td>
</tr>
<tr>
<td>
<code>AudioFileDir</code> : </td><td>Der relative (z.B. "audio") oder absolute (z.B. "/mnt/NAS/audio") Verzeichnispfad mit oder ohne nachfolgendem Pfadzeichen "/" in welchen die Audio-Dateien abgelegt sind.<BR>
Der Default Wert ist <code>0</code> = deaktiviert<BR>
</td>
</tr>
<tr>
<td>
<code>VideoFileFormat</code> : </td><td>Das Dateiformat f&uuml;r die Videodatei<BR>
Der Default Wert ist <code>"mpeg"</code><BR>
</td>
</tr>
<tr>
<td>
<code>ImageFileDir</code> : </td><td>Der relative (z.B. "images") oder absolute (z.B. "/mnt/NAS/images") Verzeichnispfad mit oder ohne nachfolgendem Pfadzeichen "/" in welchen die Bild-Dateien gespeichert werden sollen.<BR>
Der Default Wert ist <code>0</code> = deaktiviert<BR>
</td>
</tr>
<tr>
<td>
<code>VideoFileDir</code> : </td><td>Der relative (z.B. "images") oderr absolute (z.B. "/mnt/NAS/images") Verzeichnispfad mit oder ohne nachfolgendem Pfadzeichen "/" in welchen die Video-Dateien gespeichert werden sollen.<BR>
Der Default Wert ist <code>""</code> = deaktiviert<BR>
</td>
</tr>
<tr>
<td>
<code>VideoDurationDoorbell</code> : </td><td>Zeit in Sekunden für wie lange das Video im Falle eines Klingel Events aufgenommen werden soll.<BR>
Der Default Wert ist <code>0</code> = deaktiviert<BR>
</td>
</tr>
<tr>
<td>
<code>VideoDurationMotion</code> : </td><td>Zeit in Sekunden für wie lange das Video im Falle eines Bewegungssensor Events aufgenommen werden soll.<BR>
Der Default Wert ist <code>0</code> = deaktiviert<BR>
</td>
</tr>
<tr>
<td>
<code>EventReset</code> : </td><td>Zeit in Sekunden nach welcher die Readings f&uuml;r die Events (z.B. "doorbell_button", "motions sensor", "keypad")wieder auf "idle" gesetzt werden sollen.<BR>
Der Default Wert ist 5s<BR>
</td>
</tr>
<tr>
<td>
<code>WaitForHistory</code> : </td><td>Zeit in Sekunden die das Modul auf das Bereitstellen eines korrespondierenden History Bildes zu einem Event warten soll. Muss ggf. adjustiert werden, sobald deutliche Unterschiede in der Systemzeit zwischen fhemßServer und DoorBird Station vorliegen.<BR>
Der Default Wert ist 7s<BR>
</td>
</tr>
<tr>
<td>
<code>OpsModeList</code> : </td><td>Eine durch Leerzeichen getrennte Liste von Namen für Operationszust&auml;nde (e.g. "Normal Party Feuer" auf diese der DoorBird automatisch bei Events reagiert.<BR>
Der Default Wert ist "" = deaktiviert<BR>
</td>
</tr>
<tr>
<td>
<code>HistoryFilePath</code> : </td><td>Erstellt Dateipfade zu den letzten Bildern und Videos um sie in den User Interfaces direkt anzuzeigen (e.g. fhem ftui Widget "Image")<BR>
Der Default Wert ist <code>"0"</code> = disabled<BR>
</td>
</tr>
</table>
</ul>
</ul>
=end html_DE
=encoding utf8
=for :application/json;q=META.json 73_DoorBird.pm
{
"abstract": "Connects fhem to the DoorBird IP door station",
"description": "The DoorBird module establishes the communication between the DoorBird - door intercommunication unit and the fhem home automation based on the official API, published by the manufacturer. Please make sure, that the user has been enabled the API-Operator button in the DoorBird Android/iPhone APP under Administration -> User -> Edit -> Permission -> API-Operator.",
"x_lang": {
"de": {
"abstract": "Verbindet fhem mit der DoorBird IP Türstation",
"description": "Das DoorBird Modul ermöglicht die Komminikation zwischen der DoorBird Interkommunikationseinheit und dem fhem Automationssystem basierend auf der API des Herstellers her. Für den vollen Funktionsumfang muss sichergestellt werden, dass das Setting \"API-Operator\" in der DoorBird Android/iPhone - APP unter Administration -> User -> Edit -> Permission -> API-Operator gesetzt ist."
}
},
"license": [
"GPL_2"
],
"author": [
"Matthias Deeke <matthias.deeke@deeke.eu>"
],
"x_fhem_maintainer": [
"Sailor"
],
"keywords": [
"Doorbird",
"Intercom"
],
"prereqs": {
"runtime": {
"requires": {
"Alien::Base::ModuleBuild": 0,
"Alien::Sodium": 0,
"Crypt::Argon2": 0,
"Crypt::NaCl::Sodium": 0,
"IO::String": 0,
"Cwd": 0,
"Data::Dumper": 0,
"Encode": 0,
"HttpUtils": 0,
"IO::Socket": 0,
"JSON": 0,
"LWP::UserAgent": 0,
"MIME::Base64": 0,
"constant": 0,
"strict": 0,
"utf8": 0,
"warnings": 0,
"perl": 5.014
},
"recommends": {
},
"suggests": {
}
}
},
"x_prereqs_os_debian": {
"runtime": {
"requires": {
"sox": 0,
"libsox-fmt-all": 0,
"libsodium-dev": 0,
"gstreamer1.0-tools": 0
},
"recommends": {
},
"suggests": {
}
}
}
"abstract": "Connects fhem to the DoorBird IP door station",
"description": "The DoorBird module establishes the communication between the DoorBird - door intercommunication unit and the fhem home automation based on the official API, published by the manufacturer. Please make sure, that the user has been enabled the API-Operator button in the DoorBird Android/iPhone APP under Administration -> User -> Edit -> Permission -> API-Operator.",
"x_lang": {
"de": {
"abstract": "Verbindet fhem mit der DoorBird IP Türstation",
"description": "Das DoorBird Modul ermöglicht die Komminikation zwischen der DoorBird Interkommunikationseinheit und dem fhem Automationssystem basierend auf der API des Herstellers her. Für den vollen Funktionsumfang muss sichergestellt werden, dass das Setting \"API-Operator\" in der DoorBird Android/iPhone - APP unter Administration -> User -> Edit -> Permission -> API-Operator gesetzt ist."
}
},
"license": [
"GPL_2"
],
"author": [
"Matthias Deeke <matthias.deeke@deeke.eu>"
],
"x_fhem_maintainer": [
"Sailor"
],
"keywords": [
"Doorbird",
"Intercom"
],
"prereqs": {
"runtime": {
"requires": {
"Alien::Base::ModuleBuild": 0,
"Alien::Sodium": 0,
"Crypt::Argon2": 0,
"Crypt::NaCl::Sodium": 0,
"IO::String": 0,
"Cwd": 0,
"Data::Dumper": 0,
"Encode": 0,
"HttpUtils": 0,
"IO::Socket": 0,
"JSON": 0,
"LWP::UserAgent": 0,
"MIME::Base64": 0,
"constant": 0,
"strict": 0,
"utf8": 0,
"warnings": 0,
"perl": 5.014
},
"recommends": {
},
"suggests": {
}
}
},
"x_prereqs_os_debian": {
"runtime": {
"requires": {
"sox": 0,
"libsox-fmt-all": 0,
"libsodium-dev": 0,
"gstreamer1.0-tools": 0
},
"recommends": {
},
"suggests": {
}
}
},
"resources": {
"x_support_community": {
"rss": "https://forum.fhem.de/index.php/topic,100758.msg",
"web": "https://forum.fhem.de/index.php/topic,100758.msg",
"subCommunity" : {
"rss" : "https://forum.fhem.de/index.php/topic,100758.msg",
"title" : "This sub-board will be first contact point",
"web" : "https://forum.fhem.de/index.php/topic,100758.msg"
}
},
"x_wiki" : {
"title" : "FHEM Wiki: DoorBird",
"web" : "https://wiki.fhem.de/wiki/DoorBird"
}
},
"x_support_status": "supported"
}
=end :application/json;q=META.json
=cut