使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  " V; G% I  N& P4 y- D! X- H

  • 虚拟FS

  • 块设备

    
    3 c& O$ S# e( s, u

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
          T. O' _2 |; o

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    2 _* U5 x8 G  w3 o  B) W; P& E7 C" z
  
  , W) `4 \" @/ Z: C

+ @$ }2 p/ f; j( g# 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 上，主文件系统挂载在 /。

4 }- o: U& F6 c, ^块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

. j( W. ?: i7 n& hESP32

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

; N4 n9 l6 W2 E
& ?& P0 u$ |& g自定义块设备

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

1. class RAMBlockDev:
   " ]6 b. o) {" q, N2 P+ d
2.     def __init__(self, block_size, num_blocks):
   ' z* Q/ o7 b7 i4 e) B& H6 C
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. 
   , h, z/ [0 ~/ ?. V+ I% \! W
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]
    ) q# N- G, x  Z: }0 B2 T& C& E
13. 
    5 c8 e1 ?0 ^- {; K
14.     def ioctl(self, op, arg):
    0 V9 p2 A1 a* m, R7 {, F% f$ E- f
15.         if op == 4: # get number of blocks
    5 t# c( r/ }% v5 B0 t
16.             return len(self.data) // self.block_size
    1 A' d, B) }( M( r2 p* Q
17.         if op == 5: # get block size
    ( {( j3 ?: T5 c( B( f
18.             return self.block_size

复制代码

- M, T4 B7 j; U6 k4 l1 I
3 R1 u8 z' `* H; Y
- a4 [/ X( G; F& K% V

它可以按如下方式使用：

1. import os
   
2. 
   0 m: Z* ~, \1 I6 D; L3 Y8 D
3. bdev = RAMBlockDev(512, 50)
   5 b, a; M0 |( D5 Q
4. os.VfsFat.mkfs(bdev)
   ) j5 t1 Y8 }- e; K3 @0 y1 P+ I% n
5. os.mount(bdev, '/ramdisk')

复制代码

! f4 C5 k# F3 O# A4 d
- u5 |4 f% S$ M+ u5 h8 P& E

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

1. class RAMBlockDev:
   ) G' [, {$ J. b# I  _
2.     def __init__(self, block_size, num_blocks):
   + R% g, \2 V7 C/ ~) Z" F
3.         self.block_size = block_size
   : _$ i  {/ D: b% n# v( ~2 {+ n2 q" [7 T
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
     X5 w" o2 Y- c! v! k; ?: O
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
     J4 r9 \, O2 L  g# ?# k5 e+ j" P
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    & _- R; _* C/ V4 N
12.         if offset is None:
    9 L" o& b, h$ Y+ h+ i
13.             # do erase, then write
    # K' x/ S! a8 [5 k3 |1 x
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    ; P6 H$ e4 F: S! |- q
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    & ^% y# E% i3 L7 R/ [" u" w
19.             self.data[addr + i] = buf[i]
    . B# B5 F( E" ]
20. 
    & b3 z' J: k8 a1 A6 q
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    & B( {/ {2 ^( k; |3 ^
25.             return self.block_size
    & Z* |! j- f  E9 k5 Y/ B3 x
26.         if op == 6: # block erase
    * N% G& Q$ \) A' e+ t
27.             return 0

复制代码

* y) T. D* D# X

4 f5 J% K4 @% o4 D

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

1. import os
   " b5 [9 u8 l! d. L0 y" l
2. 
   ( r& f  Q( P; a' D# E' |
3. bdev = RAMBlockDev(512, 50)
   * l5 A6 I2 |6 y5 r% P5 D7 j. s
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

  \9 z7 `  D* ^& T7 V/ H
+ G  l. c; V7 n) I- V

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   0 C5 d% D9 N7 }: j# {
3. print(open('/ramdisk/hello.txt').read())

复制代码

3 [  J( d+ N" W* [2 c3 k3 y7 {


) ~3 r8 J! g* m) ~! c! u5 _文件系统

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
   7 N9 r, V( @: u7 a
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   + i6 ~. P( ~9 m7 E  t1 l- j1 M- t: Y* @
6. 
   
7. # STM32
   ( N5 g' ^7 y; A8 x, ]
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    ; k# ^3 _1 f: c
12. os.chdir('/flash')

复制代码

$ W# x+ c' I# ~
) o" `- q. B& u8 ]* J

Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   + C. Z$ G) `; z& s. Z1 o2 u2 A: C
2. import os
   
3. os.umount('/')
   , S& }9 t0 @8 R: p5 L1 X
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   ' i+ i6 [) r) ^: W
6. 
   5 l2 ]* n8 I% [/ s- a
7. # STM32
   
8. import os, pyb
   - \/ z! G- C4 ]  T7 O2 u1 `+ g. a, A
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    ) t- o; T5 J: r$ c
12. os.chdir('/flash')

复制代码

8 C) ^! D, _2 R2 P0 k9 o& a' I( G

: Y' g2 y" R* h* z- k3 j
9 e% E- _1 `# W$ l2 K混合 (STM32)

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

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

1. import os, pyb
     Q! z  n9 d4 M, `) c8 ^
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   ' F( ]: O5 k: N) `0 e
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   ! s! \% P" w4 s" b6 B0 E' e
6. os.VfsLfs2.mkfs(p2)
   9 t6 f$ g0 _2 {" T4 T* _  r
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

2 p0 l- q8 `3 L$ T: v, f2 q

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

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

1. import os, pyb
   9 e4 ?# R* r# _/ P) r6 U
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

6 x7 O# Q, O7 o% j. ?* t3 a

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   : l/ l: J$ p6 ], T: H5 _# }
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

% e% L' Y$ C2 g* v# J+ Q! L$ l% N8 ]

8 T( A0 [$ a3 b2 Y. Y) @