使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  3 t( |7 y- p# K: ?' A. K

  • 虚拟FS

  • 块设备

    
    ' Y- j) q& |, @6 A+ h- w5 o7 ^

    • 内置块设备

      
      . `0 s+ n" E* |5 y" j1 D

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        & c* L0 Q" t' H8 s' s

    • 自定义块设备

      
      + f1 [5 d8 z: d6 P1 Z# N+ Y

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    / b: ]2 ^6 f# w4 o  I" Z
  
  5 d* ?1 v/ v; m

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

& e4 T0 s" P% q块设备

块设备是实现 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指向默认分区。这实现了扩展接口。

自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   . U# Y. t0 r" q; C0 y
4.         self.data = bytearray(block_size * num_blocks)
     v4 w6 c4 Z8 C, H( J( d$ g7 R0 b% b
5. 
   $ Q- X% ^: s6 S, r
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   " v" K* X5 Z" L* S
8.             buf[i] = self.data[block_num * self.block_size + i]
   # l! s5 Q6 Q7 b' J  C, V- u) ], q
9. 
   
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    $ A' Y. I+ J9 B% `6 v
12.             self.data[block_num * self.block_size + i] = buf[i]
    & _: ]- _6 |8 ?  @# |7 m
13. 
    
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
      b$ q' E/ \& n4 C' _
18.             return self.block_size

复制代码

: y5 s2 |) r0 o

它可以按如下方式使用：

1. import os
   , A- p1 s" G1 Y/ t: u
2. 
   
3. bdev = RAMBlockDev(512, 50)
   ) Y( J- ?7 H0 E* c
4. os.VfsFat.mkfs(bdev)
   7 b$ B1 V1 W3 v$ N4 T% M
5. os.mount(bdev, '/ramdisk')

复制代码

! n' C. B! p# Y9 \" f

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

1. class RAMBlockDev:
   0 P; Z9 h  B/ i) C7 V
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   1 |4 J! h9 F$ b+ u
6.     def readblocks(self, block_num, buf, offset=0):
   ; p* ^9 P: Q: N" Z
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   ; C% r) H' Q. \! e
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    3 n4 a1 N9 W7 `% k
12.         if offset is None:
    : ?0 A" X* \. g5 a& c- R
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    & a; \3 N) {6 W& T( y, \4 B
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    ' P0 i) K5 W$ l% U
18.         for i in range(len(buf)):
    1 L! W) ?, T/ H1 i
19.             self.data[addr + i] = buf[i]
    
20. 
    9 p6 r) V, i, F) p7 g' g
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    $ d3 Z4 a9 {* p8 ^, Z
23.             return len(self.data) // self.block_size
    7 _; P( k; e, ^1 q5 T
24.         if op == 5: # block size
    
25.             return self.block_size
    # v: `/ y# A$ \" `% N$ L
26.         if op == 6: # block erase
    8 C2 G; S5 j" \8 [0 c  i; k
27.             return 0

复制代码

3 Q* H" y8 O# F0 e, _% N
; ?7 T2 a" Z: i9 F

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

1. import os
     q9 X+ N! l; y- W0 j. J5 U
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

# I1 ?2 K6 @- b& o, s# A- s$ `

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

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

复制代码

! C3 o+ m8 F. c- w. T
9 l- ]0 [. c) E3 `5 U5 X3 M
6 G8 Y# Z  n1 P. v
' n8 c) p# B; x9 B# z; H
2 a1 p0 u0 k& P* T( C& t文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   9 H# L/ N7 {9 L5 a  i
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   5 K) r2 p# |" j- _
6. 
   ! w+ ?$ P' L! h0 u9 T& F  e: W
7. # STM32
   
8. import os, pyb
   & R! P# w: L+ y! ]0 \$ R
9. os.umount('/flash')
   ' c9 I# }) W6 y& w  i8 ]
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    7 b& z& s8 i( g+ a' W
12. os.chdir('/flash')

复制代码

, E8 _% {+ Y9 L7 t" Q9 N& y/ I; z

: B' w3 {3 u" {
Littlefs

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

笔记

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

2 E, {0 \* o2 O% S

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

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

1. # ESP8266 and ESP32
   / `6 J, k( j* b, `( W3 g1 o7 q) F
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   4 X" y/ ^2 j# c
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   + h! E1 a2 E7 @# K! g) D
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

' V! X& D0 v/ H
1 X9 ?9 ~5 |$ H. S

2 k6 L  `9 T6 S( ^4 p混合 (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)
   5 s7 X7 X( ^5 o1 J: m
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

+ u0 u9 B# l( I/ G. P4 _

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

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

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

复制代码

6 B+ N  s$ N% l3 A# c, k
: Y# S3 _' x6 ~) U4 w5 j. c0 T" K

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   1 F6 p9 H4 r, x: ~. M
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   & ?' x1 d1 P5 i$ C
3. os.mount(p, '/foo')

复制代码

, F, X" a% _( G- P' i& z# |



* |7 F5 j% g- {" O9 K' f. `2 t. J
; ?' O7 G+ a5 O) C5 T