Document development features

_layouts/documentation.html

@@ -8,6 +8,7 @@
         <section class="linkbar">
           <ul>
             {%- if page.url == "/documentation/getting-started.html" -%} <li class="menuactive">{%- else -%} <li> {%- endif -%}<a href="/documentation/getting-started.html">Getting Started</a></li>
+            {%- if page.url == "/documentation/audio.html" -%} <li class="menuactive">{%- else -%} <li> {%- endif -%}<a href="/documentation/audio.html">Audio / VOIP</a></li>
             {%- if page.url == "/documentation/homeassistant.html" -%} <li class="menuactive">{%- else -%} <li> {%- endif -%}<a href="/documentation/homeassistant.html">Home Assistant</a></li>
             {%- if page.url == "/documentation/openhab.html" -%} <li class="menuactive">{%- else -%} <li> {%- endif -%}<a href="/documentation/openhab.html">openHAB</a></li>
             {%- if page.url == "/documentation/firmware.html" -%} <li class="menuactive">{%- else -%} <li> {%- endif -%}<a href="/documentation/firmware.html">Firmware</a></li>

documentation/audio.md

@@ -0,0 +1,38 @@
+---
+layout: documentation
+title: Audio / VOIP
+sidebar:
+  - article-menu
+---
+
+# Requirements
+A GDoor adapter with at least version 4.0 is needed.
+
+# Setup
+Go to the configuration page of your GDoor device.
+You can setup the connection string of you VOIP
+server.
+The scheme is `udp://username:password@server:portnumber`
+
+# Configuration
+GDoor currently offers 4 slots.
+Each slot is a individual configuration to handle a audio related action
+and can be enabled or disabled independently.
+
+A slot has the following settings:
+- Outgoing Call: Enable or disable that this slot initiates outgoing VOIP calls.
+- Trigger Action: The basic action which trigger this slot, it is the `ACTION` field in the incoming bus message which needs to match.
+  - BUTTON_RING: An action is triggered, when a ring button on a outdoor station is pressed.
+  - CALL_INTERNAL: An action is triggered, when a internal call is initiated.
+- Outdoor Address: This is a 2-Byte hexadecimal value. Do not prefix `0x`.
+This address is used to match the source field of the incoming bus message,
+so that the slot is only triggered for a certain station. Leave empty to trigger an all stations.
+- Button No.: The button number to trigger. It is the first byte of the parameter field in the incoming bus message.
+Leave empty to trigger an all button presses.
+- Dest. Phone No.: The phone number which is called by GDoor when this slot is triggered.
+
+# Tested Setups
+Currently tested are:
+- FritzBox as VOIP server
+- GDoor v4.0 as software VOIP client.
+- Linphone as software VOIP client, which GDoor calls, when a button is pressed

documentation/hardware.md

@@ -10,6 +10,10 @@ The hardware is currently in version 3.1
 
 - v3.0: First release with weak sending and a hardware bug in the receive path.
 - v3.1: Hardware adapter procured and currently being tested.
+- v3.1-1: This is a minor release with a changed screw terminal, due to parts availability at JLCPCB.
+- v4.0 (development): This is a GDoor version currently under development. Changed:
+  - Audio support, GDoor acts as Voip phone
+  - Bus voltage measurement
 
 # Design
 You can download the PDF version of the schematic [here](/assets/design/esp32.pdf).

index.md

@@ -13,6 +13,7 @@ GDoor is a project to collect and document findings about the Gira TKS Door Syst
 Gira is a german manufacturer of house appliances, including door systems. These systems are connected via a proprietary two wire bus system. 
 
 The GDoor hardware adapter supports the following features:
+- (In development) Connect the bus audio via VOIP.
 - Interfacing the bus messages with your favorite home automation software via MQTT.
 - Listening to the bus, e.g. to trigger notifications on mobile devices when a door bell button is pressed
 - Sending to the bus, e.g. to open the door