README: describe project

This commit is contained in:
King Kévin 2020-06-21 10:08:02 +02:00
parent a78d45e94b
commit 09dfd6c6f5
1 changed files with 14 additions and 5 deletions

View File

@ -6,9 +6,9 @@ project
summary
-------
Previously a button allowed to open the building entrance door and granted access to the dachboden.
Previously a button allowed to open the building's entrance door and granted access to the dachboden.
Since the dachboden got popular, it is now flooded.
The idea behind the dachtür it to disable this button and replace it with a secret sequence of button presses during certain periods.
The idea behind the dachtür it to disable this button and replace it with a secret sequence of button presses during certain periods (e.g. when parties are taking place in the dachboden).
It must be installed in the door panel, as described under `connections`.
configure
@ -19,7 +19,7 @@ It should appear as "dachtuer" Bluetooth (classic) device.
A PIN is required to connect to it.
Once connected, you can use a terminal (such as the "Bluetooth terminal" android application).
Interact with it by entering commands.
- from time to time, update the date:
- from time to time, update the date (it does not take into account summer and winter time):
~~~
date YYYY-MM-DD HH:MM
~~~
@ -46,7 +46,7 @@ In this case, replace the battery and reconfigure the device.
connections
===========
On one side there a three XH-2.54 connectors.
On one side there are three XH-2.54 connectors.
2-pin connector: 6-25 AC/DC power input
@ -99,6 +99,10 @@ This allows to communicate with the board without having to remove the panel.
It can be used to configure the opening time slots, days, and button sequence.
It is also possible to update the firmware through it.
A WS2812B LED strip is also connected to the board.
The LEDs should be placed behind the button name shield.
An animation with be shown when pressing the button (only during opening hours).
wiring
======
@ -142,6 +146,11 @@ omrom G6E-134P relay (top, for panel):
- 2 gate: PB7 (pulled low)
- 3 drain: relay -
WS2812B RGB LED strip:
- VCC: 5V
- DIN: PB15
- GND: ground
XH-4P:
- 1: ground (for button 1)
- 2: PB8 (for button 1)
@ -195,7 +204,7 @@ It is also possible to flash the application over Bluetooth as follows:
~~~
# start bluetooth
sudo systemctl restart bluetooth
# pair device (you need the PIN)
# pair device (you only need to do it once, and you need the PIN)
bluetoothctl
power on
pair 20:15:02:02:16:28