使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    ( M# }% m) d! ?# |9 c8 @

    • 内置块设备

      
      % f# g" e! ?% f

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    # b% {+ f" f1 |2 h' L) A

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      " V, v3 L+ h7 m$ ]8 `' g8 I
    
    
  
  

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

/ {2 h# u+ v  Q0 X# t1 @4 C块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

. i5 O: Z% f2 nESP32

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

8 u) A8 N: t* ^3 `自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
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]
   + H& D% U2 f( u3 J! H$ }, v
9. 
   
10.     def writeblocks(self, block_num, buf):
    ( B% b+ S% T  u
11.         for i in range(len(buf)):
    : z* Y' L+ ?3 n/ p0 Q+ J' Q
12.             self.data[block_num * self.block_size + i] = buf[i]
    - q" G; c5 [9 ~! G( y0 c/ K# r
13. 
    
14.     def ioctl(self, op, arg):
    7 Q+ o2 H& _7 Q- h+ i
15.         if op == 4: # get number of blocks
      J! r% c3 o$ Z" m- K; I0 M6 b
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    ! }) f. F, b. I6 i6 }
18.             return self.block_size

复制代码

- M3 Q& D# ^6 s

它可以按如下方式使用：

1. import os
   ) f  r0 T/ _+ B
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   , `) h& z7 V" r# H/ e
5. os.mount(bdev, '/ramdisk')

复制代码

' Q0 h/ V) x4 X: D/ {

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   * c: U/ ^* x, K9 u; l
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   ' d- Y2 N" u# N4 v  t! q
5. 
   # f$ S1 [8 J: P7 d9 T" Z
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   $ D, ~9 m5 R; ?* G9 K8 y
8.         for i in range(len(buf)):
   " J7 ~1 `8 n) G
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    8 \. k2 C, i# N3 @4 S0 w
12.         if offset is None:
    8 f7 Q6 C5 j# U
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    ) Y) R  }7 F9 J. f
15.                 self.ioctl(6, block_num + i)
    ) v: R/ b& L. M' [
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    , W. ?# d9 E. \
19.             self.data[addr + i] = buf[i]
    
20. 
    2 a* R: l! h: b4 P9 V( @' W+ i6 c! R
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    6 [- @3 w! p2 F/ b+ j9 h: l
23.             return len(self.data) // self.block_size
    2 r8 @6 r% B7 z- l( C
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

% q) ~2 p5 k& E$ W3 W% z" C; D

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   % T0 R; _$ n  p# d& t, N
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

1 k6 n: p" S" H" z3 E
9 G; E0 ?  {- v& M+ u+ s
& _/ t) F* s- ^- e

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   - \/ e, ]% j" D) Q$ {3 r1 p
3. print(open('/ramdisk/hello.txt').read())

复制代码

2 Z! I7 B7 w* P, d8 f

9 p8 E. R1 K$ j% z2 _1 J9 d

文件系统

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

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

5 f4 i( G, O7 G& z, {FAT

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

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

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

1. # ESP8266 and ESP32
   , J2 A% i- C. H1 y1 `
2. import os
   
3. os.umount('/')
   / B: W0 c1 G. G/ e
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   3 A* i# r5 v: Y7 j
6. 
   ) Q# [1 f' T) l7 @2 x; F- l2 _5 Z  b
7. # STM32
   . T; h2 v8 O- i* C
8. import os, pyb
   
9. os.umount('/flash')
   4 ^4 F8 w1 h' X: a+ _
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    7 Y7 |, q% v3 C
11. os.mount(pyb.Flash(start=0), '/flash')
    # x& ~1 I( B& K, o9 z% V0 r
12. os.chdir('/flash')

复制代码

. R7 ]9 q' g8 ~8 r5 f4 @6 S( H1 JLittlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   9 ~0 j, `' w. m
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   3 O5 n0 R  r+ ]% T1 A! y
7. # STM32
   - V6 ^. u' S! N) a8 k, k7 x
8. import os, pyb
   
9. os.umount('/flash')
   9 D3 \+ U; S! a* K9 J2 l# E# q
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    + y; X, L1 \3 n+ a" n' ?! |+ g
11. os.mount(pyb.Flash(start=0), '/flash')
    ! O, Q8 _- I8 A9 r4 B/ r" T, M- q
12. os.chdir('/flash')

复制代码

3 ]6 C/ }' x+ ?% B* r4 i
) s/ z) k! m( q+ G( |- B
混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   + X3 o$ s7 v7 W9 G% L6 v
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   9 f7 L# H# [8 w
5. os.VfsFat.mkfs(p1)
   1 y4 j3 E& P+ o/ r' M
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   % g5 g) ^2 }! ^, O% V/ B
9. os.chdir('/flash')

复制代码

  o0 a2 J% F# y! o

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

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

1. import os, pyb
   ! u0 X+ q; A' R" J/ U7 }: O
2. p2 = pyb.Flash(start=256*1024)
     v+ a# A0 J" h& _9 O
3. os.mount(p2, '/data')

复制代码

, r1 J, y+ j9 K
8 n$ \. D# Y+ \2 l2 C- K

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   9 v; e$ Q7 M( L9 W. @9 z( p- L; w, _, F
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   ! o6 p" C5 g) V2 H) M, G  _
3. os.mount(p, '/foo')

复制代码

4 b' E3 S2 I9 {2 T


% |$ `# Z+ a5 T+ r
$ f" Z, f; e* v# Q* h+ d. \& Z5 b
9 H- ^- Z- o! m; s