使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  - D% j6 r( J4 C7 E

  • 虚拟FS

  • 块设备

    
    : [8 H1 x2 m- O- \

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      + p3 a& S1 v6 n* _& z1 p

  • 文件系统

    
    0 d+ f3 @) H+ m( u

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      : O4 G+ T8 {7 y) f
    
    ' s7 f& ~) T& G% L! Z. ^: ?
  
  

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

( Z" w% A& `$ e' L! YESP8266

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

ESP32

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

! j" x; b  L; e自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   8 G. @4 u2 X, o8 s
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   5 p, `& H5 V+ C2 J# m* E5 r
6.     def readblocks(self, block_num, buf):
   8 E+ U) y. T) f4 L- W+ |8 z" ~$ y
7.         for i in range(len(buf)):
   . F3 q/ v; e2 t; L
8.             buf[i] = self.data[block_num * self.block_size + i]
   $ I  @! Y+ Y: h2 _1 Y5 a
9. 
   
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    ; q8 @! o! E" A! Q  U( f
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    
14.     def ioctl(self, op, arg):
    % w8 a8 i# n5 _0 X) a
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    " R# ~0 Y% V, m
18.             return self.block_size

复制代码

4 j3 L- e0 F( U' Z
% u+ e$ r2 e" u6 f, z/ ~
' Z& K7 P/ r- E* ^7 M- |7 D4 \

它可以按如下方式使用：

1. import os
   ( a+ M3 x- v) q, [, x9 |# d
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

  s6 S: v! _8 M& ?; e& [

, F+ @0 U4 W7 x2 S7 @

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

1. class RAMBlockDev:
   7 N$ M' |* z0 c% Z/ B
2.     def __init__(self, block_size, num_blocks):
   5 A1 \8 R8 Q6 D7 l# E' U' r' ?- g
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   5 v+ {8 q; ^, Z; K" k9 v
7.         addr = block_num * self.block_size + offset
   0 U* F0 A7 P; Y" G
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    5 \- @0 `/ ^3 R% T8 X4 }$ w1 L: W/ f, I
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    : q: R! C9 D- L# \
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    0 G/ R' v) F3 M" q7 A
15.                 self.ioctl(6, block_num + i)
    , ?3 x+ k! p- L! n5 A; H9 S( }
16.             offset = 0
    ; R8 }9 V* b: `; f8 w
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    # _$ D4 [( x! t
19.             self.data[addr + i] = buf[i]
    6 m8 }% ^* l4 b& b+ e1 R/ ]% c" `& \( O
20. 
    
21.     def ioctl(self, op, arg):
    % R+ ]/ M6 f, Z  ~( V
22.         if op == 4: # block count
    2 _+ }, g, {5 p0 W( C! I0 y
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    6 o0 V3 x5 l1 ]; l* @! V
25.             return self.block_size
    
26.         if op == 6: # block erase
    9 o, W7 Z: t. {- j: @
27.             return 0

复制代码

  c5 c3 U1 w1 u, h; c) l

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

1. import os
   ( P/ m, r2 h/ Q+ @3 {8 Z
2. 
   1 U& O) O5 B7 |5 Y  M3 P! V( j
3. bdev = RAMBlockDev(512, 50)
   + Q4 |/ l+ Q% s& s* r+ N
4. os.VfsLfs2.mkfs(bdev)
   % w& B8 u- E% P: }" ?0 j' }3 g
5. os.mount(bdev, '/ramdisk')

复制代码

$ \) e  r) x& {' }2 m2 o
/ F. E$ e0 [3 W$ g

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   + P: L# _4 o: g! [, w; q
2.     f.write('Hello world')
   " p+ k% X( ~2 u; Y8 s, W+ O- L8 q
3. print(open('/ramdisk/hello.txt').read())

复制代码

1 J# |! k# B. `2 v5 i$ R


9 q2 N# w4 |" V7 k9 d* q3 ^8 m
文件系统

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)
   * {6 |5 C* c* G; y/ W. \9 V
5. os.mount(bdev, '/')
   * G* {  ^- p2 o+ W" g5 S
6. 
   % c9 x0 V! ^1 [  {8 F
7. # STM32
   / E  z) i: l. @1 m- V
8. import os, pyb
   
9. os.umount('/flash')
   & q" \8 S! W9 d5 W, d& h
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

, e/ P4 d# e4 N) z2 V" O: g1 g
" k9 T: i) k3 ~6 @  H
Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   2 g1 J) l1 g* X9 R, f4 q
3. os.umount('/')
     X: O. {0 N& e  t9 ~8 [
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   ( ^$ c; P; N1 V( h' E
7. # STM32
   
8. import os, pyb
   + @2 a7 J* a  B: u2 v
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    " p" j1 F  T8 b% q
12. os.chdir('/flash')

复制代码

* @& [4 \) J9 E3 M


; G$ q7 a9 W) ]9 {混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   + y9 r# b8 I) V* \/ f  ^
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)
   - M# T) W" v' ?8 F  u! ?6 O! A
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   8 h  w& m; s4 X7 x
9. os.chdir('/flash')

复制代码

! y! D" Q% J) T: r* c

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

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

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

复制代码

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   ' @! v$ |0 Z% b) \/ Y" J
3. os.mount(p, '/foo')

复制代码

! e( Z& i' I7 n
7 g- j6 \( s5 G6 t