使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  2 R  P7 D. s8 m4 R4 U( s1 }

  • 虚拟FS

  • 块设备

    
    $ ]9 Z; H2 p# ~' I. i) e

    • 内置块设备

      
      / o9 e( i8 |8 Q- Z4 N1 L2 q: Y

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    : b9 o  q+ v* w' J' L

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    & h, J; ^5 f. K
  
  5 n. U1 S2 B* C( t

$ n, X' K) ?  g- {

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

) Z: `4 e6 b" \9 Q. j$ ]9 I块设备

块设备是实现 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 \; _1 Z, d- q
& H' A) s6 }- p: {3 C5 C自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   6 h+ y1 X4 @% S2 D2 i) J
3.         self.block_size = block_size
   3 Z. G0 J7 w& F1 h
4.         self.data = bytearray(block_size * num_blocks)
   % o$ M- l' F# T& R
5. 
   " J6 I# N# S9 O  X
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   8 g) f7 @7 B& D# D- V1 e+ d, B' ~
9. 
   8 ^1 i3 Q0 k9 p
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    0 E# V8 N* g# Y: a
12.             self.data[block_num * self.block_size + i] = buf[i]
    4 Y" }2 G; S% A4 U) o7 J
13. 
    
14.     def ioctl(self, op, arg):
      ?# G% @& j8 c6 i
15.         if op == 4: # get number of blocks
    ! w; ?$ m. j; e' d/ d
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    8 _" B! e4 z0 x- s( R; z8 e7 M
18.             return self.block_size

复制代码

) z& E8 H4 x: Z5 V' T; d

它可以按如下方式使用：

1. import os
   ) D" k& m+ M: _. H9 s4 v( u
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   4 A* O! D. M7 b( _4 u' p
5. os.mount(bdev, '/ramdisk')

复制代码

6 W. Y& t0 K; G
9 P/ c4 {9 N* n! j$ X

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

1. class RAMBlockDev:
   + c4 P1 u* c: J; E) F( n
2.     def __init__(self, block_size, num_blocks):
   , |9 c) p5 }* p
3.         self.block_size = block_size
   - Y: d7 r, |6 E/ T: O
4.         self.data = bytearray(block_size * num_blocks)
   . T: Z6 K5 a) L  @+ U' m, y
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   ! D+ [5 f2 y2 P
8.         for i in range(len(buf)):
   8 v4 S6 ^9 l7 x: M
9.             buf[i] = self.data[addr + i]
   7 b7 F- K! T3 ~1 f1 b7 u& y$ z" b9 T0 W/ d
10. 
    5 `& c2 Z' f: x. p4 j
11.     def writeblocks(self, block_num, buf, offset=None):
    3 O+ ]5 g+ m$ x  ?( ~, n- Y  k7 {; K6 m" ~
12.         if offset is None:
    
13.             # do erase, then write
    4 `/ C# p; x% T5 m, L
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    2 `9 }$ h# j+ m9 C  X
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    & ~" ~5 ~7 N" M, O
18.         for i in range(len(buf)):
    % M+ O1 ?2 U8 _) m! B
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    1 t" r. P: N. F# `  V) ~/ L/ n* S
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    
25.             return self.block_size
    . V% C7 C. o- Q! [8 v+ m" O/ v, U
26.         if op == 6: # block erase
    
27.             return 0

复制代码

+ X& \0 ^" c, R- t" _, |9 Y

* _' |2 ]& z0 v, F& w

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   , T. |! h7 I4 [
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

1 p, m0 v4 f7 P4 f) O2 j

7 d! o$ N  h6 {, }9 o7 v8 x. R, }

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   ' h7 e  p4 N! Q2 Y6 i
2.     f.write('Hello world')
     X+ P0 _8 Y% ^
3. print(open('/ramdisk/hello.txt').read())

复制代码

/ K# |( D. L0 r: T& I% A" j- O2 ^
文件系统

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

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

. `# T1 V7 |( A/ b) U( @" r/ {FAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   $ d4 O6 f6 I7 n% F# v
3. os.umount('/')
   ( b" z+ i* c9 u
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   ) ~* b0 u3 |- b& u" y2 v8 J* G8 v
7. # STM32
   5 U# o) M! n  M* n2 ~
8. import os, pyb
   
9. os.umount('/flash')
   ' C* ]4 S- f) z
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    ' Q. L3 Q8 q2 B. q* Z
12. os.chdir('/flash')

复制代码

, M& j) C6 F* ~+ l  k" |) P
5 j( j1 l6 U' ]. GLittlefs

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

笔记

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

. ~8 h0 |- e. e* Z

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

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

1. # ESP8266 and ESP32
   
2. import os
   / F+ X& I: k$ [7 I% K1 j2 V, X1 L$ X
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   0 K/ v: E3 P# o) D5 v# s
5. os.mount(bdev, '/')
   ( ?9 O2 L0 r) Y! y0 N
6. 
   , j; l' B1 \+ z" l/ ^' g
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    2 w4 i, d: C9 F
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   # ]8 T* k! x6 i% d% H. f
3. p1 = pyb.Flash(start=0, len=256*1024)
   2 e( a5 n3 C& Z# G+ a, n
4. p2 = pyb.Flash(start=256*1024)
   # m5 v9 J1 `2 j0 F  N8 {
5. os.VfsFat.mkfs(p1)
   ( [) A1 q5 N% z( Q. ?6 W
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   - t- r+ p* ^6 |8 f
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

% b9 F' N/ E1 K: v- t. W5 O

8 X9 ~% v9 u  W1 Q

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

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

1. import os, pyb
   3 p9 |5 x; k! R5 \1 _/ Z( w8 r
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

7 f% |" j5 ~& W6 x+ ~$ a) {. _
( r/ p7 Y" ?- s! c$ S* I

来 boot.py挂载数据分区。

/ Z' N6 ]& A/ g/ E) h混合动力（ESP32）

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

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

1. import esp32, os
   " s3 r9 Y; C" I. `. ~
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

" e. x. z/ t8 X# i" f
( ?# n- S0 L9 q( Y

0 s) O( |& Q4 `$ r- B/ K( l0 V% ^

3 M9 T3 Y! y( @$ [+ B