From db3e3103dbcf631a295c23334bbf76b1762dd440 Mon Sep 17 00:00:00 2001 From: clyne Date: Sat, 17 Oct 2020 13:48:33 -0400 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 93d7082..cde901e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,21 @@ # stmdsp -Code for an STM32-based DSP device. +This is the source code for an STM32-based DSP device. The primary goal of this device is to transform signals in real-time, through a GUI for writing and uploading C++ code to the device. -**Goals:** +The firmware for the device is written in C++, on top of the [ChibiOS](https://www.chibios.org/dokuwiki/doku.php) real-time operating system. + +**Features:** +* Read in a signal from the ADC, and either pass-through or apply a filter to the signal before outputting it over the DAC +* Sampling rate of 96kS/s +* Measuring of filter code in processor clock cycles + +**Device features:** * Read +/- 5V signal(s) off of at least one pin * Send +/- 5V signal(s) off of at least one pin -* Perform DSP calculations (e.g. filtering) on-device * Communicate with a computer program to allow for the reading, writing, and transformation of signals. -See the wiki for pages on each of these goals. - -Source code for the device's firmware is in the `source` directory. `gui` contains code for a custom GUI for the device, in C++. +See the wiki for more information about components of the device's software and hardware. -Code for using the device with Mathematica will be added soon. +**Directory explanation:** +Source code for the device's firmware is in the `source` directory. +Source code for the accompanying GUI is in `gui`. +Notebook files for working with the device in Mathematica are in `mathematica`.