使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  6 y* [' H) B' g: I: p

  • 虚拟FS

  • 块设备

    
    8 n+ g. p' e" J0 O$ @

    • 内置块设备

      
      - m/ k+ x0 e6 \0 R2 t

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    " |( R+ p8 P, ?+ @7 r1 \' |1 c
  
  8 R* @0 y/ G9 f6 j# H6 @

+ a- |) ~" v* X4 l: 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 上，主文件系统挂载在 /。

5 U; ?0 |% i' Y1 A; G1 {块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

7 k3 n; `) ^, P6 L0 cESP32

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

' I+ H2 h5 `! b8 ?7 g+ ?, v/ ~7 ]
自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   " E& O$ ]4 h. J" @8 Y! g4 R
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf):
   # h$ h& S5 _0 n) L0 F
7.         for i in range(len(buf)):
   7 J6 x- N, z! [" v( K
8.             buf[i] = self.data[block_num * self.block_size + i]
   1 x3 [- {/ j7 f4 b5 Q4 K2 e; P6 V
9. 
   6 {) m1 B; y" C9 n$ i9 v" T# J; C
10.     def writeblocks(self, block_num, buf):
    1 _0 S6 ]( G6 k6 Z
11.         for i in range(len(buf)):
    + x1 o% O0 Q) G# L! }
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    ! r% `; n) Z7 U, R) D
14.     def ioctl(self, op, arg):
    . R4 M2 y$ x6 L+ r- f
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    ) X+ S" ^* s+ B) N. z1 P! g
17.         if op == 5: # get block size
    ( u+ W7 M- k9 \  b
18.             return self.block_size

复制代码

& V9 G. A& {* Z8 s5 I

它可以按如下方式使用：

1. import os
   ; Z4 W; t( z0 m: z2 r. V
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   * `1 w1 c: \. n8 S1 m0 l$ }" A7 u
5. os.mount(bdev, '/ramdisk')

复制代码

0 _6 m. V8 T* s. u0 b
) J# o% x" l, M
: s; `+ J: u" O8 u! g

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

1. class RAMBlockDev:
   # P& b1 c" n/ r* }4 g8 G. H( g
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   4 ]/ y0 ?$ A: x1 X5 d4 _: A. l
4.         self.data = bytearray(block_size * num_blocks)
   ; U' [* L) a' A% b
5. 
   - D9 ?; w/ m3 n5 d3 p' U, r: i
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   . E( D+ B1 U+ ]& M! h% o7 v
8.         for i in range(len(buf)):
   8 v& {; O. O: U0 ^7 P1 ]: I# f. R
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    - q6 A3 s; p! t% k0 R2 I
12.         if offset is None:
    
13.             # do erase, then write
    : `& I) H3 l5 Z$ _" [6 a3 B5 K
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    $ \. S% d) ^5 ~" a& @
16.             offset = 0
    ' i5 _9 L0 e7 z6 {$ B
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    & ~6 {+ H- K0 h2 _6 b
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    + Y0 u2 Q, f7 K0 ?; Q! a) i: g/ l
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   2 F2 j# ?3 B# F9 K" t( E
4. os.VfsLfs2.mkfs(bdev)
   0 F: Y* F9 S; c, f# j7 R
5. os.mount(bdev, '/ramdisk')

复制代码

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   : }) _  ]( [2 E. a+ L
2.     f.write('Hello world')
   $ e1 f0 ^. k2 L$ S- {4 J! H: a8 _$ x
3. print(open('/ramdisk/hello.txt').read())

复制代码

1 L- [: F6 e" b* S



文件系统

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

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

% i  h1 U6 W. N! k! f; UFAT

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

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

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

1. # ESP8266 and ESP32
   3 e! z/ e0 R& Q
2. import os
   
3. os.umount('/')
   . i1 p+ U4 S4 c
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   , a+ v% D+ {5 `; X  G2 X
7. # STM32
   , \6 q$ m7 Z( ~! E+ B
8. import os, pyb
   
9. os.umount('/flash')
   ) w: G9 @5 f& U; q9 R. _0 e5 i
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    ( L+ i5 T( {' [- M
12. os.chdir('/flash')

复制代码

, q# D1 T; _$ t* F' I, ^
' A" o  d* X- y. u
Littlefs

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

笔记

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

9 }& E/ Z& e+ ^1 p5 W! N6 b

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   9 j7 s1 v% J) I) h
5. os.mount(bdev, '/')
   / B: A1 U% G  T
6. 
   # S( H8 C% {7 ]; d! u5 a) U
7. # STM32
   6 K+ }9 C* J) u
8. import os, pyb
   + J% ]: i) ^/ q' e6 M
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    ( D0 [) G, D/ T( p( L" g
11. os.mount(pyb.Flash(start=0), '/flash')
    7 ~: D# P% h5 C0 N) J% ]4 v# E
12. os.chdir('/flash')

复制代码

2 w) G# C* K, C% m7 M" H
% {6 J2 j8 H: X& m: a5 g: f+ u4 _

混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   + \1 z) D5 j# f+ S
3. p1 = pyb.Flash(start=0, len=256*1024)
   ' c3 X1 K& f6 [; l' @
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   0 N. ~$ y, }: l& Z& U* w
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

: o9 M* P3 w# }( q
% M6 c+ I2 Y# R

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

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

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   ( X3 @8 l. t8 b3 V8 i; C: g
3. os.mount(p2, '/data')

复制代码

( C( K8 K; Z# Y! l
2 e& V" o/ R, w, L4 ?' }

来 boot.py挂载数据分区。

8 U8 u; W  D" e: J0 j混合动力（ESP32）

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

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

1. import esp32, os
   - E2 n+ b; U+ j3 l% e% I" R
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

) U2 I5 Z: |) {8 A) A