使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  3 m2 e' ]/ W$ P4 A: i: E- s" t

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      6 C7 z  l, f" k$ a% L; ]

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        % X! w# e9 K% _0 `" g" G

    • 自定义块设备

      
      

  • 文件系统

    
    ; M+ N/ o6 q) G

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      * |( n! i  j6 }- c8 Q: ?# H- `3 _
    
    " R$ A* K2 W% l+ c( j
  
  - q& [( e8 e% \4 z! Z+ t

" a& Z7 Y( C0 Q2 k6 J+ Z+ p. F

本教程介绍 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指向默认分区。这实现了扩展接口。

/ `9 N. R7 w& Q$ M# G( W自定义块设备

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

1. class RAMBlockDev:
   ( f6 G; ?( s0 {: x
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   7 ]* d! ?- X1 C. l9 O7 u
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]
   
9. 
   3 @+ i8 P; a- J3 s
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    " Q1 G& p. N. q9 c
12.             self.data[block_num * self.block_size + i] = buf[i]
    ! t" G0 j! j6 P) Q# ]+ s2 w
13. 
    ( n" D; _- A1 O3 `
14.     def ioctl(self, op, arg):
    * l: l& T, d% w$ H
15.         if op == 4: # get number of blocks
    7 X6 f) P4 p1 U
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    8 v) c, X0 P. c2 u* \7 U: ?# ^, J
18.             return self.block_size

复制代码

5 ]/ a2 O/ w4 U2 d( Z  x6 _

它可以按如下方式使用：

1. import os
   0 B2 ^. @8 m4 I
2. 
   
3. bdev = RAMBlockDev(512, 50)
   9 W7 W7 v5 w$ O4 f7 X6 c
4. os.VfsFat.mkfs(bdev)
   2 s+ k6 V! |+ O* q8 u: [& k1 [
5. os.mount(bdev, '/ramdisk')

复制代码

9 e9 M& A' J$ f5 v2 |" v0 A

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

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. 
   ; n1 K1 j  c9 z, O
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   8 X0 a7 s: y% E+ N5 P* ~0 m
8.         for i in range(len(buf)):
   ) d3 F2 n: R8 I$ W* r
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    ; R# N# z; g6 Z3 @( p, d
12.         if offset is None:
    
13.             # do erase, then write
    + ]2 R5 O7 s$ B6 _
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
      B  U& n7 o  g- E
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    8 R& u: z6 E: n: ]+ \. @& {
20. 
    * i& g4 V" J$ q* U
21.     def ioctl(self, op, arg):
    . m" X5 |1 m0 c
22.         if op == 4: # block count
    ' o# n) Q) t9 m0 q1 A% ~5 z
23.             return len(self.data) // self.block_size
      Z6 m6 q1 U  s1 _4 o/ O7 a
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    ! d* V3 |. n; S5 @" U( q* [
27.             return 0

复制代码

; B& o' ]* r# h. \- `$ n+ j  _
2 u* R& m' D/ `$ H2 r4 |3 D

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

1. import os
   
2. 
   . c& ]% F) U$ e3 K% r1 i2 M
3. bdev = RAMBlockDev(512, 50)
     V% Y; W3 U8 `6 C% D) j# r
4. os.VfsLfs2.mkfs(bdev)
   9 h  M2 |, B0 H0 w& u9 k
5. os.mount(bdev, '/ramdisk')

复制代码

! \- r& b% B  B% j. W
0 P% F  O5 I/ z
( ~3 M( H4 I. _8 J1 E

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   ; X3 K, ^$ ~' N+ O0 x4 _7 L" L
3. print(open('/ramdisk/hello.txt').read())

复制代码

. Z7 g" D) E% T2 {: b/ W4 m


% V6 c/ G0 ^+ n% a5 W+ ~& U% H
文件系统

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

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

; d( x7 T" u! LFAT

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

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

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

1. # ESP8266 and ESP32
   4 s5 {$ j# R  @1 l: I' O' g
2. import os
   # a+ x1 D  u! X9 ~$ r; Z; J& t
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   . J. q: J5 p  [  ?; m1 |
7. # STM32
   ( i! O' N0 j( @  K' u  M6 M, l' a
8. import os, pyb
   
9. os.umount('/flash')
   / O; u1 e2 R! W) ^! o- q; J
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    ) D. o6 N! ~/ C( u5 A! w: |' V9 i
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

$ E  t7 c6 a( g( x5 U$ p6 v( n
3 J7 q8 \% k, m1 [

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
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   8 X1 O$ [# ?3 R7 B& d! ]
5. os.mount(bdev, '/')
   
6. 
   $ M/ [' J( E1 J( v$ R2 E2 }
7. # STM32
   * _" n/ k' L; O' U) V5 W
8. import os, pyb
   ' T+ }  x; N, M! c* t/ k
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

4 s+ J: m: I" R) d
混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   1 Q/ ]9 j2 I( u) [4 h
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   - D: w/ F" b; v* ]+ g0 f( q
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

& V4 L  T5 Y$ ]" g

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

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

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

复制代码

来 boot.py挂载数据分区。

4 o6 A& K  P4 w# r# p/ t1 [+ E. Q混合动力（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')

复制代码

# U/ r& a) R5 T( Q6 Q4 E
  b; G9 G& D: C5 m" P7 i