使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  ( s( b0 c6 x2 q: M. T) a1 O3 [

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      6 ]& x7 A4 f  ~3 L' i" W, ~; ?  X
    
    4 f; H% ~# a! X! o0 Q" Z
  
  

本教程介绍 MicroPython 如何提供设备上的文件系统，允许将标准 Python 文件 I/O 方法与持久存储一起使用。

MicroPython 会自动创建默认配置并自动检测主文件系统，因此如果您想修改分区、文件系统类型或使用自定义块设备，本教程将非常有用。

文件系统通常由设备上的内部闪存支持，但也可以使用外部闪存、RAM 或自定义块设备。

在某些端口（例如 STM32）上，文件系统也可以通过 USB MSC 连接到主机 PC。pyboard.py 工具还为主机 PC 提供了一种访问所有端口上的文件系统的方法。

注意：这主要用于 STM32 和 ESP32 等裸机端口。在带有操作系统的端口（例如 Unix 端口）上，文件系统由主机操作系统提供。

虚拟FS

MicroPython 实现了一个类 Unix 虚拟文件系统 (VFS) 层。所有挂载的文件系统都组合成一个单一的虚拟文件系统，从 root 开始 /。文件系统被挂载到这个结构的目录中，并且在启动时工作目录被更改为主文件系统被挂载的位置。

在 STM32/Pyboard 上，内部闪存安装在 /flash，可选的 SDCard安装在/sd。在 ESP8266/ESP32 上，主文件系统挂载在 /。

5 E1 P! o; Q' l) ?8 W块设备

块设备是实现 uos.AbstractBlockDev协议的类的实例 。

内置块设备

端口提供内置块设备来访问它们的主闪存。

开机时，MicroPython 将尝试检测默认闪存上的文件系统并自动配置和挂载它。如果没有找到文件系统，MicroPython 将尝试创建一个跨越整个闪存的 FAT 文件系统。端口还可以提供一种机制来“恢复出厂设置”主闪存，通常是通过在开机时按下按钮的某种组合。

STM32 / Pyboard

该pyb.Flash类，可以访问内部闪存。在一些具有较大外部闪存的板上（例如 Pyboard D），它将使用它来代替。该 startkwarg应始终指定，即 pyb.Flash(start=0)。

注意：为了向后兼容，当构造没有参数时（即 pyb.Flash()），它只实现简单的块接口并反映呈现给 USB MSC 的虚拟设备（即它在开始时包含一个虚拟分区表）。

7 O9 m9 w% s% Z4 T5 @  EESP8266

内部闪存作为块设备对象公开，该对象 flashbdev 在启动时在模块中创建 。默认情况下，此对象作为全局变量添加，因此通常可以简单地作为bdev. 这实现了扩展接口。

3 l' w% c* g& W, c6 [, RESP32

esp32.Partition类用于实现为板限定分区的块设备。与 ESP8266 一样，有一个全局变量 bdev指向默认分区。这实现了扩展接口。

9 F7 D$ |7 ~  A0 T# S# H' }自定义块设备

以下类实现了一个简单的块设备，该设备使用以下命令将其数据存储在 RAM 中 bytearray:

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   ( R* q5 A1 d/ G, G" j5 v. e
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   , L6 ^  `' J6 Q; @" f* e
5. 
   ( q- ~: F! M9 M+ X0 h, L' B3 S
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   7 D% s  A8 x2 T( E* s7 I
9. 
   + U9 d# {0 W, G5 ^
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    , ?: M: q8 o& A4 u
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    # W# }3 Y/ y8 F: M% @2 [. L
14.     def ioctl(self, op, arg):
    0 s, d4 _9 B! r6 k
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    : q2 l, v, n. i
18.             return self.block_size

复制代码

# ?1 r* P1 G, ^( U! \( g/ m

4 `, x0 P- y- B4 b, }

它可以按如下方式使用：

1. import os
   2 C8 M. B, F9 k2 r+ b
2. 
   * [2 L! b- X8 F" `8 Z9 Z6 _
3. bdev = RAMBlockDev(512, 50)
   9 l8 H+ r1 }* p+ g
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

. m5 W, W  f9 U. y1 J) e

支持简单接口和扩展接口（即 uos.AbstractBlockDev.readblocks() 和 uos.AbstractBlockDev.writeblocks() 方法的签名和行为）的块设备的示例 是：

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   $ B# m# w* }' }' }4 w/ N
4.         self.data = bytearray(block_size * num_blocks)
   3 A  Y9 l; t5 m& x
5. 
   / W$ [5 G# I5 k- o* q# E
6.     def readblocks(self, block_num, buf, offset=0):
   0 L. z$ K4 k, J: n$ T' B& [/ y
7.         addr = block_num * self.block_size + offset
   $ C1 N3 V% i" o+ F7 \6 ^0 {
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   + r* u' P7 I8 d5 H& m# m6 S1 ]% N
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    7 P: z. W0 h* H. ]: t0 B
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    5 Z$ q9 ?' S( S6 x, p& `- j7 {
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    ; n/ a: Q4 K) k! h' C
22.         if op == 4: # block count
    4 Q9 C5 m( u/ I4 \
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    - P% _0 c. V- t7 {* j
25.             return self.block_size
    5 p& n- K1 q* Z' N# L# w5 {
26.         if op == 6: # block erase
    
27.             return 0

复制代码

) r) ^4 R2 E- |6 k, H5 k( k

由于它支持扩展接口，因此可以用于littlefs:

1. import os
     q) C3 A) _6 Z3 X4 R& i/ S  K( ]
