SPIFlash_LowPowerLab/README.md

28 lines
2.2 KiB
Markdown
Raw Normal View History

2015-12-29 01:25:55 +00:00
[![Build Status](https://travis-ci.org/LowPowerLab/SPIFlash.svg?branch=master)](https://travis-ci.org/LowPowerLab/SPIFlash)
2013-04-04 23:03:35 +01:00
SPIFlash
========
2014-07-29 22:21:36 +01:00
Arduino/Moteino library for read/write access to SPI flash memory chips.
2018-03-15 15:19:03 +00:00
This works with 256byte/page SPI flash memory such as the [4MBIT W25X40CLSNIG](https://lowpowerlab.com/shop/product/72) used on [Moteino](https://www.moteino.com) for data storage and wireless programming.
2014-07-29 22:21:36 +01:00
<br/>
2014-07-29 22:23:02 +01:00
For instance a 4MBit (512Kbyte) flash chip will have 2048 pages: 256*2048 = 524288 bytes (512Kbytes).
<br/>Minimal modifications should allow chips that have different page size to work.
2018-03-15 15:19:03 +00:00
<br/>DEPENDS ON: Arduino native *SPI library*.
2014-07-29 22:21:36 +01:00
<br/>
2018-03-15 15:19:03 +00:00
This library was primarily developed to enable **safe** wireless programming on Moteino nodes and Moteino based applications such as the [SwitchMote](https://lowpowerlab.com/guide/switchmote/). This has been documented at [lowpowerlab](https://lowpowerlab.com/guide/moteino/wireless-programming/). [Dualoptiboot](https://github.com/LowPowerLab/DualOptiboot) (all AVR based Moteinos come with it) and [RFM69_OTA WirelessProgramming library](https://github.com/LowPowerLab/RFM69) are required to be able to wirelessly re-flash a remote Moteino.
2014-07-29 22:21:36 +01:00
### Installation
2013-04-04 23:16:29 +01:00
Copy the content of this library in the "Arduino/libraries/SPIFlash" folder.
2013-04-04 23:16:09 +01:00
<br />
To find your Arduino folder go to File>Preferences in the Arduino IDE.
<br/>
2015-12-28 20:49:24 +00:00
See [this tutorial](https://www.arduino.cc/en/Guide/Libraries) on installing Arduino libraries.
2014-07-29 22:21:36 +01:00
### License
2018-03-15 15:19:03 +00:00
Copyright (c) 2013-2018 by Felix Rusu <felix@lowpowerlab.com>
2015-12-28 20:44:30 +00:00
<br/><br/>
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
<br/><br/>
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
<br/><br/>
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.