使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  * w3 n2 {+ |# S& L, P

  • 虚拟FS

  • 块设备

    
    ( B/ q4 P* s, u5 l' t

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        & X  Q" A; Q( \: g3 {/ u5 T# a8 G

    • 自定义块设备

      
      

  • 文件系统

    
    ! X/ X" N3 m+ ]! n) @

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  

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

ESP32

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

3 |" e3 _7 g& c3 K% ^$ i
3 w! u+ L3 Q; r自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   # _' u' ]/ S4 D* }
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   : Y2 _& s1 s3 \; Q4 W8 b
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    7 v6 c2 A7 E+ I% A  {, r% s
12.             self.data[block_num * self.block_size + i] = buf[i]
    $ l* c0 P# |( L+ X2 g
13. 
    
14.     def ioctl(self, op, arg):
    1 @3 A* S" r+ S' ~7 r
15.         if op == 4: # get number of blocks
      l6 v( H' g! D- x3 W7 S
16.             return len(self.data) // self.block_size
    ! B+ u0 K. X7 X; W/ h
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

* e0 H2 I* c. x6 l# \( R: o

# x  C5 }9 K* b

它可以按如下方式使用：

1. import os
   7 u  U. Z! E4 ^$ F. _
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   9 a/ s6 {& b- w: v- K& g* H5 C; q
5. os.mount(bdev, '/ramdisk')

复制代码

4 L3 D. `1 {) m1 g2 p1 A
+ o* i. a& G( y4 ^8 b
+ _1 `, H  d' X+ E& g6 b

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
     @2 Y8 r2 w4 m+ _2 W0 q2 \
3.         self.block_size = block_size
   ' b- e& Z4 ]2 T
4.         self.data = bytearray(block_size * num_blocks)
   $ s, F% \/ A, B1 ], ]0 P
5. 
   ; V$ K4 `( t" O$ z
6.     def readblocks(self, block_num, buf, offset=0):
   1 S8 `* x$ ~* S$ I- |$ X7 P0 o5 y
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    # ]% z. D+ X# T
11.     def writeblocks(self, block_num, buf, offset=None):
    
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)
    % v3 }9 O8 C, F/ _$ W$ ^
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    , l0 M4 P7 c/ N4 A5 ?3 y
19.             self.data[addr + i] = buf[i]
    # W0 B$ E# H4 Y+ X2 u4 v9 W6 _7 {; ^
20. 
    
21.     def ioctl(self, op, arg):
    7 T/ i( u" ?9 \% F% m( w: I. w
22.         if op == 4: # block count
    6 v5 D+ g1 L5 t9 W
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    2 |9 ?/ [  Y% L2 R
25.             return self.block_size
    9 ?( [! l1 O1 J2 |! P
26.         if op == 6: # block erase
    
27.             return 0

复制代码

$ v) ?7 q$ M# z* H% o7 g0 u# O

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

1. import os
   : j+ A! \7 s9 l/ }  g
2. 
   6 y, K5 ?2 W: j' b; p
3. bdev = RAMBlockDev(512, 50)
   7 B  A) W# h* L% `& y
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

6 x& u) M( B  ]" M
. Y& Y3 J8 i# R8 q0 j1 K

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

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

复制代码

6 r5 {' l9 I8 X/ @% g3 M

文件系统

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

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

$ P& Q1 V: u) B8 j7 C- TFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   # T- g& e. K& A: C" E
3. os.umount('/')
   9 \% T  H& e# v, W2 X- i( w4 B# V
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   ) I# i5 v% d3 t0 Y4 o- v" Y
6. 
   
7. # STM32
   ! z  {* j7 {- E" t% y
8. import os, pyb
   , u( O+ m( L$ B) I' b4 S
9. os.umount('/flash')
   ; l+ s/ @  m" U. C4 r% U# [" P7 a
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    , X, R. M5 `7 d7 C! X
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

9 d. p9 ?1 ^: R
, }" E* z" h( |/ l7 O: m, rLittlefs

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

笔记

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

, V* D- ?. _0 j: X  T2 }

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

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

1. # ESP8266 and ESP32
   
2. import os
   3 s. z+ }" R/ [
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
     v+ ^7 h! L/ e8 t
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   . y5 e4 L+ k  \* Y% W* f
8. import os, pyb
   # |5 L! R8 U6 K) G
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    + u! A" h% w8 z, o
12. os.chdir('/flash')

复制代码

; f% W9 Z9 F" a& z- E, @
) t* Q1 e" D' A: S: l8 M
* E  i9 r* O) J' d& n$ a
混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   
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)
   6 n' w0 l" d/ a- r) k$ |
7. os.mount(p1, '/flash')
   + o7 u7 B5 A# i
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

% F  I% P2 i* Z( W! f

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

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

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

复制代码

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   - [9 m4 }# r' j# R
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   ) x' v% u9 r; s# {1 j0 K) l1 |
3. os.mount(p, '/foo')

复制代码

$ X0 [  g% `" @( Y  h
% D" k% a; U5 \3 c. Z- c
% Q# J  T% G! j0 T$ a# s5 u/ ~
0 K1 b9 R3 L) P3 Z; a3 u
( M& o" m; R& H) P; P
- C9 S% B! t- i" ^$ D& f+ [9 {