使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  5 `; ?  E$ z' n* i& I+ s  ^

  • 虚拟FS

  • 块设备

    
    1 Q0 ~. {) B, ^! @$ ?

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      ! e. f7 b- S- Q; n

  • 文件系统

    
    ( n: f- D; K6 w+ C

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      " J; ]- B! Z; N
    
    
  
  

8 X" i/ C+ |( S; K  `

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

- _' L: G! P2 V8 u块设备

块设备是实现 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指向默认分区。这实现了扩展接口。

' D/ Y/ N, d' Y
自定义块设备

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

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)
   7 L: ]1 y, k/ B+ S
5. 
   : N; _+ m1 L5 t( j9 P
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   9 \& o  L% \; C/ K7 {5 d4 I7 F
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   * P$ z: H; X  o( w/ A4 z
10.     def writeblocks(self, block_num, buf):
    1 i* [) P% R( T+ h: |, |3 y
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    9 q8 q' s. y) z: T8 s& a  o4 m4 C
14.     def ioctl(self, op, arg):
    5 R' e+ q5 e1 n, e* N. x( U  ?
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    & w) Y/ i9 G* v
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

6 S! x1 z! k& t1 p+ z5 z- F

它可以按如下方式使用：

1. import os
   8 F( `( X3 I* ~# X9 n# J2 R. v
2. 
   
3. bdev = RAMBlockDev(512, 50)
   7 P+ Q* A  Q- Y  m
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

9 x8 B. W4 b% ^( n8 ?

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   # D% L) ~& s' J! m# F, m: q
3.         self.block_size = block_size
   & x! d2 K; }* F  t& ]0 f
4.         self.data = bytearray(block_size * num_blocks)
   & G. l  G; S; v7 p& f; \
5. 
   + j% j- x  C8 p5 }( Y9 M
6.     def readblocks(self, block_num, buf, offset=0):
   * O6 P& e* g4 j' k$ e; f/ a% ^
7.         addr = block_num * self.block_size + offset
   ! e) k6 s: F- M/ G3 }8 Q! P# |
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    0 E$ y/ l' i9 r( [
13.             # do erase, then write
    " U+ y4 {& V0 }8 B% E8 x4 U
14.             for i in range(len(buf) // self.block_size):
    " h- Y. H$ H  p) y
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    - S) t5 L- z9 Q- W7 \2 Y+ t
17.         addr = block_num * self.block_size + offset
    1 i) @$ O3 R) z; {8 I8 ^
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    * L# l" b- F$ ~' l
20. 
    + q- r( h0 D: s0 v% K
21.     def ioctl(self, op, arg):
    - u. D5 d9 ^* R+ L
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    7 V. I$ Y7 C( S  y. F
25.             return self.block_size
    4 O& b0 Q- f7 S/ C! v& Y8 {; u
26.         if op == 6: # block erase
    
27.             return 0

复制代码

0 ^, a7 |$ r: W8 f* N7 k4 C6 [2 L
7 T: d. _. Z' r' @0 L% z
) B/ ?4 m$ u( `$ L+ z3 }

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   ' B% }8 F. [0 k1 H
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

" S2 q, J+ a9 G  N1 H: _

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

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

复制代码

* n9 x6 H% r  H4 @" r6 ~
+ J# _) y& H# B
9 L, z9 K9 M: n! ~+ C; l. s0 k+ l7 ^
文件系统

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
   & ~0 B' r* L& @( n
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   + R* b) y* a) l& ^- v! h: ?4 d
5. os.mount(bdev, '/')
   - |& |3 |; A) p  g, m2 X9 d
6. 
   
7. # STM32
   4 j, u. n4 n% e% f
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    - S( M; s- p6 w4 W0 }% {
12. os.chdir('/flash')

复制代码

% s: P* V0 t5 c4 }2 D6 d( Z

  r- c) u# J' j% s" T' {Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   0 k1 j& X' F- F
2. import os
   / E9 @  B3 w/ f6 b- I- S6 P. K
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   2 B3 p7 O/ N, O( N2 K7 `' _4 x
6. 
   
7. # STM32
   
8. import os, pyb
   + d6 X8 t; F! t- K; ^+ {
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    & U7 Z# f9 S4 o' }" ^
12. os.chdir('/flash')

复制代码

( y9 ^+ C$ d; f0 ]" ]7 w0 q0 O

9 W) }% v; q* v& H) f/ N5 v% o8 Z2 w混合 (STM32)

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

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

1. import os, pyb
   1 i9 K0 x5 ?* }  q) S
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   6 Y8 V5 s: i; T/ S
5. os.VfsFat.mkfs(p1)
   : ~; S1 y! g* U
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   & i/ \6 w: o* f* r
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

) R. @$ k8 g7 u4 B6 \
/ b; u# ~' ?* [, _; t6 R
  ~- C. s% e+ C

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

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

1. import os, pyb
   ) t+ k. k( y7 K! \+ N7 q
2. p2 = pyb.Flash(start=256*1024)
   3 |7 G1 I) e( p& a
3. os.mount(p2, '/data')

复制代码

+ U6 l2 }# k: e4 ]+ G1 V3 u; S, A1 X

来 boot.py挂载数据分区。

/ \( |: V, Y2 P混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

, ^/ R8 Q4 d2 J6 _: V3 k
5 A1 s# k, d5 B% }, d7 U

+ Q, s9 c$ }4 c. @- B
/ }: |' A6 f" Q" R9 d/ n& M* ]