使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  . |0 S' F! {& @- m! v# Z. V5 V

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      / m( s; h$ T4 o/ g* n" t9 z

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        , j  P( f: @  P5 F; c) W

    • 自定义块设备

      
      & H' a( I( T: _: N

  • 文件系统

    
    : j& U% C( d/ [1 x/ L( c

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      1 T( T1 h- t3 _$ o
    
    
  
  8 o( u/ Z% W7 {" l( D+ Y3 P! R6 X  ~

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

4 f( p3 g" n* N2 {; I块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

) F& y: e+ A  E6 p2 gESP8266

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

. X' S0 y% t# e, o2 BESP32

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

0 z* [$ @3 B4 k) z
自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   ' ?3 G0 c# ^5 k! P( d& k  e
4.         self.data = bytearray(block_size * num_blocks)
   & y$ ]3 p; `+ {& I4 s
5. 
   + R- O& H1 h& D% `6 l, U5 E
6.     def readblocks(self, block_num, buf):
   5 e' `) z6 J7 K6 A9 y* ?% X2 ]& I
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   
10.     def writeblocks(self, block_num, buf):
    % a0 k/ {% I, h4 K
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    7 N' X8 n7 r6 \$ i8 v
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    0 X1 t3 ]# v5 R3 g' t8 d$ ^
16.             return len(self.data) // self.block_size
    # C4 X3 a* u7 k& \* h
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

0 f  k' l# g: D: Q  n

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   , }5 {' B6 Q+ i! Q" o
4. os.VfsFat.mkfs(bdev)
   4 t: n( A: ?" x+ B9 A  F
5. os.mount(bdev, '/ramdisk')

复制代码

0 g" W7 E! M2 F% ~  Y' I

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   1 A& z- k; u% a( ?$ u) K9 @) S& q# 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):
   
7.         addr = block_num * self.block_size + offset
   2 d* n! }; e. d" A5 C- m* E
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   2 X7 ]& ^3 |) Q8 p$ K% ^
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    2 r  Z0 l% J) w, w6 y
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)
    
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. 
    ) j# S  T) u8 M# O  U  A, Y
21.     def ioctl(self, op, arg):
    9 V' V, _- m$ l+ G4 x
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    , M% l  c5 X; w# s+ z  V
25.             return self.block_size
    
26.         if op == 6: # block erase
    ! s7 ?5 |/ _6 l1 s0 }+ m& {. l
27.             return 0

复制代码

* o# ^& I* [' n; c, y

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

; z; p! m% f2 T$ I
1 X# j: \5 b  ]! C- z

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   * N" O1 J6 [8 E) z
3. print(open('/ramdisk/hello.txt').read())

复制代码

& ^: e2 w  Q* Q- M9 f7 Q



5 m- H0 U; [; e文件系统

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)
   $ J+ u2 w4 J' |0 x
5. os.mount(bdev, '/')
   7 O* ]9 u' G' C) o. g
6. 
   9 S* y5 v' z% T$ c5 U
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   " o, B. d. e. S* S4 j
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    " H) o  d* R5 v, o0 k
11. os.mount(pyb.Flash(start=0), '/flash')
    5 Q3 p# w1 `. U6 t% C8 Y
12. os.chdir('/flash')

复制代码

4 |0 t6 o/ l# \& f+ J

! @- i& u. r! ~# L2 y6 x4 y* S
Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   % @7 Q) Z( }& N! e4 d# Y) q
2. import os
   * @  a# c3 ]/ F, S" n- j
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   ; @3 _) v0 ^+ }0 n& b8 r! @
5. os.mount(bdev, '/')
   & n0 K: U, G$ q" j2 Z
6. 
   % o% k8 Y( `. d  T! H5 a
7. # STM32
   3 L( L( U0 `! v2 O9 D2 m
8. import os, pyb
   4 X' p! F2 r* G# i! |5 H1 v
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    " g% n& f' `% |. B* W8 z
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

+ `; ]* `- Z: d
! R1 f1 T) n2 q% ]' ^混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   8 z) w/ M- [$ X7 G3 q7 Q6 @2 w+ h5 L
3. p1 = pyb.Flash(start=0, len=256*1024)
   $ k/ N& w* c6 g9 P
4. p2 = pyb.Flash(start=256*1024)
   9 q9 E; s6 I! v0 B5 o
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   / D: U' g5 m, t* k/ `
7. os.mount(p1, '/flash')
   5 N, Q+ o, d2 J+ C" s1 t: |" x
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

" b6 r6 l/ \7 L/ g

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

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

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

复制代码

0 ^( M$ ^5 ~/ H
0 B  N  x+ b& K# }
! c* e0 m$ I9 _9 t$ G6 g- u  Y: o% x

来 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')

复制代码

, a9 J& @( l2 G
& s8 c( V, c& {! _1 D& j" C2 V) m
6 g5 a  p. U6 u+ E1 Q$ x

! I  G0 J1 W. z4 C+ t! l5 D