使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      ! u/ S  D8 z1 G" o% `" r  {

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        ) F4 w( {( W3 J0 k4 q

    • 自定义块设备

      
      4 I$ w6 ]8 q, h! d8 Q8 f

  • 文件系统

    
    + m3 f7 x3 F1 [4 x( Q. O9 {/ k/ v  a

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  

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

5 Z; W* i; d, W: E5 h7 rESP8266

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

ESP32

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

/ S6 i! _4 e7 b% l4 _; `0 C( ?8 W自定义块设备

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

1. class RAMBlockDev:
   $ m) b8 y; c" Z  W
2.     def __init__(self, block_size, num_blocks):
   $ c& F+ |: ]) h0 G  x
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   ( y+ A6 C* a/ N* X$ i- E( e) }
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   8 r1 Z  x6 T* u' m
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   $ ^9 ^1 `& t& F7 g* q, E4 `7 X
10.     def writeblocks(self, block_num, buf):
    0 s; e+ r0 c, ]. L) g
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    
14.     def ioctl(self, op, arg):
    2 N$ F8 K* q. U
15.         if op == 4: # get number of blocks
    * o7 W; k( U5 ~) j" Z. q# I5 E' ~
16.             return len(self.data) // self.block_size
    8 z8 Q$ w- E, R% ?8 }4 }! w
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

) H( j$ h* o# \- c( s9 }" b7 L
8 L( \: J) [+ T4 p: w' a
. q' q+ m7 g2 }" F3 F

它可以按如下方式使用：

1. import os
   
2. 
   1 B" L1 U+ e  U  L  @
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   6 M* V7 O# _7 ~' Z
5. os.mount(bdev, '/ramdisk')

复制代码

. u$ S; B8 }$ }

. J" q" l# M: n. G0 f7 ]

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

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)
   
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   2 P( j5 d/ B8 ?' b0 Q+ p0 B
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:
    & ?4 T$ M% I* }5 a8 t
13.             # do erase, then write
    4 G- j7 \- B) i1 q# K3 N" o8 P2 `
14.             for i in range(len(buf) // self.block_size):
    2 X  O" c# d/ F% p
15.                 self.ioctl(6, block_num + i)
    : w) o5 V* L7 ?0 y  ^3 S- B
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]
    * \" c0 l0 y2 {
20. 
    
21.     def ioctl(self, op, arg):
    " y& T5 V! j) u5 d& h$ g
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    : ^' P) N1 Z. d  _* `
27.             return 0

复制代码

- ~+ p5 [& k0 r8 ~6 Q. L- p0 Y

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

1. import os
   
2. 
     U! C- |% F* c# G
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   8 C8 F3 `+ R5 c4 Q; f5 D) @. I
5. os.mount(bdev, '/ramdisk')

复制代码

6 _4 E( l2 @% J( f
/ R& h, S9 w9 m: g+ X

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   $ Y$ G, _1 ~1 |- M# }
2.     f.write('Hello world')
   , @* K: h9 q% Y# Y% d# k
3. print(open('/ramdisk/hello.txt').read())

复制代码

/ N% Y7 o- w% ~& L! F- ^! n6 y
' H% X( ]; d0 U  N% Q9 w

- B6 Z0 p( q5 [, }; p+ a! W6 M( W# Z
6 O1 G& y) w0 r8 C文件系统

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

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

' z, d; k' v! V; F- T6 z+ dFAT

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

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

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

1. # ESP8266 and ESP32
   9 k+ x% Y. N7 m9 X0 D) E% _
2. import os
   , R' ~8 T) I4 E
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   3 p/ J# R; E: [) j" ?: ~* q/ T
6. 
     K/ ?% K3 r/ {# z' o* }
7. # STM32
     p% Z2 R$ f, F6 |
8. import os, pyb
   + w$ @3 |& s' M) R' w- E$ F! C2 g
9. os.umount('/flash')
   ; z4 _4 @% Q4 g8 P. O
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    - Y& [* V" _# T6 s1 f
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

& W8 D$ b6 J: o& v" p
2 }# O6 y( c$ C" l4 \2 }, |

Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   ) K& ~8 j$ |! V) c) h
2. import os
   
3. os.umount('/')
   * p& o1 _' U' ~
4. os.VfsLfs2.mkfs(bdev)
     U& H# X8 u; V2 Q. ^
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   8 @0 S- W/ \* G4 i
8. import os, pyb
   ' U/ c# W0 _( f
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    , R& u& T& V$ k$ J
11. os.mount(pyb.Flash(start=0), '/flash')
    + K& K! w, |2 k4 F5 u- K
12. os.chdir('/flash')

复制代码

$ ]8 E4 c. e, o
2 ^, K$ B: {% i
4 m) ]8 A1 Z- i' E: ]混合 (STM32)

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

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

1. import os, pyb
   ( x# N1 t" m2 C# l- r9 ^& {. a) c! B
2. os.umount('/flash')
   ) _5 H2 Q& P! `, ~5 o& ?6 ]
3. p1 = pyb.Flash(start=0, len=256*1024)
   3 h* @( a0 V  q9 ^5 K6 M) b
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   1 x: l5 o5 {# r. o6 {. h6 m. N/ b
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

/ A/ _. c1 r/ e/ o+ l/ q8 D

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

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

1. import os, pyb
   3 e& t( _! ?5 Y5 I7 n- e+ o# ^
2. p2 = pyb.Flash(start=256*1024)
   " v6 W5 a- m! z. F  n
3. os.mount(p2, '/data')

复制代码

来 boot.py挂载数据分区。

混合动力（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')

复制代码

* A  L1 F2 |* `9 I
4 _- G; I3 M, k- i# l% m; R

/ h$ C6 z. F6 y& [* k2 s