使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      & ^( k& \/ H- k: w3 C$ v

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        5 y2 K( Z8 O3 ]

    • 自定义块设备

      
      

  • 文件系统

    
    : A5 O3 @4 @6 F: |- [0 Y

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  0 V% B/ T+ h9 }

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

块设备

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

% O, s# l- B5 P8 y7 h8 k0 H
自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   6 U( ^2 L1 ?8 e1 B. h- v$ Y( \9 Z
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   5 d5 U$ N+ c- j- Q- S8 `9 d
5. 
   
6.     def readblocks(self, block_num, buf):
   + m7 ^9 H8 C% B' E5 q' M
7.         for i in range(len(buf)):
   5 p7 {8 F$ `; @9 ?) p+ I
8.             buf[i] = self.data[block_num * self.block_size + i]
     |: C: F, o% n( r
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]
    ) a, [* K. S& e
13. 
    
14.     def ioctl(self, op, arg):
    4 k# S& |7 ~8 }/ n
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

3 u" h# }8 r, \& ~; [. I* y1 j% \* L
6 c7 H" B7 s- X& n1 y/ j- J

它可以按如下方式使用：

1. import os
   % w, |6 V/ x2 K
2. 
   0 a. p. q4 A4 K7 g+ D* d
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

$ c7 r  \; B1 A6 L3 ?

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   + o$ Y  p# W/ ?% N
3.         self.block_size = block_size
   ) C0 T; t8 ~+ Q6 j9 U% I
4.         self.data = bytearray(block_size * num_blocks)
   ( ]& ?& C2 B! u$ |
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   % e7 y$ Y$ V% k  N1 g$ ?' d  t
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   ( B9 z. j9 o- ]- E1 J* _' b- L
9.             buf[i] = self.data[addr + i]
   
10. 
    7 K) B& {  r1 X  G8 y7 I
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    1 [# p! O5 b% c
13.             # do erase, then write
    ! i) p: h: d. c. O
14.             for i in range(len(buf) // self.block_size):
    0 B% s& @9 e) d* q
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    ) Y: C* C4 F. Q+ A
22.         if op == 4: # block count
    0 [- A* q: H5 U' I0 n1 Q
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    % m/ M: y) k& B/ n& P$ o: L) V
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

& U8 W, T) ~: t  M

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

1. import os
   % d8 E& e) a7 u! c$ o& K3 k
2. 
   
3. bdev = RAMBlockDev(512, 50)
   ( I2 ]  R5 D/ m* I# O: }
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

' M- ~8 d% F! \, I3 |; p& H

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   - R8 g; j5 j" S# u/ V! O9 v* A
3. print(open('/ramdisk/hello.txt').read())

复制代码

; O! T2 [$ b+ A. Y' N1 S
1 ?2 {3 E) k3 k! b& Q6 W
8 |* \% ?: J8 Z7 \# _' F5 o; H文件系统

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

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

! U2 t. r* q/ \0 Z# c. j" A) oFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   , B% z4 h7 K% C% {3 R
7. # STM32
   
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')

复制代码

! c1 t8 A0 G' H% k8 x& d+ s" f4 L
& y6 ]: V! h7 j" Z& ]
- W3 X/ _$ h; `5 n. a, ~& k) v
5 K( X% a; u  j' j5 ~4 H+ \( K& n7 Z: ~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('/')
   & X+ o) R$ n. C, j/ ?# o
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   : [8 l3 g& h) K0 \. z( \" h6 J
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
      U! ?! W4 v+ o4 k
11. os.mount(pyb.Flash(start=0), '/flash')
    ! h3 R/ h# d  X, m2 s* y9 a
12. os.chdir('/flash')

复制代码

% f4 O0 ?0 q1 F


3 w7 Y$ f# F- j2 o/ [6 F混合 (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)
   7 }! ^% q- H+ Q5 h
4. p2 = pyb.Flash(start=256*1024)
   3 N0 i5 W0 `0 M5 c
5. os.VfsFat.mkfs(p1)
   8 q7 l* o5 z9 w$ \1 Y$ T3 ?
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   * g0 ?6 W% B, A
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

! o0 _, N6 ^1 J* }

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

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

1. import os, pyb
   6 r, F7 a4 O# N# I# e3 [- J- N3 j/ {) Y
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

+ I* ^' S8 V% Z; [* l

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   9 `& }. ^! ?' e* a% s7 ~
3. os.mount(p, '/foo')

复制代码

% q& o2 ~. q% ?1 E- v) |9 M
. i* t1 N" ?& |, W. d
; \/ Y4 f  N) o2 Q

2 n, @% V' N7 e# k