使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    ' n7 i! N6 g; B2 @

    • 内置块设备

      
      * h3 a/ E' @+ J7 `- B8 M( g

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      0 L/ \* r9 ^3 w

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  & Q, V$ ~) c  G9 |+ q# e6 [) o' T

) a% \6 I* {, W1 j2 V

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

7 O1 R2 @0 k& M% X块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

' U! Z  l1 }; j7 k5 c; QESP8266

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

5 z5 y$ g- y) U2 NESP32

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

自定义块设备

以下类实现了一个简单的块设备，该设备使用以下命令将其数据存储在 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)
   6 T: j8 ~! b; T( c; r
5. 
   
6.     def readblocks(self, block_num, buf):
   6 M% g- X; T9 f0 y* K+ R( g
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   " J, f9 M4 d9 t1 o: }
9. 
   9 v/ r0 k  U1 y% m
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    , d3 O5 i& f; s( p. i( {; [3 c! ~! V
12.             self.data[block_num * self.block_size + i] = buf[i]
    % J4 T: G* {9 p, C6 [% q
13. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    - N, h7 ~$ z8 F
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

1 E$ E% d( f+ @; h" A
7 V9 N: Q/ v% ]
) g% k' a0 W+ l; F

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   2 X' Q. Z6 ?0 K1 r& i* b" D2 o
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

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

1. class RAMBlockDev:
   + o! b9 ~9 \" p% M/ Y  ?" m( |
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   . h0 f3 h1 h( B, H# o, X
4.         self.data = bytearray(block_size * num_blocks)
   1 Z" d7 ^, P+ F' l- z# G. n7 C
5. 
   5 b) ~% a1 P6 Y: ~; L2 O8 k0 u
6.     def readblocks(self, block_num, buf, offset=0):
   ) T# ?+ j2 M/ V- J! p
7.         addr = block_num * self.block_size + offset
   % @! L" T" e9 l  e9 l  k
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   + ~/ j1 O; r$ S+ i  S/ C$ a$ x
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    7 A& R! ~! M6 \# A0 b2 c2 V5 c$ A$ }
12.         if offset is None:
    / J: e( w8 q) Q! U" e
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
    ' E( g+ s0 t2 o0 Q6 ~, q% s
17.         addr = block_num * self.block_size + offset
      @  B# ^) U1 s
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
      L0 [! t: G4 d4 j5 t+ t
20. 
    $ P, `& y6 m$ z# g
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    6 `6 k" e, B; d
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

0 s  c3 K" b5 u) @5 g2 g
% z0 r4 N8 ~" }

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

1. import os
   
2. 
   / A- l8 X- t% C6 }
3. bdev = RAMBlockDev(512, 50)
   2 _: A3 @2 v1 T2 T) [) o2 O# j
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

( n4 d% A, J5 c; x; J; `) i

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   - {+ `' T" p" v. W
3. print(open('/ramdisk/hello.txt').read())

复制代码

" r! n$ I& b  x
1 N3 D5 R) Y! M& z2 v3 f; x, p文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   3 d" b1 D1 g  V& }( ]" {' c
8. import os, pyb
   " m0 C) x1 z9 `& P) `9 {
9. os.umount('/flash')
   & L# i8 T+ C& ]* [  C# r
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

% m/ Y  _/ L0 c5 p0 e1 e2 W; |
5 v1 u3 E* ?4 f5 Q- ~" A
; I/ ^" p& z- x' w/ ]( C" d& Z
% ~$ D- D9 N3 i' F' `Littlefs

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

笔记

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

4 m, S& b) H* I5 ]* Y3 }

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

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

1. # ESP8266 and ESP32
   8 |8 v; Y1 X; S- j. Q6 _
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
     z5 ^( I% ?1 p2 V' ~3 x7 R0 d# T# I
5. os.mount(bdev, '/')
   
6. 
   9 K# K. Y" D  \) Y& m+ I
7. # STM32
   ' c9 R# u: B3 J* K% b" |: L
8. import os, pyb
   , [9 _! K4 {) {
9. os.umount('/flash')
   * w' Q, K7 \/ A* ?3 Z) D
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

1 ]  y2 D" }+ B! A2 H9 T! U! T  S
; @4 i' m6 c  Y/ a' \9 K
混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   4 h& N: k1 ?! t2 b- I) g
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   . ]2 H1 n/ }% f. L7 x1 Q
6. os.VfsLfs2.mkfs(p2)
   - `6 c0 N* Z( b! O* H8 B  I
7. os.mount(p1, '/flash')
   6 o  n$ n3 w, O8 {
8. os.mount(p2, '/data')
   / _1 ~: ^/ I% P; L
9. os.chdir('/flash')

复制代码

9 G: z3 a/ t% |0 o
5 x. w! J# G# a# h6 P% U

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

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

1. import os, pyb
   " L/ t. C9 p4 F3 |% X2 Q, c0 X
2. p2 = pyb.Flash(start=256*1024)
     p5 C' D9 @2 ?$ W% n6 E' z3 T
3. os.mount(p2, '/data')

复制代码

+ `9 j2 U* n# O5 x! \5 M
7 E5 ]" t5 E$ c# {; o! l: @2 H

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   2 T9 F! m7 k% P/ E2 C7 B% A& n
3. os.mount(p, '/foo')

复制代码

0 k: W5 U6 n: a( H7 u' X+ w

, T, p: b$ p# r+ W