使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    ! ]1 a2 X  m; n+ ~

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      . R" c7 k1 Z  z- w

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
        R  @/ z+ f0 D) Y* v  k
    
    
  
  / t3 L2 h& q: {% ^

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

/ |/ u, c- U! x/ J& T7 p4 A. \1 X# c块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

/ f2 V: H1 e9 @, W) rESP32

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

自定义块设备

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

1. class RAMBlockDev:
   % H  E% M* ]$ B( V0 y
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   4 c: u* e! s) h. ]
5. 
   , l* o  j7 D# l5 K5 Y, n
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 C0 I) F- g0 `7 |( |, w
9. 
   
10.     def writeblocks(self, block_num, buf):
    ; f! T9 N* v3 _4 [: F  N6 T  Y
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    0 x0 c; z& ?! j9 I- k; o! b1 P0 P% V
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    $ l3 \1 Z2 [; S) O' G
18.             return self.block_size

复制代码

+ l# W, R5 X) D2 U6 e% w, J1 E

它可以按如下方式使用：

1. import os
   ! n& @; h0 k- Y- m+ x, r
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

! d, Z0 C( u& @5 b! p0 `

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

1. class RAMBlockDev:
   # v: L) `) D1 y/ V
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   8 q1 @" a$ {' x1 ^' o
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   % E8 B8 i6 T( e+ b. @8 w
9.             buf[i] = self.data[addr + i]
   0 U& f9 P% U- K9 v0 M
10. 
    " Q$ R! q: m6 _' ]
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)
    
16.             offset = 0
    2 h7 l: j6 @  v
17.         addr = block_num * self.block_size + offset
    4 y" }' ?( ^. @4 {% Y7 E' `
18.         for i in range(len(buf)):
      F9 u+ f7 _1 e1 o- C3 ^
19.             self.data[addr + i] = buf[i]
    9 J) l# |3 D# Q* a
20. 
    ; j$ f9 w0 W7 h
21.     def ioctl(self, op, arg):
    . w/ b: S: g& j. V. }% y* W
22.         if op == 4: # block count
    6 w/ K' _- D' ?) y9 o0 i+ P
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    
25.             return self.block_size
    & k- d/ s5 c% {" ]
26.         if op == 6: # block erase
    
27.             return 0

复制代码

$ W* N) _  R& \; Y! U1 F$ o3 F/ r
1 }0 w! \& x9 ~% |9 X9 |. \

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

1. import os
   0 T( q3 ]" f+ A( k5 K1 P
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

! L! X1 }# @  |* t$ E

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   : X3 e- P/ u& G$ c0 ~% g
2.     f.write('Hello world')
   8 h1 \9 V+ ]6 n0 Z  p
3. print(open('/ramdisk/hello.txt').read())

复制代码

$ J/ n2 k: J: h

8 @/ }9 G9 c7 T( v文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   , U' q! |& x" u- ^
2. import os
   9 V& `4 e- k$ _/ Q& i& j% r8 z
3. os.umount('/')
   - y; ^" U! O/ s0 X
4. os.VfsFat.mkfs(bdev)
   ( x& J, U. D4 I% A, i$ N1 C
5. os.mount(bdev, '/')
   " R5 Q5 {% a6 N3 Y8 c. `# L7 I
6. 
   2 q5 f& ^4 f- C& M4 B5 }" F2 @
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   2 L5 d8 [7 _# q3 X4 ^
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

/ H! q" v0 [% u7 u2 K
9 w6 p: w' h. N" V/ |5 ^
0 \0 l! F$ p% T8 a  A% J8 Y# JLittlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   , o: }/ j& n( o9 a9 V' B) G
2. import os
   4 ]4 D! \7 t7 g! \& M+ G* h3 ]9 O
3. os.umount('/')
   1 `/ G; c  p$ X
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   8 j4 L9 Z3 R6 P+ R5 M% C
7. # STM32
   7 h# Q8 h  X9 C
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

9 m4 _, b: O3 h4 a2 K% `# y8 I

1 ?! O$ y" k' Q: r1 g% w混合 (STM32)

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

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

1. import os, pyb
   6 o# V. o- g& x8 ?
2. os.umount('/flash')
   
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)
   9 U3 g9 i/ e2 q. R; t* X" p4 J
7. os.mount(p1, '/flash')
   5 Y4 A, Z+ b# ~5 P; i/ Y
8. os.mount(p2, '/data')
   ) i, S( a! C$ J% {6 r
9. os.chdir('/flash')

复制代码

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

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

1. import os, pyb
   ' Q, @# O) z4 q* _# ~
2. p2 = pyb.Flash(start=256*1024)
   + I# Z3 v& N' I; b! `4 t& S
3. os.mount(p2, '/data')

复制代码

' {, o0 z1 f; b3 E4 o

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   . R( H2 H$ h3 P" B  T' ]+ Z
3. os.mount(p, '/foo')

复制代码

6 s8 ^, @0 R, k& j2 @

) I/ A  [/ ?8 d: X

; T7 P9 {( I) x