使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
    D- o) c7 l( }2 X: @+ x/ K9 |3 P

  • 虚拟FS

  • 块设备

    
    ' I' {! o7 s' u9 F) _& R) @

    • 内置块设备

      
      ( t9 g, V4 `# W

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      / x! }8 `; @8 ?0 n

  • 文件系统

    
    0 y7 _! O  E( I, g1 R5 F" o

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  

" @; c* D" O% m8 t

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

+ w( c% C4 @# g9 G+ t: B块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

5 |0 V% l, l% O8 O9 @8 aESP32

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

自定义块设备

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

1. class RAMBlockDev:
   ' V/ _; u3 T7 Y& f
2.     def __init__(self, block_size, num_blocks):
   & n! h( o" v: B! ]; C7 [
3.         self.block_size = block_size
   ! _* d$ m7 U  E( _' G
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   $ k0 @# `, E; s4 }+ ]0 u5 F
6.     def readblocks(self, block_num, buf):
   3 ]+ y( C0 K0 G1 K$ Z
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   ; Z& j" A& o0 y4 s
9. 
   " @/ C; |% c( l
10.     def writeblocks(self, block_num, buf):
    5 Q- }* c* b8 \
11.         for i in range(len(buf)):
    3 ?0 m2 x8 R9 O9 {- g0 d
12.             self.data[block_num * self.block_size + i] = buf[i]
    9 C  i8 H) m$ |. R+ `
13. 
    
14.     def ioctl(self, op, arg):
    - F0 z$ Y! Y& v& H8 P
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

4 I6 y7 x* \* F
# n# w' a1 e; v7 l

它可以按如下方式使用：

1. import os
   
2. 
   6 L6 [) `$ L0 a0 U& V
3. bdev = RAMBlockDev(512, 50)
   6 ^$ s' S) c$ v1 w4 d3 D- g& g/ I8 {
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

4 \, Z2 y" w8 \2 }: ?/ \
/ ]) f2 g9 V" g  r0 W

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

1. class RAMBlockDev:
   " q: G% v8 v; [9 Q$ |+ f0 Z
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   # w* `# \" v; o" ?8 I5 F3 X4 }
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   # y8 n" |' E4 r7 j
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   ' q( ~" g/ Y6 a& s5 @5 U
10. 
      u1 |2 ]. G( @
11.     def writeblocks(self, block_num, buf, offset=None):
    5 t  J  L3 y9 ]% Q" N* \
12.         if offset is None:
    
13.             # do erase, then write
    # H9 N% v, o3 `& b. G
14.             for i in range(len(buf) // self.block_size):
    4 o. @7 g) \4 _9 r6 K* Z
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    . E4 r( P5 n$ o& @
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    + J0 k$ u* f$ @9 P% W4 O0 Z1 B
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    ( h& c& r2 f9 x; @
22.         if op == 4: # block count
    # [& y3 z% R& N5 E# H4 d- j
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    5 X2 V: z8 i5 N+ F
25.             return self.block_size
    4 Y: o2 D- x  v0 f. L
26.         if op == 6: # block erase
    
27.             return 0

复制代码

% y" I% N6 g# N
% m7 ~8 j( Z/ y& a, i; P+ x

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

1. import os
   ; u+ Y' B: m# u2 P5 T
2. 
   
3. bdev = RAMBlockDev(512, 50)
   8 h) G" ~1 |2 f  i5 l
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

3 M$ c* ^  s" m' g! H5 }
  P* O! N5 q4 T6 D' \
9 p) d3 d+ V7 P

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   ! B& a$ b* Z! _# V" Q- f
3. print(open('/ramdisk/hello.txt').read())

复制代码

# g; c( E. P& L

& Y+ ]- e# V3 F1 ]4 _1 j8 i

文件系统

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

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

" b; J. Q6 d* M+ D$ h! QFAT

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

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

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

1. # ESP8266 and ESP32
   0 T8 P) A2 R2 I
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   % c: W' d/ m: }6 l8 n4 p
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   6 U) w; k1 s- U% E/ O% C2 C4 ?
8. import os, pyb
   . v$ ]# T* ]# Y
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    # d8 C; L* U$ N& h5 U2 Q
12. os.chdir('/flash')

复制代码

( N; s. M3 n% H* ?Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   - }5 X. N$ ^7 d* i1 C/ G% Q
4. os.VfsLfs2.mkfs(bdev)
     @: @% W/ K$ Y. F" j  k
5. os.mount(bdev, '/')
   ( C! z% H! G+ R3 f" A
6. 
   
7. # STM32
   8 R3 v- ?, ]( f9 a) c) W, i* X+ ]- v
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    9 ~5 _5 H0 u! a. @
11. os.mount(pyb.Flash(start=0), '/flash')
    0 q* \( }6 ]' @$ Z, m8 ?- P
12. os.chdir('/flash')

复制代码

: _: o" k' Z! w7 g" @7 D/ @
混合 (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)
   # h* V# ?7 F& T
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   9 V; E; z5 T  s) w2 [) z% F1 u( @& d
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

  B. v7 G" M* f6 i. y. ?
6 L6 \3 V& B) v" O2 W

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

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

1. import os, pyb
   8 j- q9 {8 u" D. q
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

来 boot.py挂载数据分区。

: b; R' a6 E; v$ i8 v. j9 o* ^, h混合动力（ESP32）

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

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

1. import esp32, os
   7 |2 s# `' L% P; u, ^
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

/ G: y/ }: M8 a0 k* X& S! [
; x8 r3 x5 x% d: c/ D0 }
7 x/ S/ ^8 l. S8 g6 h


' j+ X4 H/ @$ d