使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
        X: u5 Z1 f" K& F% _/ P8 L

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        ' Y: L. C) a* W. A

    • 自定义块设备

      
      ( v2 a' r# h# O( O7 h/ Z+ u

  • 文件系统

    
    ; \5 D" F, g: l; S9 M* e

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  

" {- V# j3 ~  v0 I0 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 的虚拟设备（即它在开始时包含一个虚拟分区表）。

2 L& s$ V6 M  J) [9 x5 o* bESP8266

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

7 D# c! S  }3 R) O9 y' oESP32

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

自定义块设备

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

1. class RAMBlockDev:
   ) V( U5 g3 a; _* M; ^9 o+ t
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   * w- E. q/ w2 b9 ~, E/ M3 f
4.         self.data = bytearray(block_size * num_blocks)
   * \# q- w9 Q. e  A  c2 r# H
5. 
   
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]
   6 P5 q6 A5 {+ g0 r3 Q( E! A
9. 
   
10.     def writeblocks(self, block_num, buf):
    1 [6 \8 K+ m0 ?3 ]$ I( ~
11.         for i in range(len(buf)):
    # {+ F$ a, |  j7 t2 C2 R/ S
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    
14.     def ioctl(self, op, arg):
    , B) a( h  u9 |
15.         if op == 4: # get number of blocks
    8 O/ U( `! `# p" b. j) B
16.             return len(self.data) // self.block_size
    6 g# k/ n. S! j- g9 E
17.         if op == 5: # get block size
    + B2 e$ e% Y; }1 j5 H
18.             return self.block_size

复制代码

9 h( C- }& z! c3 Y% h# ?5 V0 B

它可以按如下方式使用：

1. import os
   # [* P9 T% q) a7 G
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   $ ?1 H( L2 [3 [+ V1 F3 G& X
5. os.mount(bdev, '/ramdisk')

复制代码

- e# [+ t) g) U5 l/ ~

+ k, I% V. {9 T* T; ^4 b

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

1. class RAMBlockDev:
   % y: e. L& Q% G: j5 J2 d- `2 v* }9 {' j
2.     def __init__(self, block_size, num_blocks):
   # g) j8 ^1 M  m" W, [' U) g" J, t
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   ! T+ g; K4 L( j! f" Y* p0 S
6.     def readblocks(self, block_num, buf, offset=0):
   % S1 O* i. |1 _1 z: D+ r
7.         addr = block_num * self.block_size + offset
   $ ~+ H7 Y2 |& G& `- T4 ^2 M
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
     \% I3 @, @0 r- D. G+ O' p
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    1 c! }, ], X8 h! c& i1 ?2 Q5 J
12.         if offset is None:
      q( I6 m+ W' ]; H
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    - O8 G! y) B2 A/ U. F) ?2 |
15.                 self.ioctl(6, block_num + i)
    ' ]& p* b' ?: p; B
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    & G$ `3 K7 _( m; {( ]
18.         for i in range(len(buf)):
    - ?3 h1 U; i% ^: X
19.             self.data[addr + i] = buf[i]
    - x3 ]" ?  i9 E- `$ _: U9 C
20. 
    & p. i: Z& n% V6 r8 ]% J
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    * n; E$ M$ g; h9 R/ k
25.             return self.block_size
    7 T2 M& [' N+ J! ^2 T$ q, A
26.         if op == 6: # block erase
    
27.             return 0

复制代码

8 ]( v) b6 @9 Z
- l4 Q& X$ A9 i, x4 z

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

1. import os
   & L' {% Q' d4 N# S: M: X2 J
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   ( G7 R& K3 q, ?2 Y" g$ b8 H
5. os.mount(bdev, '/ramdisk')

复制代码

* O+ g/ r7 N+ _" S, R
# y3 g! ?- v) }  W

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   4 H" |0 I( ^' w
2.     f.write('Hello world')
   ' b9 f8 y, o* w8 m& J/ n
3. print(open('/ramdisk/hello.txt').read())

复制代码

# \9 p2 C% d: `


; D3 v9 D" b" d! i2 }: ?
文件系统

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

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

& X0 l1 K" f, n0 d  MFAT

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

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

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

1. # ESP8266 and ESP32
   9 e$ O2 k2 G+ A. {6 l/ C( |
2. import os
   - H) e0 h- _6 {3 N; D
3. os.umount('/')
   3 ]! B9 [8 x- d* y
4. os.VfsFat.mkfs(bdev)
   ! P  z( \. s$ \+ ^% T! t5 i
5. os.mount(bdev, '/')
   0 t, t. N8 d( y: U
6. 
   ) E: O7 J1 f& K* f6 a2 Z6 i
7. # STM32
   1 c0 O- r& A5 m
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

7 K4 X! V' M% |* C2 I0 t
) C+ L4 u7 Y% J: t
8 `5 h! u. @: q( I3 Z) u$ n
  r' A5 y  D+ T' g! u( X8 K: lLittlefs

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

笔记

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

3 ]9 Q! F/ ]( B6 e9 |

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

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

1. # ESP8266 and ESP32
   2 R1 ]' L1 u& L: ], N* ^1 M
2. import os
   
3. os.umount('/')
   " O& n% [& _% O
4. os.VfsLfs2.mkfs(bdev)
   % S+ p, R5 D2 T; T% T% _! T
5. os.mount(bdev, '/')
   : y4 g9 X: ^5 i! s8 e
6. 
   6 g* L3 j6 u2 h: E* P: z8 y
7. # STM32
   ' a# S, a0 y- a: g0 d
8. import os, pyb
   . m, K5 Y; Q9 r- N
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    . B" J$ T4 X. w
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

- }6 O4 p  D6 d( B. F/ h$ f% i' V9 c


混合 (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)
   0 T6 ~. s9 n$ M% ]9 }- f$ @( @
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   - p" U! n; g8 f2 c0 O+ T1 E
8. os.mount(p2, '/data')
   / q# T$ L' e7 l3 O8 f; N0 g
9. os.chdir('/flash')

复制代码

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

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

1. import os, pyb
   ; Q& p9 b6 b0 w; R" ~" ~7 x4 F
2. p2 = pyb.Flash(start=256*1024)
   1 e7 n! k! s# c$ b- q5 m
3. os.mount(p2, '/data')

复制代码

8 M, M6 ?$ E% c0 ?6 I( \5 \4 U  b; ^  B

5 @2 \" f1 Z1 N- j( o2 z& Z4 p8 u

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

复制代码

* D6 A, X# X- ]( n- J8 e% N
# B0 h) v6 R4 s6 T. {" I* L
2 h& k) I6 F$ `( V  M
4 ^& I% c0 D( y7 l