使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  0 `# p- Z. L3 o' S4 c: _

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      $ o. U- e) G4 j9 T

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        , W. |1 y$ Y$ k+ w8 f. X( k. D

    • 自定义块设备

      
      

  • 文件系统

    
    ) z& j, T: g1 G

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      $ w0 z+ M; e6 g. I
    
    
  
  

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

/ a: ^: H1 D7 k# P# g# N7 ~块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

: L5 Q& L2 t3 [. V& zESP32

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

自定义块设备

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

1. class RAMBlockDev:
   * y3 l# n! }; S1 O
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   # K6 P/ C' G9 k/ s
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   ! s* ]3 U; g) t, x
8.             buf[i] = self.data[block_num * self.block_size + i]
   ' z0 ]2 u* Y5 ?% p! X' ]3 ]
9. 
   2 a$ _2 X1 @3 r3 f1 c* g8 ~. W
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    / F5 n$ v# B) p  b$ a5 T/ h/ [
12.             self.data[block_num * self.block_size + i] = buf[i]
    ' S6 `9 O4 o0 {1 K& H# k0 W
13. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    3 L$ @3 d1 X% I  V" U5 t' Q# s: `
17.         if op == 5: # get block size
    3 N! x: |* j1 ~& o6 e2 {
18.             return self.block_size

复制代码

& @) ~5 u, p" ?6 C7 A  g3 X
' Q: T+ l5 S, ^' @/ w2 R7 Z8 U

它可以按如下方式使用：

1. import os
   
2. 
   ; h+ D! {& [4 k' g6 _
3. bdev = RAMBlockDev(512, 50)
   7 B  Z: U0 \7 H4 ^! ?' E; Z# g
4. os.VfsFat.mkfs(bdev)
   : W+ x* ^9 a! T' e
5. os.mount(bdev, '/ramdisk')

复制代码

9 C% D0 X0 a8 N% |, }- ]
3 z; p# c$ X* h6 r' U5 t

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

1. class RAMBlockDev:
   1 E* @! U/ Z8 j8 B3 Y1 Q
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   % ~: D; o* r2 ~' N% z" Y; u5 W
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   & t# K& o0 M( _7 k& Z8 {  T
6.     def readblocks(self, block_num, buf, offset=0):
   $ K1 u, p: |! f' F/ S3 \: |' ~
7.         addr = block_num * self.block_size + offset
   , b- k: W2 g; t$ Q
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   6 E; ]* C+ Q* z0 J& C9 @
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    $ k5 c( [8 j$ ?4 |; {: ^! U
13.             # do erase, then write
    6 f9 d. D6 _7 P4 I
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    0 d+ d4 b0 E+ _0 q1 x. ~
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    ' i. R+ T  D8 o% x3 `' c
20. 
    & `  H0 H) Q- v& V) }8 B
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    1 ^2 O) |( U2 g5 P, O: q+ G
25.             return self.block_size
    
26.         if op == 6: # block erase
      y& B9 i* S( Z* @: |
27.             return 0

复制代码

& o' }6 g  _2 O9 a) s( p1 }

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

1. import os
   , k$ d: M# A7 M3 C% S" n+ D1 R
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

' }: ~! h- ~, l7 V" {- k9 j& {( i

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   2 i% U" X  C5 r- Q7 |* j
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

$ ?- o. n- S* q2 Y' G+ `) E0 y

; K* A7 G( g" v0 X$ V0 S  a3 p1 n1 u
5 @. G( t# I8 j, E+ y
文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   1 D" _( U, b1 P) P, R
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   2 I# n8 t, w5 n- Z
8. import os, pyb
   % C' `3 z3 c" S0 R- |' K! p1 |+ T
9. os.umount('/flash')
   " M; [: F( B7 A0 z, P- o6 w; T
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    6 d/ Q4 D, o1 u' ~2 T
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

: p. }2 D( g* [; r! o) M3 Z


Littlefs

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

笔记

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

# p- F9 P* U" D6 ^, C, O3 d

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

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

1. # ESP8266 and ESP32
   5 m; i+ L4 y) O  W- J( f' @
2. import os
   . U, C9 q; V! x; j% U5 u1 o
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   4 Q) \: c5 E8 x1 i
5. os.mount(bdev, '/')
   - V3 _8 ~9 O/ v
6. 
   8 P$ }4 C) q/ ?* K3 g* f
7. # STM32
   2 W: Q/ c3 V6 n( I0 K
8. import os, pyb
   9 M# b+ {& S" W  V& W# e3 L
9. os.umount('/flash')
   " o/ u! {$ ^  q" O
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    ) Z4 Z6 [' f! c' ?- U' o& a
12. os.chdir('/flash')

复制代码

+ G5 P% C+ [; I$ X- g  M

混合 (STM32)

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

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

1. import os, pyb
   & }. y  y+ u% e$ F8 M) _6 z
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   2 `1 P5 P1 }: P5 K7 P4 N
9. os.chdir('/flash')

复制代码

- j9 i% R/ |+ X/ @5 ^6 h+ f
% V, j* e7 |9 f/ A$ U6 _

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

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

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

复制代码

! b3 X2 k( `# e
( j8 h; i& O$ x# U/ f8 G

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   3 z: O, Z8 L7 R- W" l6 s( w6 y( o
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

' k' d, n/ A7 p' E3 |0 a$ I7 G+ Z
! K( k8 P3 D) F1 Y4 j. b

% r: k& J& x) `- t: \1 g

0 }0 k- [$ B# o5 u- k  d& P# L# m