使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      2 P( G# x; ]2 ^5 \; a2 w7 K; `1 W: J

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  ; i/ [; |* i$ z, q. ~4 V

本教程介绍 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 的虚拟设备（即它在开始时包含一个虚拟分区表）。

) E% {/ c, J" BESP8266

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

6 N% M! v# Q7 W) X$ q6 XESP32

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

自定义块设备

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

1. class RAMBlockDev:
   1 Z5 M, S# R' Y" j$ E
2.     def __init__(self, block_size, num_blocks):
   ' ~8 E* E- K( q* ]# X. F: S
3.         self.block_size = block_size
   / D' R4 d# W; w: _3 o% p
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   & W, f( I$ j  L( {, G7 [
8.             buf[i] = self.data[block_num * self.block_size + i]
   4 ?5 E1 Y" Q" S5 Z9 @$ L
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. 
    & t" u! L/ V1 [# p
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    ; O7 ]; _% f1 B& c7 {
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    " X! e6 K5 x0 X7 S
18.             return self.block_size

复制代码

& n+ f# U+ U1 Z& R# n

它可以按如下方式使用：

1. import os
   
2. 
   ! v3 _2 A+ `8 |1 b8 f8 p
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   ! I) V- m: O1 A5 H  L" X* A1 f9 M
5. os.mount(bdev, '/ramdisk')

复制代码

& g/ d" w% ?! l2 J/ J$ X0 x0 J/ i

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   ) O$ x- ^  O" n( W1 O) U
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   - R, i  ?: _, @) ^  q6 X
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   " P* Y% r. u- X# H% Z
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    ( Y, L% d: L1 @1 @( b
13.             # do erase, then write
    + F9 ^' N2 h. d
14.             for i in range(len(buf) // self.block_size):
    & \  q; z% Q* p) D; J2 Y( d
15.                 self.ioctl(6, block_num + i)
    9 X( H2 S# L2 ^
16.             offset = 0
    3 Q& T5 Y5 F7 ^7 r6 [; {: u8 h: b
17.         addr = block_num * self.block_size + offset
    : [0 c* e' U3 v7 n+ }1 w/ @9 D' y
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    
20. 
    * r* J( P* O" z  i0 O
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    $ ?. [. |& L" I6 M/ ~, F5 l$ o
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    
25.             return self.block_size
    " m( @. X7 d' N/ U- b
26.         if op == 6: # block erase
    0 Q) b8 C3 D) Q: Y7 Q2 d% X
27.             return 0

复制代码

7 \: i. M9 I9 J( T( O+ c+ {0 P
2 n6 b& M$ W& T
  F* d0 A" [$ z& F8 h: }; Q* w, h! R

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

1. import os
   1 n' V* v: k+ {; \. a) _, p- T* J
2. 
   6 }  [0 M1 K; M7 n
3. bdev = RAMBlockDev(512, 50)
   ; C, k0 a( M6 S
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

# T  W8 F; d9 h# O0 [+ r

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   5 y: i) _* C/ o) ]# ~3 K
3. print(open('/ramdisk/hello.txt').read())

复制代码

1 N5 b* K# e! ?- D; o) k
. t: h8 J- K" Y# Z
4 C2 Q+ |1 x5 t
$ h  E, R: w5 g9 N) ?4 c文件系统

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
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   * f& l0 d" A' e
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    2 X( @" H7 `/ W- J1 M
11. os.mount(pyb.Flash(start=0), '/flash')
    ! R* q4 H2 R& H' q/ k5 ^
12. os.chdir('/flash')

复制代码

' _1 \0 e1 I* D) B* L
( _% h- J0 t) k. H' r( i3 g
5 A; C) j- F3 ?1 N& YLittlefs

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

笔记

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

+ b+ I: C) `$ Y0 m2 T2 Q- G0 l0 }

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   0 W4 L# O& ~6 _6 }* [( }& e9 B0 w
7. # STM32
   8 F- J7 q( R% E! p( r6 ~- K$ O
8. import os, pyb
   7 R2 ]: }! @# D
9. os.umount('/flash')
   ; b5 d; K% k. {/ i8 |
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    # G2 \# a) R% f7 V
11. os.mount(pyb.Flash(start=0), '/flash')
    * o0 T) X; l4 w. T
12. os.chdir('/flash')

复制代码

2 O. r* ?  z. G: U: Z

2 x2 N5 Z" f2 a; q! m9 Q
$ q* P& o0 S& 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)
   # a- r$ v6 L2 h$ [; E
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   / g4 Y5 D( H9 r
6. os.VfsLfs2.mkfs(p2)
   ( z/ n1 ?7 }" X$ c
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   : L/ S6 L$ \. G: Y3 p
9. os.chdir('/flash')

复制代码

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

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

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

1 ^6 i! n  p: E5 r$ s
  O' n2 ?) a' h; d

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   3 R+ D& ~- d: d& w' Z. J2 o
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   % r$ J  [/ X! j: M
3. os.mount(p, '/foo')

复制代码

) y  l1 [$ U( c0 ~9 E, v
8 q8 Y1 i) P! A6 Z
- ~, {. A8 l, F7 _  p! [1 o


3 d2 H9 L. ~" z