使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  ! M; Q- R5 S  A5 t. l& w

  • 虚拟FS

  • 块设备

    
    ' z8 v$ I: m4 q: F1 ]

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    1 D" Z6 {' }- @0 |8 ^! \) {

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  

, {! @5 v0 [. n* ?. b2 j

本教程介绍 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 的虚拟设备（即它在开始时包含一个虚拟分区表）。

# _; W+ f9 C  s; G3 n/ Z* pESP8266

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

ESP32

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

自定义块设备

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

1. class RAMBlockDev:
   , n3 j9 Y- d  s# D/ A$ O, g3 Z) v5 ]
2.     def __init__(self, block_size, num_blocks):
   ( y" Z1 o) G9 t" o" s
3.         self.block_size = block_size
   0 d; s" b( Y( E1 f& s
4.         self.data = bytearray(block_size * num_blocks)
   2 }. f# [" o" z) P5 I, K2 @/ s
5. 
   2 z2 O' u/ s. Y# Y( p8 u2 c4 R
6.     def readblocks(self, block_num, buf):
   * d/ E6 N' @9 f5 i: c
7.         for i in range(len(buf)):
   9 H  G9 E( @' y# H2 f- n9 c
8.             buf[i] = self.data[block_num * self.block_size + i]
   , P6 i" w2 I# Z: K; k
9. 
   6 ^  H% ^, |. d. P
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]
    
13. 
    & ~; N+ [5 J' S0 i  v
14.     def ioctl(self, op, arg):
    0 {' B( j- [1 j0 [4 {
15.         if op == 4: # get number of blocks
    , m, Z( P. n5 T  V' O) g) _
16.             return len(self.data) // self.block_size
    ( ]5 O( [, n! O: m5 R
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

5 R  M# h4 }$ y5 `  ^! y
' k9 V! g  c/ |8 D* q
) G; ~" l. W4 i/ k. G. O9 Y. @

它可以按如下方式使用：

1. import os
   5 U2 O. f9 @" B& U; Z/ D
2. 
   , |: ?1 S. w. s
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   ( P- S$ D8 C: V0 Q* z, L7 T
5. os.mount(bdev, '/ramdisk')

复制代码

& r. G& T! Q# B0 q( D# E

; R8 m* B4 u% y

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

1. class RAMBlockDev:
   % U$ c4 U4 q5 H1 `! I! R6 ^% ]
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   2 P- p5 h. i+ H* V8 P
5. 
   + c! ~. ]# d- n9 j
6.     def readblocks(self, block_num, buf, offset=0):
   & M/ _& N+ `. U
7.         addr = block_num * self.block_size + offset
   0 [% J2 b2 f" o4 a6 A
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   / t2 w2 x" K& Y- }) j, S& X* H
10. 
    $ ]9 j& y. H' a5 b2 Q! \+ @
11.     def writeblocks(self, block_num, buf, offset=None):
    + Y4 j1 J# u% M7 [+ y( P& z! F
12.         if offset is None:
    
13.             # do erase, then write
    4 m( d& g* ]: x1 q" b0 I
14.             for i in range(len(buf) // self.block_size):
    + x- d; ?) W' o/ X# k# O
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    ; k; w( N% ]2 P) w0 y# q
20. 
    3 T' M1 |+ ?7 A1 k% s: ]
21.     def ioctl(self, op, arg):
    * r2 o$ u. y8 b" l3 [) c1 p
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    & S; L9 v* I( |# r
24.         if op == 5: # block size
    9 k7 k* R8 [) q
25.             return self.block_size
    
26.         if op == 6: # block erase
    , P# d/ M( Q0 {6 b/ q
27.             return 0

复制代码

2 c2 a- X; _$ g1 {% |( ^

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

1. import os
   3 y6 k& K6 T# ?3 i8 g- @; q1 j- K2 r
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

, ?3 g/ x; B+ V. }; v9 l$ X
8 u+ |% e3 F  n! n1 m9 L

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   + q! P: u  L3 o
2.     f.write('Hello world')
   4 J+ }+ `4 i3 ]9 b7 v+ P# ]
3. print(open('/ramdisk/hello.txt').read())

复制代码

# i; |  f9 C, m# l+ g) \# t7 P


- E/ T* h1 p  q$ A
+ Z4 H, P  x: k4 I  r2 f3 a文件系统

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

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

$ H! z  p* g" }5 V! y# UFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   9 U2 @2 ], [) W
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   $ q3 ]) [8 Z  f6 ]7 \  E9 B
9. os.umount('/flash')
   ( C) H7 K# q# V' o- E
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    & A/ D. y1 E% n# D0 j8 T$ f
12. os.chdir('/flash')

复制代码

5 f+ G, k5 R5 ^- P6 o4 G) [
! g7 t1 E) W, W- i' P
- o' g- X3 m8 `1 b# E$ C
Littlefs

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

笔记

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

8 N8 p' l  j6 [& {& P

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

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

1. # ESP8266 and ESP32
   2 c8 L$ j3 I9 a6 f/ K
2. import os
   
3. os.umount('/')
   6 K+ I- |# L; Z! `) N( f- ?
4. os.VfsLfs2.mkfs(bdev)
   : M" |% _7 ^2 @, s; U* t0 ^
5. os.mount(bdev, '/')
   6 u  @9 ~( T' a, n6 \
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   + U* n8 K) S  X5 ^( l0 @) ^
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    % Y6 G, x+ @9 y+ s: l, U- e% ]( [6 h2 U
11. os.mount(pyb.Flash(start=0), '/flash')
    ' \1 q3 p6 ?/ B) K
12. os.chdir('/flash')

复制代码

5 s# h% c) u0 S! R  a


混合 (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)
   ( W' f- V* u8 P% w/ G& D0 S
4. p2 = pyb.Flash(start=256*1024)
   4 I7 |# N& c" }) ~$ B
5. os.VfsFat.mkfs(p1)
   ! {; h+ q: l6 m" g0 B5 d- i4 e
6. os.VfsLfs2.mkfs(p2)
   3 @4 Q6 y% E% K; P) h* Y7 e
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

4 n# A: ^' T* t' L7 Y

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

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

1. import os, pyb
   , T8 y  q4 V$ C3 i; N2 d# ?0 R! t
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

( T7 W8 V4 _: X9 T. c4 [
$ @) ^! w3 S7 L% T9 [, A- u& q

来 boot.py挂载数据分区。

4 O; b5 E5 {: l: o0 [6 b& V! g0 T混合动力（ESP32）

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

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

1. import esp32, os
   1 z! ?! A. I6 Z) U6 }5 m5 B
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   1 f, Z9 o7 |$ c! ?. W/ @
3. os.mount(p, '/foo')

复制代码

7 q, y% K  e- j  {1 U/ e. p) b
2 Z' l9 A1 f4 k( j$ I% F+ e

% W$ b% J- l+ I/ O
$ s2 _( ]# G( m0 `1 g) q