使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  # T- d  U8 g4 Q

  • 虚拟FS

  • 块设备

    
    - |3 J1 \  X) h0 L, Z% T

    • 内置块设备

      
      0 R1 q5 Y' `( E& b

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    : v& |& E. J) M$ t6 \6 ?0 ^& w

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    ( m3 c( C6 u; F4 r, T
  
  3 E+ E& p  _. A- r) I2 q

; Z: L' D& }9 [+ C3 B2 r* t8 r; [3 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 上，主文件系统挂载在 /。

/ S6 L, ^. ]8 A& D" R( t块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

# s5 Z4 d( C. M* O1 IESP32

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

# K' [+ _6 o8 h# H
自定义块设备

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

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. 
   / ?$ e2 x, u/ y- I( {
6.     def readblocks(self, block_num, buf):
   + N  j, g% @. g0 b3 q1 w
7.         for i in range(len(buf)):
   , V. l; ~2 C0 d3 I7 i- J
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   # ]; f7 ^( C- n
10.     def writeblocks(self, block_num, buf):
    2 m+ {. }  W3 G  Q  D* r
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    
14.     def ioctl(self, op, arg):
    4 J2 [# s( E, u
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    % `: X# j+ ?) L/ B- m8 O) n- O# B
18.             return self.block_size

复制代码

1 x; @, C6 M, d: s  b( D; [
8 x. H4 n+ f5 ~  v& }6 _

它可以按如下方式使用：

1. import os
   4 k! T8 _1 V2 |; g
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

' H- G& U/ d  H

% d3 l* q( P" z2 N. m0 S# @

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   # F  @9 N3 H# k9 U
3.         self.block_size = block_size
   1 g1 G8 g2 v  L7 r
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)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    % @1 e7 M! B% q- C' W5 j- o+ |
11.     def writeblocks(self, block_num, buf, offset=None):
    : R/ O9 r* X. S
12.         if offset is None:
    # F; u0 w' Z5 g6 r9 Z3 l" n5 ^( I
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    : d" x/ z$ a" ^2 E: i; z
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    7 G, K( \7 g* g  l1 g* ~. L
17.         addr = block_num * self.block_size + offset
    1 b- L. T- d: ?9 l) B
18.         for i in range(len(buf)):
    $ C7 |2 r3 u6 Z0 d
19.             self.data[addr + i] = buf[i]
    * ^1 j' [6 m6 N8 c, X* C) P
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    / ~5 \% A# W  V. \" ~
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    $ ?& A1 B! t$ b% W5 w- ?5 z% K
27.             return 0

复制代码

  ?( ?* J9 }! h9 K  C

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

1. import os
   - s( m8 t8 K" s8 D
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

# O2 \% d: E$ f; _1 \# {

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   1 A6 |" Z7 f1 O9 C4 B
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

8 r: z' u+ I9 S5 q1 M
  @! [% g  B  Y+ p1 u7 W
( U' c$ j1 S' I; \+ u8 i
+ v6 \9 Z# l4 d/ }% S4 M文件系统

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

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

/ C1 O# [3 S  e% `FAT

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

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

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

1. # ESP8266 and ESP32
   * C) u2 w2 z7 W2 U% u2 K/ A" k
2. import os
   ( I8 x* q$ J# U# h# c, H
3. os.umount('/')
   : b* t: F3 ]! ~& x0 t1 J  L
4. os.VfsFat.mkfs(bdev)
   4 G5 G% @5 b2 O/ o; V* W
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   / u0 d9 o; ?. e- K0 {8 a* r
8. import os, pyb
   0 t3 c% G6 }) b8 o) d8 Z; `
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

: G" X9 \" [5 w- V3 t& G$ f
2 Z7 w, E8 j0 \+ d/ s- P; }

7 e4 @( d9 p$ z* \3 u, Y1 BLittlefs

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

笔记

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

; _. s1 Y6 ?4 s0 c: ]- V! }) B

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

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

1. # ESP8266 and ESP32
   # N$ \* t" p5 a2 S7 P$ _
2. import os
   
3. os.umount('/')
   0 y  z6 ?, |; F' _
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   4 T' g/ H1 u# I0 f
7. # STM32
   ; m  ?7 @  [5 [' l1 `
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')

复制代码

1 H* q, Q- D' z; }; X
4 H# A5 B5 ?  Y. P7 r5 J

混合 (STM32)

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

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

1. import os, pyb
   * d& C/ j: R9 ]1 K, o- p  R
2. os.umount('/flash')
   3 y: B6 m# @7 u2 O: q( [" [- g+ x
3. p1 = pyb.Flash(start=0, len=256*1024)
   + ]; t- v# y# I5 p' ?# e$ |8 c" z
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   2 s- {, [  K* n5 E8 Y9 q/ J
8. os.mount(p2, '/data')
   & h! L. s6 R, ~2 o/ g0 U  k' a
9. os.chdir('/flash')

复制代码

. o+ L) C  w+ B) J# R' R0 U

7 u  o& M" C* k- w' q

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

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

1. import os, pyb
   1 w' X' ]( J. O* a
2. p2 = pyb.Flash(start=256*1024)
   ! k3 ?7 p% P0 }0 }+ K! h
3. os.mount(p2, '/data')

复制代码

) I: l$ J' \. E$ @

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   * a6 y2 o! n6 M0 H: k7 Q
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   9 k$ T& E2 N* q% H0 l7 O" U$ d  o
3. os.mount(p, '/foo')

复制代码

5 x$ ?) i2 u5 L. x) M( M$ K( }

6 w0 d% G4 ~; T. y+ h
- h. c  q& F1 b7 x$ O7 v( J, U

$ \, M3 }0 d5 \0 e* d. h' N' O3 e