“SPIFlash库”的版本间的差异
第78行: | 第78行: | ||
::返回:uint8_t | ::返回:uint8_t | ||
− | :- <font color="forestgreen"> | + | :- <font color="forestgreen">getCapacity()</font> -- 获取芯片容量 |
::参数:无 | ::参数:无 | ||
− | ::返回 | + | ::返回 :uint32_t |
− | :- <font color="forestgreen"> | + | :- <font color="forestgreen">getMaxPage()</font> -- 获取最大页数 |
::参数:无 | ::参数:无 | ||
− | ::返回 | + | ::返回 :uint32_t |
− | :- <font color="forestgreen">getAddress(uint16_t size, uint16_t &page_number, uint8_t &offset)</font> -- | + | :- <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 - | :::* size - | ||
:::* &page_number - | :::* &page_number - | ||
:::* &offset - | :::* &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 | ::返回:bool | ||
− | :- <font color="forestgreen"> | + | :- <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="forestgreen"> | + | |
− | ::参数:无 | + | -- 从一个页面的特定位置读一个<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 | ::返回:uint16_t | ||
− | :- <font color="forestgreen"> | + | :- <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 | ::返回:uint16_t | ||
− | :- <font color="forestgreen"> | + | |
− | ::参数:无 | + | -- 从一个页面的特定位置读一个<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 | ::返回:uint32_t | ||
− | :- <font color="forestgreen"> | + | :- <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 | ::返回:uint32_t | ||
− | :- <font color="forestgreen"> | + | |
+ | -- 从一个页面的特定位置读一个<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 - | + | :::* address - 地址(0 - 最大存储地址) |
− | :::* | + | :::* outputString --> 字符串 |
− | :::* | + | :::* fastRead - 默认为false( 如果设置为true将执行 _beginFastRead() ) |
::返回:bool | ::返回:bool | ||
− | :- <font color="forestgreen"> | + | :- <font color="forestgreen">readStr(uint16_t page_number, uint8_t offset, String &outStr, bool fastRead)</font> -- B |
::参数: | ::参数: | ||
− | :::* page_number - | + | :::* page_number - 页数(0-最大页数) |
− | :::* offset - | + | :::* offset - 页面中的地址(0-255) |
− | :::* | + | :::* outputString --> 字符串 |
− | :::* | + | :::* fastRead - 默认为false( 如果设置为true将执行 _beginFastRead() ) |
::返回:bool | ::返回:bool | ||
− | :- <font color="forestgreen"> | + | |
+ | -- 写一个<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"> | + | :- <font color="forestgreen">writeByte(uint16_t page_number, uint8_t offset, uint8_t data, bool errorCheck)</font> -- B |
::参数: | ::参数: | ||
− | :::* address - | + | :::* 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 | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
2017年1月11日 (三) 14:45的版本
小编奋力编辑中....
SPIFlash库 -- SPI华邦电子闪存Flash芯片arduino库 GITHUB 工程地址:SPIFlash 该库是用于华邦串行闪存芯片的库。目前的形式支持识别闪存芯片和它的各种功能;自动地址分配管理;在不同位置读写数据类型bytes/chars/ints/longs/floats/Strings;读写页面字节;连续读写字节/字符数组;扇区,块或整个芯片的擦除,关闭低功率操作。 支持arduino IDE 版本:
支持控制板:
示例
。
|
SPIFlash SPIFlash 函数。 |
|
|
更多建议和问题欢迎反馈至 YFRobot论坛