使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  5 x' j( x; \4 q" M/ ]

  • 虚拟FS

  • 块设备

    
    ! T  z; w+ V# l% B1 Q% z5 m5 G6 b

    • 内置块设备

      
      ' y9 y# }0 I* u4 t3 m$ j

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    : r+ B& U0 f% I# v4 W

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    0 W: f) H# E) N1 |' `( o
  
  6 }( d7 n& F: i

, X/ p' a* U) Q# h& A4 x

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

# r) X: J8 [) Y2 }' C' ]4 n, L块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

7 g! c4 ^( I' t8 qESP32

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

# b1 k4 M% A( m& x- K
) {* E2 s+ B+ Z- q; `( X* O9 F自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   3 \" M9 u9 g% c
3.         self.block_size = block_size
   . Z! J! h  o) e! ]  {
4.         self.data = bytearray(block_size * num_blocks)
   & _- ]5 |6 ~( u( T
5. 
   
6.     def readblocks(self, block_num, buf):
   & x" w- A2 [1 ?; r* G3 f$ _# n
7.         for i in range(len(buf)):
   ( S9 K7 e1 ~( [1 W" H; S0 p6 `
8.             buf[i] = self.data[block_num * self.block_size + i]
   + }; r- f5 Q1 |: q
9. 
   7 u. T) n9 P6 v3 V4 d
10.     def writeblocks(self, block_num, buf):
    3 f3 D; r# @* f. I; G2 T
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    1 J0 q* W4 p( v: z6 N4 p2 @6 U0 y
13. 
    
14.     def ioctl(self, op, arg):
    4 p- `9 ?5 L0 ]0 q! ~! P
15.         if op == 4: # get number of blocks
    + v3 C/ a. L, E4 N9 [
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    0 @9 @) n6 C  H& P. Z
18.             return self.block_size

复制代码

它可以按如下方式使用：

1. import os
   
2. 
   0 B; O3 Z0 k- Z/ d
3. bdev = RAMBlockDev(512, 50)
   ( ^$ T; z3 Y# ?' x
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

- }: D$ y- d1 O8 Y# ^

' ]; w7 p3 L2 R- h$ d, ]

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   / E/ @! `. R4 J9 I. \  y2 J2 s8 d
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
     D4 F0 k. ^9 `
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   1 t6 _$ k4 B: i; w6 N7 v" T
8.         for i in range(len(buf)):
   " K8 i+ L9 Z7 k7 o, v* I" O) R1 w  [
9.             buf[i] = self.data[addr + i]
   ( K6 p: J1 m2 J2 {% i5 E1 m
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    
13.             # do erase, then write
    # [  z* b! r" X- v' t
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    : B8 W/ a3 T4 y/ ]  z
16.             offset = 0
    7 y" c& R! t4 }( d3 t9 q  v6 J
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    ! R7 l' Y5 D) Q3 h5 G- S" ?
19.             self.data[addr + i] = buf[i]
      K% c/ w' w0 c
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    5 d$ n% [; b* I
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    + x' I) w2 [% B" I
25.             return self.block_size
    4 k* o% b7 z& m
26.         if op == 6: # block erase
    
27.             return 0

复制代码

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

1. import os
   3 X  R  b. _4 h" Y1 z6 [) u$ H8 }4 X
2. 
   4 F3 w9 k$ X* {
3. bdev = RAMBlockDev(512, 50)
   1 I. R% C. Q* h& a; }4 k% w- {
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

9 Y, A& y7 H, @
1 V3 x, H- i4 ^* z

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   7 X. E2 z* r7 q
2.     f.write('Hello world')
   * S4 H$ @7 ]% ?4 \
3. print(open('/ramdisk/hello.txt').read())

复制代码

/ T9 q* Z2 Q9 y

. M, M) j3 d" \' k+ I
文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   ) F1 B' ?% F; y, D( @2 [
2. import os
   - U- @) d: L& B& D8 x. [
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   ! f/ @6 ]+ A2 `+ \; R0 S7 o7 J: Q) l- v
5. os.mount(bdev, '/')
   . {* }/ t# H- W/ ]6 n1 A
6. 
   
7. # STM32
     R3 U6 u) c2 C0 w; `) d, Q
8. import os, pyb
   4 a+ c- ~8 S3 w) ?/ }
9. os.umount('/flash')
   " ]9 N7 _) y* Y: [6 C; F0 C% o
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    + {% w1 A, c$ }1 z1 ]9 a
11. os.mount(pyb.Flash(start=0), '/flash')
    0 v* c# [- \, B: o; w! Q/ y$ v) S
12. os.chdir('/flash')

复制代码

: L+ G  }: p, J- TLittlefs

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('/')
   ) T/ i, g6 ]7 h/ [. o) B, g$ \  W
4. os.VfsLfs2.mkfs(bdev)
   . Y  F: N* i0 I1 e% W
5. os.mount(bdev, '/')
     x/ C% y, d6 X( N
6. 
   
7. # STM32
   6 n* }% n) e! \9 p* |1 e
8. import os, pyb
   
9. os.umount('/flash')
   / v7 J  e0 C+ I* h3 y, ?% C) l! V; j
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    3 e' J( a7 T+ f( Q
12. os.chdir('/flash')

复制代码

& r( a/ t1 A! M" b
混合 (STM32)

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

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

1. import os, pyb
   4 t) a. ~# n2 N, J' |# d8 {, l
2. os.umount('/flash')
   * b/ r/ h' c9 c2 I8 q
3. p1 = pyb.Flash(start=0, len=256*1024)
   # P4 r( B- r/ }% v" H
4. p2 = pyb.Flash(start=256*1024)
   & ~2 M+ [+ s) Z5 l) l' S! M' V( m$ `
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   " y0 Z5 v1 f* q& c$ n' X
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   * a. c) R. `8 g! l
9. os.chdir('/flash')

复制代码

) D% L5 @$ u$ q& x" J
' j6 U% B/ H5 n  G. v2 t, k
) N( V3 U7 S! b1 r! C- A

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

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

1. import os, pyb
   / h5 }0 U7 l$ X; y8 a
2. p2 = pyb.Flash(start=256*1024)
   + {$ o4 p+ U0 T2 b0 g( |- [
3. os.mount(p2, '/data')

复制代码

# P* o0 D7 o* h4 Q- A, S
' n! |+ Y% U8 @+ m2 M

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   ! S4 R* u0 I* x4 i, L" I8 E6 _: [
3. os.mount(p, '/foo')

复制代码

& _7 Q  l7 B' S0 Y1 {5 \6 A: o* C
2 ~9 @  O4 l7 n! P

! V  R) x8 t* V: C5 M1 K, F2 J! p