使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  ( F$ ?; S/ y' f# y( R! C

  • 虚拟FS

  • 块设备

    
    7 F+ c2 O# R0 Z% m9 Y# g4 o- q

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        1 X$ Z  W. b+ P/ W# D! I

    • 自定义块设备

      
      

  • 文件系统

    
    / K% d7 C, ?: S. x) V5 B

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      % E- d0 u% s9 \, `! k$ k
    
    
  
  

$ p2 K1 c1 q9 t( w4 I

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

4 H1 I/ A( |( {  h6 I块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

6 a1 y9 ~) ^4 RESP8266

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

ESP32

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

/ N- }& I, M+ u5 j
2 X. \7 w) P4 F自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   * g: w. m5 v. m
3.         self.block_size = block_size
   7 ?- ^, p. N4 Z) A' k4 n
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf):
   * Y) |6 [% K6 w6 ]( l$ w3 A
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   % w+ ]  f0 F' p9 s
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    6 C1 {9 d% w9 L% a  Q4 C
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    & F  `# u! Q. c$ ^! _
14.     def ioctl(self, op, arg):
    . t) e7 N. x7 x' j( I' Z( q" j
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

- K: f* _/ e  U4 Q: C" u7 {( N( z

它可以按如下方式使用：

1. import os
   
2. 
   $ r' P1 ~% W6 i0 I
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   ; W# q' w" a. j8 k# s% O: y
5. os.mount(bdev, '/ramdisk')

复制代码

4 v+ Z4 q; x8 |+ h: |5 B

+ {$ V4 D4 j$ E! S6 I5 B$ [

支持简单接口和扩展接口（即 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. 
   . D# _" O4 A* d5 P  i
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 F: R$ K  j1 d5 ^8 U( S8 Z( g
9.             buf[i] = self.data[addr + i]
   
10. 
    + U$ @0 ^0 a6 s4 ?
11.     def writeblocks(self, block_num, buf, offset=None):
    & L$ y: q' p5 w% y  |  E% r, X
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
    # c, s0 S* v( q$ y
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    4 a# V) Q! f# r
19.             self.data[addr + i] = buf[i]
    & c  u# N# S- G2 _# z; J" s
20. 
    
21.     def ioctl(self, op, arg):
    & Z. _. c) a, |; V# I! Z: e
22.         if op == 4: # block count
    - H9 a9 t& v. \% S4 I$ z
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    : e) U( d) V$ {; u) T3 {9 M. U
27.             return 0

复制代码

0 ?2 \7 P- D7 z, J
  B% O6 n' C2 H5 o: I

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   7 X* x+ Z' [+ k: [9 \
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

& s, k. v5 z! |/ @0 I! w

, a- c. @0 q2 ?6 ^8 \8 p

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

6 S- j) s3 |# ?7 Y, ]


  l4 Y% d3 i3 u- `
3 k* k9 a* R. d- L/ d: d文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   1 j' A: n( e* g: w2 u
2. import os
   ) t9 e0 y- T: B5 p' d# t
3. os.umount('/')
   % u* n) _/ O) R# }/ w9 ?
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   ' g. [1 a" ^' t+ t) X6 h
6. 
   
7. # STM32
   1 M9 f7 D# g0 o" T- ~* |4 l
8. import os, pyb
   
9. os.umount('/flash')
   / R" b' B7 Q: ?, S+ _* x
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    5 W7 h( }" I2 Q8 b
11. os.mount(pyb.Flash(start=0), '/flash')
    7 i+ w( A) H" p7 {3 t
12. os.chdir('/flash')

复制代码

/ t7 K; `  \( g8 u* N( J) C% v
Littlefs

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

笔记

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

) E0 n/ H- C* D% u8 D

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

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

1. # ESP8266 and ESP32
     _6 k4 d4 m; \3 d+ x5 x' g
2. import os
   % j& `/ |& z3 j: p! r
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   & y( T  g2 z( Q
6. 
   
7. # STM32
   9 v$ Q: B0 }. e. S# ?
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    + Y6 t: `) l- S5 D5 O# J- T6 |  g- ^
11. os.mount(pyb.Flash(start=0), '/flash')
    6 X1 K! C, S, I. ?; v
12. os.chdir('/flash')

复制代码

# p! n5 ^& Z2 t' i; R

, y0 ?. P9 E2 |2 R# L混合 (STM32)

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

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

1. import os, pyb
   $ M4 [: m! |' M) q* `
2. os.umount('/flash')
   1 K8 c$ e" q* }/ ]9 q* h
3. p1 = pyb.Flash(start=0, len=256*1024)
   4 C" u" i; F3 P
4. p2 = pyb.Flash(start=256*1024)
   / E, f. z2 Q/ Y
5. os.VfsFat.mkfs(p1)
   3 Q; K; s! p. y' \
6. os.VfsLfs2.mkfs(p2)
   , ~# \( i( L+ f) S
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

8 V4 \& A8 g9 r, C+ y3 j% B2 x

; ?$ P; @' g$ L8 l

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

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

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

复制代码

; m: K# U: [. W; M/ M! L4 l
. w& F; R8 P  q. @+ L% j
7 Q( a4 o" d* c) [8 r

来 boot.py挂载数据分区。

: u# Q4 m5 {( a% `& ]/ u: S1 R混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   : s  I! Y$ }% A5 W/ c1 f% I
3. os.mount(p, '/foo')

复制代码

& S, g2 X, R1 ~  [5 ?

1 ]9 N0 r3 i+ w: [" l/ C# \
8 C5 H' C5 v" m9 g5 L, ]1 x3 g
0 l/ _0 g2 u* Q+ ?' l9 a7 ?% C3 g
5 k4 ^5 I7 T: @. |9 a% b