使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  3 x4 r4 S7 G1 ~$ H. m0 Q; T  u

  • 虚拟FS

  • 块设备

    
    ! b) G- \: `8 s3 A  z5 M* j

    • 内置块设备

      
      2 q& P0 D  t2 D7 n6 ]4 p

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        9 j9 ~% o3 F2 C1 b* o6 G+ F

    • 自定义块设备

      
      

  • 文件系统

    
    3 h% C* }7 d" _. V5 K: q

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      + e9 a1 W: s/ b, }5 c
    
    
  
  + m& }( ~7 i1 f5 F/ 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 上，主文件系统挂载在 /。

( y; F0 \6 c( _! f# {块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

1 C# H- |  k! B: I- R# vESP8266

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

ESP32

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

自定义块设备

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

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. 
   8 c# ?. s# O' d- Z; L  E' X
6.     def readblocks(self, block_num, buf):
   $ D  ?2 n6 z! T7 h! f
7.         for i in range(len(buf)):
   " F* M& ~7 Z+ ?" r! ?
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   
10.     def writeblocks(self, block_num, buf):
    - `5 H9 a6 k! Z8 F
11.         for i in range(len(buf)):
    ! X9 D/ x2 B, D% }* q# F# V+ v. I
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    ) @% g& u: M" G3 D
16.             return len(self.data) // self.block_size
    7 W$ v* D: U, b, w& f1 U% ^
17.         if op == 5: # get block size
    4 G1 c/ Q$ f# b
18.             return self.block_size

复制代码

" T& C* Y' U6 R. \' X- G  L
6 q5 b* p- |8 G1 l9 N+ O' ^6 V

它可以按如下方式使用：

1. import os
   
2. 
   2 q: g$ y3 C) ^8 z" C9 d
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   - E& K6 Z' T3 f* r' a& m0 n' _
5. os.mount(bdev, '/ramdisk')

复制代码

. ~8 C2 a* `7 ]9 a" Y6 L( E

0 ]4 W* U, j+ J. {6 t1 W( v

支持简单接口和扩展接口（即 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. 
   8 ?$ ?: a6 N0 M
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]
   
10. 
    - O3 u4 D5 t; I9 C4 E: y
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    ! i2 V# k1 ~2 G
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    ) q; ]$ [/ W# S2 W5 o
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    , d& _4 R) c  X& S- F# v7 x. u
24.         if op == 5: # block size
    5 w: m* \3 r+ ?- v  D1 y7 Y& I
25.             return self.block_size
    
26.         if op == 6: # block erase
    $ u2 B3 g) J9 t/ {7 \
27.             return 0

复制代码

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

1. import os
   . E" @6 U  g) }4 L4 ^7 l7 Q
2. 
   * P. o6 J7 s8 g  S% e3 l
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   $ F8 p. D9 |7 t. p! A# I9 I
5. os.mount(bdev, '/ramdisk')

复制代码

7 w% l5 j' `5 S: I5 s2 S

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   8 k2 A# w# ?6 S1 o1 a/ c3 j
2.     f.write('Hello world')
   8 \! I+ T" D6 q8 L2 u! K
3. print(open('/ramdisk/hello.txt').read())

复制代码

! U9 ?9 t9 C! V) y, b7 n
0 F6 j& D7 S( a

文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   0 j  j1 C6 [7 L$ z# a& |
2. import os
   ( k& s& h: y# @5 J4 h4 H  K
3. os.umount('/')
   , J" y7 n+ ]9 V7 U7 B
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   / k/ X  b9 E/ D3 y% Z4 f. |5 Y8 I
8. import os, pyb
   
9. os.umount('/flash')
   - E; u, ^. {) m0 d( ^: m
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    ( Q. r' [" v& L% Z* Y" E- M
12. os.chdir('/flash')

复制代码

6 ]: e1 s5 ?7 y& J$ e
8 \8 Y* h5 T# G" ^1 G" \9 ~/ _
Littlefs

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

笔记

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

5 p: R- v9 P9 g: f% g5 y

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

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

1. # ESP8266 and ESP32
   
2. import os
     [- n2 n9 p( }5 h
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   / c* A9 n. I! @) ?  f  J* G
5. os.mount(bdev, '/')
   7 m/ r3 N0 F8 A$ H# J$ `( p  S0 t3 T
6. 
   
7. # STM32
   
8. import os, pyb
   / G1 ]# H, c: {
9. os.umount('/flash')
   + l, \) ?7 A: F' l5 T+ }8 N
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    + [& F, ^( p- {, w' ~* Z& x
12. os.chdir('/flash')

复制代码

- w  e1 d% P" y( ]0 t! D# R* B
+ C; E8 n4 M/ }! i

混合 (STM32)

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

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

1. import os, pyb
   5 Z6 e6 \' z  ^# R& `
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   4 H" B! x, p* h% t  U' X2 B
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   7 f3 ^3 D) |$ @$ H
7. os.mount(p1, '/flash')
   4 k! t3 e: w0 t! I8 [4 h7 d0 @
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

2 Q& P+ A  U  i' B

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

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

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

复制代码

9 C1 a3 ~' o" s5 O: H

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   5 u5 i) @4 o1 [5 y( O- q
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

( s1 e  {4 U2 [0 z( t
& @7 c7 M3 ?$ t6 k( Q7 }- N. t0 o! @


$ B6 z6 _% x$ E