使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        5 d' g4 ]3 r; f1 ~3 C0 r, i

    • 自定义块设备

      
      

  • 文件系统

    
    7 o8 P! K9 \  d" q8 Z. [% u: ?+ [

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      9 O3 q! n3 M2 M$ k; O
    
    
  
  

8 u% P+ P( N; }

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

% e% x: r* I' ]. |7 o+ Y块设备

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

: w! q6 d7 S2 @4 H8 M: x
( G" E9 t( }6 Y自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   ; Z" @* F8 p: n* J
4.         self.data = bytearray(block_size * num_blocks)
   " t$ U; |" {  b
5. 
   
6.     def readblocks(self, block_num, buf):
   ' m8 i9 J% ~% I. k0 A5 a
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   9 O. T) t& A8 e
9. 
   , u9 H$ H& D) i0 u9 w/ n' `
10.     def writeblocks(self, block_num, buf):
    - X1 Q3 P4 K0 X" r) y
11.         for i in range(len(buf)):
    0 O: G, _  d& e2 G
12.             self.data[block_num * self.block_size + i] = buf[i]
    . t! r5 c2 d1 n% M
13. 
    * S9 ^9 X# Q% F4 \
14.     def ioctl(self, op, arg):
    % q+ X! n: r) ]# g  {" _
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    $ m8 z6 a) |7 t) z8 h) i
18.             return self.block_size

复制代码

) s& M8 b2 B7 T- N

它可以按如下方式使用：

1. import os
   
2. 
   6 a$ d; J- Q/ d. u$ `, e- c5 E
3. bdev = RAMBlockDev(512, 50)
   9 f' _6 @  U4 {& Z* e) ~
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

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

1. class RAMBlockDev:
   0 f; z; H3 i# _% N; C* k, E
2.     def __init__(self, block_size, num_blocks):
   0 s! S+ u* @% {2 j" F2 X
3.         self.block_size = block_size
   & r# l. D- O( J  ^. `) L6 D
4.         self.data = bytearray(block_size * num_blocks)
   2 V4 {" v" a# t$ e1 A) Y
5. 
   * e. L  o9 D/ c' N% B4 R0 r
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   # g5 V7 E3 v; W' v! j4 K
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:
    # r) [3 F& o" A+ s0 i: u* g
13.             # do erase, then write
    - w9 U, t' `$ K* d9 b; H, g
14.             for i in range(len(buf) // self.block_size):
    0 k3 w$ Y4 j5 L7 `0 V* L
15.                 self.ioctl(6, block_num + i)
    ! m% M8 c( b; u! y' v$ x! R
16.             offset = 0
    3 D" s) T# W7 t' r9 d/ M. O0 i
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    2 {- Y1 ]' q2 ?  E& g7 q' f% b
19.             self.data[addr + i] = buf[i]
    
20. 
    ; s- g* w$ u/ R  |9 V& ^; k% }
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
      d2 S; n: V& {3 w0 z
25.             return self.block_size
    
26.         if op == 6: # block erase
    ! \1 @! c2 ^& y$ U" B
27.             return 0

复制代码

- H. U" S0 h, w0 ^/ _9 U) N" e
0 J2 L- K9 ^# h; y; M5 J7 g

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   " r2 b4 B5 w8 f% ?2 k5 l9 H% i
4. os.VfsLfs2.mkfs(bdev)
   ! {9 N8 f6 [/ L
5. os.mount(bdev, '/ramdisk')

复制代码

, ]# p0 i) J' a1 K" r( b

. s9 o8 f; J" I9 z- w0 P" k

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

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

复制代码

3 y8 C1 k0 J  d8 d

* E. R0 I) U% x8 m% ^# {2 M  I8 G
文件系统

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

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

- I# `0 x5 n0 ?FAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   . x. j- f0 e& [+ V5 _; a2 \; z
3. os.umount('/')
   ' x& t" p+ p- q, j- d5 B" o7 g
4. os.VfsFat.mkfs(bdev)
   1 \/ d: H5 U# _0 l
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   ! V- D  C9 P6 z6 E
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

; Q5 {# Y$ h2 _+ l7 \Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   0 l7 a$ y3 K& F1 h
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
      Z% x  v+ E4 O
11. os.mount(pyb.Flash(start=0), '/flash')
    , k8 f& ^' m- |, `, g& n
12. os.chdir('/flash')

复制代码

/ c* \; i; Q  \% P% |/ ~0 J混合 (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)
   
4. p2 = pyb.Flash(start=256*1024)
   + H: W2 H0 F1 h* T% T; k" `
5. os.VfsFat.mkfs(p1)
     c  b' h& G1 m" R
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
     i  u+ d8 v, w
8. os.mount(p2, '/data')
   # r+ T& I* e& ?( `% P4 u$ h
9. os.chdir('/flash')

复制代码

3 {* }! ?) @* @
  W* f% L$ d' |

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

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

1. import os, pyb
     `6 f4 R7 j4 p) p2 |
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

2 r) K3 |5 S- v9 i' v. ]1 c& y
# |; U1 E! w: T+ H

来 boot.py挂载数据分区。

( w0 u# E: C2 J+ R8 e' _1 [混合动力（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')

复制代码

. T% F( _2 K% E: t2 b3 Z


$ q. s; X5 s. i' Z6 L7 C: K: @