使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    5 J: W9 G  i9 r- H

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        / e/ M$ p0 P5 I

    • 自定义块设备

      
      ' G' R4 N  x3 M! z$ W1 X( Y

  • 文件系统

    
    . D! @4 N6 r: H6 n) \6 a+ l0 F

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      ) |6 M+ @, c6 @1 x7 r9 a2 P2 G
    
    : e7 s, G: L, g5 T& R
  
  

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

: v+ @1 R: W+ t; |5 j7 a: ~块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

& Q: l. Q: w8 _* Z# kESP8266

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

: [1 ?) X! R3 \$ j: UESP32

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

自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   . x' i6 h* r* z
5. 
   
6.     def readblocks(self, block_num, buf):
   & `8 z+ Y2 }/ _3 l
7.         for i in range(len(buf)):
   ! T  G; g0 Q6 e2 w
8.             buf[i] = self.data[block_num * self.block_size + i]
   ( t9 I3 s# T+ |. u6 L" L6 \
9. 
   
10.     def writeblocks(self, block_num, buf):
    & R  E5 ]/ c( v; x( f4 \! k
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    8 M* ?4 O# Q1 N
13. 
    - D% Q8 U9 B) ~8 u
14.     def ioctl(self, op, arg):
    % K- I1 E# Z1 R9 G8 D
15.         if op == 4: # get number of blocks
    / E% u! S0 B" H- x
16.             return len(self.data) // self.block_size
    ; R" X( _* V0 Z* m/ Q2 T) @% @. ^
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

/ a/ I0 Q4 [+ [9 u- k3 L, l

- v% n1 D. ?2 U, ?

它可以按如下方式使用：

1. import os
   - x  b3 Q7 Z% b' p% a. r; J4 c# V
2. 
   ; v6 p0 N8 Y6 d( m3 g1 I8 q0 _
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

7 V  G  S2 k! [  v; F) Q

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

1. class RAMBlockDev:
   8 w  v# w+ f; @; H" y0 x+ N
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   5 _$ ]5 m( m8 I! T+ N1 D: G. D
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   / d& f* j$ I2 i" X8 l0 C
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   ( V( x% f+ J" z' }8 }
10. 
    6 F" n1 [9 T# z# T' p. c+ V$ u  h
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    + V& p' x' u4 C* v' ^  P3 a
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    ! Q- L; s7 m4 w: P4 \- b
18.         for i in range(len(buf)):
    3 O4 [+ h# l) G+ B& @& M
19.             self.data[addr + i] = buf[i]
    ' ^. \# w& i+ v5 ]
20. 
    
21.     def ioctl(self, op, arg):
    9 L8 w  m; l$ {  R7 G( ^
22.         if op == 4: # block count
    6 L8 [2 T& m1 y3 V
23.             return len(self.data) // self.block_size
    1 ~5 u/ p8 Y+ I9 c
24.         if op == 5: # block size
    
25.             return self.block_size
    : l3 [+ \( q; ?" \$ E' x. V
26.         if op == 6: # block erase
    
27.             return 0

复制代码

- u$ q1 I  z. w( x4 [* t

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

1. import os
   
2. 
   8 k: |: t( f6 r5 l* y0 P: w/ Z4 ~' f
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   + N+ K- p' ]+ P$ g- o  K4 p
5. os.mount(bdev, '/ramdisk')

复制代码

' s; p; B! j+ V0 U/ B. E
2 X: H8 O+ u  q0 K* X

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   ) m! A" [' c" E/ F* @& x
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

* D" }8 G! U2 H3 N6 d) V' q
" T5 ~& J5 x# s9 [8 l7 @+ _' {

7 v5 W1 j5 {& Z* n( p: y2 f. ?: b
- n/ e; Q! [" y. `0 _, ~* A' 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('/')
   
4. os.VfsFat.mkfs(bdev)
   5 F  T! Z+ W3 m& T4 N
5. os.mount(bdev, '/')
   5 ~' @: J3 M; m% }$ s
6. 
   
7. # STM32
   # I) `, V3 e* B+ I
8. import os, pyb
   6 X/ |0 d  `& X/ W9 f5 |9 w8 i
9. os.umount('/flash')
   5 x, u' L: T, K" Z. S/ A
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    0 W1 m! c- O/ I/ k, e; k
11. os.mount(pyb.Flash(start=0), '/flash')
    1 ]4 A2 I; _7 l
12. os.chdir('/flash')

复制代码

9 y" X0 |: r0 \2 E: ^4 {4 U( E
' [2 E+ z% {- [+ h
# }$ k0 D) h; L: z: B$ l( m
$ P' N* K, O3 \2 i2 G3 ^, ]Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   # D! A/ C. c! B5 k! i1 b6 ?
2. import os
   - e9 V2 h6 Z* e( g2 S
3. os.umount('/')
   6 R2 m; P! E+ |+ P3 o2 @1 Z# f
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   9 |+ v/ N: `2 X
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

! _# j" O1 g* p
* e0 B& N: ]2 k& U% {9 I
6 y3 w8 Z& J; r& g4 C3 W! R
6 p1 R. Y. w, o( {9 `混合 (STM32)

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

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

1. import os, pyb
   5 P6 {+ `* u, ?8 N5 x/ H- Z
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   8 p% W+ |1 z* O& x7 Z1 ^
4. p2 = pyb.Flash(start=256*1024)
   * P& H& h. v# K( D
5. os.VfsFat.mkfs(p1)
   # e4 T; u- U6 t" `
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   " k# \8 z) y8 @- A( |
8. os.mount(p2, '/data')
   ( ]# I- E; u2 N; ~5 \7 u1 I' @3 k
9. os.chdir('/flash')

复制代码

! B7 g& f' \4 L! ~% }; N
8 A# [4 f# d, I  u: O/ [

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

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

1. import os, pyb
   $ Z3 J5 I+ H- m1 h% {
2. p2 = pyb.Flash(start=256*1024)
   , D5 g1 r9 D, Y: y
3. os.mount(p2, '/data')

复制代码

4 P! j9 t6 z: h: x8 u( W1 n! o
0 R7 c6 p1 I5 L

来 boot.py挂载数据分区。

' K- V) C) I& X+ C1 h+ L混合动力（ESP32）

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

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

1. import esp32, os
   9 f/ G) o! F% C. L
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   , R0 i6 u, N& T- P( e  f/ ~
3. os.mount(p, '/foo')

复制代码

# D' ^8 e6 v+ `+ i: ]0 v


' n5 Q$ U/ T9 L1 I8 y$ o