查看SPIFlash库的源代码



'''小编奋力编辑中....'''


{| border="0" cellpadding="10" width="100%"
|-
|width="100%" valign="top" align="left"|
'''SPIFlash库''' -- SPI华邦电子闪存Flash芯片arduino库
GITHUB 工程地址：[https://github.com/Marzogh/SPIFlash  SPIFlash]

该库是用于华邦串行闪存芯片的库。目前的形式支持识别闪存芯片和它的各种功能；自动地址分配管理；在不同位置读写数据类型bytes/chars/ints/longs/floats/Strings；读写页面字节；连续读写字节/字符数组；扇区，块或整个芯片的擦除，关闭低功率操作。

支持arduino IDE 版本：
* IDE v1.5.x
* IDE v1.6.0-v1.6.5
* IDE v1.6.9-v1.6.11

支持控制板：
* Arduino Uno
* Arduino Leonardo
* Arduino Micro
* Arduino Fio
* Arduino Mega
* Arduino Due
* ESP8266 (On the Arduino IDE)
* ATTiny85
 


<font color="orange" size="+2">'''示例'''</font><br>


:-[[ Diagnostics]]: For a full diagnostics rundown - with error codes and details of the errors./有关完整诊断程序 - 包含错误代码和错误详细信息

:-[[ Struct_writer]]: This program writes a struct to a random location on your flash memory chip and reads it back./这个程序写一个struct到闪存芯片的随机位置然后读取它。   

:-[[ TestFlash]]: The Test program show all most function./测试程序演示大部分功能函数

:-[[ getAddressEx]]: This program shows the method to use the getAddress() function to automate the process of address allocation when using a flash memory module. Please note the special function used to get the size of the String object./这个程序演示了使用getAddress()函数自动地址配置的过程在使用闪存模块。 请注意特殊函数使用字符串对象的大小。 
。

:-[[ readWriteString]]: This program shows the method of reading a string from the console and saving it to flash memory./这个程序演示了阅读一个字符串从控制台并保存到闪存 

|width="0%" valign="top" align="left"|
<!-- 空白 -->
|}

{| border="0" cellpadding="10" width="100%"
|-
|width="100%" valign="top" align="left"|
<font color="orange" size="+2">'''SPIFlash'''</font><br>

'''SPIFlash 函数。'''

|}

{| border="0" cellpadding="10" width="100%"
|-
|width="50%" valign="top" align="left"|

:- <font color="forestgreen">begin()</font> -- 初始化
::参数：无
::返回：无

:- <font color="forestgreen">error()</font>  -- 检查错误
::参数：无
::返回：uint8_t

:- <font color="forestgreen">getCapacity()</font>  -- 获取芯片容量
::参数：无
::返回：uint32_t

:- <font color="forestgreen">getMaxPage()</font>  -- 获取最大页数
::参数：无
::返回：uint32_t

:- <font color="forestgreen">getChipName()</font>  -- 获取芯片识别名称
::参数：无
::返回：uint16_t


:- <font color="forestgreen">getManID()</font>  -- 检查和启动芯片并获取16位int型制造商ID
::参数：无
::返回：uint16_t

:- <font color="forestgreen">getJEDECID()</font>  -- 检查和启动芯片并获取32位int型 JEDEC ID
::参数：无
::返回：uint32_t


-- 获取下一个可用地址使用：
--    A.以数据的大小作为参数,并返回一个32位的地址 
--    B.3个参数，数据大小、页数及位置
--  所有地址的素描必须获得通过该函数或不 
:- <font color="forestgreen">getAddress(uint16_t size)</font>  -- A
::参数：size - 数据大小
::返回：uint32_t

:- <font color="forestgreen">getAddress(uint16_t size, uint16_t &page_number, uint8_t &offset)</font>  -- B
::参数：
:::* size - 
:::* &page_number - 
:::* &offset - 
::返回：bool

:- <font color="forestgreen">sizeofStr(String &inputStr)</font>  -- 函数返回字符串的大小(仅用于getAddress()函数) 
::参数：inputStr - 字符串
::返回：uint16_t


-- 从一个页面的特定位置读一个<font color="red">字节</font>的数据
--    A & B
:- <font color="forestgreen">readByte(uint32_t address, bool fastRead)</font>  -- A
::参数：
:::* address - 地址（0 - 最大存储地址）
:::* fastRead - 默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：uint8_t

:- <font color="forestgreen">readByte(uint16_t page_number, uint8_t offset, bool fastRead)</font>  -- B
::参数：
:::* page_number - 页数（0-最大页数）
:::* offset - 页面中的地址（0-255）
:::* fastRead -  默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：uint8_t


-- 从一个页面的特定位置读一个<font color="red">字符</font>的数据
--    A & B
:- <font color="forestgreen">readChar(uint32_t address, bool fastRead)</font>  -- A
::参数：
:::* address - 地址（0 - 最大存储地址）
:::* fastRead - 默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：int8_t

:- <font color="forestgreen">readChar(uint16_t page_number, uint8_t offset, bool fastRead)</font>  -- B
::参数：
:::* page_number - 页数（0-最大页数）
:::* offset - 页面中的地址（0-255）
:::* fastRead -  默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：int8_t


-- 从一个页面的特定位置读一个<font color="red">字节数组</font>的数据
--    A & B
:- <font color="forestgreen">readByteArray(uint32_t address, uint8_t *data_buffer, uint16_t bufferSize, bool fastRead)</font>  -- A
::参数：
:::* address - 地址（0 - 最大存储地址）
:::* data_buffer - 读取的数据
:::* bufferSize - 读取数据大小
:::* fastRead - 默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：bool

:- <font color="forestgreen">readByteArray(uint16_t page_number, uint8_t offset, uint8_t *data_buffer, uint16_t bufferSize, bool fastRead)</font>  -- B
::参数：
:::* page_number - 页数（0-最大页数）
:::* offset - 页面中的地址（0-255）
:::* data_buffer - 读取的数据
:::* bufferSize - 读取数据大小
:::* fastRead -  默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：bool


-- 从一个页面的特定位置读一个<font color="red">字符数组</font>的数据
--    A & B
:- <font color="forestgreen">readCharArray(uint32_t address, uint8_t *data_buffer, uint16_t bufferSize, bool fastRead)</font>  -- A
::参数：
:::* address - 地址（0 - 最大存储地址）
:::* data_buffer - 读取的数据
:::* bufferSize - 读取数据大小
:::* fastRead - 默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：bool

:- <font color="forestgreen">readCharArray(uint16_t page_number, uint8_t offset, uint8_t *data_buffer, uint16_t bufferSize, bool fastRead)</font>  -- B
::参数：
:::* page_number - 页数（0-最大页数）
:::* offset - 页面中的地址（0-255）
:::* data_buffer - 读取的数据
:::* bufferSize - 读取数据大小
:::* fastRead -  默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：bool


-- 从一个页面的特定位置读一个<font color="red">无符号整型（unsigned int）</font>数据
--    A & B
:- <font color="forestgreen">readWord(uint32_t address, bool fastRead)</font>  -- A
::参数：
:::* address - 地址（0 - 最大存储地址）
:::* fastRead - 默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：uint16_t

:- <font color="forestgreen">readWord(uint16_t page_number, uint8_t offset, bool fastRead)</font>  -- B
::参数：
:::* page_number - 页数（0-最大页数）
:::* offset - 页面中的地址（0-255）
:::* fastRead -  默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：uint16_t


-- 从一个页面的特定位置读一个<font color="red">整型（int）</font>数据
--    A & B
:- <font color="forestgreen">readShort(uint32_t address, bool fastRead)</font>  -- A
::参数：
:::* address - 地址（0 - 最大存储地址）
:::* fastRead - 默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：int16_t

:- <font color="forestgreen">readShort(uint16_t page_number, uint8_t offset, bool fastRead)</font>  -- B
::参数：
:::* page_number - 页数（0-最大页数）
:::* offset - 页面中的地址（0-255）
:::* fastRead -  默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：int16_t


-- 从一个页面的特定位置读一个<font color="red">无符号长整型（unsigned long）</font>数据
--    A & B
:- <font color="forestgreen">readULong(uint32_t address, bool fastRead)</font>  -- A
::参数：
:::* address - 地址（0 - 最大存储地址）
:::* fastRead - 默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：uint32_t

:- <font color="forestgreen">readULong(uint16_t page_number, uint8_t offset, bool fastRead)</font>  -- B
::参数：
:::* page_number - 页数（0-最大页数）
:::* offset - 页面中的地址（0-255）
:::* fastRead -  默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：uint32_t


-- 从一个页面的特定位置读一个<font color="red">长整型（long）</font>数据
--    A & B
:- <font color="forestgreen">readLong(uint32_t address, bool fastRead)</font>  -- A
::参数：
:::* address - 地址（0 - 最大存储地址）
:::* fastRead - 默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：int32_t

:- <font color="forestgreen">readLong(uint16_t page_number, uint8_t offset, bool fastRead)</font>  -- B
::参数：
:::* page_number - 页数（0-最大页数）
:::* offset - 页面中的地址（0-255）
:::* fastRead -  默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：int32_t


-- 从一个页面的特定位置读一个<font color="red">浮点（float）</font>数据 ？？
--    A & B
:- <font color="forestgreen">readFloat(uint32_t address, bool fastRead)</font>  -- A
::参数：
:::* address - 地址（0 - 最大存储地址）
:::* fastRead - 默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：float

:- <font color="forestgreen">readFloat(uint16_t page_number, uint8_t offset, bool fastRead)</font>  -- B
::参数：
:::* page_number - 页数（0-最大页数）
:::* offset - 页面中的地址（0-255）
:::* fastRead -  默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：float


-- 从一个页面的特定位置读一个<font color="red">字符串（string）</font>数据 
--    A & B
:- <font color="forestgreen">readStr(uint32_t address, String &outStr, bool fastRead)</font>  -- A
::参数：
:::* address - 地址（0 - 最大存储地址）
:::* outputString --> 字符串
:::* fastRead - 默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：bool

:- <font color="forestgreen">readStr(uint16_t page_number, uint8_t offset, String &outStr, bool fastRead)</font>  -- B
::参数：
:::* page_number - 页数（0-最大页数）
:::* offset - 页面中的地址（0-255）
:::* outputString --> 字符串
:::* fastRead -  默认为false（ 如果设置为true将执行 _beginFastRead() ）
::返回：bool


-- 写一个<font color="red">字节（byte）</font>数据到一个页面的特定位置 
--    A & B
--  提示：写数据之前需要清除存储位置
:- <font color="forestgreen">writeByte(uint32_t address, uint8_t data, bool errorCheck)</font>  -- A
::参数：
:::* address - 地址（0 - 最大存储地址）
:::* data - 写入的数据（0-255）
:::* errorCheck - 默认true，检查是否写入
::返回：bool

:- <font color="forestgreen">writeByte(uint16_t page_number, uint8_t offset, uint8_t data, bool errorCheck)</font>  -- B
::参数：
:::* page_number - 页数（0-最大页数）
:::* offset - 页面中的地址（0-255）
:::* data - 写入的数据（0-255）
:::* errorCheck - 默认true，检查是否写入
::返回：bool


-- 写一个<font color="red">字符（char）</font>数据到一个页面的特定位置 
--    A & B
--  提示：写数据之前需要清除存储位置
:- <font color="forestgreen">writeByte(uint32_t address, uint8_t data, bool errorCheck)</font>  -- A
::参数：
:::* address - 地址（0 - 最大存储地址）
:::* data - 写入的数据（0-255）
:::* errorCheck - 默认true，检查是否写入
::返回：bool

:- <font color="forestgreen">writeByte(uint16_t page_number, uint8_t offset, uint8_t data, bool errorCheck)</font>  -- B
::参数：
:::* page_number - 页数（0-最大页数）
:::* offset - 页面中的地址（0-255）
:::* data - 写入的数据（0-255）
:::* errorCheck - 默认true，检查是否写入
::返回：bool

























:- <font color="forestgreen">getMaxPage()</font>  -- 检查错误
::参数：无
::返回：uint32_t

:- <font color="forestgreen">getMaxPage()</font>  -- 检查错误
::参数：无
::返回：uint32_t



|width="50%" valign="top" align="left"|

:- <font color="forestgreen">getMaxPage()</font>  -- 检查错误
::参数：无
::返回：uint32_t

:- <font color="forestgreen">getMaxPage()</font>  -- 检查错误
::参数：无
::返回：uint32_t


|}




----

[[语音模块|返回语音模块]]

[[Arduino库|返回Arduino库菜单]]

[[首页|返回首页]]

更多建议和问题欢迎反馈至 [http://www.yfrobot.com YFRobot论坛]