使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
    r# X/ y& m+ Y; j% G

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      % p' n& J: e% C, s/ |. ?" u

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    & v7 N6 Q- Z8 b9 z% E# F5 ?2 W

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      " B6 F, F2 q) R- ?5 K
    
    
  
  7 c( R2 Z3 }0 j& k* f8 R

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

5 m* E% B7 P4 m" _9 t# b7 R块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

$ G& v) w# ]0 y. y/ x5 oESP8266

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

ESP32

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

/ o0 D+ v0 P2 j6 t8 e自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   ! X$ a5 s0 l  L7 S- U' A
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   9 o- g* N! e+ q* `0 T; O) P2 K
6.     def readblocks(self, block_num, buf):
   * {* w) ?1 f& @/ Q: y* t
7.         for i in range(len(buf)):
   0 s# Y2 l, U" ^6 j+ K5 b5 a
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   0 N# |- s$ e3 _4 f+ M2 q
10.     def writeblocks(self, block_num, buf):
    - u) G' z" B. L+ }! I7 b8 A, C) U
11.         for i in range(len(buf)):
    5 h: i1 ^/ ~& f( g/ j+ \# q+ O
12.             self.data[block_num * self.block_size + i] = buf[i]
    / k7 g3 R4 q0 Q
13. 
    ) `; l5 X0 G8 ~* p$ S: B
14.     def ioctl(self, op, arg):
    6 m- d/ z4 M# y4 s
15.         if op == 4: # get number of blocks
    " |* \8 z& f; }! {; d% _9 r0 W
16.             return len(self.data) // self.block_size
    7 k: P" M/ I& B* u) Y
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

" y, c+ ~6 W9 r( M- B5 o

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   $ D; l0 n7 X( J. s1 b1 Z
4. os.VfsFat.mkfs(bdev)
   ' a2 c# @  `) }
5. os.mount(bdev, '/ramdisk')

复制代码

$ u, _$ p) [" k) T9 [
, W4 E" {! \: u% k. S' w

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

1. class RAMBlockDev:
     \" ?7 G( [6 r+ V! @( L* i
2.     def __init__(self, block_size, num_blocks):
   - x3 ^: [  `! n# ]6 i
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   ) Q) h9 q- L' H3 ]2 r) \' i
6.     def readblocks(self, block_num, buf, offset=0):
   3 B. O) F, n0 r- b7 K& s; f/ u1 T0 `
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   $ S! \( q2 W9 {  P
9.             buf[i] = self.data[addr + i]
   4 F! P% j" Z0 \
10. 
    / u2 y1 w8 H" X% s+ y
11.     def writeblocks(self, block_num, buf, offset=None):
    4 B+ ?7 Q$ d6 X& W. T1 a
12.         if offset is None:
      z: F( D1 \- e) p# T0 c1 E
13.             # do erase, then write
    ; ^2 ?/ I: f! n, f: r" l
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    ) I. }$ a- Q, E6 o% ?
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    6 S* C! \5 X$ L/ |
19.             self.data[addr + i] = buf[i]
    
20. 
    " @9 ]! C' D: O2 q4 k
21.     def ioctl(self, op, arg):
    9 t! d0 W& x3 [/ m8 B9 g7 i
22.         if op == 4: # block count
    9 \+ t# i0 F1 n" E4 ?9 q
23.             return len(self.data) // self.block_size
    - h3 L/ o4 a8 b) |
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

' }! U4 g" Q" L! C. T; S. h+ O5 {

, E) e2 ]$ l( M

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

1. import os
   
2. 
   5 y7 b) e& A6 o+ E3 ^
3. bdev = RAMBlockDev(512, 50)
   / f/ j; b6 e  u! z
4. os.VfsLfs2.mkfs(bdev)
   9 }5 T) h6 H& m# R8 @- y
5. os.mount(bdev, '/ramdisk')

复制代码

9 o8 C: ?: @$ J0 m3 z' \

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

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

复制代码

5 N- X+ i0 u. `1 g+ f$ ]

3 a+ p+ ~* h" B9 k( ~( P/ M文件系统

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

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

9 j/ X+ f; k% F& ^FAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   8 K+ ~" o2 |4 ~' |( Q9 J
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   1 o5 t, t3 v3 r" G. H" a
5. os.mount(bdev, '/')
   4 ?. j3 R$ e) k- E
6. 
   
7. # STM32
   9 c2 O+ ^2 a* N/ A* H
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    ) E5 V& `" _  f  k! Q
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

! H9 r0 S" ~4 Y* v- u4 X


Littlefs

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

笔记

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

) Z& \' @- u6 Z7 n0 e: Z

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

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

1. # ESP8266 and ESP32
   
2. import os
   ' d  v5 P& A! w; t6 s1 S) F
3. os.umount('/')
   6 T- j; `0 ^, b8 g
4. os.VfsLfs2.mkfs(bdev)
   0 ]2 n& L. p; Y3 X# t8 y
5. os.mount(bdev, '/')
   % |4 L! {, \8 N+ ]$ W# `
6. 
   + R8 i$ m2 M( Z$ S. m$ C
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   + C# }2 }* ?  K( }, v4 z- y
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    3 F$ h% z' `' h6 {& P
11. os.mount(pyb.Flash(start=0), '/flash')
    & g& o8 I4 @" Q0 R1 ^
12. os.chdir('/flash')

复制代码

7 G+ J4 k; [1 g% _% Q

混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   - i4 [) B2 Z  E  s2 P% l
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   ) d6 a, r8 A# C$ y* v
6. os.VfsLfs2.mkfs(p2)
   . k/ u4 p- P! }
7. os.mount(p1, '/flash')
   0 l+ L3 B  |# N6 Q( O3 B. i
8. os.mount(p2, '/data')
   , e! L4 P# ^) \& M  S# v
9. os.chdir('/flash')

复制代码

, w6 G, g) o: j6 |5 c( }7 C+ I. O
. W% p+ W- Q# U) m4 E8 Z

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

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

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

复制代码

0 w& [3 `8 |/ t: E( w4 _5 S& r4 ^

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   1 g0 _* U5 H5 b6 N& M! i. ~) q
3. os.mount(p, '/foo')

复制代码

6 y5 x8 }5 }( |- b% Q. m0 [( M4 N

% J  ]& M8 B: a; v& X, u


7 c; g3 [( ^) O; c; U