2. 
   0 v: v6 |) d* i$ ^* W  b
3. bdev = RAMBlockDev(512, 50)
   ' J2 m2 \: j2 c/ a/ _
4. os.VfsLfs2.mkfs(bdev)
   9 ^: i6 s, ^" o( `
5. os.mount(bdev, '/ramdisk')

复制代码

% q$ D( M" O- G  u
: X$ M7 _+ g7 @

一旦挂载，文件系统（无论其类型如何）就可以像通常在 Python 代码中使用的那样使用，例如：

1. with open('/ramdisk/hello.txt', 'w') as f:
   ' Q0 i" z" O4 R# B# a/ ^0 R5 f  k/ O8 O
2.     f.write('Hello world')
   # g) v& K# B& T0 v) Q) N
3. print(open('/ramdisk/hello.txt').read())

复制代码

) x! G2 @  r! B8 ^2 a8 E
! o9 k+ d/ K4 q) q4 f: @* ^
/ Z9 a: Y: T- p& D( d# U
# T/ U& s2 _. E% V7 ]
文件系统

MicroPython 端口可以提供 FAT、 和 的实现。 littlefs v1 and littlefs v2.

下表显示了固件中默认包含给定端口/板组合的文件系统，但可以在自定义固件构建中选择启用它们。

FAT

FAT 文件系统的主要优点是它可以通过支持的板（例如 STM32）上的 USB MSC 访问，而主机 PC 上不需要任何额外的驱动程序。

但是，FAT 不能容忍写入期间的电源故障，这可能会导致文件系统损坏。对于不需要 USB MSC 的应用，建议使用 littlefs 代替。

要使用 FAT 格式化整个闪存：

1. # ESP8266 and ESP32
   , ?/ P! R4 q& i3 d* E
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   2 c* K% \9 @5 ?, `
5. os.mount(bdev, '/')
   + N% ?- b- a, R! C: j2 b* e
6. 
   * [5 H3 ^& M9 m  {4 L! G9 |
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    * s8 h3 Q( P$ P$ b4 M5 M2 z6 n
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

5 s" E; b$ ^4 _7 {3 }
( F  I! H% ?  `8 D: M% ^' _
4 v8 `; z+ R4 w4 v5 Y
3 }- M8 e- R$ ?Littlefs

Littlefs是专为基于闪存的设备设计的文件系统，对文件系统损坏具有更强的抵抗力。

笔记

有报告称 littlefs v1 和 v2 在某些情况下会失败，有关详细信息，请参阅littlefs issue 347 和 littlefs issue 295.

注意：它仍然可以使用 littlefs FUSE 驱动程序通过 USB MSC 访问。请注意，您必须使用该-b=4096 选项来覆盖块大小。

使用 littlefs v2 格式化整个闪存：

1. # ESP8266 and ESP32
   3 m3 z& u7 P) q* \7 C7 {
2. import os
   7 `' c; o% H( e* d" B
3. os.umount('/')
     y5 B8 S& [/ v, @% O# H! {
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   5 r9 t# O& O  o0 [
6. 
   . h5 F. @: j/ [
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   & W# y  C; I) a' ]/ |
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    + ^- h: W- Q, o7 y+ t- ^
12. os.chdir('/flash')

复制代码

混合 (STM32)

通过使用 start 和 len kwargs to pyb.Flash，您可以创建跨越闪存设备子集的块设备。

例如，将第一个 256kiB 配置为 FAT（并通过 USB MSC 可用），其余配置为 littlefs：

1. import os, pyb
   * a" M) W4 Z# L
2. os.umount('/flash')
   5 {+ u) D( J+ d2 r1 Q# F
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   : M) u7 X( s7 P; h: L
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

这可能有助于使您的 Python 文件、配置和其他很少修改的内容通过 USB MSC 可用，但允许频繁更改的应用程序数据驻留在 littlefs 上，从而具有更好的电源故障恢复能力等。

偏移处的分区 0 将自动挂载（并自动检测文件系统类型），但您可以添加：

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

+ `1 F. G1 v$ Q% A" G& R7 G
/ ?/ L8 c) r# o; m. j0 i* O5 `

来 boot.py挂载数据分区。

混合动力（ESP32）

在 ESP32 上，如果您构建自定义固件，您可以修改 partitions.csv以定义任意分区布局。

启动时，名为“vfs”的分区将被/默认挂载，但任何额外的分区都可以boot.py 使用：

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

. a9 A% e! s# M" R
9 c2 \% o/ L. D9 T- I
& g) u! N$ n+ a# r2 s$ }- P% [4 {
0 T9 O, W! @  ~. j, N4 d& t+ c+ X) I
0 q) z' ^0 V# ]+ N6 \3 V# H: s7 f
8 \, W' b/ D" ^  M1 P