使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  $ H" S' ~# m5 L  l5 ]  c

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    / x2 g  k, v; f7 c, X

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      2 G9 e% q( T% Q
    
    5 F, R9 u/ z2 V4 S0 c  N5 T, l
  
  / Q7 i9 C* Y6 P

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

* v6 w( }6 V6 _5 G- b块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

/ W0 _3 @! D, cESP8266

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

ESP32

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

自定义块设备

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

1. class RAMBlockDev:
     S7 M9 Y8 l/ A1 y/ G
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   ; ?- j$ h* D" r$ A- p
6.     def readblocks(self, block_num, buf):
   : M! }% D) m( w% |* ~
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   ! l' o2 ~0 @' r  x/ G
10.     def writeblocks(self, block_num, buf):
    5 S  P& D8 a$ I
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    & H: u" ^' F. a/ N2 Q
14.     def ioctl(self, op, arg):
    / G/ h/ `: V; ^' j+ o" A' Z) {- p
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    ! q$ j7 Q$ M( ]
18.             return self.block_size

复制代码

* h7 T, y, g& `0 \! C

它可以按如下方式使用：

1. import os
   
2. 
   $ u: G* a1 [8 w3 s; |
3. bdev = RAMBlockDev(512, 50)
   + e7 R3 l2 V9 p( p
4. os.VfsFat.mkfs(bdev)
   ; D- j! |# w& P% X
5. os.mount(bdev, '/ramdisk')

复制代码

: p' ]/ A; G# n# z
9 ^+ X" I, |7 `8 @. X) B
) i, ~8 j2 d1 a% C! n, v3 C

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   2 b1 e6 G6 y( |& {) F9 |" G
3.         self.block_size = block_size
   4 J& c, s1 X& Q, S7 M1 N- g
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   ) s# {* {6 k% P" q$ H0 W
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    ( w9 s( [& q/ X; h4 M0 u1 c  ~
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    ) R# Q+ I( N8 [9 A* j
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    / ^& z+ U" U* e
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    
20. 
    1 m+ _' u0 Z( n+ @5 H) Z0 n
21.     def ioctl(self, op, arg):
    : n3 V+ g8 @, K! M
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

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

1. import os
   
2. 
   1 j4 u. ]* U" X4 Q: b
3. bdev = RAMBlockDev(512, 50)
     F+ m3 C) R. Z' Q& L
4. os.VfsLfs2.mkfs(bdev)
     d6 t0 p5 B' @( G& u
5. os.mount(bdev, '/ramdisk')

复制代码

( W" A: k3 l( o. u1 ?  f

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   7 o+ E5 a' Y% {# {* }3 b; {
3. print(open('/ramdisk/hello.txt').read())

复制代码

# x3 w* c4 a, L7 J; e9 b! e% S
9 t; P' q- W0 p8 W
4 j2 J' Y- }8 e+ ~0 q( ?
% @. I+ P- n8 F9 l' }
文件系统

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

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

( W1 d9 p# m5 H1 z! o5 fFAT

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

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

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

1. # ESP8266 and ESP32
   , {& \3 q$ |; B# j5 n5 \, Z7 m- E
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
     i/ ?: s* ]6 \# m' T
5. os.mount(bdev, '/')
   
6. 
   5 [; N$ j  \5 }3 o7 G9 X3 y5 G7 f
7. # STM32
   
8. import os, pyb
   6 @- G& j1 [( o5 z/ E/ K) p# ~
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    4 y; U) \8 l# i3 ?( k
12. os.chdir('/flash')

复制代码

" I  @- F6 k' ?  l0 F6 v
( p" f* {: c4 Z; V2 t4 f" N" H1 @, o

6 L- h, N9 Y* S  _" k& h0 H0 I& w2 ~Littlefs

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

笔记

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

) u% B4 V( Y& S% w

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

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

1. # ESP8266 and ESP32
   ; Y/ Q% ~: P. L% M+ C
2. import os
   3 n# u5 c7 {) U# B! ~& [* O
3. os.umount('/')
   " ]2 V& n) [* N6 Y
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   4 x: q3 S+ w7 E$ _9 M  Q# ^0 _
6. 
   % B8 _6 }3 o+ s2 Z0 t) ]
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    5 E% i' x" O( K0 A: J7 u3 D0 b4 @
12. os.chdir('/flash')

复制代码

4 F$ u# ~- o" N- D, f) r$ ]

- g* i2 Y0 ?$ f; p! k2 T3 i混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   , x& m* P9 f9 `/ }# J! R
3. p1 = pyb.Flash(start=0, len=256*1024)
   . ?0 }- k) o. g5 S2 b
4. p2 = pyb.Flash(start=256*1024)
   6 B) x) q* d3 z9 x
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   6 z- \* o8 {8 W* o4 O  v
7. os.mount(p1, '/flash')
   " G# Y, d3 u$ d8 D
8. os.mount(p2, '/data')
   & l* _& H# j& A4 P
9. os.chdir('/flash')

复制代码

" Z2 L# v8 ]* b+ V1 p- x' P& l# A

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

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

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   ' V6 s1 M5 ?2 o- C
3. os.mount(p2, '/data')

复制代码

9 N2 i! e9 z! \4 F, s) l  {0 l

' O; y/ q! q; D8 m

来 boot.py挂载数据分区。

2 _3 F8 `& P+ b% B+ d混合动力（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')

复制代码

! ]! h" x8 e4 g; J0 c

3 I7 e1 G8 i& c9 P$ J( T
* V: i6 p! l) l- a