使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      ! G0 g/ c& }! Q9 ^% V4 q* I

  • 文件系统

    
    + C+ R" G6 O) P" v+ M

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      $ B! @6 `  m, a' s( [6 M% j! o
    
    & d" @! g: c3 ^) X: m& X
  
  

. B4 i5 S4 `: d: N* k; t5 e

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

3 K$ p5 k! x# r9 A; f4 J& r0 ]块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

# u2 H+ ?) m$ b3 hESP8266

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

, l1 t6 ]3 m  i' t1 X2 ~ESP32

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

) }' q6 z# y4 M& z, Y' s5 D
自定义块设备

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

1. class RAMBlockDev:
   3 N6 S9 C9 u* W' t
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   # z* G$ K  ?4 Z& B
5. 
   
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]
   5 j! N1 {$ N* d7 [% d+ u& B( W
9. 
   
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    1 i  s( |7 V0 m* z& B  |0 ?
12.             self.data[block_num * self.block_size + i] = buf[i]
    ! \6 |. x  A6 f* [& }6 f5 w2 s
13. 
    
14.     def ioctl(self, op, arg):
    6 Z7 B6 o8 _4 O) S$ i
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    ! [8 Z( [) b7 q
17.         if op == 5: # get block size
    + G0 ]/ U. n, n0 X+ q' r$ S0 I
18.             return self.block_size

复制代码

3 j' O9 M( [1 F4 z
2 {# a0 }$ m1 ~

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   : t: p# @+ h: l6 x6 O% `; _. R4 a
5. os.mount(bdev, '/ramdisk')

复制代码

. i4 v2 A/ B" l5 V( c2 O- E
4 G& e$ u3 O* h7 s
! P0 D- y8 K1 i) R0 |

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   5 `1 {. T) {7 I: H1 f' t* m
3.         self.block_size = block_size
   ( Y6 {4 }3 \7 ?2 U
4.         self.data = bytearray(block_size * num_blocks)
   $ V4 l9 k9 H' n) C& s, W
5. 
   ! _, n* e& x: I4 Z" @7 y
6.     def readblocks(self, block_num, buf, offset=0):
     @! v% y5 }3 {/ j3 {0 k
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   " C6 X9 S9 Z0 V4 q# Z# u. A
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    2 s" k0 |# d/ }  P" E* ~
13.             # do erase, then write
    , l# A# c. Q3 I4 [
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
      z; r% _+ ]( l/ ^
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    ! R9 u: j0 R( l/ D
18.         for i in range(len(buf)):
    5 d$ S- g( j7 X2 Y. k4 [1 `
19.             self.data[addr + i] = buf[i]
    , G4 g8 q0 q4 M0 ?. p) d5 D
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    + [1 D6 M& G9 E& g  c
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
    
27.             return 0

复制代码

7 y. P9 o1 ^) B+ I+ E* @% C
, E0 n: z9 d7 a
/ `# z' L$ o6 ?2 l2 }

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

1. import os
   
2. 
   : L3 G9 ^/ X# N% q; Q
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

. m7 P& k* |( Y$ H2 C
. i6 {, b- o! ^1 t6 G0 e4 q$ f
6 K3 S0 W9 L" S' }" c

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   ) m; c( ~8 a6 B; X' ^3 {
2.     f.write('Hello world')
   % |1 q$ q+ H0 a9 D1 p
3. print(open('/ramdisk/hello.txt').read())

复制代码

" X$ G8 B( e5 |$ R/ Y
# g0 D8 K' {# L: ?* z. D" R" q
) B4 N9 x" t$ K) b- b
文件系统

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

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

# {$ g' ^% c4 z* t: \1 S/ Z3 yFAT

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

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

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

1. # ESP8266 and ESP32
   # W* s, G1 p# b1 x9 T
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   - d# e% I  `( h2 I1 n/ r
6. 
   
7. # STM32
   5 w4 A" K7 s. U* n
8. import os, pyb
   . o- [  P( M" o# A
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    4 E4 c, ^: O& m/ m$ s9 _
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

( H* r# V( J1 g7 |8 c5 N

* k8 W/ l. C2 e  e0 v  t  k
+ Y* r2 g2 C* sLittlefs

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

笔记

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

, c7 n4 L) H# h- q; P- K

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

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

1. # ESP8266 and ESP32
   : J( x" H% K7 c1 A; x- V
2. import os
   - [5 \, G  j9 _) V& S; j
3. os.umount('/')
   * G2 I# r- Y4 G% b. g4 c" M
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   * j3 {; u; D7 i
6. 
   
7. # STM32
   
8. import os, pyb
     w! g& A" Q! S/ y
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    2 _8 S+ _( s4 ~# @
12. os.chdir('/flash')

复制代码

' F- ^/ L5 K) j7 S" C3 A" c" P

# n( e% x9 M, }2 ~% X1 q' }
混合 (STM32)

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

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

1. import os, pyb
   ! [' \. c% z/ f4 p/ h! u% y! V
2. os.umount('/flash')
   2 d/ Y! s6 p/ M- D9 m) x* ?! N
3. p1 = pyb.Flash(start=0, len=256*1024)
   . `% @) C" ~# j% I; v/ p
4. p2 = pyb.Flash(start=256*1024)
   - f8 [9 Z# b# l+ P
5. os.VfsFat.mkfs(p1)
   ( n) V- @8 l! |% P: x
6. os.VfsLfs2.mkfs(p2)
   , l  |3 L, H; w' O
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

# n/ S) i; U4 i+ `& X; Y( z# I% S

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

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

1. import os, pyb
   ' K' @$ Y4 g) h+ X; i
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

3 m, C. u$ M& h- |0 W' z2 Z& L

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   8 a/ k$ L' u' j- R/ Y
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

3 r! V& g- a. g. z* u; y
4 W% u9 t' ]3 z5 j4 ~' G' Z  O8 V4 I