使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  ) B, C- t  Q# t5 I! p

  • 虚拟FS

  • 块设备

    
    + L3 k: k7 t" v, p0 q2 f" v7 [

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      & ]. {, I9 L4 T- |3 P) R

  • 文件系统

    
    : M8 E8 E1 l2 s$ @4 t. u

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  

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

块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

& a% h- {7 {4 MESP8266

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

- a  N% N  b5 s$ b& j- C, {ESP32

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

自定义块设备

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

1. class RAMBlockDev:
   3 M: f; Y: a1 l' j, I1 P9 {
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]
   
9. 
   9 ?7 ~# J; {. o; F' E: n
10.     def writeblocks(self, block_num, buf):
    1 \! o0 a1 ~( O; t
11.         for i in range(len(buf)):
    $ g- R4 `: J. _0 \# R  }" F# ^
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    3 _( V3 r( j: h1 q# h+ L: i9 v8 j
14.     def ioctl(self, op, arg):
    , L3 b% U, M8 K0 k" C- J; @+ N; o! t
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    , L( d# j6 P1 J) S
18.             return self.block_size

复制代码

0 j3 _) w5 d. ?9 [' t* {
% r# Q  S9 H$ F, R- _$ w; p5 g- [$ r7 Y/ h

它可以按如下方式使用：

1. import os
   
2. 
   ; P! d; l, M2 R4 c1 m4 s) C
3. bdev = RAMBlockDev(512, 50)
   6 b6 k, q- C2 p# V. J; M
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

# @+ {# z2 i+ i$ }

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

1. class RAMBlockDev:
     R' N' r" B: H8 a! {# f
2.     def __init__(self, block_size, num_blocks):
   . D* j7 ?% F  a/ Z
3.         self.block_size = block_size
   3 A* o8 u* `8 e( ]( v& X
4.         self.data = bytearray(block_size * num_blocks)
   1 S3 ~' [! y: g( l2 c
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   8 b/ f: A- P6 s, o* l; }0 v/ ?3 u
8.         for i in range(len(buf)):
   ! U* `4 |0 i2 b* x. U+ q! f' B' t
9.             buf[i] = self.data[addr + i]
   
10. 
    
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):
    - H& k% ?1 x! j& z6 P0 x
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. 
    % \0 ]7 n  N$ H6 ?0 J0 }5 E
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    4 }$ Q- |. X9 S+ I# _- [& @8 T
23.             return len(self.data) // self.block_size
    % D; r& w0 q. I5 h2 E: P
24.         if op == 5: # block size
    ) S3 I9 l/ b9 E8 L
25.             return self.block_size
    / N: R+ L+ J& a3 t7 T+ m
26.         if op == 6: # block erase
    
27.             return 0

复制代码

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

1. import os
   7 V; ?; }' _. }
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

& Q4 b7 v3 W- V3 q, j

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   $ y+ W# K" z2 e9 q
3. print(open('/ramdisk/hello.txt').read())

复制代码

) ?+ Y, c+ I1 g0 L; V* C" }: S
& L3 Z5 o4 l7 M& E2 w5 J+ \
! h" q! N3 j4 [% Z8 ^2 C. w- \
# a% l0 ^3 k# `2 b6 _文件系统

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('/')
   ) c' j& e: c. p+ l, X: J! j
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   8 a+ P, C  q& {
6. 
   ) l) R9 A, A' v4 r9 A7 ^1 t
7. # STM32
   
8. import os, pyb
   8 [6 l# D9 U: Y3 r7 X( [4 R" q
9. os.umount('/flash')
   5 g1 `4 n" _& V7 X5 ?
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    ! A6 N# V( P* ?) Z4 R; E
11. os.mount(pyb.Flash(start=0), '/flash')
    % P9 J5 A  {. n" N
12. os.chdir('/flash')

复制代码

; h* H$ a1 i( `8 s+ g
Littlefs

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

笔记

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

# l5 r1 I) u3 R3 Z3 u

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

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

1. # ESP8266 and ESP32
   : S  T1 m: x/ P- n- o, H
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   ( T/ N1 f# t/ k$ `
5. os.mount(bdev, '/')
   
6. 
   2 g* x9 v9 C. W1 h* j3 g1 x0 H
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    0 }! q+ }/ f+ G& c
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

- p7 l5 \* \# D' F) G& g: S

混合 (STM32)

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

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

1. import os, pyb
   4 C# s$ Y5 F  Z; W
2. os.umount('/flash')
   # I. Y. ?3 v, l1 \( U
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   1 Y+ g- U2 H5 R* g3 b
6. os.VfsLfs2.mkfs(p2)
   ) V/ N7 E1 _7 V1 p
7. os.mount(p1, '/flash')
   0 n& b0 h% R% U' k  \. e/ \# l) A
8. os.mount(p2, '/data')
   $ W  V" B. M9 y- |0 B
9. os.chdir('/flash')

复制代码

( N9 u6 y* b* S: o/ E  U, V9 w
$ \/ P. ~2 x9 {' p) C- S" m2 `# a
6 t6 J. j7 O0 z- j# C! U

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

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

1. import os, pyb
   - N1 Q% |- V/ y, w5 u
2. p2 = pyb.Flash(start=256*1024)
   1 A# i( S7 l; F5 }6 K
3. os.mount(p2, '/data')

复制代码

/ s1 \+ _; ]5 o7 y1 a

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

复制代码

, |7 m- _3 @# }
0 r5 o  S( [$ H! f6 F3 Y% u


# c, Q9 |1 I2 M+ }
2 y" Y3 I/ V" `: \