Arduino--SD卡官方库官方文档

古城微笑少年丶 2023-06-20 06:34 1阅读 0赞

官方：https://www.arduino.cc/en/Reference/SD

## SD库 ##

SD库允许在SD卡上读写，例如在Arduino Ethernet Shield上。它是建立在sdfatlib威廉Greiman。该库在标准SD卡和SDHC卡上支持FAT16和FAT32文件系统。它对文件使用短8.3名称。传递到SD库函数的文件名可以包含用斜杠/分隔的路径，例如“ directory / filename.txt”。由于工作目录始终是SD卡的根目录，因此无论文件名是否包含前导斜杠，其名称都指向同一文件（例如，“ / file.txt”等效于“ file.txt”）。从1.0版开始，该库支持打开多个文件。

微控制器和SD卡之间的通信使用SPI，它发生在数字引脚11、12和13（在大多数Arduino板上）或50、51和52（Arduino Mega）上。此外，必须使用另一个引脚来选择SD卡。这可以是硬件SS引脚-引脚10（在大多数Arduino板上）或引脚53（在Mega上）-或在SD.begin（）调用中指定的另一个引脚。 请注意，即使您不使用硬件SS引脚，也必须将其保留为输出，否则SD库将无法工作。

## SD 类 ##

SD类提供用于访问SD卡并处理其文件和目录的功能。  
函数：

<table> 
 <thead> 
  <tr> 
   <th>函数名</th> 
   <th>解释</th> 
   <th>用法</th> 
   <th>参数</th> 
   <th>返回值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>begin()</td> 
   <td>初始化SD库和卡。这开始使用SPI总线（大多数Arduino板上的数字引脚11、12和13； Mega上的50、51和52）和芯片选择引脚，默认为硬件SS引脚（大多数Arduino上的引脚10）板，在Mega上为53）。请注意，即使您使用其他芯片选择引脚，也必须保留硬件SS引脚作为输出，否则SD库功能将不起作用。</td> 
   <td>SD.begin()<br>SD.begin（cspin）</td> 
   <td>cspin（可选）：连接到SD卡芯片选择线的引脚；默认为SPI总线的硬件SS线</td> 
   <td>成功返回true; 失败返回false</td> 
  </tr> 
  <tr> 
   <td>exists()</td> 
   <td>测试SD卡上是否存在文件或目录。</td> 
   <td>SD.exists（filename）</td> 
   <td>filename：要测试存在性的文件的名称，其中可以包含目录（以正斜杠/分隔）</td> 
   <td>如果文件或目录存在则为true，否则为false</td> 
  </tr> 
  <tr> 
   <td>mkdir()</td> 
   <td>在SD卡上创建目录。这还将创建任何尚不存在的中间目录。例如SD.mkdir（“ a / b / c”）将创建a，b和c。</td> 
   <td>SD.mkdir(filename)</td> 
   <td>filename：要创建的目录的名称，子目录之间用正斜杠（’/’）</td> 
   <td>如果目录创建成功，则返回true；否则，返回false</td> 
  </tr> 
  <tr> 
   <td>open()</td> 
   <td>打开SD卡上的文件。如果打开该文件进行写入，则将在尚不存在该文件的情况下创建该文件（但是包含该文件的目录必须已经存在）。</td> 
   <td>SD.open(filepath) <br> SD.open(filepath, mode)</td> 
   <td>filename：要打开的文件的名称，其中可以包含目录（以正斜杠/分隔）-char * <br>模式（可选）：打开文件的模式，默认为FILE_READ- byte。之一：<br>FILE_READ：从文件开头开始打开文件进行读取。<br>FILE_WRITE：从文件末尾开始打开文件进行读写。</td> 
   <td>引用打开的文件的File对象；如果无法打开文件，则此对象在布尔上下文中将评估为false，即，您可以使用“ if（f）”测试返回值。</td> 
  </tr> 
  <tr> 
   <td>remove()</td> 
   <td>从SD卡中删除文件。</td> 
   <td>SD.remove(filename)</td> 
   <td>filename：要删除的文件的名称，其中可以包含目录（以正斜杠/分隔）</td> 
   <td>如果成功删除文件，则为true，否则为false。（如果文件不存在，则返回值未指定）</td> 
  </tr> 
  <tr> 
   <td>rmdir()</td> 
   <td>从SD卡中删除目录。该目录必须为空。</td> 
   <td>SD.rmdir(filename)</td> 
   <td>filename：要删除的目录的名称，子目录之间用正斜杠(’/’)</td> 
   <td>如果删除目录成功，则返回true；否则，返回false。（如果目录不存在，则返回值未指定）</td> 
  </tr> 
 </tbody> 
</table>

## File 类 ##

File类允许读取和写入SD卡上的单个文件。

<table> 
 <thead> 
  <tr> 
   <th>函数名</th> 
   <th>解释</th> 
   <th>用法</th> 
   <th>参数</th> 
   <th>返回值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>name()</td> 
   <td>返回文件名</td> 
   <td>file.name()</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>available()</td> 
   <td>检查是否有任何字节可用于从文件读取。available（）从Stream实用程序类继承。</td> 
   <td>file.available()</td> 
   <td>file：File类的实例（由SD.open（）返回）</td> 
   <td>可用字节数（int）</td> 
  </tr> 
  <tr> 
   <td>close()</td> 
   <td>关闭文件，并确保将写入其中的所有数据物理保存到SD卡。</td> 
   <td>file.close()</td> 
   <td>file：File类的实例（由SD.open（）返回）</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>flush()</td> 
   <td>确保写入文件的所有字节都物理保存到SD卡。关闭文件时，此操作自动完成。flush（）从Stream实用程序类继承。</td> 
   <td>file.flush()</td> 
   <td>file：File类的实例（由SD.open（）返回）</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>peek()</td> 
   <td>从文件中读取一个字节，而无需前进到下一个字节。也就是说，对peek（）的连续调用将返回相同的值，与对下一个read（）的调用相同。peek（）继承自Stream实用程序类。</td> 
   <td>file.peek()</td> 
   <td>file：File类的实例（由SD.open（）返回）</td> 
   <td>返回值：下一个字节（或字符）；如果没有可用字节，则为-1。</td> 
  </tr> 
  <tr> 
   <td>position()</td> 
   <td>获取文件中的当前位置（即，下一个字节将被读取或写入的位置）。</td> 
   <td>file.position()</td> 
   <td>file：File类的实例（由SD.open（）返回）</td> 
   <td>文件中的位置（unsigned long））</td> 
  </tr> 
  <tr> 
   <td>print()</td> 
   <td>将数据打印到文件中，该文件必须已打开才能进行写入。将数字打印为数字序列，每个数字为一个ASCII字符（例如，数字123作为三个字符“ 1”，“ 2”，“ 3”发送）。</td> 
   <td>file.print(data) <br> file.print(data, BASE)</td> 
   <td>file：File类的实例（由SD.open（）返回）<br> data：要打印的数据（char，byte，int，long或string）<br> BASE（可选）：打印数字的基数：BIN（二进制）（基数2），DEC（十进制）（基数10），OCT（八进制）（基数8），HEX（十六进制）（基数16）。</td> 
   <td>print（）将返回写入的字节数，尽管读取该数字是可选的</td> 
  </tr> 
  <tr> 
   <td>println()</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>seek()</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>size()</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>read()</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>write()</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>isDirectory()</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>openNextFile()</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>rewindDirectory()</td> 
   <td></td> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>