使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  5 O# m4 u/ O* h7 F$ d

  • 虚拟FS

  • 块设备

    
      X; f' \0 l, Q" L* K* z$ W. S

    • 内置块设备

      
      * N, {# b' [) K- u  `/ K2 b0 T! {

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        7 q$ ]  G/ T' G  s+ x

    • 自定义块设备

      
      2 p9 x! v4 a6 I% x; M

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      2 l- @8 r5 F! w! V, g8 `
    
    " L2 r( K+ N) W7 F7 |
  
  

4 [8 W# Q* v( i. l5 N. @

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

块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

ESP32

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

4 \& u- }$ T$ `; ]自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   - z' m, j& v/ X6 n9 v
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   $ A" f- x' K: O' f6 l8 @
6.     def readblocks(self, block_num, buf):
   $ b7 ~- }  _+ ^# W, a) f* v
7.         for i in range(len(buf)):
   6 M% P' ^3 G0 J( a* ]9 R
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   
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]
    ; o- ^4 b9 m: X( ~: J1 T' K
13. 
    ( N$ M1 l. d8 a1 k- ~7 l% r
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    + F8 p2 R) W9 E: @/ a
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    % V( u% ]1 b: g- o) j
18.             return self.block_size

复制代码

; Y4 i! ]" _# ^/ E# H; H  i

它可以按如下方式使用：

1. import os
   . t5 {( J9 Z6 A8 q* n3 S- B9 A* r
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   % w" M- n' v4 s, }$ Y, K0 x
5. os.mount(bdev, '/ramdisk')

复制代码

( `+ o3 [+ t* f1 I3 ]( _6 w  Y

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   , W# ]* h1 i1 P0 \7 \& N$ C
3.         self.block_size = block_size
   ( I; W% d) i+ e2 x1 s: W1 C9 p% ?. b
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   , P" I: v6 P6 R. `8 Q9 j4 v
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   # B. I# N1 P% O# u) X, j
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    1 _6 b6 w. Q9 L0 a, M
12.         if offset is None:
    - \$ z1 S# O* Y( H
13.             # do erase, then write
    9 u1 a! u% Y5 Z7 y
14.             for i in range(len(buf) // self.block_size):
    " k+ H" Y8 ^( g& `  p* C3 k/ o
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    9 t6 U# Z: S9 M# M3 a& Z- v  |/ w
17.         addr = block_num * self.block_size + offset
      C  h0 S, z; a0 y
18.         for i in range(len(buf)):
    ) ]" J8 {: N/ j: [# Y. N
19.             self.data[addr + i] = buf[i]
    
20. 
    1 B8 h% A  @2 ?& A6 k1 W! K
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    3 w9 h3 j. m; r) A* ^/ [
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    
25.             return self.block_size
    7 F: s2 y; B1 s3 _2 j
26.         if op == 6: # block erase
    
27.             return 0

复制代码

5 D& Y  I- X0 K0 a& C! X2 ]

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

1. import os
   
2. 
   ( X/ X/ b- ]0 z
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

$ d6 k' v* V' B

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   ( p5 m# X9 i3 q0 j0 Q
3. print(open('/ramdisk/hello.txt').read())

复制代码

( C; b! S; m* E* |1 z

9 [( w# r! C5 @' ]9 f% Q; F) t文件系统

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

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

' P/ O1 t/ \- _6 w( RFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   4 L5 g5 u+ s4 ~; t* H- x
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   1 ~6 c3 c' \1 `" Q* B" O/ v" u( p$ o
5. os.mount(bdev, '/')
   
6. 
   ' ?2 k) O' z3 o7 m, f  x* S
7. # STM32
   
8. import os, pyb
   : ?$ `( I1 m1 H- 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')

复制代码

6 G! c, F! ], G: @, Z/ C: Q
7 h; @# V6 q/ b7 @' i9 i
$ C; P4 J3 S2 Z7 _: N! {( dLittlefs

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
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   . y7 q0 e& N7 f9 M5 v6 M  g
6. 
   
7. # STM32
   % i. b( ~) t" k' C6 P
8. import os, pyb
   - F9 ]# W- l4 L5 w0 j1 G
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

" b, x, f! f* Q" A, W; F" B1 h& ~


0 B2 M& D& K5 f: |2 G# A混合 (STM32)

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

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

1. import os, pyb
   % \! R" B' U6 o0 S5 V; ^4 k
2. os.umount('/flash')
   2 Y- R& D6 r; @5 w5 g0 U9 `
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   1 j6 N7 i# H- @' p. q
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

, r9 d4 A* `9 W" ?+ U4 h: N

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

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

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   * b- w( L. @7 C: S  o
3. os.mount(p2, '/data')

复制代码

( f% N! [6 H. J
( @" s8 h# P8 E, o" B

来 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')

复制代码

9 p4 }+ L* h- X  b( H6 A

5 y1 C  L7 x5 V2 K: y( Z% @7 G
) ?' A) Z7 o  v0 ~( ~) |% s