使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      1 V& W. y  K' Y6 m( F# {

  • 文件系统

    
    " h8 F& Z# Z% T7 c, [# z$ m7 ~

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      2 C, B6 Q3 g  }8 @* W! ^) \
    
    1 B$ Q5 p% \) A/ X5 w0 d9 b
  
  % M2 D3 r# M& t/ `! M

0 i! F' A7 }; p3 Y1 w+ u4 J+ W

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

' {& b* S! d. I6 G' e6 B/ @ESP8266

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

ESP32

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

4 P) g3 y+ X" d5 E* ^/ M
3 }+ T7 b3 }/ ?2 |1 Q) r1 |  E1 i% l自定义块设备

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

1. class RAMBlockDev:
   ! u# b; T. z$ ?1 g
2.     def __init__(self, block_size, num_blocks):
   5 @7 H- u; `$ H) [
3.         self.block_size = block_size
   8 ^  b. }8 h1 }' }* x$ X% f4 c& R9 P
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf):
   # t1 k& @8 {+ S
7.         for i in range(len(buf)):
   + _" O/ K! B  @( c3 G
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   ) I8 D* t) j7 U& m. i  W3 {6 f1 r
10.     def writeblocks(self, block_num, buf):
    ! d( H3 U6 V1 ?: W! d& g8 ?; K
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    7 `: B% F; I3 B" i, l% W9 x, w
13. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    1 y8 t, v! I% D5 X) X. i
16.             return len(self.data) // self.block_size
    - ?5 M+ n" x! c3 G8 x8 G
17.         if op == 5: # get block size
    $ s0 l' u* w0 D$ N& h" D
18.             return self.block_size

复制代码

2 O1 r1 @  W1 l# \; s
7 M3 k6 E) K& ^8 `! `, R- X
: ]7 A8 }( u$ B! T+ B+ z

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   6 t9 G0 H) F! V! G1 @+ S
5. os.mount(bdev, '/ramdisk')

复制代码

4 n4 J8 Q9 Z) T. o  h+ L3 t& q
+ ?* X' V1 f% V/ s* X

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

1. class RAMBlockDev:
   ! W# d' {  Y9 A& _
2.     def __init__(self, block_size, num_blocks):
   : _! ^# l+ Y7 u) G: l5 }5 M
3.         self.block_size = block_size
   $ J# R* Y* X1 D* T5 Q
4.         self.data = bytearray(block_size * num_blocks)
   ! \2 c3 `; |6 r; G9 a
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   ) w, |  v/ E9 @) C' @! D% u
7.         addr = block_num * self.block_size + offset
   + I% y0 f- k5 _% l: n( @3 S
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    # X4 i9 ?: H  I/ m* {5 J
12.         if offset is None:
    " t5 M# P) E1 y4 L; h9 @4 o  @1 N/ I! o
13.             # do erase, then write
    ; F" x0 h8 n0 F4 \! N1 e2 I7 E
14.             for i in range(len(buf) // self.block_size):
    0 C3 w4 v# B# ?6 H2 K/ w* s
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    5 z. L  I4 I' V8 V/ {+ z  B
19.             self.data[addr + i] = buf[i]
    $ L+ I9 X8 e3 Q& B( i" t# ~
20. 
    8 t6 u9 S, L. J! g/ B, [7 ]
21.     def ioctl(self, op, arg):
    : J, j( [, G$ E" N+ m5 F. P2 z
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
    3 o7 R$ H# ]+ \! C$ h+ S
27.             return 0

复制代码

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   6 B# q2 W) }; t; {* @1 S
4. os.VfsLfs2.mkfs(bdev)
   3 Y4 k! m. i0 |; ?1 {/ M
5. os.mount(bdev, '/ramdisk')

复制代码

/ l  ^- S* b7 q+ i
4 a& o0 J! S! c) Q8 X

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

# ]4 l3 e" ]( n0 D" U& Z

文件系统

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

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

' h# d+ C3 n8 }% x3 bFAT

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

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

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

1. # ESP8266 and ESP32
   & ^# H) ?# P: P  D
2. import os
   
3. os.umount('/')
   ! t( A* [+ d! O; d$ U2 F# T! Y% ?3 X
4. os.VfsFat.mkfs(bdev)
   " y" V) ~7 z* D  n
5. os.mount(bdev, '/')
   1 \7 R" m. n0 Y; ]
6. 
   3 e; x4 x9 q9 ^7 r1 Y* R
7. # STM32
   
8. import os, pyb
   ' V/ l0 c: w. f/ ~6 q
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

' O) B4 O) J) N! s/ e, O% _) }
, V$ R+ p% z+ n* u# CLittlefs

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

笔记

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

1 w: h# o0 [& _2 |" Z$ E* ?

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   ( W+ B/ X  \1 T
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   ; A* Z7 o0 r) h% ~! R
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   / P! l3 X, {* t, X6 k6 ^% }" x4 l
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    " Z* Y& Z. r) W  ]6 \$ s& L
12. os.chdir('/flash')

复制代码

混合 (STM32)

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

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

1. import os, pyb
   " g- U# J( N/ O9 ~6 i
2. os.umount('/flash')
   * [& }! C- q3 T: m4 ?: G% t0 e
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   2 d- P4 P& [" K$ M+ t3 t
5. os.VfsFat.mkfs(p1)
   ( T0 l( L) a% j
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   % w; W4 h# Y2 D$ u
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

1 Q+ c% N* K2 r* J

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

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

1. import os, pyb
   , s2 C; q! _+ ]
2. p2 = pyb.Flash(start=256*1024)
   3 \. i6 Q! P5 P! K
3. os.mount(p2, '/data')

复制代码

+ n* ]/ M" ?% k" v9 @
; Z! m% D/ S: X9 W! R9 H) C

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   ' ~& b4 ?  \6 K
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

- H" b+ |) g  f$ A
5 l6 N% X* _& }4 |# W6 S
2 o7 W0 Y8 G4 d) _; `: q
6 Y% H7 P' b( Q8 C7 D) _; v4 p