使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  ; w" Y0 F3 t( C9 H  D1 _+ r

  • 虚拟FS

  • 块设备

    
    3 T* _5 t& Q6 v0 @0 R0 a

    • 内置块设备

      
      . j1 L1 K3 H* |: ?4 z" T+ M

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
          h( i/ m1 H4 @! \

    • 自定义块设备

      
      5 B! d3 s9 ?4 o: u3 w* c$ r9 Q

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    + A, h5 R3 @# X& d
  
  ' N. c7 i8 j6 J' x: \+ F

. N, |: f. a. r  _9 r

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

# o. q2 A( n) h  Z, ^% S% h* M0 v/ K块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

( v( ~0 {4 c3 L8 m4 I) ^ESP8266

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

ESP32

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

, f- B5 r: W0 l7 c自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   , M4 ^0 X0 u9 S6 {' D4 y! l
4.         self.data = bytearray(block_size * num_blocks)
   8 {+ f" C4 I2 Q# ~) ?4 C1 c2 i& E
5. 
   7 Y2 [- t* j6 ?3 e" [
6.     def readblocks(self, block_num, buf):
   . n% O0 i/ `* I0 }0 Z
7.         for i in range(len(buf)):
   : @  P- M* v. }
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   
10.     def writeblocks(self, block_num, buf):
    1 U$ v8 S8 j" ?  \6 w" q
11.         for i in range(len(buf)):
    0 n  x: C- W' ~
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    
14.     def ioctl(self, op, arg):
    8 E1 k. F7 k2 V: r* G9 {
15.         if op == 4: # get number of blocks
    : B" s# ?5 e7 e
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

% G2 S  P( ^" J

它可以按如下方式使用：

1. import os
   1 I( ~% Z- ]' x! E7 ^) K7 m
2. 
   0 `6 W* a7 g1 z& S2 c& A# @
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

( e! A# p; r# ]7 m1 S
& T, ?  S" ~% H
) f  J* }0 e/ b3 v. d5 a8 X1 S

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

1. class RAMBlockDev:
   $ h7 ?+ V; X, @& j
2.     def __init__(self, block_size, num_blocks):
   2 ~& e7 z  n1 W% B" j* p+ I1 G
3.         self.block_size = block_size
   # W: K7 m) c# q% X1 j" P
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   + s4 j! C1 S5 t4 t6 M
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    9 G7 A$ p0 r2 ?6 x$ Z0 E4 h
11.     def writeblocks(self, block_num, buf, offset=None):
    % c5 q; s% w: A) Q7 O& h
12.         if offset is None:
    
13.             # do erase, then write
    * P! r* K1 W! R2 n0 k
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    2 S2 t$ e" h- |' u
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    
20. 
    8 _* d' X2 L6 |" m
21.     def ioctl(self, op, arg):
    * p6 c# X; l' E* M
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    4 n) {% v5 {) B
24.         if op == 5: # block size
    
25.             return self.block_size
    $ n8 c' Q- x( a/ u+ T! D) r
26.         if op == 6: # block erase
    ( I8 R7 X1 x+ e9 v
27.             return 0

复制代码

# z) D% i5 O; k% w) f$ x1 i

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   : m" Y9 L) j/ i2 K- W0 I
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

4 {: N& A0 y* e* t7 p$ T( N5 ?

" g6 Z# `: t: q) \6 {+ H" S, m4 A

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

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

复制代码

7 f: c' R; ]5 i: G/ r; {1 G2 d
, `! [- D" C3 i/ f1 [( d! p# f
8 x3 L' W) o& i8 [; D  J2 B
* o' a  e7 Y8 H
文件系统

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

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

' P7 P1 r& \5 \& ]0 w5 y2 {* YFAT

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

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

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

1. # ESP8266 and ESP32
   5 I9 k0 F9 I+ z% [2 x
2. import os
   
3. os.umount('/')
   + ~  \+ S$ u' N
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
     z( {4 R2 c) J
6. 
   5 O; }5 A  A# S. A
7. # STM32
   
8. import os, pyb
   5 ^+ C# U6 q3 g$ i2 r* s& ?
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    3 x6 N5 ~5 J9 W1 T# e1 d; W$ ^
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

  M6 H0 F4 X* @+ \Littlefs

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

笔记

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

7 N; K" }2 }+ Z

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

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

1. # ESP8266 and ESP32
   ! U; {4 Q" N6 _: ?/ t3 D4 w
2. import os
   : w7 @! U! }3 ~' s- `
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   ; q  j6 ~, p% _# \; a
5. os.mount(bdev, '/')
   
6. 
   1 P7 A. S  T" Z2 g
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   # k6 t# v1 G& J. Y2 ]5 S
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    ) `' n+ {3 I; M" q3 @
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

# N. ^/ Z- p; c! i& F

8 \6 [, u  c: U  g! w3 p. @4 U
混合 (STM32)

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

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

1. import os, pyb
   ( e  m* t# I+ ^4 r2 p4 ^
2. os.umount('/flash')
   6 b* ?" q/ U8 x9 n
3. p1 = pyb.Flash(start=0, len=256*1024)
   # Q4 z( W, S( C% ]
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   # X5 D' R% F! R$ L: }. `# j; \
7. os.mount(p1, '/flash')
   1 H, o6 o% C: n9 T6 s
8. os.mount(p2, '/data')
   # t5 ^( k! W; ~9 R$ u
9. os.chdir('/flash')

复制代码

- g/ x; v; O8 q4 `  E8 s9 d

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

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

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

复制代码

/ U% M% |, @) e1 X! G) S

来 boot.py挂载数据分区。

  u) ~' U4 B5 @, G: A( E7 Q混合动力（ESP32）

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

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

1. import esp32, os
   7 ]4 @6 L$ f& X: s1 f# N5 p
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

' {( h) f' p5 N  b4 i4 K0 l

/ b2 q/ e0 ]9 w$ {$ `+ \4 D
" w, r- L3 y, H) d! g