Update README.md

This commit is contained in:
LowPowerLab 2014-07-29 17:21:36 -04:00
parent 57715ad5c0
commit ed39b2da17
1 changed files with 15 additions and 5 deletions

View File

@ -1,8 +1,13 @@
SPIFlash SPIFlash
======== ========
Arduino/Moteino library for read/write access to SPI flash memory chips.
Arduino library for read/write access to SPI flash memory chips. This works with 256byte/page SPI flash memory such as the 4MBIT W25X40CLSNIG used on (Moteinos)[www.moteino.com] for data storage and wireless programming.
See code files for initial documentation, more to come soon. <br/>
For instance a 4MBit (512Kbyte) flash chip will have 2048 pages: 256*2048 = 524288 bytes (512Kbytes)
Minimal modifications should allow chips that have different page size but modifications
DEPENDS ON: Arduino SPI library
<br/>
This library was primarily developed to enable *safe* wireless programming on Moteino nodes and Moteino based applications such as the SwitchMote. This has been documented at (lowpowerlab)[http://lowpowerlab.com/blog/category/moteino/wireless-programming/].
###Installation ###Installation
Copy the content of this library in the "Arduino/libraries/SPIFlash" folder. Copy the content of this library in the "Arduino/libraries/SPIFlash" folder.
@ -10,3 +15,8 @@ Copy the content of this library in the "Arduino/libraries/SPIFlash" folder.
To find your Arduino folder go to File>Preferences in the Arduino IDE. To find your Arduino folder go to File>Preferences in the Arduino IDE.
<br/> <br/>
See [this tutorial](http://learn.adafruit.com/arduino-tips-tricks-and-techniques/arduino-libraries) on Arduino libraries. See [this tutorial](http://learn.adafruit.com/arduino-tips-tricks-and-techniques/arduino-libraries) on Arduino libraries.
###License
Copyright (c) 2013 by Felix Rusu <felix@lowpowerlab.com>
<br/>
This library is free software; you can redistribute it and/or modify it under the terms of either the GNU General Public License version 2 or the GNU Lesser General Public License version 2.1, both as published by the Free Software Foundation.