使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        ( T5 f/ I  d+ b8 s, f

    • 自定义块设备

      
      

  • 文件系统

    
    , p3 x2 W; l& X4 k8 _1 W

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      : q' M8 P* p9 J/ S6 ^6 Q
    
    ( w8 i0 T+ I1 E
  
  - N, x+ Y& a; [. L; a

本教程介绍 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指向默认分区。这实现了扩展接口。

8 {: y& }; X" V8 _+ \9 u& e
+ s. e: O$ {4 Z! Y自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   * f6 o. Z; H1 Y7 v3 Z$ d
3.         self.block_size = block_size
   9 F8 |: [" N; ]6 w. a- v
4.         self.data = bytearray(block_size * num_blocks)
   1 l- n+ M- m  f6 g2 k* N  _+ R
5. 
   
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   0 N8 M% [' B! ^4 B" ^
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   ' W) ^& E: _: m3 X* |9 r( b9 `
10.     def writeblocks(self, block_num, buf):
    ) O# z/ M- k" s3 l. Y/ Q) Z+ G: n% W
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    7 K  q$ Z0 D7 T, {2 _' F3 M; C9 w, u( v
13. 
    
14.     def ioctl(self, op, arg):
    . z; G/ e* u+ Z1 Z- k
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    " |# L" l: A( V% j6 l' W% B
17.         if op == 5: # get block size
    3 T* ~, Z& w4 A
18.             return self.block_size

复制代码

3 n/ s) L1 K$ L% I. ?5 b1 }" {6 M1 y
, i3 H7 W9 |) }  r! H* A

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   + |( @5 I9 r0 e
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

9 A9 r0 E/ `. O& `! Q- m

) \; [+ N' ^/ ^

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

1. class RAMBlockDev:
   9 a; {7 J% R$ U& u& \- h  ^
2.     def __init__(self, block_size, num_blocks):
   $ B- ], J$ W, Y* I+ r# ?, z- X
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   ) V+ B, S0 }: Z9 J- t2 w% }8 |$ \" f
5. 
   4 R3 l4 U) c1 G6 N' G; `; g
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   $ n* C/ u0 K6 |* X& `
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   1 P+ d# F9 Z! B0 N) N5 Z/ k4 M: w2 j/ Q
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    ! o% G- f; g& ]+ z4 o
12.         if offset is None:
    ) G6 s1 {8 d0 L6 I: Z
13.             # do erase, then write
    7 b; O9 Z6 d  v$ J
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    1 I5 H( m  [* ^* g
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. 
    3 G+ Y% x* O/ I* |6 D. u2 B" j  w
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    + c  \3 D- A9 F2 l& _  I
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

2 x' t4 _) T7 P* r0 ]0 B

( q$ Y0 V& D& ^0 x0 H# Q

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

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

复制代码

) ]: n' S' Y8 o# D- K

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   & [! i5 ?  u. ~$ b  Q' ?2 J
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

" H6 q. ?/ ?: s0 I4 y$ d- r& @
0 b, Z0 G9 r) X* h. k4 J


: {3 N! N  {" V/ B- o. W9 E! t- Y文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   ' M0 y) v8 o" q. {. O/ s, z
2. import os
   , J, q, j" I7 Z4 r+ o
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   ; ~" G3 Z. \; p0 b$ g
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   - H& ]) S  V9 H
8. import os, pyb
   - P$ o- u: g. m' W3 t  J& r
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    8 O' B7 a! J# h! L' L6 L2 F& ?
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

; l4 _; |9 }$ {7 L- G, ~* {" v
  S1 Q0 G6 h2 B, T! J; u
" |# P: q5 a. Q) Z& A  _3 u, N
8 ?. c1 N" ^9 C, G% T9 t8 jLittlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   1 h0 Q9 K+ ?; I! e5 [7 J  m
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   , _" ^9 f; K: k! v' ?
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   $ q: m; Z8 G3 @0 F( B
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    ! R$ ~+ x5 h' I1 d- v3 t' P3 p
11. os.mount(pyb.Flash(start=0), '/flash')
    9 p% D& _6 d3 |* _/ L
12. os.chdir('/flash')

复制代码

7 z, l& J+ @6 C7 E

4 w6 A+ S$ d+ }) B/ f, L: ]; a
* ]+ C. z9 O) _& j混合 (STM32)

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

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

1. import os, pyb
   7 C; X$ H: U; W" x2 e1 u
2. os.umount('/flash')
   1 ^2 {( T4 F7 @0 I3 |
3. p1 = pyb.Flash(start=0, len=256*1024)
   - q) j& Y; J8 A+ _5 Z
4. p2 = pyb.Flash(start=256*1024)
   1 E8 P; c  i& l# h  ^: ?5 [
5. os.VfsFat.mkfs(p1)
   * n4 \; u* @5 E1 d/ c
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   * g, Q& u+ j/ Y+ \4 \4 ~
9. os.chdir('/flash')

复制代码

. ?, T' E! d$ ^2 e& v/ S; o3 I" o! f
/ ^8 @8 U- {9 ?

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

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

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   & s- T2 ?6 J' m% }/ `
3. os.mount(p2, '/data')

复制代码

: _, q+ B; O0 n1 V
* ]4 z) P/ J! k$ `- ~
+ _, @. ~# N7 O4 k" j  e- t! r& C

来 boot.py挂载数据分区。

8 D5 k4 P9 {# o" v1 x& ?6 g% N混合动力（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')

复制代码

! [6 P7 o0 z& B7 \7 A. G


0 p/ g" P7 a6 ~! {8 T" M
/ d0 u% E" I& _  G% `' C6 g; N
* Q- x# I" v+ z3 [1 G) l* j