使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      : N6 @+ x7 Z; ^7 y3 R/ o

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        % {3 h* r, h4 y) H! u

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  3 M+ ^0 K3 z, t4 c7 X0 a$ G4 u$ f

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

2 U2 \# o* e* r0 V* \ESP8266

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

ESP32

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

自定义块设备

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

1. class RAMBlockDev:
   ( E; Y( |9 M9 a) h3 F
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   9 O- I7 {; C) k5 ?
5. 
   
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   + \; i; d6 G! v8 r# T2 G, l1 k
9. 
   8 a# N, m1 w! O% v; b& g
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]
    
13. 
    8 R: j) G9 t4 n2 ~
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    , |! m; E, o3 \  F; O0 J$ C! |
16.             return len(self.data) // self.block_size
    ( Q; H' E. [; S
17.         if op == 5: # get block size
    1 M% E9 V; V9 m: a' N9 Q7 O
18.             return self.block_size

复制代码

. R6 j! Y6 N3 Z* ?, A3 u
5 \+ o" d+ c& z2 o: s5 I+ \
* x! t( Q: ?7 G5 X* I

它可以按如下方式使用：

1. import os
   . h& D/ x% O3 k0 k4 D% \9 ?% k
2. 
   + g& l9 j2 S- O- P) ~! g" O
3. bdev = RAMBlockDev(512, 50)
   1 ]+ R' O9 K/ [' D
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

1 [& `% n$ v- I# o+ O0 ?: M
% z- X1 L/ q; q3 i

支持简单接口和扩展接口（即 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)
   / U! F, @8 Y% Z9 t0 P2 T
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
     M2 y1 A# N% a6 f  t& `% u9 c; ?
8.         for i in range(len(buf)):
   , M5 O6 t+ @: M- p+ r7 H* |
9.             buf[i] = self.data[addr + i]
     m" v( i# L, v6 j: I) G
10. 
    * a  S: b5 D8 D0 j6 T# `: u& N
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    
13.             # do erase, then write
    7 L' |- b. w* r& Q6 {" w  N; I
14.             for i in range(len(buf) // self.block_size):
    . q+ Q+ M' z, X7 @3 @0 }4 c0 L- x
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    * R3 ^: A, Q4 P1 J- c' ]
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    2 J% i0 a8 O' F+ N) T# D
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    3 w. l2 b$ w7 c0 Y5 D/ w; I% w% x* ^; j
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    , K, G6 C' S/ S: Y9 G( f+ p$ D% i
24.         if op == 5: # block size
    
25.             return self.block_size
    - Y7 v: }9 p9 s( |" {8 [
26.         if op == 6: # block erase
    ' `, t, s$ n8 G4 K( Z/ D6 a7 I' N- _
27.             return 0

复制代码

2 k) s$ P0 n. f$ f! a, L  q

+ c  m/ z# ~+ v+ x5 [' r

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

1. import os
   
2. 
   / k& @# k' F8 \! H7 z) v; k
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

" F& s6 x8 `) R
9 |7 C' \0 q& P$ c& X
$ g6 U9 Y3 {  ?# T0 o, a

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   / n7 `! E# P8 D) m1 B& l
3. print(open('/ramdisk/hello.txt').read())

复制代码

1 D' T& L! ?* M. |, d$ y5 _



. r+ ^. C0 P8 V  b6 j! T* B文件系统

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
   % n: A, Z( @1 c8 Y* b: O% s0 y. @
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   ) K2 G5 a# W9 s
5. os.mount(bdev, '/')
   6 H& V# }5 I+ _+ _. b  n
6. 
   2 c6 N, `: \9 }1 x
7. # STM32
   ' K  h2 I# v) I: V+ d
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    1 U* E  u: T1 D$ {% @
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

) h1 ?8 T/ X4 E! u, p. V/ a- I' n/ k
Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   2 `% u% i, L- ~6 w; y0 N
2. import os
   ; C8 D6 `2 @" o& r) j' @8 X7 V. w
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   4 S/ B+ Q* u9 n9 L( a* W- a
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   # O& f/ q( w0 H$ j/ j# G! j
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

: T. M; n7 j0 d5 |5 l( T9 a, F
混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   0 i% L; G+ R" v" A$ t2 c0 {# P# T
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   ) l$ Z9 H1 h. U* f/ L- ^
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   . u: ~* a$ [- [1 F6 q& I
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

, L; |0 P* T* X3 D1 r" R& }

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

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

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   ) N) C" z+ Q/ N0 _, H# _/ G) V
3. os.mount(p2, '/data')

复制代码

; m% F( w+ I2 J
2 x' c+ C8 E; Y! D. Y( R

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

9 R& S+ H# A# _9 {0 z6 W
8 D2 d* n2 e; h! n  k

& L( b+ `: N$ s
8 y3 s3 {9 O( @9 v# i& k: s
# K( o; h" j8 N; O9 H+ Q" {  D5 e