使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    ' m1 q+ a. t8 i5 @3 v4 e1 U( L( g+ b, p

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    " l; s" \/ ^( T* j4 u# D" z( M

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      7 w  k9 Z3 G' o
    
    
  
  . \# g9 ]  v3 M1 j' E& d2 }

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

6 {# Z4 n' @; r! u( zESP8266

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

ESP32

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

( I: v6 {' Q3 P) [9 [
自定义块设备

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

1. class RAMBlockDev:
   0 ^; \" e- Q# U% q5 r1 m
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   + b) \9 ~3 u' {; v! R7 u
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   3 @5 @/ |% e" g/ o! @7 N! h
8.             buf[i] = self.data[block_num * self.block_size + i]
     e( ^* r6 R+ w: u" q. F, z" U. m
9. 
   
10.     def writeblocks(self, block_num, buf):
    # s1 O; Z( V' r7 H
11.         for i in range(len(buf)):
    0 N$ U9 c2 D+ W6 n6 l$ [2 J
12.             self.data[block_num * self.block_size + i] = buf[i]
      l7 X; h2 j% M# K) L( G0 }
13. 
    
14.     def ioctl(self, op, arg):
    
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

复制代码

3 X- b: |% Z7 |8 `' ^* u. c" c) L

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

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

1. class RAMBlockDev:
   # z! G9 W' [- J6 b
2.     def __init__(self, block_size, num_blocks):
   ) T9 w( r! X! U/ [) s) e
3.         self.block_size = block_size
     L4 R+ e, ~+ N4 \3 u0 Y
4.         self.data = bytearray(block_size * num_blocks)
   , M' f5 m6 _' a' @' V
5. 
   8 `( ?5 k  V! ?8 i
6.     def readblocks(self, block_num, buf, offset=0):
   / p+ |* I5 G, V
7.         addr = block_num * self.block_size + offset
   - f9 R" S7 K' F9 A5 K/ J
8.         for i in range(len(buf)):
   0 S/ a2 f/ c4 h/ l% X
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    & ~2 \' R" y, y: ]. X5 R
12.         if offset is None:
    % r# i* I1 a5 s3 F& g7 Z) D3 @
13.             # do erase, then write
    ' J; Z8 {4 F$ K$ X
14.             for i in range(len(buf) // self.block_size):
    5 ~0 P$ C2 i  N
15.                 self.ioctl(6, block_num + i)
    $ N4 P& w* o; r* Z4 E, o9 V
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. 
    ) J3 w) y+ z$ A6 W4 y
21.     def ioctl(self, op, arg):
      }# G: y: E! H! j
22.         if op == 4: # block count
    ) l( C# P+ |: b! s
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

4 E" n7 R: a+ Y6 k

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   - p' w+ G$ {& g6 Q% {! H
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

, |" W3 F5 D. W2 N% Z

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   0 F  V7 e* R: @( x' P3 a2 W
2.     f.write('Hello world')
   # f$ V' @5 C& M; c4 I
3. print(open('/ramdisk/hello.txt').read())

复制代码

" B9 i1 O7 f% i7 p: C
0 @" w7 F: {+ `1 b6 Y

文件系统

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

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

3 K2 Q: a  E! {2 h0 J3 v5 sFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   $ C: ^' Y% C& o
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   ( ]% Z" ~, C# O6 t7 d% m6 M
6. 
     }$ M0 b8 l/ Y2 w/ d1 u6 Y
7. # STM32
   
8. import os, pyb
   * n/ K5 i  ]+ u
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    ' ]( K; N, Z: z+ X, |& ?
12. os.chdir('/flash')

复制代码

% [6 O" N3 e. n: r0 a/ a
) I* d; D/ q" _  Y
6 ?( Z+ X: X9 c/ V9 W
) y- n) E0 L' M; f5 a4 dLittlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   & s" K; f3 _2 R1 S) B% L4 e1 G
2. import os
   9 {: ~& a- Y9 Z% y% Z
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   * D( `# T3 j& s/ x& ~3 J6 ]
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    7 k0 N& @" e1 R; Y' h
11. os.mount(pyb.Flash(start=0), '/flash')
    ' e/ Y8 o! i' N; y1 Q8 D
12. os.chdir('/flash')

复制代码

; @- z: g, m& f0 K$ m& D" ]9 k. w
) I* B! i; {' k+ }0 V

混合 (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)
   
5. os.VfsFat.mkfs(p1)
   4 h" w3 |' V$ C8 j  P- v
6. os.VfsLfs2.mkfs(p2)
   " L: \* e4 A: O/ e( z, Y8 V
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   " }- w9 H0 p, O
9. os.chdir('/flash')

复制代码

* ^7 |3 X# @( v. z" Y

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

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

1. import os, pyb
   " V+ v9 B6 D3 R, F- q5 e2 ]
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

: u( R; E8 s  [, V

来 boot.py挂载数据分区。

( H, B9 F- ]1 J; \; d* W混合动力（ESP32）

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

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

1. import esp32, os
   : K! x% E) m1 h* J, S5 k
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   / X8 r, h3 J( j6 {3 `! `
3. os.mount(p, '/foo')

复制代码

' E7 V& {) \- k6 W
  u$ r; I7 w) ], |
  Q( K6 y# q/ P: V9 x8 Q

* R  w; U0 L2 {/ p