使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    & Z5 _. ^; J0 `* R, Z( W) z

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        - E) z6 c$ y8 s5 }( ^4 `

    • 自定义块设备

      
      & W# [: \2 J9 V. J

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      0 b8 D- v+ R1 A, d' M6 d4 _
    
    : l5 i0 O3 C1 @  J& y# B
  
  

/ Q2 p2 T( t* X! |) Z+ q, Z$ w) e

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

1 P8 O4 h* ^  J5 m1 J5 g- y9 k6 w" l块设备

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

; q2 M- J* {# y* J  j, ^2 R5 L
自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   6 W7 C/ j4 G- t/ F
4.         self.data = bytearray(block_size * num_blocks)
   , H1 ]$ J7 d$ S2 N* f
5. 
   
6.     def readblocks(self, block_num, buf):
   9 C+ W4 C8 W8 P) Q/ o# F$ D
7.         for i in range(len(buf)):
   " j6 k7 |6 L% ^
8.             buf[i] = self.data[block_num * self.block_size + i]
   , H- [' g  g+ w/ t
9. 
   
10.     def writeblocks(self, block_num, buf):
    0 {: U0 H8 y8 w  z: w
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    : `1 {' s! `0 s0 j8 O  }2 i) V
13. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    ) K) l! A3 m2 \( X
16.             return len(self.data) // self.block_size
    # S# g5 \1 H7 G+ k, K
17.         if op == 5: # get block size
    ) Z6 C# e* x1 a3 @" l) a
18.             return self.block_size

复制代码

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   ; d; ]# E; f& x7 [8 Z
5. os.mount(bdev, '/ramdisk')

复制代码

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

1. class RAMBlockDev:
   % a6 @( R0 H4 Y* T  d$ F
2.     def __init__(self, block_size, num_blocks):
   ' I! |* n& D9 z- g6 s
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   / @) O) O6 H% ^( d0 H  j
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   $ x/ D( {% X4 S- `
8.         for i in range(len(buf)):
   - N( ~3 n1 w* q! ^3 n
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    6 W# I! X. l! s% _( n, w$ z1 J
13.             # do erase, then write
    , }, X! m, w  w6 \1 |
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    1 A6 v# t$ K' Z% L, Z! s5 X
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    9 f! |, R: {7 w1 Z. n0 O+ g
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    
20. 
    ' M/ M2 y4 ^% Z7 g  p$ P% h
21.     def ioctl(self, op, arg):
    1 ]% I0 J- B/ p
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    " }! A6 }% G. x' S: L9 S. Y
25.             return self.block_size
      v' h# I3 [8 p) h: c
26.         if op == 6: # block erase
    
27.             return 0

复制代码

5 M2 F- H- a  K

: G  y8 ?& S: {) I4 l1 D& s9 f

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

1. import os
   & d8 M6 {8 X7 Z. {
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   6 ?. `0 E/ R  |% k& W
5. os.mount(bdev, '/ramdisk')

复制代码

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   7 C0 t4 [0 b; f
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

! q: }1 n* r/ H/ n2 l8 q9 }


文件系统

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

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

! i( d, d( ~& e) r9 P  rFAT

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

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

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

1. # ESP8266 and ESP32
   4 D; z/ I+ K, `- l: s* d8 F; d
2. import os
   
3. os.umount('/')
   3 E& e1 K' r- H
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   ( N% E$ o9 T9 s$ v3 X
6. 
   
7. # STM32
   9 v8 H' w2 e7 ~7 U. Q1 J
8. import os, pyb
   
9. os.umount('/flash')
   # n1 _6 k! K  y+ K; Z+ {
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    3 Y' q# I( t, E$ d" Z% i
11. os.mount(pyb.Flash(start=0), '/flash')
    & E# \  |* L7 W* d
12. os.chdir('/flash')

复制代码

3 e0 V  y5 |1 \8 }- I' @

Littlefs

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
   / z4 a$ j4 Y1 B) N1 f
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   ! d7 g! E! x: V$ q
7. # STM32
   4 c0 V7 A2 |$ |7 m' v" o7 `
8. import os, pyb
   0 g+ J1 _% A' x9 p& l/ k
9. os.umount('/flash')
   ' ^; ?( ~8 G  z: n% D1 ?
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    * E* x# L+ V7 V  J8 \$ O
12. os.chdir('/flash')

复制代码

1 d7 J% n( H, V* G" [! v( n4 v
3 F) d/ b5 `2 C* I) Z7 C混合 (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)
   , G2 c% l. R, U2 r! @
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   $ n/ c# t+ R7 C# E" J4 S
8. os.mount(p2, '/data')
   ) t; q) j4 z, B+ H# M4 N
9. os.chdir('/flash')

复制代码

3 W0 S. G3 T* I5 ]/ b8 z) \6 |; v
' [8 }) c$ W9 e6 t9 h
& s6 x& F) j" `9 ?2 M5 t8 l

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

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

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

复制代码

1 ]* `0 A2 z/ ~7 u

2 ]# i+ Q2 T1 F0 w8 [5 P8 P0 {

来 boot.py挂载数据分区。

/ O6 d0 s9 H& }6 C混合动力（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')

复制代码

2 R4 |5 {0 B$ Q2 q0 S