使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    & s  h  T3 N. Y8 K4 N& P. E% |" W

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        % }5 i* ]" _2 \7 s' j1 P/ L; h

    • 自定义块设备

      
      . \: C; e& o  M, e4 p$ @  [

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      6 g2 _% j5 V7 q( _
    
    0 T9 k; [% K& d2 r9 t
  
  

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

7 D. o7 o- l# U. G% e" M  T* e9 W! d块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

ESP32

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

& ~3 x4 W8 [0 Y
自定义块设备

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

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)
   
5. 
   
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   # T& _' d7 M  e/ J+ |. X$ v  N
8.             buf[i] = self.data[block_num * self.block_size + i]
   3 h  o! Y1 j  T. v0 p, ?
9. 
   1 Z: \9 `! H  d% m
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. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    / q" Z* R6 J$ r4 H4 o% c
16.             return len(self.data) // self.block_size
    2 w$ D+ {( ?& k; s( a9 E  P
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

, N3 B7 Z7 M! s# e, n

它可以按如下方式使用：

1. import os
   & r  Z. ^) g1 _; }3 `
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

: e2 k. k5 l' Y6 a

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   - B* ^) t( q" M; h6 `( J& [
3.         self.block_size = block_size
   0 Y' |8 x5 F$ S; V- f
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   7 s. ~( V, L. q, H
7.         addr = block_num * self.block_size + offset
   ; z8 Z0 U7 c  N7 H/ [
8.         for i in range(len(buf)):
   + |( x+ m& G6 Y  T* _0 T
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    3 `5 x$ ~  E* a6 M
12.         if offset is None:
    : [9 O1 U7 z* _9 `
13.             # do erase, then write
    ! f; I1 K; A) a3 n
14.             for i in range(len(buf) // self.block_size):
    # M& P( t$ A: J& M; y4 n& j3 C+ f# M
15.                 self.ioctl(6, block_num + i)
    - ^, j2 t) d4 k6 F! ~8 G- l
16.             offset = 0
    " g# P- j$ }1 |
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
      I) e- k/ F+ A* ?8 R. M+ \
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    6 o0 L( }3 j$ X. A9 O
22.         if op == 4: # block count
    1 ]9 y- M7 w0 u! _8 {, o4 \& B+ f
23.             return len(self.data) // self.block_size
    : P7 S% G( V9 ]0 T+ {
24.         if op == 5: # block size
    1 C( z- K1 O3 t, l
25.             return self.block_size
    6 @) T4 A0 Y8 |' J$ u/ g8 Y
26.         if op == 6: # block erase
    
27.             return 0

复制代码

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

1. import os
   9 y" q7 Q% B+ j# ^" N9 t, D) P
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   6 D- w. V' K" U' U
5. os.mount(bdev, '/ramdisk')

复制代码

9 i; ~0 X, x% n5 S9 r

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   / D) ]0 H6 O! K" c5 ?. U! z
3. print(open('/ramdisk/hello.txt').read())

复制代码

- n$ j& s2 M' r, ^6 N/ G

$ M, i1 o0 L( W5 W1 Z% z3 ?5 l
! Z: U; S0 ~" w- P, E% u& ~/ R文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   7 q' k4 n: x9 S1 J& H
2. import os
   5 [$ Z) r3 i3 N- |
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   . p, }9 ^% u/ _1 l& L0 d/ J6 r
7. # STM32
   ) ?" R, H5 l0 M, \+ v3 l8 W, ]
8. import os, pyb
     S. e# u2 o. C! E# X
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    & j1 z3 d7 a, [! J2 Q( W
11. os.mount(pyb.Flash(start=0), '/flash')
    , a6 C9 \6 C3 v# X# Q7 B
12. os.chdir('/flash')

复制代码

) f  p+ B% q0 p  z" L7 ]. `/ ?+ T
7 r5 ^# c- c) {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
   
3. os.umount('/')
   7 B) ~6 d2 O! M
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   ( W9 ~$ {" b) y+ t( e$ q8 |
6. 
   $ b( M% a0 ^  Q9 n& M
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

7 s) k* c' T! J混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   # ~4 n5 W. U; K
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   & c6 z( e- _# n( b& p8 s
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   - d8 C( \: ?* C) S+ v, ^  w' Q
9. os.chdir('/flash')

复制代码

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

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

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   3 Z9 C0 g) u9 Q" S/ _
3. os.mount(p2, '/data')

复制代码

来 boot.py挂载数据分区。

* r$ C( {! y( h: p' V+ ~+ F8 o混合动力（ESP32）

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

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

1. import esp32, os
   ' L( {( J- Q/ [2 h
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

$ d2 ]( ]; \! A/ F+ K6 X