使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      0 U- ~1 O" p1 z6 z6 u: Q3 Q$ B: H5 [

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        $ N: Q. q  i- M2 \

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      3 P& S, M' f8 @& b5 g9 \
    
    
  
    W+ a4 I0 y0 {, `. n

) O" M6 k% n0 ?* M7 _

本教程介绍 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 _& o9 c/ c! g( l" Z3 f* b; a9 ?块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

' y! E# k, g! E+ k+ U2 i& }1 K! dESP8266

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

ESP32

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

自定义块设备

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

1. class RAMBlockDev:
   * a. b0 y5 p9 l8 L9 `- V/ Z
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   : l. J% ~# N: U# O: J+ }4 l
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   4 n8 R4 ]. \' y+ o: b
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   ! ^9 B0 }  d% C- Q) }) p
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    2 n" B1 W/ Z- u& b3 f  E
13. 
    ; R$ j0 i  d( ]( s% A: f: P1 m
14.     def ioctl(self, op, arg):
    
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

复制代码

& Z! n( i2 u# g4 h: C4 |. I" s
- h6 j" F0 }! j/ W; Y8 n

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   & H/ _* T8 z+ @% A
4. os.VfsFat.mkfs(bdev)
   , C4 k9 G: W! i  \) Z8 V
5. os.mount(bdev, '/ramdisk')

复制代码

; C  W+ k" z6 a0 @- o0 p

3 N$ K& O% X, `3 K6 p

支持简单接口和扩展接口（即 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. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   : D2 g5 H$ v8 c5 n7 t
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    3 P( m; k. J4 p) V$ n- o! |. I$ A
12.         if offset is None:
    
13.             # do erase, then write
    3 |! k: ?4 i( }7 y/ Y; q) o: j
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    ( I8 C3 ~) u! g5 N7 O
17.         addr = block_num * self.block_size + offset
    4 B% a5 F+ [4 i& |
18.         for i in range(len(buf)):
    5 s9 `1 {) V- R. {! e, a+ Z3 |
19.             self.data[addr + i] = buf[i]
    
20. 
    7 m& R0 _- A# x$ W, q2 M
21.     def ioctl(self, op, arg):
    + k! |: R( i0 {& U! D- p) r. ~
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    3 n! h; i- {' Z( O/ w: v$ }
25.             return self.block_size
    4 N% n' ^; B/ v; y% i" H
26.         if op == 6: # block erase
    8 ^- q) U; ~# `
27.             return 0

复制代码

5 Z+ b/ N+ d$ z  i3 H

( E7 N$ b* `6 E  i" ~7 V$ `

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

1. import os
   
2. 
   ; Y5 A5 f5 {. S' ^. Q' ]! U
3. bdev = RAMBlockDev(512, 50)
   + K3 G9 G: j  o2 B( \) P
4. os.VfsLfs2.mkfs(bdev)
   - q  g3 x" G* d/ _7 N: b
5. os.mount(bdev, '/ramdisk')

复制代码

- x& [$ Q' f) ?' O

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   & _* C0 B2 ^/ Q- f/ b3 {4 m2 p
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

0 D, C8 a3 \4 @8 `) b
' T9 `- w9 q( i. K4 d6 |8 {1 Y

文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   " c7 r6 G7 o- b& O0 r5 c0 n
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   2 m; c/ J7 m8 j" u
6. 
   
7. # STM32
   7 D. U2 N& U3 m' ]. L
8. import os, pyb
   * R  H6 e" {' ^) _; O
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    0 a$ m6 n$ Z. M9 {5 I5 ^
11. os.mount(pyb.Flash(start=0), '/flash')
    / s- j9 M; M- _/ _7 u
12. os.chdir('/flash')

复制代码

( u  N6 U+ J- w5 |! T( w$ N2 O

3 y0 E' C+ R7 U
Littlefs

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

笔记

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

; `  L9 C* e5 d  c# l  `4 S- g

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

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

1. # ESP8266 and ESP32
     n. l* Y+ x9 Q8 k! K2 A- A# @  T
2. import os
   
3. os.umount('/')
   $ j7 L  J7 p! q: _# Z2 j* g
4. os.VfsLfs2.mkfs(bdev)
   , V2 q0 I+ D. P! o, W/ U9 Z
5. os.mount(bdev, '/')
   ; t1 V7 K; c3 h1 l; X
6. 
   + [2 }& k; I4 [6 b7 ~& c
7. # STM32
   
8. import os, pyb
   / {- K7 v+ J% H; S
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    / e/ G3 Q8 i  q7 l
12. os.chdir('/flash')

复制代码

+ `' g% B+ I. c& y. K$ \; [3 ^# x- G
$ E( [1 E, L+ q9 \& o
+ ^: L& J3 [) H9 j( Y
混合 (STM32)

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

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

1. import os, pyb
   5 l( |* L4 I, `, L0 [6 W
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   & X+ B9 r  M% Y: v
5. os.VfsFat.mkfs(p1)
   8 K' T6 I+ L% y: X8 }& M
6. os.VfsLfs2.mkfs(p2)
   9 D  D# v5 ^( j$ ^; @
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   + N; r! q1 g5 i3 \! ~4 s. O
9. os.chdir('/flash')

复制代码

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

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

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   - u: F7 O& w" D6 J# M
3. os.mount(p2, '/data')

复制代码

0 P/ O1 v) G( A8 j2 F# A

7 E) V& C6 c5 C" u2 ~

来 boot.py挂载数据分区。

% }* J9 v, Y/ Q9 T! f3 D混合动力（ESP32）

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

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

1. import esp32, os
   & H3 p# n9 A4 u- N1 R
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

  a& z+ `2 f, i$ ^6 x

* [! w- K; `4 D7 ~4 P1 X5 {
( @6 P/ A# m- D( d% \