使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  3 A3 J; n  O; s: w

  • 虚拟FS

  • 块设备

    
    $ d5 [* H0 U* F5 Q8 M

    • 内置块设备

      
      / Q3 t! T. }% e$ t* O

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      6 s8 m. u- R3 J( ?0 C& c' o) I

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      2 z6 z( H+ ^# F7 J
    
    
  
  

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

6 M. Y% c5 e" k  u% T块设备

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

自定义块设备

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

1. class RAMBlockDev:
   : Y$ q+ Q9 P2 ~' k1 O% i
2.     def __init__(self, block_size, num_blocks):
   6 t, w7 \4 L0 b* R
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   + k% W* ]# v2 P: F4 g$ h
6.     def readblocks(self, block_num, buf):
   & a% F$ P$ ~- h
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   0 A3 D5 v' ]; C" R
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. 
    
14.     def ioctl(self, op, arg):
    , ?8 M3 Q: N! d9 T6 c& n
15.         if op == 4: # get number of blocks
    $ P2 r6 |/ X$ ^- z4 C5 \5 ^
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    ; h  [9 i- u# C& e) G2 ^
18.             return self.block_size

复制代码

. x6 ]! \  c# f! L

它可以按如下方式使用：

1. import os
   
2. 
   % K7 x0 P1 u; a
3. bdev = RAMBlockDev(512, 50)
   9 _6 o5 S/ \7 D% z4 N; L* D* N0 ?
4. os.VfsFat.mkfs(bdev)
   9 E+ M4 k9 K) c
5. os.mount(bdev, '/ramdisk')

复制代码

3 _' n5 G* t( e0 W6 ?- Q7 s

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

1. class RAMBlockDev:
   , \+ p7 j/ ]( z( _8 P" o0 B/ t
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
     o' `1 _* r; m3 K+ _7 W" C
4.         self.data = bytearray(block_size * num_blocks)
     e# w0 G- P7 L: |  e( l
5. 
   ! ~4 S" `) K, p  w+ q: C  ~
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   % `0 ?% t# a2 Y* t# T% j( b0 {
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   8 W0 {8 K8 ^, {
10. 
    + E5 T; @7 x: \3 W
11.     def writeblocks(self, block_num, buf, offset=None):
    * W. ^# K! D1 A+ a1 _' U* C; t  K5 x
12.         if offset is None:
    3 E/ ~; F3 o3 k
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    $ a# O* K. k8 a/ ?
15.                 self.ioctl(6, block_num + i)
    ; P; A* b1 V4 e  E& l; o
16.             offset = 0
    / {) ~+ e# |1 ?' h/ n5 |
17.         addr = block_num * self.block_size + offset
      ~) _* F. {9 [8 {; j: z' t
18.         for i in range(len(buf)):
    4 W0 D  }! H1 p) Q4 T
19.             self.data[addr + i] = buf[i]
    ) c# A# H6 J2 B/ C% c, O/ `
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    " y& m3 y5 s( [
24.         if op == 5: # block size
    3 f2 |' x8 {3 f" f
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

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

1. import os
   " o4 D# [+ d  \3 X
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   ) V5 s9 T7 y5 n' p' n$ e1 n
5. os.mount(bdev, '/ramdisk')

复制代码

/ s0 {  ]4 N- q0 O8 b* M

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   . }( y, w0 q" m9 C' N5 e" [, L
2.     f.write('Hello world')
   ( h) C; a& c$ f4 R
3. print(open('/ramdisk/hello.txt').read())

复制代码

/ E5 R* A1 s8 V0 C
3 O6 y  K# ]5 d7 [" S

& l+ }$ p4 F. t& z6 k
$ I5 x2 I' R2 {0 x. ~. m9 t9 q文件系统

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

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

6 F0 }* a+ T0 D( q0 v5 r  q1 R5 VFAT

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

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

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

1. # ESP8266 and ESP32
   - d6 T+ A  r6 Q( E- z5 Y5 Y2 r. ^; E
2. import os
   " N/ J6 H& ]) ?
3. os.umount('/')
   ; X% N8 y) X1 U3 u
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   ) q9 ~, |1 W: [  x, G  T
6. 
   
7. # STM32
   0 _/ v; }9 b! {0 x2 F$ ~. p0 N
8. import os, pyb
   
9. os.umount('/flash')
   ! v# N* s6 Z% k# c4 k
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    ' P  C. S3 U5 i) f* z
12. os.chdir('/flash')

复制代码

% k6 I0 H1 z7 \: l& e/ B
' i+ [8 G) h" f3 [# A6 H
- T6 S( I3 ^4 T4 E3 T
: k! f  l# C1 b, Q% `Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   . ?/ M2 P" d7 f( I! X5 R, x
2. import os
   2 A" H, M& ]8 [6 m1 O" H
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   8 n( j" N$ e% g1 N; e8 F( }5 Z
5. os.mount(bdev, '/')
   
6. 
   4 Z3 B1 v$ z2 s
7. # STM32
   1 z% |0 _+ A8 t
8. import os, pyb
   0 H( T9 `6 r( {2 J* s
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    & V1 b: \7 \- |$ c4 y/ c
12. os.chdir('/flash')

复制代码

* m: `9 F' V8 s) ?% |! _
混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   0 P; j7 w+ h; o% K. [, [' f8 [, x5 O& b( N
3. p1 = pyb.Flash(start=0, len=256*1024)
     H9 N4 M( W  m( l; O4 r: J
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   , Q0 U6 L  e* a) f
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   0 i: V) |$ d5 J; M" j
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

: S; V3 b+ U# F( l7 z' m3 T

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

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

1. import os, pyb
   # r, E) z- X) U
2. p2 = pyb.Flash(start=256*1024)
   $ C! |1 X; G2 |7 g
3. os.mount(p2, '/data')

复制代码

9 W1 a/ q" H' o3 n/ d: A
  a/ @  H9 D, D
, E, @1 O3 U% I

来 boot.py挂载数据分区。

+ g. ~, Y; P- S: E0 P0 h混合动力（ESP32）

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

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

1. import esp32, os
   9 [! w, l0 w7 ^
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

5 ]& |( w3 \3 |8 z# z5 T* x

5 x% ]4 }# V( B4 ]/ r

0 v0 b, C6 n# m( ^) L/ |