使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  " j- Y2 m4 Q" b3 S# B4 b

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        9 S% x: s0 L8 N7 ^& C# }

    • 自定义块设备

      
      * _4 ?9 b8 r# E  a8 n9 H

  • 文件系统

    
    ) a8 J' g1 e$ r& J" r6 M1 K- ?

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  

8 {, F9 s+ s5 `) z/ w

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

4 ]2 j' y- i, t块设备

块设备是实现 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指向默认分区。这实现了扩展接口。

+ J3 L3 o6 ]( z% b: s4 [; x& ]& \自定义块设备

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

1. class RAMBlockDev:
   3 \+ R) x  I+ o0 F( z
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   . n. E/ k. ~, M4 g- r; f& t2 u
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf):
   : s; B; z1 W( j
7.         for i in range(len(buf)):
   : M9 t( {0 Z% q( B
8.             buf[i] = self.data[block_num * self.block_size + i]
   0 V1 A, p' `; I2 Q1 ~8 k
9. 
   ) r  ]: `4 L7 e  O- s' U$ H
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    3 [7 s  E% M+ l" A! I
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    : _5 F  \) b4 B
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

3 c- y0 Q! P7 P
6 C" s4 C5 ^/ F' r* i
  S9 s6 h0 o& A  }$ {* K2 H* h

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   ; A3 e0 E. c7 D/ w2 k
4. os.VfsFat.mkfs(bdev)
   4 q. p2 v1 f3 V: q7 {% z; O- _
5. os.mount(bdev, '/ramdisk')

复制代码

+ Y8 z/ J  D. l& q
6 X: ]- P4 a( w) V! m

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   & {( Y0 [! h5 R' e. _) x
4.         self.data = bytearray(block_size * num_blocks)
   & l. `  a. @3 W, t% j8 p' H# ^  Q
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   % X1 v) o, t4 d9 Q8 ]
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   1 w! |/ n' b% N/ B+ @
10. 
    9 ]; j- g$ w  b: o) H& G& e% E
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    * E+ D8 v2 Z' }- P# m' p$ k
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    5 b/ L) z* i* P& q
15.                 self.ioctl(6, block_num + i)
    5 m5 U" E4 L# \$ _. s/ Q% J
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    
20. 
    * B6 q- {; N1 V- a! W8 {. w# l! w9 D: ~
21.     def ioctl(self, op, arg):
    * |! R) ~3 B9 d6 R- J" w
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    ( B5 D) t; k- \+ x  b
25.             return self.block_size
    
26.         if op == 6: # block erase
    ! Z1 u5 Y* b) f$ x% l, Z7 z, e
27.             return 0

复制代码

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

1. import os
   ' K, C2 x/ G8 k5 X- A! l: A
2. 
   & D# q+ `5 P9 g/ s! x& i
3. bdev = RAMBlockDev(512, 50)
   . r6 I' Y9 ?  d
4. os.VfsLfs2.mkfs(bdev)
   6 w, s/ N7 _% h" J& i
5. os.mount(bdev, '/ramdisk')

复制代码

7 t$ I* G4 p5 z$ m% X

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   ! q# U( U# i( }) E
2.     f.write('Hello world')
   # C3 u! f( B1 W2 [
3. print(open('/ramdisk/hello.txt').read())

复制代码

/ X7 {/ Z! c3 j( J  l# Y
! |2 p+ m$ K# u0 S文件系统

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

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

+ E6 v. K0 Q1 Q+ gFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
     _  s' e# A2 ?/ ]: B8 n
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   ! t: {) \; ?. s# Y
7. # STM32
   5 T7 L! ~0 r+ h* R) o" k
8. import os, pyb
   ! ?  |$ m) Q9 J& t8 t& s4 X
9. os.umount('/flash')
   $ u8 A" J. y5 M1 ]0 x4 L" t+ F
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    $ ^: K$ W/ X; |6 c. T6 c$ k, A
12. os.chdir('/flash')

复制代码

! \8 k/ N. V3 W8 w. E
' p: F- [/ g' @- X3 e3 p
. \$ I! \' f7 j& `
1 k. }' d: K+ BLittlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   0 t- C( k. n. J( M
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   9 k0 s( U: `) G$ }' W7 _" D7 W
5. os.mount(bdev, '/')
   0 r, m" A0 X6 p: g/ J' h$ N( y$ }
6. 
   0 x, R% u( b" T" y& a
7. # STM32
   % k  Z* K' L6 l
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    ( A% Z# ]+ k2 X$ i! U
11. os.mount(pyb.Flash(start=0), '/flash')
    % @* e& _# O) Y2 s- Q0 G
12. os.chdir('/flash')

复制代码

混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   * f, o) M" P$ q5 H! I' d' n- s
3. p1 = pyb.Flash(start=0, len=256*1024)
   - E2 H' P: Y0 z: S
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   " R* w# R, \, P& G. m
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   8 ?- B5 M, A" Y# y7 h; ~% ^
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

5 J  O; {, _. e! p
' j8 E4 m+ s% z6 G3 w
% c& k2 w, B/ l9 i) F% [/ f

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

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

1. import os, pyb
   % [3 a/ G5 [: c- A& X. H8 o
2. p2 = pyb.Flash(start=256*1024)
   $ C5 P6 |6 W6 R9 `" D4 U
3. os.mount(p2, '/data')

复制代码

/ c. |# m" g. W! d
7 N0 k. d' h0 o" k& @
  D2 S- U( e5 J: C$ Q

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

; `' Z1 L/ s2 q3 E
  Y* R: w* d2 Z( g, U
+ M& Y2 E* v2 E- l5 P) J