使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      * J0 `  i/ U2 k

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      5 _# c( ]* X3 r8 Z+ }: E

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      . Q% C1 S: K  U8 `$ Z. q$ d4 z: ^7 H0 |
    
    ; Y8 J) S1 o* l$ 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 上，主文件系统挂载在 /。

' W9 C) L  C+ E. }' I: N; k+ G: {2 H块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

" E# d, k2 s  b8 r1 `' p7 c' `# UESP32

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

% r$ _2 M+ }; E4 g# b" z
自定义块设备

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

1. class RAMBlockDev:
   : b8 S9 k* E, Z( i: j5 V
2.     def __init__(self, block_size, num_blocks):
   " i$ f# c& Y/ b6 |" u+ v
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   , @7 k. i3 K; X/ \! z8 n
6.     def readblocks(self, block_num, buf):
   & ^# W1 `+ ^+ Z3 a# J' Z
7.         for i in range(len(buf)):
   0 ], s. q$ m! \# _
8.             buf[i] = self.data[block_num * self.block_size + i]
   ( U2 f8 b* ]3 t. k( n! K4 @
9. 
   
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    * c7 H; J8 {# }, g. k
13. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    6 D: K& W5 K/ p/ b9 i- j
17.         if op == 5: # get block size
    7 x) p& M# ?. ]; g
18.             return self.block_size

复制代码

4 N* `2 O" ~- S

它可以按如下方式使用：

1. import os
   7 P5 t$ j. K: _. e! b+ o1 q
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

5 N% ]9 ?% t/ ^' |8 I8 j9 I1 G' O- ?2 y

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   1 q. \% M: S4 A% v
3.         self.block_size = block_size
   ( h/ m5 o8 Y0 t, B6 ^+ ]
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   $ ]: v) @8 W& p6 q
6.     def readblocks(self, block_num, buf, offset=0):
   . F% l$ X! \* [) G$ ?
7.         addr = block_num * self.block_size + offset
   ' E- D$ J$ x. W0 S8 m
8.         for i in range(len(buf)):
   : t/ E2 R: O, t: y: Q
9.             buf[i] = self.data[addr + i]
   
10. 
    % B* ^* V* f  l2 E  e! `, M# d
11.     def writeblocks(self, block_num, buf, offset=None):
    , b7 ~/ x: X1 z4 L
12.         if offset is None:
    
13.             # do erase, then write
    ) R8 u4 O: Z, L* ^( {
14.             for i in range(len(buf) // self.block_size):
    ! }, I3 c$ [) Z; K" u5 O  H
15.                 self.ioctl(6, block_num + i)
    3 j" |: d: E) h" A# T! d
16.             offset = 0
    
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):
    
22.         if op == 4: # block count
    6 H& U( j- `8 J4 D0 \9 A0 w1 }
23.             return len(self.data) // self.block_size
    . s; X# v) H  L/ o6 R
24.         if op == 5: # block size
    7 w4 Y! B4 M) v+ U  c/ j  z! V
25.             return self.block_size
    
26.         if op == 6: # block erase
    3 d1 |  ~) ^# z  k. p% g. ?; p
27.             return 0

复制代码

3 M9 v; `' O4 ~1 Z, v5 }, `# X

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

1. import os
   
2. 
   % L  v" u  G; L9 v4 C" O- d
3. bdev = RAMBlockDev(512, 50)
   ; W7 U1 t9 B( ^
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

. U1 B( c) X# j

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   * B7 \- Q0 l& U* L; ?
2.     f.write('Hello world')
   $ Y$ Q" ]- A8 Q) y; l
3. print(open('/ramdisk/hello.txt').read())

复制代码

3 p6 w2 n& ^7 k0 [
: _1 `8 x; B. T" W5 V) T$ g

$ K+ R) j+ L; R0 @5 h$ R文件系统

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

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

5 L1 |8 ^$ f1 \& k" U, Q+ bFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   6 E* U3 G' e& [2 \
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   6 A5 Q6 W2 T  s" Y! f; a0 P
6. 
   8 v6 v. b& c) b$ ~& A; T; Z# A
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   : s! a7 D' W: \) v: O$ G* w$ Y4 D
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    " R& F, `! I2 G: f/ U! E' d0 v) N9 ^
11. os.mount(pyb.Flash(start=0), '/flash')
    9 q& R* R2 y/ }* h
12. os.chdir('/flash')

复制代码

1 c2 G& z: V6 wLittlefs

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

笔记

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

9 `: Q5 {8 K' c) n6 W

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

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

1. # ESP8266 and ESP32
   % o; d5 ~2 D, I3 U5 g" r
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   6 _! _" J9 j: t7 @: q' t4 Y* a
6. 
   
7. # STM32
   2 R, M6 m" {. D4 Z
8. import os, pyb
   ! v5 E0 F+ X  H' o
9. os.umount('/flash')
   7 w" u9 [+ }- z7 J" V  k
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    , W, h/ i' Y% D! x" v6 z& n0 D
11. os.mount(pyb.Flash(start=0), '/flash')
    0 b  F: ]* F6 I# w  H( L
12. os.chdir('/flash')

复制代码

0 b7 R+ O( e) R0 L$ m5 B# U  [) ?
, \+ I# y1 Z, h! u0 g- N" I  ]% e
# A; V* n4 L- V- `5 C6 k混合 (STM32)

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

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

1. import os, pyb
   $ T2 p& T9 a" H" o! z) Z
2. os.umount('/flash')
   9 r9 K8 |! v! F; n9 M7 n
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   - N$ d& F6 [  ~, Z
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   1 K  b' ~8 I& U6 [% Q8 B
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

2 u. g; l+ q+ |$ ]

9 ?2 r% @8 n) i9 W# ]8 A/ c

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

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

1. import os, pyb
   + G* D: ]) e  X& o. ~, X" J$ V# c
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

3 V+ x4 f, N+ b: }' C+ ]; [' C

来 boot.py挂载数据分区。

3 _; M, m  y/ c/ v2 X( h2 I5 n' v混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   - v% Z! V; i  o4 A% k5 [8 ^
3. os.mount(p, '/foo')

复制代码

4 i$ I: j0 c1 ~% ~3 ^- w0 k


( w9 S) l  H1 ^3 H$ @6 I
% c9 {+ t' }( }4 K: e! O9 t