使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    9 g! W5 x3 c4 w; D) X

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      " ~; y. N( y' w6 P: `
    
    # W, @. ^& w* X* E7 _& _
  
  

( S) _' `, w6 }& Z

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

- p1 t. D! E. _- x: `ESP8266

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

' D5 L& |; P+ Z+ N/ xESP32

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

自定义块设备

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

1. class RAMBlockDev:
   0 w9 F( V" y' }! u. H  h( G
2.     def __init__(self, block_size, num_blocks):
   0 {" M# ]: M+ X5 h  b
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
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]
   
9. 
   0 F0 F" a8 I% i: L% D5 e: q" c; B: A
10.     def writeblocks(self, block_num, buf):
    6 M. h! S* k- {3 O" l1 Z- w! O
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    ; t! z1 S. k2 u3 g) l
13. 
    2 R4 K# B: ?# T' g5 J1 U, _
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    2 s1 a8 q" ^# i" L" r$ E+ M
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

% o5 F$ o3 D' C$ p( D6 Q

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   $ t5 }- T: s0 c0 P6 ]
4. os.VfsFat.mkfs(bdev)
   % f: y7 l& ^* c# E
5. os.mount(bdev, '/ramdisk')

复制代码

% a3 u. ]9 g& Q3 A* e3 c# u0 Q
2 t! V- _+ n! J1 `, B' F' _! a
3 g2 G. s! F# j0 I6 E5 x# _

支持简单接口和扩展接口（即 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)
   ; g' {! v: K4 @" @: m. G) m
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   6 u4 Q8 \3 o% g0 ]# O7 w" i  c
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   0 I/ H2 r- `& b2 }3 v- s% M% ^* H
10. 
    ! Y* ^- u$ |: z
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    - A8 I3 ?+ m* f8 o/ f
13.             # do erase, then write
    9 y/ z( X3 Q9 U6 \+ \
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    ; f$ I" Y, p4 N
17.         addr = block_num * self.block_size + offset
    $ S# A2 M4 D) m1 p: G
18.         for i in range(len(buf)):
      |4 Q  N4 F! a' P
19.             self.data[addr + i] = buf[i]
    - s2 u0 J$ r1 _" _! a. p, L' e' W  s
20. 
    
21.     def ioctl(self, op, arg):
    0 m; R+ }& D( p4 f# @
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
    ( a& W+ \" I7 {7 G1 ~+ \& E
26.         if op == 6: # block erase
    
27.             return 0

复制代码

9 f6 C3 X% e; H" }* I2 I" z! w

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

( _  U) F" O. w

7 d3 e9 }0 r" U$ P

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   * ]0 I$ P5 p  a& S6 Y
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

# a3 L- X4 I. {9 u" q
5 x% {3 S7 F6 e& Q

' w( h4 j/ G8 w3 R0 [文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   & @+ T( [3 K  q# h0 D  G/ O! @7 T
4. os.VfsFat.mkfs(bdev)
   % x: n- H1 [3 f1 U4 x% J
5. os.mount(bdev, '/')
   % E3 j; x5 S& y& O% {2 C
6. 
   / q! z. S/ g" i6 ~4 i/ M
7. # STM32
   
8. import os, pyb
   , q2 X& Q  h, f* M
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    : F9 O2 o0 E! e' _# V
11. os.mount(pyb.Flash(start=0), '/flash')
    * C) Q7 l" |1 {0 A( |. `
12. os.chdir('/flash')

复制代码

4 X1 a( g; y- K7 y6 X

4 |- @/ B1 y& s: n+ A$ @4 V* K
Littlefs

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
   , |$ X, G: k0 Q3 i* W
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   / G$ b$ ?  F. K% n, C8 U7 X" M9 V
6. 
   / U: O& {+ V: L! C+ e9 u
7. # STM32
   
8. import os, pyb
   / H, F& S2 z' U5 {! O. r& }
9. os.umount('/flash')
   0 [* z& m9 z( l0 k0 y
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    : s! |/ k  X' g3 C! n
12. os.chdir('/flash')

复制代码

% x$ t" e+ K3 H! T- U$ d

3 d! t! U) ]% L  M. y, l混合 (STM32)

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

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

1. import os, pyb
   " I3 D& A$ X1 |$ R/ P1 t0 C. ]
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)
   . i7 g; T' i9 M4 T+ g5 S
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   1 w- J+ p0 d# }/ [* Y
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

1 ]& y) q6 d/ H" u: B* b' s
5 d: q  a0 w0 n$ c, ^4 R& W

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

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

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

复制代码

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   3 f! o, O+ d4 h6 l- t! y
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

! C2 f7 H2 j, x
: m, l7 M6 ]' ?. U9 b) h

2 g. C( O3 F; P. ~' ?; x* h. o& d, |
  l8 o+ J9 P6 q. z; N: z( {
6 a" f3 d8 I( ~! R( a4 Z+ N