使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  3 s' ^7 P# w& U; y4 I6 F

  • 虚拟FS

  • 块设备

    
    $ m9 |' \( W* A- D

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      7 p3 m" b4 ~) v, h6 \3 `' q1 M* Y5 M
    
    + v3 t5 x5 q' K7 a
  
  6 i2 h" F+ O, f0 L- [* F

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

, e7 @, }3 |( \' U: V块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

* t0 ?* e+ d( C& r7 H/ XESP8266

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

ESP32

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

7 d4 |  O3 R8 L! P
自定义块设备

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

1. class RAMBlockDev:
   4 R. t; O5 {# I: z
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   7 V* |5 v3 I5 i0 ?2 }
5. 
   ; ]; Y3 Z( q3 R7 \- x6 b% f% ^
6.     def readblocks(self, block_num, buf):
   * r# F" e: _3 y
7.         for i in range(len(buf)):
   $ Z# N# r! `8 ^( a0 p% |3 E# g
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   , \4 R/ Z: Y  U
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    : ~# T6 n, M* C2 v1 ]- |: s. ^
12.             self.data[block_num * self.block_size + i] = buf[i]
    1 y# w2 Z4 D, P+ u
13. 
    # ?1 I0 I( Z$ d' C$ h7 H
14.     def ioctl(self, op, arg):
    ! g3 w5 B2 @. Y! I& {
15.         if op == 4: # get number of blocks
    . f& `3 Q2 d- p  f5 A& M2 L+ g4 S
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

* J$ E2 @- ^5 D
  K' O) E  I0 `* O) M; w
* |6 B2 v! l' t3 X

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

支持简单接口和扩展接口（即 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)
   + U/ H' o5 Z8 m  \
5. 
   ! K: a! q- g; Q; y1 e8 x0 U* W
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   . G8 q1 ?% f# ?
8.         for i in range(len(buf)):
   8 G- @% L+ f6 \" e6 ?
9.             buf[i] = self.data[addr + i]
   ' z( h9 }( f$ g3 l# t
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    6 i4 B/ r/ d$ L" T/ S* x
12.         if offset is None:
    ' Z8 x# n) n9 |
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    . w: P5 v' y+ f" C3 `/ @
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    8 N( t% }9 x1 [( {
17.         addr = block_num * self.block_size + offset
    ) |! x' z! e) J; Y$ Y
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    
20. 
    & n5 d# c: l; W: w
21.     def ioctl(self, op, arg):
    8 g& Z/ z% d5 w! d
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    : Z( {7 d' K% h( `0 v! J) V$ y- r
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

, ~: `( @' T1 y: r5 x

7 s" v$ O  q1 f( C( l

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

1. import os
     A% ^7 ]) s3 @! r& b- C1 b- L
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   7 x8 a- A! E) j( @3 c
5. os.mount(bdev, '/ramdisk')

复制代码

) _2 ]% n+ [3 e  C0 U

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   1 n1 z2 H4 L/ @- V( z' V
2.     f.write('Hello world')
   - O. `- Z" v9 O2 B  S8 H
3. print(open('/ramdisk/hello.txt').read())

复制代码

! I& W) u8 ]3 ]/ E5 t) M4 E

8 d1 E/ G+ |& `% f/ _
6 j7 }5 @: ]6 K
文件系统

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

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

: y; T& k- u1 |  Q  K! @+ c% EFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   % I: A( @5 N! z" R
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   4 b! G* J- P% u! D' z% Q8 |
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    ' O8 Z6 c! `- L2 p4 ?, w' K8 v9 ?
11. os.mount(pyb.Flash(start=0), '/flash')
    ; Z8 v4 x, t# J  Y/ O8 Q. F( X7 g
12. os.chdir('/flash')

复制代码

& R6 w1 O: c+ d% O; W
- Y4 Y0 a2 S3 X

6 n& `1 o+ N* A6 v6 w, ]8 RLittlefs

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

笔记

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

, B8 ^' h* S- u, Z3 A$ B

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

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

1. # ESP8266 and ESP32
   
2. import os
   " Q- P2 F  \7 X. I" _
3. os.umount('/')
   / L. P" b- z1 l7 m! Q9 l
4. os.VfsLfs2.mkfs(bdev)
   9 W, b! M; R% Y- i
5. os.mount(bdev, '/')
   , n" F% t: M0 F7 f# u* M1 O" s1 Q
6. 
   
7. # STM32
   1 `( e+ M# k* ^8 B, M# R2 C
8. import os, pyb
   
9. os.umount('/flash')
   ' N0 C6 F7 a$ L: u- [6 {
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    / c2 h, W" [' M" |/ Y* K; t
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

5 H7 P* U1 M& H7 X! [
' ~% R! Y3 O* h/ D* c* j/ B0 O5 c3 q
4 K  z# h5 \; t! }# @% h  ~  V/ N
( Q+ p, J& q/ H. i1 Y混合 (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)
   & z5 d, Q* Q% h, z2 y
4. p2 = pyb.Flash(start=256*1024)
   + \& [8 d, }6 x+ h. C1 J
5. os.VfsFat.mkfs(p1)
   : j* [; |: Y( b; D. h
6. os.VfsLfs2.mkfs(p2)
   * K  x9 p6 t$ B4 e
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   7 Z3 h0 ~- V2 a9 Y+ `% Q. W. y
9. os.chdir('/flash')

复制代码

. ~8 B( z) {; G  O

, s6 ]/ ^$ {- c' l

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

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

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   * O$ x3 u. Q( ^2 H4 \) m4 U- K
3. os.mount(p2, '/data')

复制代码

+ D  p2 T8 f% ?

来 boot.py挂载数据分区。

5 M( X" S2 b! y* Y6 P. u  M混合动力（ESP32）

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

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

1. import esp32, os
   ! W1 l; A9 G6 y7 L
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   ; W0 [$ I1 l+ P+ W: L% |: G2 j$ I
3. os.mount(p, '/foo')

复制代码

$ M' P  ~! l0 ~3 X  U5 U  S



, X1 Z3 f" }+ ?0 a" W/ N6 ]