使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    $ [% C! m1 ^' t7 B+ ~- r/ P8 ~2 o

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        * z  A/ ^2 w2 A2 U

    • 自定义块设备

      
      4 o" L8 Z& Y. b! }( `

  • 文件系统

    
    8 c6 [5 ]1 w" E/ ], x3 W

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  * C0 E3 H- `' a& |) R

5 {0 Z5 T4 S3 F

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

) e9 |+ O( d$ q3 e" {0 r- T  b块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

( `- Z" I# e6 Q# t7 TESP32

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

# ]( T/ [& }' M5 \自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   & }& U6 ?$ @6 p1 r. k
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
     w, i% M. ^7 w& J% P# g
6.     def readblocks(self, block_num, buf):
   $ u: H4 T, I+ k. b- v
7.         for i in range(len(buf)):
   0 v! S( X$ z& M' |4 S' }
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   4 k" h; [0 S/ Q
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    , K: ^. V! i) F/ n8 R; i: ^
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    , o/ h; Q  g- `2 G, c4 a
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    - |. D; p4 x1 F& t; S
17.         if op == 5: # get block size
    * X8 D2 J/ z) _+ K" O
18.             return self.block_size

复制代码

它可以按如下方式使用：

1. import os
   
2. 
   $ N3 c4 L/ f) W; m& V: X0 U
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

  I; q& m; A$ i0 {

- Z4 O2 Y. k  r( U

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   7 A* n$ p/ A* j; B  l  Q) [
3.         self.block_size = block_size
   # `$ P) o2 A8 G. w, z
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   ) r# j- h- e0 A4 @9 i
6.     def readblocks(self, block_num, buf, offset=0):
   ) x, i% v% B( y# F+ [% e
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    - b3 F% }4 v  Z0 `& H
16.             offset = 0
    ! F* U* N# D5 Q
17.         addr = block_num * self.block_size + offset
    9 C) Z, c6 q3 I
18.         for i in range(len(buf)):
    7 J; y5 p9 ~4 u9 K4 }7 b% D4 \
19.             self.data[addr + i] = buf[i]
    
20. 
    4 ~4 q" C0 X0 }4 {0 B; F2 Q) P
21.     def ioctl(self, op, arg):
    ! q9 d; G/ ]; T0 M/ {# A! k6 }" S
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    & {) h. T% L3 i' x8 Z$ K
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    . n% H, }. G# k  x) z
27.             return 0

复制代码

( P- S# t# u( w$ N8 n& q* K2 m& ]# Y
; F3 j6 z( b6 }6 |
6 H( x% @" L) V* x# @

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   / V" h7 j% I/ c7 V
4. os.VfsLfs2.mkfs(bdev)
   5 S) [! ?$ l* ]8 d" r9 u: O0 R
5. os.mount(bdev, '/ramdisk')

复制代码

# n; T9 c0 A  [) K
0 [7 @1 N( a' {+ h

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   + s5 Z5 C0 _2 S& \  g  F
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

1 W7 X+ F% G% h7 @2 r) z7 c

. i, \2 F+ e9 }+ l0 g

. H4 C+ \6 F) E) C/ f, E文件系统

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('/')
     w' \7 S( M, v  }; [
4. os.VfsFat.mkfs(bdev)
   , F& K% F1 U8 L& F) X
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   8 S! y! H) Y1 L' p$ ~. [  y
8. import os, pyb
   2 X! I: k5 T9 Q$ C) w- Q+ I- p
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

* g, Q4 m# i6 L( i; ?* a, o# |

7 ]+ @) j3 U( r7 m! H" @8 \
Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   5 U; z5 _3 t9 Q+ o  e' i
2. import os
   # _! V$ x% u& \& ^! t0 u; }# w
3. os.umount('/')
     f! H4 z( P/ V6 e$ ?2 w+ G$ Y
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   " o$ {7 T% s4 @7 p
6. 
   
7. # STM32
   ! y1 p) j- v6 O: q+ F0 }. X
8. import os, pyb
   
9. os.umount('/flash')
   9 {2 f- P0 ^, B) I$ z0 e1 C
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    2 a' r7 p2 Y% u3 M4 S( I7 v; {
11. os.mount(pyb.Flash(start=0), '/flash')
    1 ^3 R8 R8 ], i. T% f
12. os.chdir('/flash')

复制代码

混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   2 d9 b: o  L: W5 ~/ ?
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   * `6 e- s" z! [" n
5. os.VfsFat.mkfs(p1)
   , |+ P$ J, o1 ^! a0 ?. Q
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
     G3 z# E4 r8 [/ ?
8. os.mount(p2, '/data')
   ) H. P* o( m9 o3 P. k3 ~
9. os.chdir('/flash')

复制代码

$ o* S* g0 z7 c' B9 N- y- W. m* d6 F/ R

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

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

1. import os, pyb
   1 u! G1 K5 }% o% `& P, E) i
2. p2 = pyb.Flash(start=256*1024)
   ; r2 p$ R/ m' `: R
3. os.mount(p2, '/data')

复制代码

3 x" J0 P* P7 @3 F( ]" M
& D8 ^# d0 h* t3 S( j6 Y
; v: P9 k1 r& N' D% j; c

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   # C3 G) r! |6 S/ x$ w
3. os.mount(p, '/foo')

复制代码

) g  r) [% z1 D, i

" q+ Q% ^/ w) |# w! r0 r

) W$ v0 V- P) R# n3 d8 t( W$ x) b
! ?, Y( `* q4 M- {6 f. T