From a6c5fde79e2ecb2d7b22826aef46d180de403f35 Mon Sep 17 00:00:00 2001 From: boyska Date: Tue, 23 Oct 2018 23:40:52 +0200 Subject: [PATCH] better readme --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ ad9850/README.md | 12 ------------ 2 files changed, 46 insertions(+), 12 deletions(-) delete mode 100644 ad9850/README.md diff --git a/README.md b/README.md index e966553..4db7afe 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,48 @@ This is a collection of misc libraries, examples, etc. for stm32f103 (aka blue pill) + libopencm3 (+ FreeRTOS, sometimes) + +AD9850 +======== + +Control some DDS like AD9850 and AD9851. + +This library doesn't use SPI, just regular GPIO: this is simpler (imho) to implement and understand, and gives +you freedom to use whichever pin you prefer. + +Notes +------- +Support for ad9833 is completely lacking (despite some code you might find). + +I am uncertain about ad9850/1: the two are similar, and I have some difficulties understanding which do I +have. However, I think the implementation is correct. + +Rotary TBL +=========== + +Rotary encoder reading implemented with interrupts and lookup tables. This implementation uses a single +interrupt, both on rising and falling. + +Credits to http://makeatronics.blogspot.com/2013/02/efficiently-reading-quadrature-with.html + +_This is not a library, just an example_ + +The example uses FreeRTOS just for convenience, you can easily remove it. + +Rotary TBL2 +=========== + +Same as before, but with interrupts on both ports of the rotary encoder. It is more precise but, well, "uses" +one more interrupt. + +Credits to http://makeatronics.blogspot.com/2013/02/efficiently-reading-quadrature-with.html + +The example uses FreeRTOS just for convenience, you can easily remove it. + +_This is not a library, just an example_ + +SSD1306 +======= + +Controls the oled display SSD1306. + +SPI is used, so you don't have complete freedom on which pin/port to choose. diff --git a/ad9850/README.md b/ad9850/README.md deleted file mode 100644 index 0635fc9..0000000 --- a/ad9850/README.md +++ /dev/null @@ -1,12 +0,0 @@ -AD98xx --------- - -This library doesn't use SPI, just regular GPIO: this is simpler (imho) to implement and understand, and gives -you freedom to use whichever pin you prefer. - -Notes -------- -Support for ad9833 is completely lacking (despite some code you might find). - -I am uncertain about ad9850/1: the two are similar, and I have some difficulties understanding which do I -have. However, I think the implementation is correct.