使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      ! i% H9 L4 `' _) I9 T

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    0 r# J) o  u& s" c9 i( b! X

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      , C' s  T) ]3 S
    
    
  
  

) `6 K) [; s. Q6 M; T3 |

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

$ D  W% G6 U5 L  ^' V4 ]& Q* N块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

. N1 w8 D3 c8 y: n& ]: VESP32

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

自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   " ~2 c- S7 P" [& U9 Z
3.         self.block_size = block_size
   * t  i+ s+ f/ x4 G( c5 V
4.         self.data = bytearray(block_size * num_blocks)
   ' c+ Q  L- }$ ^6 H7 m" k6 W" o
5. 
   5 P5 k( }! X( Q. t) p
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. 
   ) L) j  m0 O1 [; S
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    ' P$ p( }8 j1 b) y7 Y! J
13. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    8 A0 N& A9 h0 ]: A! ]6 O
17.         if op == 5: # get block size
    # U9 K4 l. M, i2 t2 X6 ?8 O; ~5 a7 i
18.             return self.block_size

复制代码

. R9 j* P, t1 ?6 S

/ O* n% X) ]9 T2 |9 I+ v- k

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   1 O: b: ~; w( C9 f/ \& o
5. os.mount(bdev, '/ramdisk')

复制代码

) w( J+ w+ O9 G( `4 n& {! N

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

1. class RAMBlockDev:
   # A9 {7 ^/ W& L3 B6 F8 ?! {" h/ B1 o
2.     def __init__(self, block_size, num_blocks):
   % O; n) y% V# i" M7 N
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   ! b2 B% E9 r  a: s9 s+ _
7.         addr = block_num * self.block_size + offset
   , {# z+ ^& k* @$ N) C1 W
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   5 v; S6 _- K- X+ H
10. 
    
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)
    
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    * v  a! y# k2 C& _8 I
18.         for i in range(len(buf)):
      v) x3 d# ?, Y
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    0 A  Q3 I6 N6 a6 \
23.             return len(self.data) // self.block_size
    ! H# _" y2 f6 ?8 V
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    & i( B, s! P! O& w( z- l
27.             return 0

复制代码

/ o  H8 e2 J. F$ |/ O

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

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

复制代码

* ^$ J6 W$ \# J4 K# V% r. P3 k' X
: x+ R" @' Q1 {

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   , W. |2 [( e: J& q% C% b- t
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

! `1 m- B7 n9 D8 w7 w; D6 h


4 Z- y4 B& ^% {. i" r: Z3 f
1 U9 t& N7 j0 e- ?文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   2 T- |/ X* y0 W% }
2. import os
   3 w' Y( a; q3 e+ _/ }9 o
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   " a3 I( H1 J% I) T; C& G, p* N
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   9 M' ^3 j: n2 r/ U+ [+ ^
8. import os, pyb
   $ i5 b2 b* m. d
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    ! `1 u  |5 s& w1 Y/ a
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

, C: H0 d; `8 b$ b# r, B


' m5 Z- a4 r# B+ O! F3 C0 uLittlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   1 s' p- p1 r2 Z6 ^
2. import os
   
3. os.umount('/')
   . Q2 f% y& s3 v" F& f5 {' N
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   4 n4 X$ k4 j8 p& J8 S
7. # STM32
   0 |6 I9 o( F' [
8. import os, pyb
   
9. os.umount('/flash')
   2 J( f: N$ T4 z4 N7 ]& x
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    . J; z2 r- e+ n& E8 C
11. os.mount(pyb.Flash(start=0), '/flash')
    & f# w: G# H1 a, Y5 }! d" q# C
12. os.chdir('/flash')

复制代码

# Z+ n: @# d+ E6 C" E
混合 (STM32)

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

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

1. import os, pyb
   9 \" V$ I  f; M
2. os.umount('/flash')
   " N2 J1 l( R9 U" I% O" L6 u
3. p1 = pyb.Flash(start=0, len=256*1024)
   * p1 Z: m4 E2 B! E6 D! L5 K
4. p2 = pyb.Flash(start=256*1024)
   8 w" o  x5 q$ Y$ F
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   6 E. U7 ^) S# _6 ^/ H3 X
7. os.mount(p1, '/flash')
   ) o6 o* ]4 J: z3 D. |
8. os.mount(p2, '/data')
   + E" K9 v2 o+ l. T- E9 b
9. os.chdir('/flash')

复制代码

/ Y: C- f, L8 q2 k8 E

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

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

1. import os, pyb
   9 d1 M# a( N" a2 R  W$ _( [4 K
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

7 m+ [  c1 |1 v
$ T2 t! i6 N5 }% k

来 boot.py挂载数据分区。

0 l+ y* C- l+ \  m' @# U混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   " S2 I" n/ M3 _! d" R& K7 R
3. os.mount(p, '/foo')

复制代码

# V! N  n9 W! z3 n9 P& K- j

$ |, T6 {. U  C. ^' [& l
" ]' `3 D- `. g/ j: Q/ {% q, B

* @0 f1 ?" t3 d