使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        8 T8 i3 j2 c  L5 s2 m, o. o

    • 自定义块设备

      
      % N; H5 R7 N' g, ~3 E

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    $ g2 @" {3 C4 U& n
  
  0 a6 h+ G0 E. @/ s  C2 h( L

" @* G2 r4 S7 e7 \6 q

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

ESP8266

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

ESP32

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

5 T, j( K$ a8 E4 A' ^' P. o自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   $ l  ?; M+ j1 P* B" I3 g
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   ' t- o. ?. Z- s) L' k
6.     def readblocks(self, block_num, buf):
   & y! h6 Q& ]7 {( e: S
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   ' u& ?" y& Y& [4 W) O) X
10.     def writeblocks(self, block_num, buf):
    ! v# \) i) V# R+ e, b( n
11.         for i in range(len(buf)):
    - T2 C6 k1 A9 w4 K, A$ v" W
12.             self.data[block_num * self.block_size + i] = buf[i]
    : h/ L( W  F  _* M3 d  u
13. 
    + g4 z, }* v6 q
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    * `1 F- i8 y7 o5 L& m9 _
17.         if op == 5: # get block size
    0 b$ }# L- W5 J
18.             return self.block_size

复制代码

7 L: L3 x1 M$ u" F7 ~

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   : J5 t# e2 M" x* g' Z( M3 ?
4. os.VfsFat.mkfs(bdev)
   9 ?: R( |2 x* b8 k% r9 I- \! u7 r
5. os.mount(bdev, '/ramdisk')

复制代码

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   " A. \8 k. |! H1 g6 |
3.         self.block_size = block_size
   6 V# e: g$ f1 T& {
4.         self.data = bytearray(block_size * num_blocks)
   ) e1 {8 a; c. Y5 W% L2 e
5. 
   ! n9 s: C! \, X8 \# X. W5 `( \
6.     def readblocks(self, block_num, buf, offset=0):
   & F; m& h5 l9 ~; \+ \
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    ; a* [8 d- Y1 f. M" d
12.         if offset is None:
    $ ^, I3 I- x; X
13.             # do erase, then write
    . w! U" G# ^$ S% I& ~
14.             for i in range(len(buf) // self.block_size):
    " c* s1 v+ C% D8 Z6 E* Z$ c0 B
15.                 self.ioctl(6, block_num + i)
    ) E3 F2 j: R# p
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    8 X/ g) p0 }% W8 g# k4 B
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    # b) C* X, i9 N  M2 N8 |
24.         if op == 5: # block size
    ) l  r1 p' _1 j1 J
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

1 r/ w' G( Y6 G- O+ W

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   4 e+ \; z7 i  H* r3 E# e. P
4. os.VfsLfs2.mkfs(bdev)
   ' J; V# M2 b) Y2 h& ]: p9 X
5. os.mount(bdev, '/ramdisk')

复制代码

$ i: a2 @5 d! X' J: w+ _5 E1 Y: K
3 g- l2 b, Z& |/ P6 ~! J

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

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

复制代码

, g) V9 d! f$ r5 k- d4 G& S


, o+ L! X8 T6 z7 A
0 I7 ?/ ^0 Y: U7 }% E文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   / C* t2 s- m  y. R
2. import os
   
3. os.umount('/')
   . p4 j/ [/ a' X
4. os.VfsFat.mkfs(bdev)
   9 ?! M2 g$ I2 E$ Q& ~1 u1 H
5. os.mount(bdev, '/')
   " o" Y5 D, A& x' R$ w
6. 
   
7. # STM32
   
8. import os, pyb
   5 W0 a$ b7 f$ Q' P" o
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    5 K- F/ K/ K) A" p7 O3 p  K6 ~+ e
11. os.mount(pyb.Flash(start=0), '/flash')
    * k5 U; p1 b$ E) _2 M2 V
12. os.chdir('/flash')

复制代码

9 K* i# a. j+ Z: f  u; V; L% F& B
) N7 ]3 p0 K+ Y0 \  Y
0 M6 c) i' P( Y$ a  z) c8 D  G: WLittlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   ' u5 M" p5 ~# Q( |$ t
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   . f- v* [# [( E; `! ?( T. J
5. os.mount(bdev, '/')
     L, M0 o* |# ~2 r" k
6. 
   6 r; T- N4 k! M# q1 _
7. # STM32
   " {1 z! h$ T. _/ J
8. import os, pyb
   : w5 H' N# x3 E* \: G% h
9. os.umount('/flash')
   : j5 c$ c$ Z' A: f4 O# A$ r6 u8 a6 V
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    ! f6 H! `: |3 H  I3 u3 [& l. p
12. os.chdir('/flash')

复制代码

% ]6 J: I! R7 Q% Y% }4 M' V4 M
' [; j; N, _8 X9 }% 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)
   
4. p2 = pyb.Flash(start=256*1024)
   ' y, r# x! F+ ~$ j' K/ u, d
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   6 _5 s' _2 F0 H* X: P" W
7. os.mount(p1, '/flash')
   " M+ w* e. O* G0 b  ]
8. os.mount(p2, '/data')
   ' s' `, {  z" f$ Z" z5 p& ]* X
9. os.chdir('/flash')

复制代码

# u" m& S& Q+ u5 A' ^6 `
) M4 v4 q& E, O# M  L3 m

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

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

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

复制代码

, R0 p! Y8 a0 P1 L. i

来 boot.py挂载数据分区。

; }" R8 J: g' r. t混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   ( C/ q; a; E+ `% n4 q6 Q. t- P. W
3. os.mount(p, '/foo')

复制代码

# j" v( n/ D9 D1 ?% U2 s
8 c# B5 a& J+ l& I4 P$ T
5 O; ^" p0 y. a4 a
. _$ I" l" t9 A2 V+ t; o3 T