使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  8 A$ I. S7 p& T! g/ N

  • 虚拟FS

  • 块设备

    
    ; o, Z/ R% i) h2 a3 @# k

    • 内置块设备

      
      ) _) j9 k. T4 m, ]

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        4 n! a' v+ J3 {: @( \

    • 自定义块设备

      
      

  • 文件系统

    
    9 `- s4 p; \2 }: U* G

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    ; _  G: u# s0 {) _
  
  

# q1 f+ Z% K1 m; j* T4 `5 p. y# C

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

& F) E% v  h$ }6 V* H9 F5 b- W块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

# {- z9 [& X0 Q) p' }; ?  fESP8266

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

, l( Q7 l! p1 f3 L" CESP32

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

) q- @# c# {* C$ c
自定义块设备

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

1. class RAMBlockDev:
   8 ]' ~. L7 W' }9 j
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   3 j. H4 ^& D, q# u  I/ P
5. 
   2 S3 _, [0 k, h  J  l
6.     def readblocks(self, block_num, buf):
   2 h" n7 U: G7 I* H
7.         for i in range(len(buf)):
   4 X/ v2 b- L8 g# S* ~  O
8.             buf[i] = self.data[block_num * self.block_size + i]
   1 X2 m9 [7 x1 F: ^8 f
9. 
   
10.     def writeblocks(self, block_num, buf):
    $ {. P$ G/ O& G$ ^! T) v0 d
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    1 A3 m6 d3 }; a0 g% t8 t1 p4 `
13. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    , l! ~9 ~( N. C" K  H# L
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

4 ~+ W2 y. C: Z/ P
/ [, B& X" y7 E- k1 T( g4 ^% q# \

它可以按如下方式使用：

1. import os
   
2. 
   : S' Z: x+ m) J
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   , F1 o" r4 S  G2 V7 t8 b) d1 ]
5. os.mount(bdev, '/ramdisk')

复制代码

- N+ `% J+ q/ Y2 u( q& ~+ ]( i

9 `  f% Z/ U; @  |* K/ F

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   - ^" X9 j- A$ z: g- T
3.         self.block_size = block_size
   2 ^) [; R6 ?; g% l
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   , K$ N% }# A/ i4 ^2 i: l
6.     def readblocks(self, block_num, buf, offset=0):
   ' O! ~1 Q' e  @# Q" K
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   * P9 E8 @4 h- K* ]$ @, q
9.             buf[i] = self.data[addr + i]
   $ s2 g$ W0 Y( f  b, L+ ]$ A+ _
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    ( v& i9 v. B& c! X6 U' x+ ]( F
12.         if offset is None:
    
13.             # do erase, then write
    * K( b3 b3 i8 H, n4 c6 g! l5 b
14.             for i in range(len(buf) // self.block_size):
    0 ~5 `" x2 W( O
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
      S4 p! `* q& `5 G
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    1 _* Z/ D+ x3 b* Z6 p7 ^5 q
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
    
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    % e3 i! T9 H6 u: N& G
27.             return 0

复制代码

" n6 g0 F) X. F4 E$ a
( \) d" i* f5 e1 B3 F5 N& @% @

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   3 ?- _' U: e* R5 j% _# ]# Z( Q
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

0 G6 q) g' F/ g# C
$ R" Z3 L8 ^6 i  x( A. S2 ?

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

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

复制代码

" X; ~/ u  l8 I' |文件系统

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

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

1 Y7 E4 l# |  d# I8 L: v- T) G$ LFAT

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
   
8. import os, pyb
     l1 S4 M) V; }) r, ]6 s) G
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    % a0 Q' I# `0 E
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

7 ^2 ?  N6 k# D  X2 x
: O% I9 i5 l' A( U) g" G

Littlefs

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

笔记

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

" t- J/ A0 F' c

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   ; Z6 r7 o/ N0 x/ E
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   7 g' X* N6 w- W
7. # STM32
   & r2 O$ S1 s5 d8 }) @5 a
8. import os, pyb
   / _1 X9 G8 P3 F' R1 W. T
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    ! [9 P# E2 Q/ O! W
11. os.mount(pyb.Flash(start=0), '/flash')
    " J& S5 y& L! B5 W
12. os.chdir('/flash')

复制代码

混合 (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)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   7 S8 S% Q9 R9 S3 l
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

* n& n% _$ l4 k0 ~* q/ r
- h" @1 @" R6 C( w
: [5 J! r4 C1 G- _% }) q

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

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

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

复制代码

8 |4 O6 L8 |9 a

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   ! [: E% k/ R8 B2 X) Q: P: k
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   5 R* \1 |+ c* k! S8 U% r3 D
3. os.mount(p, '/foo')

复制代码

0 ^& e- `/ x& K; V. _

4 s# I  \! O5 P& p
; J) E, B: F+ I  T0 Y