使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    " U" Z1 Q1 r  f  h

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    9 w, ]9 Q( c7 l8 N' O

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  - O: I  f5 D% h3 U

% V0 \5 e: B4 ]" u) a! o7 o

本教程介绍 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指向默认分区。这实现了扩展接口。

自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   8 O1 ^, c# E1 ]4 o1 d, q* Z! E
3.         self.block_size = block_size
   " D9 R! O8 F3 B0 R8 x. b4 A
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   ' A0 F2 A6 w! O8 q
6.     def readblocks(self, block_num, buf):
   7 a$ ^% E" h6 t4 ]6 @  w! v
7.         for i in range(len(buf)):
   3 f2 I+ o/ E% \: ]6 r& f& h! Y* A
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   3 f8 j/ ]  j3 E, Q# i
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    3 k7 {3 B& P5 {3 r9 p
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    5 O# M: d- ~- d  F, p! B
14.     def ioctl(self, op, arg):
    6 t4 T7 h& T7 Y& ]" Q* {& A
15.         if op == 4: # get number of blocks
    2 s( C: {% k* P
16.             return len(self.data) // self.block_size
    # ]1 T0 ?8 n; r  k! W! N* ?
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

) Z% r0 c4 v& e
4 o1 e) }' _$ C

它可以按如下方式使用：

1. import os
   9 I  ^0 Q6 X. Z- t- K
2. 
   - r; K  ~3 u! Z8 [
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

  q; a) f# j' e2 K$ d

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   . `' d" e. s5 u+ X  D' x) M
3.         self.block_size = block_size
   6 m) A3 `2 W: u
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]
   $ @4 m* H* n6 n3 d% K; w
10. 
    ' D* S* }. d4 o( \; j: E9 S
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    
13.             # do erase, then write
    % {$ e& W. q0 g& G4 L
14.             for i in range(len(buf) // self.block_size):
    * Z6 u0 A- {: v) O7 O) x
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    2 Y6 Z6 j* `$ E4 z9 L
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):
    1 j0 a  n  F  g: t- {+ v1 b
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    6 `7 S8 R# ]. W" x* M
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

" S/ z( B8 Z7 j' q! B

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

1. import os
   
2. 
   $ Q+ o2 C! v2 C1 @8 o
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   . e4 x+ B/ z! b, x- C2 `
5. os.mount(bdev, '/ramdisk')

复制代码

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

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

复制代码

, \+ E6 N. ~$ Y. N

# j5 a) B6 _8 w# U4 D5 }6 N文件系统

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

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

$ d* v' j! {  }1 x' @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. 
   + W, J3 C% t7 j1 X5 ^, Z
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   3 u8 w( J( v& ~) h" k. b
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    0 x) h" w5 \6 m# x$ j
12. os.chdir('/flash')

复制代码

- F2 m0 k6 R- M' M  [' r, M0 I
; c/ _7 l* |" A; V4 c! z. q

4 B' Y4 V4 v( y) cLittlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   7 P$ H2 Q7 [2 i& y; P) Q' w
2. import os
   
3. os.umount('/')
   + z9 J+ R- M: o9 d2 H% V
4. os.VfsLfs2.mkfs(bdev)
   9 d4 T& o; R6 H; Q. T
5. os.mount(bdev, '/')
   
6. 
     x# C! D, o, G0 J7 g  |0 l
7. # STM32
   8 k8 t) p0 C: z
8. import os, pyb
   % \+ n/ O* }$ |  ~( l( F+ _
9. os.umount('/flash')
   ' M7 {1 G! ~2 e2 P% O" v8 y: A6 @
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    ( f! y" \5 J  P  I( L) n
12. os.chdir('/flash')

复制代码

2 ~* K/ M; v' J1 T
) f3 y1 t" K( d3 y; y, S# ^7 I% |
混合 (STM32)

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

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

1. import os, pyb
   , V( S; x+ H1 c7 j" A3 O+ K
2. os.umount('/flash')
   7 q$ p+ A0 ~. ~  N+ T- j" j
3. p1 = pyb.Flash(start=0, len=256*1024)
   . \. l" N1 j" s  n0 r  _3 D! Q
4. p2 = pyb.Flash(start=256*1024)
   ) M* F7 Q5 y; \9 Q2 s4 z9 O
5. os.VfsFat.mkfs(p1)
   ! h$ a9 I2 g: Z* @7 a7 q
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

* M& V: K4 H6 q6 X2 j1 ]9 c% O
0 j9 B  h( r1 k' v( d, f4 R

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

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

1. import os, pyb
   ! i$ {, _7 g8 \( y
2. p2 = pyb.Flash(start=256*1024)
   0 X& D( w: E/ N3 v( s0 r0 X! z
3. os.mount(p2, '/data')

复制代码

+ E0 i) r+ l% |

来 boot.py挂载数据分区。

7 m9 H! |6 U* {- z; _混合动力（ESP32）

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

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

1. import esp32, os
   " c7 ]2 t2 a. P& H& e2 ~8 c
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   ) F0 @7 H( m1 T  y8 o9 z' x+ S
3. os.mount(p, '/foo')

复制代码

! z7 v) ~: p5 `
  j/ U; m4 ?: I1 k/ S4 B1 r% j