使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  * S, ]7 B* _) W4 ]+ |! U

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

8 K+ ~( q4 M. M. B! u7 n块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

0 p: r% o/ n* H8 PESP8266

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

7 T2 z! J0 W4 ~; lESP32

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

1 s1 x% y  p1 K4 l) ~自定义块设备

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

1. class RAMBlockDev:
   " ?9 A4 U( n! X! r1 }/ C  m1 y
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
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]
   ; K6 s. S  i& f# o% b* j
9. 
   # C2 ^# b2 z, M! Z7 z& d
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    9 l: n% y! p: i6 f
12.             self.data[block_num * self.block_size + i] = buf[i]
    ( P) {9 d6 z. T: D1 x# H& G
13. 
    " e$ ?- X3 U; y# t
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    7 X9 [% S: V% c( ^
16.             return len(self.data) // self.block_size
    ; [6 m  g  {5 _4 I5 p! y- N
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

  c9 z2 f# p& `, z2 t% Z; R
5 {# V6 f& R- F1 y) ?- }
6 B1 S. F7 `7 x8 C

它可以按如下方式使用：

1. import os
   9 R3 K! ?- Z) L7 U/ A
2. 
   / W! P/ M% P* q5 r. X
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

! E( _! l0 J3 q/ |* @
: f6 O5 z3 A9 O3 C- M
7 S- m+ j  j! C! z

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   7 d* O6 Q' }/ a( e
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   + B$ x3 p: \2 t: r& V. ~! E" k
5. 
   ! i  l" w+ I2 O" u  l) l
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   + m5 j% ~6 F7 c
9.             buf[i] = self.data[addr + i]
   
10. 
    6 r9 \: z" P0 `$ c+ ?8 H1 w
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    / A' B; |1 q( N0 K
15.                 self.ioctl(6, block_num + i)
    * T, X$ j+ _/ [% M3 E; V0 e
16.             offset = 0
    / }3 i4 [9 r% a5 V# L- K* ~2 e
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    ( h- b$ `' h' E8 s( ~6 w4 r
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
    4 G, T" @* J3 ^! B+ d7 s0 n- H( s( N
24.         if op == 5: # block size
    , w0 O3 q+ C7 R8 c  {- F
25.             return self.block_size
    * b$ S$ j1 s: c  I2 @5 K
26.         if op == 6: # block erase
    6 {! r4 o+ @& H! \
27.             return 0

复制代码

) o) N  u. z9 t8 y

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

1. import os
   # s, p# [3 l, M# Y4 L
2. 
   
3. bdev = RAMBlockDev(512, 50)
   3 B1 {; y2 |+ W' ^, ]4 Y
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

/ \# S/ \  ^2 }4 }3 M# D, q0 L& e

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   0 y& ]9 N7 @! e3 p' l0 ~4 d
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

) R! o9 }7 T" c) e" Z" ~# \

. L) D% |5 b7 ^; Z0 t& ^
, q$ X/ G( \5 X/ J/ m
文件系统

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

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

+ Y0 Z/ e* Q( F' P3 i) J6 P, QFAT

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

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

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

1. # ESP8266 and ESP32
   2 W$ c/ _9 P( ~2 H. N5 @0 n" l" `
2. import os
   1 _' H9 K: ?! ^! w6 o
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   5 m' h0 Q* J9 r5 j0 c
8. import os, pyb
   
9. os.umount('/flash')
   9 N; K  ]) b9 C, @" \1 W3 \
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    * B. f; `% d9 c" v" Y3 b& w& V* K, R
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

# K$ o! J8 n. S( V
% n" n* J1 \- C" H

* m; \' W- h4 p2 K) S4 y# tLittlefs

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

笔记

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

- V; G# N5 s) X1 Q. X- q

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   8 B6 @( H, x6 E2 Z) e) E
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   " I0 h7 Z1 Y* ^; p
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    2 K' [; J9 g# T) }5 c1 U+ J6 X
11. os.mount(pyb.Flash(start=0), '/flash')
    4 p0 h! V; B/ k1 ~( g: K
12. os.chdir('/flash')

复制代码

9 S8 ?% Y3 g- r1 y1 ]5 u
; O8 W: d4 U0 S& ?2 D4 c

+ S/ i& I. ~  u4 j1 b/ t1 I混合 (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)
     e/ v) Y8 L, p
5. os.VfsFat.mkfs(p1)
   - T" w5 X, V  X% N0 e
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   % e* x8 ^; \8 x# l3 E
8. os.mount(p2, '/data')
   5 X2 z; ~# [* Q: H6 x, G7 d! d
9. os.chdir('/flash')

复制代码

( U8 H  Y4 `7 w# G

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

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

1. import os, pyb
   " Y& O1 q% q( P7 T! Z0 Z8 G
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

* n/ {9 J3 e+ ~3 s# x! \) L
/ C' F/ x+ e: K( ~3 ]

来 boot.py挂载数据分区。

/ B8 `% v( i0 v7 R混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   1 ^3 H, v1 ]3 u1 Z4 m
3. os.mount(p, '/foo')

复制代码

7 D. J/ [) \% N0 n4 Z8 p3 R8 V
  M" Q. x$ S. J' c% N
' e" G1 F5 F4 y+ G$ X& d


: x- z$ ]( H. N, M