使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      6 m$ [5 o8 D! d# s* U- |! B, f

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        ! S# ^2 {5 N* Q! J" x4 |  x# u

    • 自定义块设备

      
      

  • 文件系统

    
    1 }, Z+ e0 e: B: @1 s4 q

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      4 D0 ?+ \+ }- ?
    
    / u2 n1 n  @: t
  
  0 p+ z- H4 M% Q* q8 X/ M5 L+ Q

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

ESP8266

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

8 |9 k. M) u4 O& b  t4 IESP32

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

' Z4 Y3 d& o8 A5 ~( E
自定义块设备

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

1. class RAMBlockDev:
   . ^2 @; p# J  O
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   4 w) f! g/ ?- o/ a) e( s- @. s  H
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   ; z# _% `9 ]1 r" x  r9 w
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]
   9 m; Q3 _1 q$ m! z- d8 d& C
9. 
   
10.     def writeblocks(self, block_num, buf):
    & m8 q9 b  ~  ^# o: k1 q- B( D
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):
    . @$ K4 t. Q- H9 g
15.         if op == 4: # get number of blocks
    . H" [7 V" x. E- a' J8 |" g/ q: b
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    ( w4 E3 ]% S/ V0 w3 a
18.             return self.block_size

复制代码

) `$ n, c' X2 L

' U0 f! E" ?1 x/ H& O) S. L# i. o9 l

它可以按如下方式使用：

1. import os
   2 P& b0 U( U' ]7 F
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   5 l" I$ G4 i1 l* S
5. os.mount(bdev, '/ramdisk')

复制代码

+ n$ M# D7 R1 q! X8 w& Q5 L

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   " ~  C6 U* K+ a  B
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   % p. b) O1 H0 y9 m$ y; T8 _0 |* R
7.         addr = block_num * self.block_size + offset
   1 X' s7 k' l) \0 A! ]
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    ! O5 o. L- Q$ T/ C( h
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    / V# b% l$ S2 ^$ A
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    ( `& y* E- J+ O# c
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    : `4 [7 ?0 y# @% Q: c
17.         addr = block_num * self.block_size + offset
    2 G# d5 A) `$ Y  }) W
18.         for i in range(len(buf)):
    * a( |3 r. H" P' ?/ i: S
19.             self.data[addr + i] = buf[i]
    & T- r) ^7 E% w" L1 N7 ^
20. 
    
21.     def ioctl(self, op, arg):
    0 N3 r1 f7 ]: {; {
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    7 @, d+ ]! ]8 e' j" i2 f; J
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

  I3 L+ U2 f. D7 F" s) M+ G5 I2 M$ N
* ^* T3 B: {8 V

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

1. import os
   5 Z5 D* c1 ]/ J' w1 d5 k
2. 
   6 t; C' V4 t! }0 o% {# X
3. bdev = RAMBlockDev(512, 50)
   8 c  C: {, N. z0 j. u
4. os.VfsLfs2.mkfs(bdev)
   ' L, Z8 I' J+ _. v" d0 C
5. os.mount(bdev, '/ramdisk')

复制代码

4 d* M: H9 Y2 k9 M

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

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

复制代码

0 O" R$ o. W% `' \! ~! X! y

$ N1 O6 d, h' {
0 ?6 H8 n" Z' ], F* C( h8 T* ?
! @2 j! ?; r  r文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   7 A1 [4 N# }1 O4 E2 b
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   4 K; }) W7 B8 T& K
5. os.mount(bdev, '/')
   
6. 
   + @3 g( N8 m! L7 D* ]6 v( N
7. # STM32
   " a" ~! u3 q" J3 }  t& y
8. import os, pyb
   " P- X0 T' i  F0 e3 k! ^- j5 ]
9. os.umount('/flash')
   , A/ Q! r! b* c1 D
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    % R  \) K. X' ~. ?' V( _
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

4 j' L0 R# B/ Y% K% C0 D( ]

8 _8 s4 @9 b$ Q
Littlefs

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

笔记

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

) f. b6 h. X- u: ~4 v

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   1 P- k* N) w; C6 Z
4. os.VfsLfs2.mkfs(bdev)
   . P/ W+ e4 \! Q7 t
5. os.mount(bdev, '/')
   8 C1 t' b  a5 |3 a* s
6. 
   1 v$ E5 P6 {8 s' d/ X+ V. B
7. # STM32
   2 _2 v1 t/ @" J/ t' \0 ]; ^
8. import os, pyb
   7 E* b' U2 |; |( e
9. os.umount('/flash')
   $ o5 r# Z" N' [2 C/ o
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    % {2 y/ o+ p; A  p2 n0 n* d. M
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

- i9 c1 W0 l' N8 j  N0 d- e$ M- [: p

混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   5 |0 n$ x6 k  i5 ^9 ]
6. os.VfsLfs2.mkfs(p2)
   * O8 i; T. J. {8 o8 j2 U3 M
7. os.mount(p1, '/flash')
   : T) M, G% n/ f: I/ o
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

! f+ l2 u. p- A: p! M  n5 _

5 u: C  g2 j1 g, L9 t. M

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

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

1. import os, pyb
   ' M: ?/ o, Q; k* [- B9 k
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

来 boot.py挂载数据分区。

3 n4 U6 `5 J1 H3 |0 M* e- ~( g6 M; J( r混合动力（ESP32）

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

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

1. import esp32, os
   " j( i5 w! ]6 q; J. c6 P
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

- f6 A/ _, P5 N7 X8 S

# O2 ^7 j3 s/ w+ Q! c# f
, L- {  n0 B0 F$ m5 a

. D; v5 \: T* m