使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  & N$ o1 ^6 u' x: c+ M' U7 j

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      5 ~8 z9 }! ^) u1 m; F1 O

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        4 t+ N3 p! A$ L! o, D

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    4 e9 T5 C' l+ k4 u  Q7 d
  
  & g: |+ Q3 _* D1 g% p& p

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

! I  D4 g( P" z9 g! ]块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

4 e' q9 x, f3 S: |, QESP8266

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

ESP32

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

. O9 B7 U  k. f+ [+ d
' w0 o: }; w# X自定义块设备

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

1. class RAMBlockDev:
   , F" @5 |8 H/ z6 H# S
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   / _0 ~5 N6 T0 @# ^, m& Z: \
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf):
   0 o+ J. T6 p  S' k. x6 S9 U
7.         for i in range(len(buf)):
   3 o% v6 q0 R3 \. X4 S- u  U5 ~
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   6 ]; q' C6 R2 P4 _/ S3 c1 w
10.     def writeblocks(self, block_num, buf):
    ) B# l$ I4 y* J' F& [
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    ; P% l+ ?- h! @$ ], ]. ?6 i9 }, i
13. 
    
14.     def ioctl(self, op, arg):
    # M8 {2 k' t  J5 d0 [+ L
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    . s( r+ `8 S* n8 P6 q! ?! e) R
18.             return self.block_size

复制代码

% A  \4 K) w) a; u- C/ d' H; y2 Z; A
9 ^5 f" e; ^& _- Z* \7 q
: ?& j/ l4 t$ k* U  t- h

它可以按如下方式使用：

1. import os
     N; t) _8 I$ b0 ]6 ]  U
2. 
   - j* A9 _  z# l2 g* E
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   & y  ^! x6 v: g+ p5 U/ A
5. os.mount(bdev, '/ramdisk')

复制代码

# u4 O' u0 @4 H( l% p( Q" b
1 @8 I" z9 n$ z- W* i3 S1 w& C7 t4 E9 t

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   + o: M4 l2 ^" b
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   ' r/ O4 z/ f/ [% @# G
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   + x) g+ [9 M& \- ?8 u% y- r
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    4 \; E0 h9 X& q1 j" R
11.     def writeblocks(self, block_num, buf, offset=None):
    0 `5 l8 C3 ^3 k  `2 h
12.         if offset is None:
    9 p( |3 ^* A9 R0 N2 s
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    ! Z- E, x! ^7 U8 r% S3 ^
15.                 self.ioctl(6, block_num + i)
    
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. 
    
21.     def ioctl(self, op, arg):
    ! v& p- Y& F0 |1 Y7 V; V2 M
22.         if op == 4: # block count
    9 w! K) d: A% E3 [. S# S9 K
23.             return len(self.data) // self.block_size
    - g# w# _( G1 n
24.         if op == 5: # block size
    
25.             return self.block_size
    % z" h( K) m  U7 X* I
26.         if op == 6: # block erase
    
27.             return 0

复制代码

* L" H& Z. ]  y1 }9 z

- s2 v9 h" i8 s, M# ~9 }

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

1. import os
   & X" h" w) U. I9 c
2. 
   ) C# I6 f  r5 E: G- \& E6 \
3. bdev = RAMBlockDev(512, 50)
   * c9 X( K, b9 C/ F8 u
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

' N" H6 P/ ?5 W; ~% l- ?4 p

/ g7 R  G& s* @7 k

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   7 U0 R1 d- e$ F* I( N
2.     f.write('Hello world')
   4 `5 J1 M& q4 F4 W& o
3. print(open('/ramdisk/hello.txt').read())

复制代码

; \/ T$ y  o; A2 {+ E* @, I+ c

; x! H7 f; A6 Q5 X4 J% D. a3 I
文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   8 G; B0 R$ {& j* f' e
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   * m6 }% E6 j& f
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    8 L/ y% {8 \2 ?% d7 b1 I
12. os.chdir('/flash')

复制代码

* i9 ]1 o6 [- _; T1 u. f9 g

9 q' s  b) I" xLittlefs

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('/')
   
4. os.VfsLfs2.mkfs(bdev)
   . F* ?( P3 e6 b, q0 S& l( \& c2 H
5. os.mount(bdev, '/')
   # v7 ?$ l+ B$ ~6 R1 L
6. 
   7 ^& R8 e- s5 e  m' X) B
7. # STM32
   
8. import os, pyb
   # d( {3 o' R- R0 j  B  [
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

+ z1 b, \4 o1 U' m+ L( r混合 (STM32)

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

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

1. import os, pyb
   ) K' W# A9 H. n- a' C
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   / p* e4 W2 r$ x) y
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

$ G* {4 M5 V/ K7 b6 v
" P, c0 ]# n/ W9 b/ E9 o- E* V9 T

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

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

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

复制代码

3 {, I, j( P4 S1 ~# F

( H# w* v5 [% q( M9 x7 B

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   4 P1 E: H( ~& K7 T2 X
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   5 q, z8 S' m8 m. N: j# T  W; c' g6 Z
3. os.mount(p, '/foo')

复制代码

8 F7 W+ s6 o0 I2 T3 i- X9 b# `
8 Y3 s+ _5 e  Q" z