使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  : B/ ]0 G: U2 h: m$ U2 f" S0 N

  • 虚拟FS

  • 块设备

    
    * V0 e3 }, `% I$ t4 X

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        9 |9 f+ N+ P: b

    • 自定义块设备

      
      

  • 文件系统

    
    # i' A3 s6 \4 s$ T; B4 A1 }+ d

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  

6 a2 f5 p' G+ [* P

本教程介绍 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. 这实现了扩展接口。

5 y: |! ^& C+ S& R# p! T8 SESP32

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

' C: M0 j" M( o. D2 G# o自定义块设备

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

1. class RAMBlockDev:
   ! ~0 a  K9 c) }+ P0 d1 N' X
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)):
   8 i. V) {) n0 `5 P# \8 D; r3 Q/ i! j
8.             buf[i] = self.data[block_num * self.block_size + i]
   & W& t4 d- I2 K3 B* R% v7 V$ s$ J
9. 
   
10.     def writeblocks(self, block_num, buf):
    ; u. ^# m7 o9 C" \7 o
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    8 k" `" N0 u6 p3 B4 v- ^
13. 
    - m) E$ q) f; M! o9 ?
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    / x4 g0 x4 F/ {; p5 _! C
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

  S( D$ j# m9 j$ s

4 @$ g% Y+ ~- M4 O. J

它可以按如下方式使用：

1. import os
   
2. 
   ! A& x5 c( C+ N  a5 v1 R
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   8 u6 I4 v- \* ~: c; `; ?
5. os.mount(bdev, '/ramdisk')

复制代码

3 x4 G5 r" i3 W+ w
0 Y& L( a; e: Q/ w

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   . P5 L% M% _( ~; j
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   : o. }2 z9 W  V" M
6.     def readblocks(self, block_num, buf, offset=0):
     Y4 n3 Z# ~. F1 W  b4 }# u
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   3 |2 p! q# z' P, Z0 k
9.             buf[i] = self.data[addr + i]
   
10. 
    + o5 ]% S3 C4 [& w# I
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    2 K9 Z3 O/ P$ z* a! A" A' s
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
    
17.         addr = block_num * self.block_size + offset
    ' g+ O5 ?$ m' I+ Z- h$ h; d% y
18.         for i in range(len(buf)):
    $ p" q, C/ U1 B4 B8 h* E
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    6 P3 _6 R1 A: W) F) R0 ]) W2 k
23.             return len(self.data) // self.block_size
    1 E* j0 q, D* p/ @
24.         if op == 5: # block size
    
25.             return self.block_size
    ' `& ^! ]% w& S5 `) a
26.         if op == 6: # block erase
    6 ^& y5 \7 G6 L( B  C
27.             return 0

复制代码

- S  }) s: J. F

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

1. import os
   . g  ?8 J  O9 |" _- b
2. 
   / _; k: j3 e: r5 c( `; d
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   2 B2 s3 a" |0 c$ R3 }- o. D9 D
5. os.mount(bdev, '/ramdisk')

复制代码

2 w. ^8 l* l. ~1 j, O5 X! m
+ r7 D. O; `2 I! H5 [- v5 ]

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   , u4 o" X/ {7 K+ E7 n% V
2.     f.write('Hello world')
   ) C8 P; k/ M0 w) z) U( W: d( ~
3. print(open('/ramdisk/hello.txt').read())

复制代码

$ X# Q: J, n0 A, P( x) ~
文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   5 \5 |- Z  r8 U1 R5 K1 e5 j- ]
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   1 s  E4 x, A7 e; ~
7. # STM32
   - e$ ^. z+ s6 G
8. import os, pyb
   ( }  [, H( p6 Q: [, c* n& B8 N
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

/ `8 x; f- ?) N$ y& y+ x
( K$ V/ [4 C4 P
Littlefs

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

笔记

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

1 [( F! ~( l% g3 p' E" k

注意：它仍然可以使用 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, '/')
   - v% _4 L8 V! [% C' g( J) c% u  S
6. 
   
7. # STM32
   $ f, J  S% O! x$ S) k
8. import os, pyb
   
9. os.umount('/flash')
   8 q3 d/ M, u( Y/ u& T  B2 G& p
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    0 i' X( _5 V9 l
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

9 X3 H  |# g( P! B# w
混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   5 h  R$ L6 T2 C. _
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   3 M$ W/ W- T' P+ K9 _9 {0 W% v* O
6. os.VfsLfs2.mkfs(p2)
   2 Y& `- [" x: C. M* z
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

' a4 P; i) B% q3 w. z
# }' ^8 {4 a, e/ M

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

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

1. import os, pyb
   9 z- s: @: ~3 H) n# |' }. h
2. p2 = pyb.Flash(start=256*1024)
   7 T, |, w' v( U) ]$ l5 W8 }
3. os.mount(p2, '/data')

复制代码

) b2 S+ Z) F% b- S  Z

来 boot.py挂载数据分区。

* c3 Q% n3 q* H( p+ C9 r/ f% V混合动力（ESP32）

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

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

1. import esp32, os
   3 T" k" H0 @0 E$ J8 _" f( z
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   " H/ j7 F$ i# f+ E7 w
3. os.mount(p, '/foo')

复制代码

+ n  G1 j7 J6 [
1 q+ l# T' G" \# b: h# x

. g2 i) @3 T- ~* D7 F0 h# |6 l# k4 i( U
6 W& n. B! i- i1 X" @# }% G7 [