使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  8 [6 a' n0 G( `: z

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      . I# c* x" b- ?% U) p

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      1 M+ x1 B; u- K0 C
    
    
  
  

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

ESP8266

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

ESP32

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

6 S  k: ~  z: F7 E( F
+ I) K2 E$ u" J% P: r自定义块设备

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

1. class RAMBlockDev:
   0 S1 _8 D" u, Y
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   : k" N; G$ e$ @) u4 y
5. 
   
6.     def readblocks(self, block_num, buf):
   + X/ a% ]+ u+ B! P% s
7.         for i in range(len(buf)):
   2 ^7 J, r: R/ Q2 J1 F9 T2 t
8.             buf[i] = self.data[block_num * self.block_size + i]
   4 j2 y1 Q5 {2 O' f; B& h9 k& X
9. 
   
10.     def writeblocks(self, block_num, buf):
    5 D/ ~# l2 Y. N
11.         for i in range(len(buf)):
    : ^5 M9 u8 ]8 J* y  R) X2 q+ B0 x
12.             self.data[block_num * self.block_size + i] = buf[i]
    7 b; g" Q2 v. w3 Z& S, v3 f% b9 j: ^
13. 
    " a" |+ _5 b. q( F
14.     def ioctl(self, op, arg):
    ( u8 z! ?3 q* V7 Y# J5 s9 f
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    : v! Y9 j, E( h- V6 `
17.         if op == 5: # get block size
    $ d0 R; D3 ^9 R5 V5 ^/ n
18.             return self.block_size

复制代码

, I; M8 P* c6 I5 B

它可以按如下方式使用：

1. import os
   5 \0 W/ q6 S* t; F$ w1 U
2. 
   
3. bdev = RAMBlockDev(512, 50)
   # c8 c' g6 r8 a- y: f
4. os.VfsFat.mkfs(bdev)
   / k/ {$ C4 z( D5 @( w8 H
5. os.mount(bdev, '/ramdisk')

复制代码

/ j. X' Y$ |- U2 a7 @

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

1. class RAMBlockDev:
   , q- C8 ]* C/ P
2.     def __init__(self, block_size, num_blocks):
     K5 E0 o  a# e  w4 v; Y0 _3 Z
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   , Z/ ^. v3 |6 w
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   ! m4 G- c: t# Q0 c. N
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
      O0 T( N* D: V* l$ y
11.     def writeblocks(self, block_num, buf, offset=None):
    ) m6 ]& I( d  m9 r
12.         if offset is None:
    
13.             # do erase, then write
    ! n5 C; M, {9 |( ^
14.             for i in range(len(buf) // self.block_size):
    " z$ H! Q+ R8 R7 m: i
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    9 d$ b1 g8 b, I2 v- r
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):
    
22.         if op == 4: # block count
    2 X0 @- y1 R7 q$ G9 s
23.             return len(self.data) // self.block_size
    . R) Q* Q8 s4 f+ r4 {/ M# f
24.         if op == 5: # block size
    . Y0 E+ a  x- F* M# ]* y, _
25.             return self.block_size
    
26.         if op == 6: # block erase
    2 R* X" x! {$ i
27.             return 0

复制代码

* ~. k# L. K7 D4 G0 K! z8 T

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

1. import os
   4 r' @1 @3 C- |- _+ o; @% `9 c+ h! S
2. 
   
3. bdev = RAMBlockDev(512, 50)
   " s+ n: x3 i$ I+ S# O) F( ]
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

5 |/ A# a" B, |
/ y. s3 E: B' o2 T

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   4 |4 b! E- N; v$ R. i6 ]# d
3. print(open('/ramdisk/hello.txt').read())

复制代码

9 g9 \1 _6 `* ^: U. W

文件系统

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('/')
   " }. `9 @, p) Z
4. os.VfsFat.mkfs(bdev)
   & Y, N4 _9 o0 Q: v1 t0 l! M
5. os.mount(bdev, '/')
   0 M6 }; G* T3 E
6. 
   ! o- ~- n9 w+ q% l- V
7. # STM32
   3 p3 H+ Z1 j& x) I" Z9 n' ~! ?
8. import os, pyb
   2 D% ]" c% p& V7 b* N4 i9 L
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    , Z( v% S7 R, T
12. os.chdir('/flash')

复制代码

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
   : ?, a5 }0 e7 }( M' F
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   " R2 K% J' q) ~, w, w1 k7 H
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   . t) H# Q% }, k' ]7 S! [
8. import os, pyb
   4 `% W8 ?4 G, f) o
9. os.umount('/flash')
   9 @7 s. c6 U1 D" S/ ?: Q9 |% H, k7 w
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    4 @, R# h: n8 r- }6 W8 f( v; Q
11. os.mount(pyb.Flash(start=0), '/flash')
    7 p0 X# [( S5 C% F$ c6 j# s
12. os.chdir('/flash')

复制代码

' E6 D+ R( B' i7 Y

( g2 K; R" g7 u3 v7 m2 Y
# M2 M% c; e# N4 U混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   * {: H& s6 ^; Z2 [$ O, M8 G6 I
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   * C7 Y" c. |, h4 O  [, c
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   ' [0 w( J% ~/ n: [
9. os.chdir('/flash')

复制代码

8 |- e. X* n3 J; Z' B5 C

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

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

1. import os, pyb
   ( X2 h4 F3 i* ]0 S' n
2. p2 = pyb.Flash(start=256*1024)
   " b* x( J" s4 f$ T* W7 W
3. os.mount(p2, '/data')

复制代码

+ J9 `6 ~, ~- L; H5 o) ^' p

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   % G9 L* N+ O8 R& F  k
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   4 p" O- O1 m2 k8 {3 g
3. os.mount(p, '/foo')

复制代码

! S  t3 v1 ?, K0 h8 _$ e( Y




) r5 U& k# e' b