使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    . x) G# F# c7 Y1 n7 ]3 a. D

    • 内置块设备

      
      , |* P3 y" `: g) R; u" w7 J

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      " i( C' E& Y: W8 ^: {) m, w% n

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    , T# h- m! Y- }# i/ s# G
  
  0 _7 D/ E$ E0 Q0 {5 y6 S3 k6 i

1 h3 d/ D& W& u; t0 A& U

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

& D, w5 ?- T# l) Q$ F1 J块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

6 w" H* W' u" }7 jESP8266

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

) ~6 v. o/ n0 M2 y9 Y  Z3 nESP32

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

2 R4 }% g8 E$ h/ D
+ w7 H1 A% p. a4 {# I% [9 G自定义块设备

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

1. class RAMBlockDev:
   % o3 C, p) o/ T: B/ L$ C
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   # j/ R( @$ v! f) R: q  H3 T+ C5 W- W) _
4.         self.data = bytearray(block_size * num_blocks)
   # i* W3 Y' @$ s; w3 r* Y
5. 
   
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   9 j3 p6 C6 j5 w" j0 \0 l5 c/ q1 Y3 N
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    5 [" d: V( l( Q
14.     def ioctl(self, op, arg):
    # ?( N; u# I0 c
15.         if op == 4: # get number of blocks
    " H1 F+ M% [$ A( G
16.             return len(self.data) // self.block_size
    + @7 K: W9 g$ X/ x1 U( l3 U& e
17.         if op == 5: # get block size
    $ T0 Y; X5 B5 ?" g0 R5 ^- a& B
18.             return self.block_size

复制代码

( S7 [) f- r  _8 j8 s6 `8 F/ K, G. H

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   3 B- y7 f. e, n- }6 d" K
4. os.VfsFat.mkfs(bdev)
   4 a1 F, N) T3 f( h4 o# w
5. os.mount(bdev, '/ramdisk')

复制代码

- ?0 b% K6 d- M# h6 q8 V

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

1. class RAMBlockDev:
   " K0 Y$ {4 [, |
2.     def __init__(self, block_size, num_blocks):
   ; k: T) R9 q  p
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   4 w% Z. z( e3 a. A& R
6.     def readblocks(self, block_num, buf, offset=0):
   / ~% @* c9 N* T0 |% w6 o( ~
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
     O/ }: l1 H! x# I1 c
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
      L% S  W) \6 H2 W# A  M4 t
12.         if offset is None:
    + f2 i- Z. H+ i2 s  P. z
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    5 ]1 \5 X$ K5 f2 C) a# J! [- `2 x
17.         addr = block_num * self.block_size + offset
    # d* K% M3 s# [1 @! L
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    
20. 
      z1 O+ o5 ~' F/ z& O
21.     def ioctl(self, op, arg):
    # e. Q3 N% Q# v1 ?9 l
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
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

9 U$ E4 O9 T( Q4 z' j9 X

7 \& f* a( `# L- B, S4 K

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

1. import os
   0 ]/ z1 l9 d6 x4 H7 W) _9 O
2. 
   ) E# t. D: H8 j0 k
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   ; V1 C' L& O8 t2 |6 U
5. os.mount(bdev, '/ramdisk')

复制代码

9 I; z4 M$ t, V  n8 ]5 Q0 H" J5 i

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   7 P' L/ r7 R  @
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

6 B6 M  ~: Z9 t( x% z
& U5 H, o# P7 \2 Y1 ?2 _" [
* D1 e( t3 x* n. H

0 Y& e. t  v. n  K! s6 h文件系统

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
   & T% a- m' n/ m1 J% B# F& Y0 Y
3. os.umount('/')
   0 Y  W) k  d1 F
4. os.VfsFat.mkfs(bdev)
   7 x. t- l6 u: B1 p
5. os.mount(bdev, '/')
   
6. 
   9 m5 Q1 W' D+ k
7. # STM32
   : s) Z" h; p" ?! F% t6 d
8. import os, pyb
   % A9 z% ]2 [/ F$ ]
9. os.umount('/flash')
   3 f1 ], R; }' h1 ?7 Q  D
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    * f+ U& h2 S1 f- E6 Z" F
12. os.chdir('/flash')

复制代码

+ _; w  O. k7 @( r3 C7 ~7 |

; X* u* x3 z5 ^/ j, d  }
6 S- C: I/ Y) F+ w5 p$ s, ?Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   3 P; Q8 _# m$ E9 n. k
2. import os
   
3. os.umount('/')
   $ D7 ~1 }4 `& \# k0 V. v3 A- W
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   # E" r& n/ S" `/ b/ M7 T: N
6. 
   
7. # STM32
   & E7 R( q% q& F) g$ Y" b& R
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
      O* {$ `8 |6 L& X& K$ \
11. os.mount(pyb.Flash(start=0), '/flash')
    6 t$ R* G( a, F5 N% q/ J. p/ P+ N4 I
12. os.chdir('/flash')

复制代码

, ^- ^7 N) I; R* S$ U/ m
" _0 N# H# g$ I3 K9 e7 |  o8 O* ?
5 X& I6 N5 f( m% P6 Y* A
混合 (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)
   8 U$ [) Q1 {0 E" o0 E
4. p2 = pyb.Flash(start=256*1024)
   1 `) _" a' e9 G
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   : l: g5 l6 T7 x$ e
9. os.chdir('/flash')

复制代码

) m& x7 e; ^5 @- x0 M! m8 z1 P" o
3 z2 }' D  A/ c) i6 ?5 s. k

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

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

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   % a9 I, q* g7 g
3. os.mount(p2, '/data')

复制代码

; m% v- z) N/ U0 I5 u# `) z( o, O

来 boot.py挂载数据分区。

' V' \/ L5 ]- H. j5 O混合动力（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')

复制代码

2 A2 j" S/ i1 A1 y* z3 v

1 W9 F5 {+ U3 Y' n. R