使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  8 I9 H( `1 M1 X) v1 X! {: R- m, u

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      . \4 T7 ]  q- j5 T" Y8 W! O  \

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    2 l- v: u6 _1 n: @% L

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  0 r5 {0 \  v' R& W* u; e6 p" c

$ W0 Y; T9 M5 r

本教程介绍 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 上，主文件系统挂载在 /。

4 j  R4 t, E5 P! n3 Q! ~- x6 i块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

1 K2 g+ f( C% M' d1 B9 B# ]ESP8266

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

% x5 t& v6 f) m  g* v* eESP32

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

3 q; |  D3 d/ l5 \
" ]0 F* ^' @+ m$ q8 _0 q" U自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   + c+ F3 x- C: O' n/ @& v
8.             buf[i] = self.data[block_num * self.block_size + i]
   1 G( T' L- \; r' Q5 j
9. 
   0 H. T' w! n# T0 x" E
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    4 u: z7 ?, G  D% Y! g
13. 
      f/ ~% }" k$ P; [+ i
14.     def ioctl(self, op, arg):
    / r, R2 ^1 G& b% I# U4 r
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    5 n( B. A( ~: G( \
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

7 D$ C7 r0 v) i) t

它可以按如下方式使用：

1. import os
   1 E2 \% y/ H2 ]9 |
2. 
   + [+ c* s" y0 N) j5 P# m' K
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

- [4 A$ F. a: X( n" N8 W

+ ^8 Q9 C5 V) j$ y

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

1. class RAMBlockDev:
   9 D, e2 @- G- q$ [& J2 }
2.     def __init__(self, block_size, num_blocks):
   , a0 G/ \( |) M# l! N9 u
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   / Q! N' i; W4 y1 I$ q( F" ]) H
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   * H! @( C3 H8 l  ~$ F5 r
7.         addr = block_num * self.block_size + offset
   $ U7 f- ]/ ^" K( }3 r
8.         for i in range(len(buf)):
   ( g. X4 G4 q& D, I
9.             buf[i] = self.data[addr + i]
     k" ]$ i  b) X
10. 
    ( B. w: b, o# Z8 V( H4 \4 t6 `, N
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):
    ' i$ q+ f4 F. j1 H- ]/ |% y
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    : A' @4 ]2 J- ~$ Q7 }  ]( ?# Q7 P
19.             self.data[addr + i] = buf[i]
    % @9 h0 C0 C4 S% ?. w9 m! L
20. 
    / ~- P- |8 K* \! Q
21.     def ioctl(self, op, arg):
    4 x! i7 M; |1 R* a9 \
22.         if op == 4: # block count
    + A! n5 m+ |' s8 S+ R. B$ a
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    3 S5 x7 A- _* h' g! M! s
27.             return 0

复制代码

! t4 f. M7 h  s9 T
! v+ M4 y5 ]; P6 d5 E; Q& B

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

7 C$ B3 B8 @+ I5 v: W# O

. C" ]# Q  _* r8 o% G

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

/ T3 B6 ?. k  f! U' C* M



0 J+ _& A) }7 v8 P: @9 r文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
     z6 p- o. M( b" L/ i
2. import os
   
3. os.umount('/')
   % N" f( X0 k3 @
4. os.VfsFat.mkfs(bdev)
   / f- \: Y1 Y6 ^1 g! y6 \3 [
5. os.mount(bdev, '/')
   " g( r: F/ a  C" h4 ~' p' d/ e
6. 
   ; Q. F7 O  u. P8 l
7. # STM32
   
8. import os, pyb
   ( {, a. v9 N0 k/ l: j8 @, j; I8 W( k
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

0 o5 [1 T8 R. O

Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   . N. I3 U: U' b3 D0 v
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   : ~! _0 w% y0 ?0 {3 x, }5 P
6. 
   # C* q6 B1 u/ P& j1 p3 p) s( j
7. # STM32
   3 j# u( @1 f) r2 @7 O! \7 `7 n# h- K: A
8. import os, pyb
   ; g' d+ Y3 F, B$ [+ i& L
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    1 ]$ L! D5 `5 x, M7 ~4 C
12. os.chdir('/flash')

复制代码

5 _3 ?; ~. Z4 {8 w% F

$ [  L5 f! q7 L* ~" x! p9 C2 ^
$ s% o9 E$ W8 U% q! ], {混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   / T+ e! r% C. x; ?
5. os.VfsFat.mkfs(p1)
   & r* Y3 H/ }9 ]9 s, N
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

( U: b; d, ?% o6 ?6 u
/ b: X8 E. y. J! N0 Q

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

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

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

复制代码

( [* P4 r8 @% ^4 H- {( y+ @

来 boot.py挂载数据分区。

) A8 s; i8 f' k& s) L0 l$ k混合动力（ESP32）

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

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

1. import esp32, os
   & ^  X3 A! V: o: M( s
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   : e# `' C3 O) _  f
3. os.mount(p, '/foo')

复制代码

2 G* A) y# s8 B- f' \

1 `# ]1 d; P" o  N

) I: ^! G: G, k2 Z3 `4 I, ?, W