使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  & U# o' [) W  d/ {9 n0 i9 D

  • 虚拟FS

  • 块设备

    
    ( K$ r/ u! u  P, D' @1 g

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        6 g1 A9 R4 d! Z: C* K; ]& Y

    • 自定义块设备

      
        m  H. r0 r3 @9 B& w

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      9 k+ h& o- {; W, B: s6 K  C- x
    
    1 p) E) O. h+ y$ S' l$ T
  
  

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

" U( v2 P0 v* I) eESP32

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

0 q, k( G# K  O  h
自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   - U  x) k. v2 A/ b" O+ ~# N
3.         self.block_size = block_size
   # q: x% n* c6 g2 Z7 R4 L' w/ e( \  [
4.         self.data = bytearray(block_size * num_blocks)
   4 F' Q' i/ b6 l( O( A
5. 
   4 S9 Y; n1 |! ?% K) ~
6.     def readblocks(self, block_num, buf):
   3 j$ _& ~( n: Q0 n& {
7.         for i in range(len(buf)):
     o# n, [9 e, E6 u: `
8.             buf[i] = self.data[block_num * self.block_size + i]
   6 g1 z9 V1 g# N0 K9 j# c" V
9. 
   
10.     def writeblocks(self, block_num, buf):
    3 v) O$ y) c/ p
11.         for i in range(len(buf)):
    ; d/ A" I* C3 N( M1 F& p" b
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    % E1 q* I- d2 W: u# |& @
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    : H, w! x! \# Z! I
16.             return len(self.data) // self.block_size
    # C3 H; H$ B5 l" x- E3 Y7 E
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

它可以按如下方式使用：

1. import os
   
2. 
   9 X# k1 ^6 w* y1 g+ N7 [
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   8 M* V1 H, l) u: A- k
5. os.mount(bdev, '/ramdisk')

复制代码

' A7 |/ X! S2 N5 U" X$ Z( `

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

1. class RAMBlockDev:
   . d  p' Y9 J, }9 K$ z! W( w5 x1 {
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   + c( ^( o) S& r$ N( {( C
6.     def readblocks(self, block_num, buf, offset=0):
   - j% e0 B- G* L5 `' `" z
7.         addr = block_num * self.block_size + offset
   ; b: |+ d* K+ u
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   3 k. _% _: S7 l% ]" ?
10. 
    5 `. k; [. A* x7 t9 \2 B  |3 n
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    
13.             # do erase, then write
    / u9 F+ I% r) T# m. A
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    / q3 }# ]- E% c' ?
17.         addr = block_num * self.block_size + offset
    / S2 F0 r- e9 m* L; G
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    $ J: g0 H" b# ~2 }# F! a) D6 w
20. 
    6 ]- @, T5 @, [8 @
21.     def ioctl(self, op, arg):
    3 q) S. F* d, T+ q- _! z) P
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    
25.             return self.block_size
    ; N/ [6 H) f2 j, }8 R; K* |% S
26.         if op == 6: # block erase
    
27.             return 0

复制代码

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

1. import os
   ' J7 K0 J$ S+ k8 a7 b
2. 
   % p6 X. C+ A* o1 H5 e5 c
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

: z. U1 B! P4 ?  n
. {, j* @$ P  [3 Y
" c% W! M1 T, _) e

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   & P0 U5 {* }+ t4 l+ x
2.     f.write('Hello world')
   4 |2 ?- D, [1 o, h& L; J9 y
3. print(open('/ramdisk/hello.txt').read())

复制代码

: b2 z& x( `) X! v

4 T' V& V4 ]0 T- {. z0 t! v文件系统

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

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

8 S$ M1 I$ j: d7 `. z" sFAT

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

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

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

1. # ESP8266 and ESP32
   : F4 [' [# ~; ]3 P
2. import os
   
3. os.umount('/')
   8 i  j0 c; J$ @0 M# L
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   & N/ e7 A, w$ h- W8 D3 \7 |1 |; a7 q
6. 
   
7. # STM32
   
8. import os, pyb
   7 M* W1 I9 M$ b
9. os.umount('/flash')
   6 S$ v* G3 m, N; z; V4 G! J
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    7 J: [0 i7 @" @$ M9 e5 K
12. os.chdir('/flash')

复制代码

" n& \  G0 [- f; B5 |

6 P  X: S$ ^; n7 l/ i7 x
4 ^( V4 X* }+ s$ f7 ELittlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   5 r9 W, S9 W: F6 A& G+ ?
2. import os
   ; Z: `" y+ v  v* s
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   - ], [  J2 ]/ v; h; s1 G, w
5. os.mount(bdev, '/')
     t; Q7 L4 u  H" E. t7 T$ U+ A" Q
6. 
   7 F* e( B; e2 z
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    * M( e5 d7 L3 K8 g, x) v
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   5 O% a9 s( b1 N6 ?- j1 t$ P$ p7 Y
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)
   2 e8 B# B+ [* L7 U3 G  Z, T  r3 f
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   , M" {; H6 K/ J1 x! W
9. os.chdir('/flash')

复制代码

0 X3 R( a9 c% u! I# q

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

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

1. import os, pyb
   8 ~2 O$ W) }: F) v
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

/ j  A, F  P- C- u( ?4 o  J
* \' G1 _2 D" {! B/ `" c3 g) l

来 boot.py挂载数据分区。

! p$ J) n3 f1 c+ h1 ^混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   5 ~: k  h: I' [( ]
3. os.mount(p, '/foo')

复制代码

1 Z' ?9 l0 G2 J- C0 V
* g. H# ?7 s/ @+ f$ m6 I

% u9 q/ Y4 G* q