diff --git a/README.md b/README.md index e31efb7..1f45276 100644 --- a/README.md +++ b/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). +This is the firmware for the **spark abacus**. project ======= @@ -6,38 +6,16 @@ project summary ------- -*describe project purpose* - -technology ----------- - -*described electronic details* +The spark abacus is a system to monitor electricity consumption. +A micro-controller collects data from various electricity meters placed at the entry of the 3-phase 4-wire mains electricity distribution installation, and sends it over a local network to a computer storing the values in a database. +The measurements can then be visualized. +More information is available on the [wiki](https://wiki.cuvoodoo.info/doku.php?id=spark_abacus). board -===== +----- -The current implementation uses a [blue pill](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#blue_pill). - -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](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 - -connections -=========== - -Connect the peripherals the following way (STM32F10X signal; STM32F10X pin; peripheral pin; peripheral signal; comment): - -- *list board to preipheral pin connections* - -All pins are configured using `define`s in the corresponding source code. +The development board used for this project is a [blue pill](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#blue_pill). +This offers a [STM32F103C8T6 micro-controller](http://www.st.com/web/en/catalog/mmc/FM141/SC1169/SS1031). peripherals =========== @@ -74,8 +52,8 @@ dependencies ------------ The source code uses the [libopencm3](http://libopencm3.org/) library. -The projects is already a git submodules. -To initialize and it you just need to run once: `git submodule init` and `git submodule update`. +libopencm3 is already a git submodules. +To initialize and update it you just need to run once: `git submodule init` and `git submodule update`. firmware -------- @@ -104,8 +82,10 @@ To start the debugging session run `make debug`. USB --- -The firmware offers serial communication over USART1 and USB (using the CDC ACM device class). +The firmware offers serial communication over USB (using the CDC ACM device class). +This is mainly used to show the activity and help debugging to code. +Type `help` to get a list of additional available actions. You can also reset the board by setting the serial width to 5 bits over USB. To reset the board run `make reset`. -This only works if the USB CDC ACM is running correctly and the micro-controller isn't stuck. +This only works if USB CDC ACM is running correctly and the micro-controller isn't stuck.