README: document dachtuer project
This commit is contained in:
parent
7d425f6cfb
commit
af8aca9218
194
README.md
194
README.md
|
|
@ -1,4 +1,4 @@
|
|||
This firmware template is designed for development boards based around [STM32 F1 series micro-controller](http://www.st.com/web/en/catalog/mmc/FM141/SC1169/SS1031).
|
||||
The dachtür is a device to restrict access to the dachboden.
|
||||
|
||||
project
|
||||
=======
|
||||
|
|
@ -6,51 +6,149 @@ project
|
|||
summary
|
||||
-------
|
||||
|
||||
*describe project purpose*
|
||||
Previously a button allowed to open the building 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.
|
||||
It must be installed in the door panel, as described under `connections`.
|
||||
|
||||
technology
|
||||
----------
|
||||
configure
|
||||
---------
|
||||
|
||||
*described electronic details*
|
||||
|
||||
board
|
||||
=====
|
||||
|
||||
The current implementation uses a [core board](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#core_board).
|
||||
|
||||
The underlying template also supports following board:
|
||||
|
||||
- [Maple Mini](http://leaflabs.com/docs/hardware/maple-mini.html), based on a STM32F103CBT6
|
||||
- [System Board](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#system_board), based on a STM32F103C8T6
|
||||
- [blue pill](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#blue_pill), based on a STM32F103C8T6
|
||||
- [black pill](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#black_pill), based on a STM32F103C8T6
|
||||
- [core board](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#core_board), based on a STM32F103C8T6
|
||||
- [ST-LINK V2 mini](https://wiki.cuvoodoo.info/doku.php?id=jtag#mini_st-link_v2), a ST-LINK/V2 clone based on a STM32F101C8T6
|
||||
- [USB-Blaster](https://wiki.cuvoodoo.info/doku.php?id=jtag#armjishu_usb-blaster), an Altera USB-Blaster clone based on a STM32F101C8T6
|
||||
|
||||
**Which board is used is defined in the Makefile**.
|
||||
This is required to map the user LED and button provided on the board
|
||||
|
||||
The ST-LINK V2 mini clone has SWD test points on the board.
|
||||
Because read protection is enabled, you will first need to remove the protection to be able to flash the firmware.
|
||||
To remove the read protection (and erase flash), run `rake remove_protection` while a SWD adapter is connected.
|
||||
|
||||
The Altera USB-Blaster clone has a pin header for SWD and UART1 on the board.
|
||||
SWD is disabled in the main firmware, and it has read protection.
|
||||
To be able to flash using SWD (or the serial port), the BOOT0 pin must be set to 1 to boot the system memory install of the flash memory.
|
||||
To set BOOT0 to 1, apply 3.3 V on R11, between the resistor and the reference designator, when powering the device.
|
||||
The red LED should stay off while the green LED is on.
|
||||
Now you can remove the read protection (and erase flash), run `rake remove_protection` while a SWD adapter is connected.
|
||||
To program the days, times, and button sequence, connect to the dachtür.
|
||||
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:
|
||||
~~~
|
||||
date YYYY-MM-DD HH:MM
|
||||
~~~
|
||||
- enter the days on which the access should be restricted (starting with Monday, here only Thursday is active):
|
||||
~~~
|
||||
days 0001000
|
||||
~~~
|
||||
- enter at which time the restriction should start:
|
||||
~~~
|
||||
start 20:00
|
||||
~~~
|
||||
- enter at which time the restriction should stop:
|
||||
~~~
|
||||
stop 06:00
|
||||
~~~
|
||||
- enter the secret button sequence to open the door (here press button 1 then 2):
|
||||
~~~
|
||||
password 12
|
||||
~~~
|
||||
|
||||
connections
|
||||
===========
|
||||
|
||||
Connect the peripherals the following way (STM32F10X signal; STM32F10X pin; peripheral pin; peripheral signal; comment):
|
||||
On one side there a three XH-2.54 connectors.
|
||||
|
||||
- *list board to peripheral pin connections*
|
||||
2-pin connector: 6-25 AC/DC power input
|
||||
|
||||
3-pin connector: opening button (the one already wired)
|
||||
- 1 (left-most): common side of button (leave the bus bar connected)
|
||||
- 2 (center): other side of the button (remove the cable)
|
||||
- 3 (right-most): the cable which was connected to the button
|
||||
|
||||
4-pin connector: ring buttons (yet unused)
|
||||
- 2 left-most pins: to button 1 of door panel
|
||||
- 2 right-most pins: to button 2 of door panel
|
||||
|
||||
On the other side is a USB connector.
|
||||
This is used to flash and configure the micro-controller.
|
||||
|
||||
peripherals
|
||||
===========
|
||||
|
||||
The XH-2.54 2P connector is for the 15V AC power input.
|
||||
A full bridge rectifier and smoothing capacitor make a DC power supply out of it.
|
||||
A buck converter module steps it down to 5V.
|
||||
Under 50 mA of power consumption it is very inefficient.
|
||||
With no load it has a quiescent current of 37 mA.
|
||||
The 5V rail provides power to the blue pill, Bluetooth module, and boost converter.
|
||||
|
||||
The MT3608-based boost converter steps the voltage up to 9V for the omrom G6E-134P relays.
|
||||
It is more efficient to re-use the existing 5V than stepping down the 15V because the buck converters drawn a large current under no load.
|
||||
|
||||
The XH-2.54 3P is to be connected to door opening button (the installer will know what I mean).
|
||||
Two omrom G6E-134P relays will take control over the button.
|
||||
This allows the door button to be used.
|
||||
At the specified time intervals, this is disconnected.
|
||||
When the right code is entered, the second relay simulates the button press and opens the door.
|
||||
The relays are controlled by the board using two 2N7000 n-channel MOSFETs.
|
||||
|
||||
The XH-2.54 4P is to be connected with the two buttons.
|
||||
They are used to enter the secret sequence to open the door.
|
||||
|
||||
The [blue pill](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#blue_pill), based on a STM32F103C8T6 micro-controller, will handle the logic.
|
||||
|
||||
A CR2032 battery is connected through a diode to VBAT.
|
||||
This keeps the real time clock (RTC) running when there is no power from the panel.
|
||||
A 3.3V pin is also connected through a diode to VBAT.
|
||||
This powered the RTC when the board is powered, saving the battery.
|
||||
|
||||
The HC-05 Bluetooth module allows to remotely connect to the UART port.
|
||||
It has been configured (using `hc-05_porg.rb`) to appear as "dachtuer", and requires a PIN to pair.
|
||||
It offers the Serial Port Profile (SPP) from Bluetooth classic (Bluetooth Low Energy makes little sense).
|
||||
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.
|
||||
|
||||
wiring
|
||||
======
|
||||
|
||||
HC-05 Bluetooth module:
|
||||
- STATE: no connect
|
||||
- TXD: PA10/USART1_RX
|
||||
- RXD: PA9/USART1_TX
|
||||
- GND: ground
|
||||
- VCC: 5V
|
||||
- EN: no connect
|
||||
|
||||
CR2032 coin cell battery:
|
||||
- +: VBAT, though diode (VBAT should also be connected to 3.3V through diode)
|
||||
- -: ground
|
||||
|
||||
LED (because the on-board LED screws the LSE):
|
||||
- anode: 3.3V, though resistor (1K)
|
||||
- cathode: PB11
|
||||
|
||||
omrom G6E-134P relay (bottom, for button):
|
||||
- 1 +: 9V
|
||||
- 6 -: 2N7000 drain
|
||||
- 7 COM: door button bar
|
||||
- 10 NC: no connect
|
||||
- 12 NO: other relay NO
|
||||
|
||||
2N7000 p-channel MOSFET (for bottom relay):
|
||||
- 1 source: ground
|
||||
- 2 gate: PB6 (pulled low)
|
||||
- 3 drain: relay -
|
||||
|
||||
omrom G6E-134P relay (top, for panel):
|
||||
- 1 +: 9V
|
||||
- 6 -: 2N7000 drain
|
||||
- 7 COM: wire to panel
|
||||
- 10 NC: door button (where the wire was)
|
||||
- 12 NO: other relay NO
|
||||
|
||||
2N7000 p-channel MOSFET (for top relay):
|
||||
- 1 source: ground
|
||||
- 2 gate: PB7 (pulled low)
|
||||
- 3 drain: relay -
|
||||
|
||||
XH-4P:
|
||||
- 1: ground (for button 1)
|
||||
- 2: PB8 (for button 1)
|
||||
- 3: ground (for button 2)
|
||||
- 4: PB9 (for button 2)
|
||||
|
||||
All pins are configured using `define`s in the corresponding source code.
|
||||
|
||||
The prototype uses a SZOMK AK-N-01 enclosures salvaged from a J-Link clone.
|
||||
|
||||
code
|
||||
====
|
||||
|
||||
|
|
@ -83,13 +181,33 @@ It is up to the application to advertise USB DFU support (i.e. as does the provi
|
|||
|
||||
The `bootlaoder` image will be flashed using SWD (Serial Wire Debug).
|
||||
For that you need an SWD adapter.
|
||||
The `Makefile` uses a Black Magic Probe (per default), or a ST-Link V2 along OpenOCD software.
|
||||
The `Makefile` uses a ST-Link V2 along OpenOCD software.
|
||||
To flash the `booltoader` using SWD run `rake flash_booloader`.
|
||||
|
||||
Once the `bootloader` is flashed it is possible to flash the `application` over USB using the DFU protocol by running `rake flash`.
|
||||
To force the bootloader to start the DFU mode press the user button or short a pin, depending on the board.
|
||||
It is also possible to flash the `application` image using SWD by running `rake flash_application`.
|
||||
|
||||
It is also possible to flash the application over Bluetooth as follows:
|
||||
~~~
|
||||
# start bluetooth
|
||||
sudo systemctl restart bluetooth
|
||||
# pair device (you need the PIN)
|
||||
bluetoothctl
|
||||
power on
|
||||
pair 98:D3:33:80:86:BA
|
||||
quit
|
||||
# connect to device
|
||||
sudo rfcomm bind rfcomm0 98:D3:33:80:86:BA
|
||||
# switch to bootloader
|
||||
echo "system" > /dev/rfcomm0
|
||||
# flash firmware (it always fails the first time)
|
||||
stm32flash /dev/rfcomm0
|
||||
stm32flash /dev/rfcomm0 -S 0x08002000 -w application.bin -R
|
||||
# disconnect from device
|
||||
sudo rfcomm release rfcomm0
|
||||
~~~
|
||||
|
||||
debug
|
||||
-----
|
||||
|
||||
|
|
@ -99,4 +217,4 @@ To start the debugging session run `rake debug`.
|
|||
USB
|
||||
---
|
||||
|
||||
The firmware offers serial communication over USART1 and USB (using the CDC ACM device class).
|
||||
The firmware offers serial communication over USART1 (where the Bluetooth module is connected) and USB (using the CDC ACM device class).
|
||||
|
|
|
|||
Loading…
Reference in New Issue