使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  1 `' L0 G9 L/ p8 b* z% z

  • 虚拟FS

  • 块设备

    
    5 {! f$ h' Z" u" @  Y5 o0 X2 m

    • 内置块设备

      
      7 e! o+ W/ T* X: H# k1 C$ g- M

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        ) b# }2 t1 _' r% r; I) X

    • 自定义块设备

      
      - z* ~7 o/ Z( O! ?& j$ u

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    8 o/ @" X! ^2 W7 ~; c8 Q3 p! X% Y
  
  

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

+ Q, B8 e3 M* ^% g3 r块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

& D" M! X  y3 d% S% ^- lESP8266

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

& k" s: k  F$ \( ~8 k; c" oESP32

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

" G! j- ~1 C+ z8 X* v' b自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   ! x/ |; z; \; W. z2 I
4.         self.data = bytearray(block_size * num_blocks)
   . n) B2 ~& e  P3 S8 [9 \
5. 
   
6.     def readblocks(self, block_num, buf):
   & P3 _. A: c0 F/ p0 K& W
7.         for i in range(len(buf)):
   , e# C/ G% B) }* w) D; `
8.             buf[i] = self.data[block_num * self.block_size + i]
   3 w6 t4 r5 Z! U, u9 m) L) t( M
9. 
   
10.     def writeblocks(self, block_num, buf):
    : @8 V3 s$ N; I3 a; Q3 {1 U
11.         for i in range(len(buf)):
    ; n  M0 Q: R  F4 a5 {
12.             self.data[block_num * self.block_size + i] = buf[i]
    1 M+ W# q) m# Y6 _: t% A; b. C# O- o
13. 
    
14.     def ioctl(self, op, arg):
    ' l, K4 D8 {; i( d
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

复制代码

它可以按如下方式使用：

1. import os
   ! j8 }. u: Y. x; Z4 a/ P3 C8 `
2. 
   9 O4 J) W: E1 I$ [8 g/ z- E
3. bdev = RAMBlockDev(512, 50)
   7 i0 B4 J; a# x( x; O8 G/ c
4. os.VfsFat.mkfs(bdev)
   ' m/ t. i7 ~/ P6 v
5. os.mount(bdev, '/ramdisk')

复制代码

% L8 f, ~5 l6 ^+ X% ^/ `& a
( f4 D7 |* ~2 l, |4 M. _
* g0 n3 \; I7 t

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   8 f3 d7 S) e2 r( J
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
     ^5 v0 }( H/ `0 H. c2 s, I7 J
6.     def readblocks(self, block_num, buf, offset=0):
   + @8 M! d# d+ d2 H8 P
7.         addr = block_num * self.block_size + offset
   ' Y6 ]% P" S- w
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   / c. m/ K& ^# y0 O6 b$ m
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    6 B4 U. B6 r. y8 L/ U: T4 w! ]
12.         if offset is None:
    
13.             # do erase, then write
    * F( M! n2 S/ ^% S$ `, h* Z3 R
14.             for i in range(len(buf) // self.block_size):
    ) p3 N" L# t( `
15.                 self.ioctl(6, block_num + i)
    $ D2 _- V: D  {2 P" o
16.             offset = 0
      f6 [* a2 b- N) t
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    7 A4 x7 L+ f* ]# x( ?
19.             self.data[addr + i] = buf[i]
    
20. 
      z0 L- f9 _- H
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    & x# d! J" x8 p# a
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    . Y" {' R. x8 {1 j0 [7 g3 D
27.             return 0

复制代码

& w' \7 i$ D/ J! o- k- _

1 z9 S7 T8 S. g; M' ^- L4 U6 A, i- B

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   5 j* `$ m5 z: b$ ~* A3 o0 F& e
5. os.mount(bdev, '/ramdisk')

复制代码

9 ]5 k0 Z# B. [1 _& V5 U

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   0 m  O$ y3 w' b6 Q, O5 O2 }
2.     f.write('Hello world')
   ( N* k/ w8 `3 K
3. print(open('/ramdisk/hello.txt').read())

复制代码

) W% h  x% k+ l/ Z% k1 s
7 s: V" F+ ^% J; q( l6 Z% ]5 X2 X" y4 P

8 \* y# t6 x3 w6 W6 c6 _0 Q  w文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   ) L% p3 E3 ], l5 B
2. import os
   
3. os.umount('/')
     H6 C8 v. m; e5 m" a) q
4. os.VfsFat.mkfs(bdev)
   ( r+ l0 I2 R$ n6 }9 a6 P; }- M/ A
5. os.mount(bdev, '/')
   * m& U0 L0 u$ Y) C5 r3 P: e
6. 
   
7. # STM32
   6 R( R2 _+ i, P. A) v
8. import os, pyb
   : q: q" S" u" q: C
9. os.umount('/flash')
   : j8 V" j4 s) `) H' D
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    : K9 n% c6 V1 h
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

8 ]/ I2 ]; {/ b5 V4 C/ k


) I* [0 M  |/ K7 ?! j, L( w- FLittlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   / n) J; a9 y6 g1 q: K6 @
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   2 e" W; T4 ?4 I% v. H- l
5. os.mount(bdev, '/')
   
6. 
   8 h- g$ K7 ]; {4 f2 i
7. # STM32
   
8. import os, pyb
   ; o! C+ |' E/ u3 @
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    : y0 {1 [+ {7 T6 j+ d- q2 s' \) |
12. os.chdir('/flash')

复制代码

3 Y: ^7 x+ U* J  k9 G


混合 (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)
   $ J4 l( Z+ S- ^5 S4 x; ~$ U
4. p2 = pyb.Flash(start=256*1024)
   8 s2 M3 `1 T; ~9 o9 {- y  s; ^0 S
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   7 |) Q/ d5 ]- W$ I
7. os.mount(p1, '/flash')
   * D) h  \6 J) I! r  }
8. os.mount(p2, '/data')
   ' G9 n) g7 |  U0 f" _! R/ X3 q% D
9. os.chdir('/flash')

复制代码

+ f7 X0 a" K  x6 s2 \$ g8 G

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

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

1. import os, pyb
   ( J. Y: F9 _* d1 k
2. p2 = pyb.Flash(start=256*1024)
   ( J  s7 d2 {. ]- T7 y, K
3. os.mount(p2, '/data')

复制代码

# r! H, C1 G  d5 L6 D

来 boot.py挂载数据分区。

; B& Y+ C* p. A. J' b混合动力（ESP32）

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

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

1. import esp32, os
     A$ r# |+ z' x# O9 P# ]
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

) w# p' w- {6 V, L  D& O
1 ?8 l' M1 y; S) V, m, e' K% K7 t