使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  & o7 K! D& i7 _

  • 虚拟FS

  • 块设备

    
    ( a6 S+ b, W& g3 a3 P+ X! I2 {

    • 内置块设备

      
      ! [# o. ~2 I/ K7 w

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      9 l; G2 e1 c2 h) U: \* j

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  % M3 ~, h. Q- Z) `4 C  x! @

本教程介绍 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. 这实现了扩展接口。

ESP32

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

7 h+ c  \/ u, w$ z0 n0 C自定义块设备

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

1. class RAMBlockDev:
   ) H! ~$ {+ l0 B0 r. q, q6 @1 Q  C# Z
2.     def __init__(self, block_size, num_blocks):
   3 ^- Z6 I/ I' ~4 W2 I
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   ) Y/ F0 z4 L8 ~, }9 Z
5. 
   
6.     def readblocks(self, block_num, buf):
   6 k2 S& g1 a; J8 M3 h
7.         for i in range(len(buf)):
   . Q! F! L2 f' l9 i. X+ o, q8 K' t
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   
10.     def writeblocks(self, block_num, buf):
    7 t% [% ]4 q- b
11.         for i in range(len(buf)):
    * W& j9 ^7 {+ F3 k+ B. k( o
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    $ g/ C& ^8 d; d! y$ m5 X5 D8 c
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

+ ]% j3 c- X5 E( G- D3 K" j
4 Q3 ~# u: Z" y  t  A

它可以按如下方式使用：

1. import os
   ' Y5 c) r% r7 u; z" H1 r
2. 
   
3. bdev = RAMBlockDev(512, 50)
   7 p* ^9 T! B  _! t7 _! \
4. os.VfsFat.mkfs(bdev)
   9 i) W# t4 `* M
5. os.mount(bdev, '/ramdisk')

复制代码

  m' s/ C$ ]: S' u7 |- x
9 \8 i+ G" C& ~/ q0 t# Q( O

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   6 @9 p" R5 Q. [% ?  X' \
4.         self.data = bytearray(block_size * num_blocks)
   8 Q( [' m2 \; {. t, T8 f
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   ( W& ~, n. L0 ]( w1 T' F
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   ' u: f+ O5 ?4 j
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
      w% J) U) G% j1 h6 O1 c
13.             # do erase, then write
    : W4 @9 t# A3 f
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    / C! g# e* p8 v( K3 ]
16.             offset = 0
    3 E9 t# {9 q' h: L0 A
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    2 N( H/ |7 D! |- i
19.             self.data[addr + i] = buf[i]
    + C7 I4 a) q6 ?( R, ]/ F/ |
20. 
    , K" h( ^% n  x5 [. F, g
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    / L* u7 y- P. ]
23.             return len(self.data) // self.block_size
    " }5 K' `  q0 F& H2 k" g1 ~
24.         if op == 5: # block size
    % D0 b# x3 ^4 Z/ w5 s6 E, R
25.             return self.block_size
    3 R, i$ T8 g, }& i
26.         if op == 6: # block erase
    
27.             return 0

复制代码

( h  M) u  }: o( I1 T/ J

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   7 q7 {. {; Z4 ^. u
5. os.mount(bdev, '/ramdisk')

复制代码

' n( ]) D% d: w

% w# Q2 n1 k- Y

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   7 b* z/ a3 w4 ?* l  j; w
2.     f.write('Hello world')
   5 m$ t6 ?- }; h) N( t1 ]0 }
3. print(open('/ramdisk/hello.txt').read())

复制代码

# q* c: \. |# m1 `) Y4 j
+ r8 z, p5 _$ t) e7 k

$ q% [6 ]! q/ b+ t文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   1 T$ ~( N; _1 T( ~. T# u3 p" ]
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   ( W; W# G) n6 `, n1 b6 J
6. 
   
7. # STM32
   2 v/ R5 i. G1 A
8. import os, pyb
   
9. os.umount('/flash')
   & _( [' k2 X# }$ D7 @2 F1 _3 N9 e
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    6 k) k  S. A) v9 Q5 a
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

# ?/ {& x. O3 _
5 Y$ O8 _3 F. m% X! [/ w
. J$ W( Y2 T, y5 A4 n1 ELittlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   1 j1 @5 ]1 G" F# M, Q/ \
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   + m9 c4 L  ?/ [: z9 Z# s7 N
8. import os, pyb
   
9. os.umount('/flash')
   $ V6 _' a. t" z% I: m0 n
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
      p( B! A3 F9 ~# R8 U9 y( y
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

7 o! y" K9 v2 l; [# k
# ^" o" F6 `2 t( e8 s& \) Q
$ I  V+ a0 g2 V, R& X% t5 `- T4 M
混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   5 I) i4 K0 v$ r. C' e* E8 q. o
3. p1 = pyb.Flash(start=0, len=256*1024)
   $ f5 q! F) |9 t- Y! I1 I; ?
4. p2 = pyb.Flash(start=256*1024)
   7 R" h, G5 \+ m3 {! Z/ ^
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   ; x5 z. r% h7 w  W0 I  w/ J  P
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   4 [+ Q* Y3 @' o: t* R) K
9. os.chdir('/flash')

复制代码

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

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

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

来 boot.py挂载数据分区。

: p0 T/ w3 E' T1 y! W混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   & r7 U5 c/ X/ J- i/ o7 t
3. os.mount(p, '/foo')

复制代码

9 _5 ]4 R( H- h& J6 f& l, A