add project presentation

README.md

@@ -1,41 +1,71 @@
-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).
-
 project
 =======
 
 summary
 -------
 
-*describe project purpose*
+This is the firmware for a digital clapperboard.
 
 technology
 ----------
 
-*described electronic details*
+Clapperboards are used to synchronize audio and video tracks by clapping two wooden pieces.
+This is then visible on the video and the sharp sound is also present on the audio.
+Using the scene and take number written on the clapperboard and spoke at the beginning of the recording it is possible to know which sound track corresponds to which video track.
+
+This clapper board improves this system with some features:
+
+- use 7-segment displays to show scene and take number (instead of having to manually write and erase it on the board)
+- show audio and video track numbers (number used in the file names or the recordings)
+- show current time
+- automatically increment the take and recording numbers
+
+The numbers on the board can be adjusted by hand using button switches.
 
 board
 =====
 
-The current implementation uses a [blue pill](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#blue_pill).
+The current implementation uses a [core board](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#core_board).
+The underlying [template](https://git.cuvoodoo.info/stm32f1/about/) supports additional board.
 
-The underlying template also supports following board:
+peripherals
+===========
 
-- [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](ihttps://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#blue_pill), based on a STM32F103C8T6
-
-**Which board is used is defined in the Makefile**.
-This is required:
-
-- for the linker script to know the memory layout (flash and RAM)
-- map the user LED and button provided on the board
+- 1x 8-digit 7-segment display based on the MAX7219 to display the date
+- 1x 8-digit 7-segment display based on the MAX7219 to display the time (hours, minutes, seconds, frame)
+- 7x 4-digit 7-segment display based on the TM1637 to display recording information
+  - 1x to display the chapter/episode
+  - 1x to display the scene
+  - 1x to display the take
+  - 2x to display the video file number
+  - 2x to display the audio file number
+- 1x 16-channel multiplexer to communicate with the 7-segments individually
+- 8x2 button switches to adjust the recording numbers and seconds
+- 2x ball-based tilt sensor to detect the orientation
+- 1x DS1307 RTC to keep track of the time
 
 connections
 ===========
 
-Connect the peripherals the following way (STM32F10X signal; STM32F10X pin; peripheral pin; peripheral signal; comment):
+Connect the peripherals the following way (peripheral signal; peripheral signal; micro-controller pin; micro-controller signal; comment):
 
-- *list board to preipheral pin connections*
+- DS1307 RTC
+  - VCC; 8; ; +5V;
+  - GND; 4; ; GND;
+  - SCL; 6; PB10; I2C2_SCL; to get the date
+  - SDA; 5; PB11; I2C2_SDA; to get the date
+  - SQW; 7; ;; to synchronize the seconds
+- 2x MAX7219 in chain
+  - VCC; 19; ; +5V;
+  - GND; 4; ; GND;
+  - CLK; 13; ; ;
+  - DIN; 1; ; ;
+  - LOAD; 12; ; ;
+- 7x TM1627 with multiplexed clock line
+  - VDD; 16; ; +5V;
+  - GND; 1; ; GND;
+  - CLK; 18; PB6; GPIO
+  - DIO; 17; PB7; GPIO
 
 All pins are configured using `define`s in the corresponding source code.