使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        5 C+ f* y4 I$ ~9 s

    • 自定义块设备

      
      

  • 文件系统

    
    5 ^% @4 G' C+ e0 ?, T0 \  q

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      1 f+ y6 J* n9 F  N% X
    
    
  
  5 D# v: I- i% N% ^, I; u* x( X

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

7 F  Q9 R: s8 w$ T. lESP32

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

自定义块设备

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

1. class RAMBlockDev:
   7 `3 h( i; X  k" L1 d" y& i/ s
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   # f7 r0 Z4 L/ ?- Z- f
6.     def readblocks(self, block_num, buf):
   / i2 Y* f5 S; y
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   4 ?- p* a+ J4 S' x" d+ t
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    3 n$ e. v$ V' }) x% i: N( E
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    
14.     def ioctl(self, op, arg):
    6 V- B0 k1 M3 l; Q% ~
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    * \" m1 y2 J6 \6 i. M5 m
17.         if op == 5: # get block size
    ( {  @8 v5 A5 T* _" X% t% ^
18.             return self.block_size

复制代码

, ~$ R. ?  T. J# K0 t
& ^/ r! Z/ R; J* `8 r! P9 h% z5 x/ B

它可以按如下方式使用：

1. import os
   4 N2 x! `7 X% {  ]  ^+ J  ?  i* C7 ?
2. 
   / S# M: Q& ]% k; }- _3 o
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   & U3 b* \4 D$ \. `' d
5. os.mount(bdev, '/ramdisk')

复制代码

3 x5 L/ J- e5 Y
- r  r4 ~# T8 X% c5 B1 B1 v

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

1. class RAMBlockDev:
   ( g! `# K/ \# \- L; ^! M/ j2 y4 Y
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   4 X4 t5 W/ _6 G- s0 f" q  q
5. 
   & F, n9 Z6 }6 [3 L; q& h8 I0 i
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   / w/ D. d! Z7 A' E0 M
8.         for i in range(len(buf)):
   ) v! X; Z6 p3 L
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    9 G- i, y" {) e6 C; b# ]& B8 U! z
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
      |2 e+ K( _4 L3 e" B& e: J
15.                 self.ioctl(6, block_num + i)
    * D) u& p; H8 V' R
16.             offset = 0
    9 t8 ]5 ]+ x* f4 }+ `
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    0 N" N, c, u+ g3 \
20. 
    
21.     def ioctl(self, op, arg):
    
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
    8 b3 K0 h. [, S5 I# P9 E. V- f8 s
26.         if op == 6: # block erase
    1 v0 v5 C: l7 Z; M& i
27.             return 0

复制代码

; U/ p" K: B- [9 A- K
2 z* @/ N/ |4 b2 [3 b0 ^3 M

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   % l- g8 d" H$ [7 ^* F1 `: u4 i
5. os.mount(bdev, '/ramdisk')

复制代码

$ r5 Q7 Z. ?3 c* q7 V! W* S- c

9 i4 M! o2 m5 S) f

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   ; L6 A( c6 g3 G% s6 T1 [
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

  P4 s9 C  o, a8 ]


1 e$ \# w- r; m  b& v
文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   $ A9 X4 f; V$ S& A2 Q, J, E
3. os.umount('/')
   ; N- n. n1 i8 p( D: k
4. os.VfsFat.mkfs(bdev)
   4 r8 j! X0 U4 b+ g7 L0 x
5. os.mount(bdev, '/')
   6 q7 F* }2 V+ U$ s8 D1 ^" i
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   * o1 E2 p  u* x2 ]6 \
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    3 a3 ?5 o7 y2 S
11. os.mount(pyb.Flash(start=0), '/flash')
    ' c# }6 R2 l# D6 E/ M! s; b# K. R
12. os.chdir('/flash')

复制代码

7 K7 a$ ]# A- Z& n9 z  q
' p# ?- J- Z8 W' G- C( }
Littlefs

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

笔记

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

5 D6 L4 K9 v- Z

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

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

1. # ESP8266 and ESP32
   
2. import os
   ' `' g; i2 W0 \2 {7 P5 e' ]
3. os.umount('/')
   9 g9 {- g6 `* e- X# q
4. os.VfsLfs2.mkfs(bdev)
   * o1 D( j& F$ @6 u
5. os.mount(bdev, '/')
   # |) c5 O# v  E/ d
6. 
   
7. # STM32
   
8. import os, pyb
   , \6 I: b: L5 g" [' D+ r
9. os.umount('/flash')
   / q. c: K, _) p, f0 n5 M, m
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

% [- v3 J7 f  I3 @1 a
# m3 F$ q$ M+ B& L/ h/ L; ~混合 (STM32)

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

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

1. import os, pyb
   # G9 C- b" `; }4 N( w0 _4 [
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   / W9 m( |( ]4 }% y7 N
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   $ C& R' V. e4 ]9 f
7. os.mount(p1, '/flash')
   5 D/ v( l2 k+ X2 a
8. os.mount(p2, '/data')
   ; U$ W5 s( g& p" N* X) k
9. os.chdir('/flash')

复制代码

& P" y: ]1 D7 n3 d4 s

7 G6 |0 ]& i( o9 M. l" N

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

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

1. import os, pyb
     x" W) }, {$ m, X7 |8 _* f4 D8 d
2. p2 = pyb.Flash(start=256*1024)
   + R! r$ D; b; j2 F3 M
3. os.mount(p2, '/data')

复制代码

2 f8 W  f* H9 i. ]: I4 X2 }
7 d, C9 p2 [9 |  L' p

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   : O! K7 f1 y$ O6 p% Z  y
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

9 Y1 f" G3 U& l% L1 [
1 `5 j8 k. M3 J  [) E

0 l! G3 z0 t+ G, \+ i# y% w