使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  3 ^7 C# a, y6 A# e- z5 C

  • 虚拟FS

  • 块设备

    
    ! w% ?. ^+ w8 G

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        # \6 A: T- j3 T# `

    • 自定义块设备

      
      

  • 文件系统

    
    " ~7 ?6 ~! s3 D& ~* q* ]! N  Z. ~

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      3 W2 L2 f& I: u6 F) b, 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 上，主文件系统挂载在 /。

/ ?/ D7 S8 l5 ?/ w. G# G块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

2 A7 e( g: A  b; l) O9 z; c! PESP8266

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

ESP32

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

6 ]7 ]% F8 a* Z" R
自定义块设备

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

1. class RAMBlockDev:
   7 Y& `9 w( s3 e  ]) c/ B1 S9 m
2.     def __init__(self, block_size, num_blocks):
   + x% S( p6 E* E, p3 P8 v
3.         self.block_size = block_size
   5 b6 L- A! y/ \, E8 z7 X
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf):
   % W% J: e% \3 G2 m8 y: K  M9 `' c  p
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):
    
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
    
16.             return len(self.data) // self.block_size
      k: \0 O6 c$ N) s/ f* q3 \
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

0 P; R" @; c/ q0 r8 Q. G

它可以按如下方式使用：

1. import os
   ' q+ m; q; Z1 _/ x0 K
2. 
   
3. bdev = RAMBlockDev(512, 50)
   ' x( @: m4 }' f
4. os.VfsFat.mkfs(bdev)
   ; W7 y, v3 Z0 D/ i% X
5. os.mount(bdev, '/ramdisk')

复制代码

+ p4 I5 E; M- U( o- _& b$ {. k+ b
( B8 g" i( R7 U, d' I* L
7 j& p) g1 Q+ N) ^

支持简单接口和扩展接口（即 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)
     H$ `0 p* t6 U) q! F8 J0 p% a
5. 
   ! @: c! M. j1 @( X# W" S4 K4 h% }
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   + E: y% Z2 q0 q% f7 }
9.             buf[i] = self.data[addr + i]
   . ?: q3 u1 Q2 s
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    . b2 C; C+ ]9 Y: R  Z
12.         if offset is None:
    
13.             # do erase, then write
    ; n* o4 o$ L- B1 _  i
14.             for i in range(len(buf) // self.block_size):
    / Z- ^$ c" }7 l; m7 P8 ^4 D
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    # |' S$ |6 L8 ?& O
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    7 Y0 N) u  V; P9 R3 T: |
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    ; j9 |) I7 I/ D, J1 m& F; l& e
22.         if op == 4: # block count
      u5 V/ {9 w3 ?3 L0 U5 A$ e
23.             return len(self.data) // self.block_size
    % j6 J8 Z7 ?. @* N5 l$ I
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

! K2 N& l1 T8 j' H2 u
6 K. W6 R6 W- D9 V, W! r& p. W
- `" L  x" ?; h. z9 ~5 _& h4 h. j+ ?

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

1. import os
   ) `5 d+ b9 q! M" }. }
2. 
   
3. bdev = RAMBlockDev(512, 50)
   " B/ k) c# t) M; G$ u
4. os.VfsLfs2.mkfs(bdev)
   4 U. S5 f. `+ c0 o+ g* g7 c# e* B( A
5. os.mount(bdev, '/ramdisk')

复制代码

7 K# W. [2 X# a- @! D; Z

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   ) }( ?) B/ K' Z$ ]* s
2.     f.write('Hello world')
   5 C( x0 l8 j3 J" v  k! Y+ Y# L
3. print(open('/ramdisk/hello.txt').read())

复制代码

5 v7 N4 P. B4 h4 e
+ B# ?/ p1 J# L$ p* P, t
( C; y( X2 f# k3 G3 w) X
* s3 ?3 `% s7 y( l+ Z4 b
文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   3 t1 v+ |' a6 k4 y7 J
2. import os
   
3. os.umount('/')
   0 W2 l1 t3 z, w" U
4. os.VfsFat.mkfs(bdev)
   2 w- E+ X( j% W4 E
5. os.mount(bdev, '/')
   
6. 
     G8 i* J1 A8 O, C
7. # STM32
   
8. import os, pyb
   7 `7 f  ^2 l9 T
9. os.umount('/flash')
   / C- M$ u8 \, l! e, t6 s
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    ) R9 w2 a; r" c8 Q+ \: Q$ D
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

2 [) _) _+ y4 b- \: ?0 L  XLittlefs

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

笔记

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

3 h% e" C" ~3 A# ~$ K: U

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

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

1. # ESP8266 and ESP32
   1 {5 I( o; g6 v& D, L& G. S/ ~* d6 D
2. import os
   # @: p$ m, k, `" R8 s) Z" B8 R
3. os.umount('/')
   0 O% u9 A; H# b; l) {- f, x
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   " f. D* s/ {1 c
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   6 k8 s8 L4 s; g" x
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    . B6 R% A; f/ y5 |/ R
11. os.mount(pyb.Flash(start=0), '/flash')
    4 u3 m6 \" U" d( E
12. os.chdir('/flash')

复制代码

2 i$ M; A6 ~4 ~
, ~. t( h$ A" _. l* V% l" o0 o
混合 (STM32)

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

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

1. import os, pyb
   ( X4 {3 v" O& q" D; J
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

& a8 O3 L6 e. Y- X9 B
9 D( r$ m+ J6 D7 Q9 ~

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

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

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

复制代码

: F5 u2 j: C! L; x; t: k

1 O' E6 i# t3 }, l

来 boot.py挂载数据分区。

  p3 r& [- |3 L. K8 j5 T混合动力（ESP32）

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

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

1. import esp32, os
   4 d4 O/ q6 l+ K: @
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

+ q/ k- v! s* r" d% A

  G* v( |$ \& {3 p1 z0 F
7 u. g6 O6 p& C& v- h  j! E  U2 W! J
, b: Z6 r/ p' \2 l. E5 @