diff options
| author | David Blajda <blajda@hotmail.com> | 2017-10-17 19:41:54 -0400 |
|---|---|---|
| committer | David Blajda <blajda@hotmail.com> | 2017-10-17 19:41:54 -0400 |
| commit | 3db4c3ef59f920adc86bd3a8d8425e74fcb81bb9 (patch) | |
| tree | 13c26b761077af923ebe906285c025d017d7bdbf /readme.md | |
| parent | ee820891c9f9c7db8aa5ea2ae24a71e1a3c16b31 (diff) | |
rename readme for github
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..a7b28cf --- /dev/null +++ b/readme.md @@ -0,0 +1,14 @@ +#DS1302 Library for the Raspberry Pi + +This is a library for interacting with the serial interface of a DS1302 with a Raspberry Pi. +Serial communications is bit banged instead of using the Pi's SPI pins to allow flexibility when setting up. +Single register read and write operations are supported and burst read and write operations on clock and ram registers are also supported. +Additional utilities for manipulating `struct tm` on the device is also provided. + +##Requirements +bcm2835 library <http://www.airspayce.com/mikem/bcm2835/index.html> + +##References + +DS1302 Datasheet <https://datasheets.maximintegrated.com/en/ds/DS1302.pdf> +bcm2835 arm peripherals <https://www.raspberrypi.org/app/uploads/2012/02/BCM2835-ARM-Peripherals.pdf> |