使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  4 q9 {+ _) y5 u3 H2 r7 l. A* v* F- ?" Z

  • 虚拟FS

  • 块设备

    
    - v$ U. M/ v( N/ L  y5 m

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        * u8 ^2 |3 \6 b4 m+ N9 y

    • 自定义块设备

      
      

  • 文件系统

    
    ) t0 J2 t( [/ W: _& k& ]3 \

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      ) p7 ?! d; Q0 o% P1 a* a
    
    
  
  . L7 b& ?" S3 Y/ _1 {* l  o

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

  O  M* w0 z/ I/ O- z; a3 k5 QESP8266

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

2 _% S* C  u6 h- x8 R+ G- qESP32

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

1 o" |7 f9 j: ^. ^/ Y
* w! C2 v! G8 ~0 S1 r# c) O7 a自定义块设备

以下类实现了一个简单的块设备，该设备使用以下命令将其数据存储在 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. 
   ) {; q  a6 |3 r2 r: i7 C
6.     def readblocks(self, block_num, buf):
   4 ~) }4 p% ]0 P. N8 N* t3 ]' d
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   - u$ \+ Y5 C2 S! p5 P" L
9. 
   7 M5 c& j5 L+ g9 M: {- H( ^3 S2 G& k
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    9 f5 U* B, K& W$ L7 t( D
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    
14.     def ioctl(self, op, arg):
    ' X, [, H. E+ A3 s
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    ) t" ]- y- Z7 G7 D+ C
18.             return self.block_size

复制代码

: P5 \, ~& S. S2 @
: Z) o! C) K' P% u

它可以按如下方式使用：

1. import os
   4 y- {& x/ p* A* ?" V
2. 
   # [- K6 v* Y6 e" R
3. bdev = RAMBlockDev(512, 50)
     L  u( e' r& k0 L# L7 g
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   , I) m% N. e! `! H
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
   
8.         for i in range(len(buf)):
   ! O. Z+ H5 a0 ~' q% F- `8 o% d0 h+ J: M
9.             buf[i] = self.data[addr + i]
   
10. 
    4 H' ?  C3 j" h$ s. n* t
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    * p; \6 _& w% d/ _+ [& c. V* V" a" R
13.             # do erase, then write
    ) s; x1 G3 Y% H" i
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    , d1 t# V; r' }" y
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
      H3 p) q$ h9 i8 r
19.             self.data[addr + i] = buf[i]
    1 c( U7 z( \- e% Y& Q
20. 
    
21.     def ioctl(self, op, arg):
    & e) D- H. P- g" U5 F9 ~
22.         if op == 4: # block count
    5 [" U! E' {: R8 H" H9 J
23.             return len(self.data) // self.block_size
    , b/ F) B) u% x( ^
24.         if op == 5: # block size
    
25.             return self.block_size
    & u9 J) q  X% _) l+ T
26.         if op == 6: # block erase
    
27.             return 0

复制代码

7 L' n! A" _$ J* l& S" M# I3 ~; f
. y9 K6 c1 r. j6 p

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

1. import os
   - ~. z* v" y# U
2. 
   0 q9 S) j8 [3 F$ R1 p
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   7 G; l0 v. L$ R# e! K- E1 e2 n
5. os.mount(bdev, '/ramdisk')

复制代码

) l# a& Q/ {! L% v

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

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

复制代码

0 g; x* p* w9 o% c* e/ Q3 d


. S0 x; @8 a! P2 ~
* z. B2 x0 z" i9 m. A! \文件系统

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

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

& }8 @* w: P5 z/ S( p$ AFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   7 q' C, v$ [& t, V7 D- X% I" X% Q1 k
3. os.umount('/')
   6 f! f' @, I/ m6 w+ j3 Z
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   ! f3 a4 v, Y+ |/ G7 r
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

6 ~8 }7 p8 c1 @  ]3 R) o; x8 h, c3 ^
Littlefs

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

笔记

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

' T, t0 r1 O( q1 q- x8 F

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   5 i% o' n6 l* R; e
4. os.VfsLfs2.mkfs(bdev)
   9 A* y7 b: A& P+ ^2 T/ |
5. os.mount(bdev, '/')
   ' c( y/ p* S& X: k
6. 
   
7. # STM32
   : `, f$ e9 y' o
8. import os, pyb
   9 R& \) b  F7 b) Y! D1 T
9. os.umount('/flash')
   5 g. Y5 O3 V  Z) P. C) {
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    ) e- A: f1 I7 _) S
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

$ u  s. b; W: w+ n2 y

9 g1 r! ~7 E/ e: B( p. B
混合 (STM32)

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

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

1. import os, pyb
   3 Y$ |, H9 n0 W
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   ) q8 Q' N% y% W$ ?; y/ @
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   : _  a0 m: l- F* \- c1 F
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

7 _5 W1 `" H) W, G" P8 g  b9 h
% U& U% Y5 s# p4 y% s) @6 k; w

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

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

1. import os, pyb
   6 q: g  ]8 p  q+ o
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

2 e* w1 r) B$ b* ^; H! h
! F: ?2 Z  e# v# T' R3 x

来 boot.py挂载数据分区。

" ?$ s' d* X7 w, Y2 j混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   + l6 X; y4 E  e4 [. e
3. os.mount(p, '/foo')

复制代码

% Q2 H" a( Z/ L+ x8 K- {% F. Q

! E; i, J$ k5 b- d1 ]
% |3 f- m+ e! J0 _( l8 s- `8 ~
8 ]" ?* j: `- g+ J; e. V