使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  , E, B" F( n3 Y# [* h

  • 虚拟FS

  • 块设备

    
    & B+ o* S! d2 L

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        3 q3 ~. }+ P* ^4 m$ e# M: K- y

    • 自定义块设备

      
      

  • 文件系统

    
    ! H. m- ]0 S2 B* Q1 [- c

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      3 Q% O2 X# ^5 N' I" u6 Z* g; g
    
    
  
  * V; B9 `5 ~  J, E5 `

本教程介绍 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 的虚拟设备（即它在开始时包含一个虚拟分区表）。

ESP8266

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

ESP32

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

5 ]! r; W: y/ l  w4 B: ^自定义块设备

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

1. class RAMBlockDev:
   , x* S9 S# a+ h0 |0 }! s  Z
2.     def __init__(self, block_size, num_blocks):
   2 j4 [6 H. M& D( n8 c0 h& q1 q7 W) j; d
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   9 U( o( Q. D5 L/ n  H' X: e
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   3 _0 m2 ?  T+ ]+ ?
8.             buf[i] = self.data[block_num * self.block_size + i]
   ( i4 l% a3 [$ R. G- j9 [6 W
9. 
   9 t* O8 p+ g7 p8 o) Q* f
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    ( Z1 k6 f9 \9 u% W2 K$ z
12.             self.data[block_num * self.block_size + i] = buf[i]
    / }$ J. h+ t6 U4 l0 e) G
13. 
    + H" A3 l1 E1 G6 T
14.     def ioctl(self, op, arg):
    ; [; ?0 ?1 K, ?: l5 g
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

& t0 f% s  \: V9 V2 O# ~

它可以按如下方式使用：

1. import os
   6 Q0 H' @/ u: B0 P: Q' P; q
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   ( [  O/ }* M$ R2 R
5. os.mount(bdev, '/ramdisk')

复制代码

7 G1 o+ f/ J' ?% z) w
6 H" B: G) S6 G# B

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

1. class RAMBlockDev:
   ; h6 d2 D9 t* \9 z# I
2.     def __init__(self, block_size, num_blocks):
   9 J, q% e; v+ X! V( I
3.         self.block_size = block_size
   : P. i2 ~+ i* r) H% |; v: W
4.         self.data = bytearray(block_size * num_blocks)
   1 }+ A5 f2 t3 \5 y# O9 y' A
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   ; U1 \" n% N7 ?+ r: p
8.         for i in range(len(buf)):
   ' `" z4 T( ]  ]  W0 u. p2 w7 C
9.             buf[i] = self.data[addr + i]
   
10. 
    , I( y; `# _8 a0 k( Z# L2 P0 X/ B
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    
13.             # do erase, then write
    & T: j' l. W; U! r4 u4 U
14.             for i in range(len(buf) // self.block_size):
    - I5 ^" l9 u9 H$ i
15.                 self.ioctl(6, block_num + i)
    ; }- F' X7 c2 w6 O3 R% l
16.             offset = 0
    ; X' t0 [5 V% X: {: a$ @9 _' w
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    9 H" ^6 T0 W8 c% R
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    4 C% M/ o3 _  R
22.         if op == 4: # block count
    2 p- {5 G* D8 }, y8 L% k- r6 e, ?
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    - Q# p7 L$ E# @* R
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

$ r. u/ G5 [& j
& T' D; C* p% u- @. _9 o, o

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

1. import os
   . X* }6 g) ]% R4 _
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

+ d5 W5 S0 ?2 D- m" [1 t

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   $ ^& d9 m/ z$ u
2.     f.write('Hello world')
   $ K4 v7 f$ t" Z( t" H
3. print(open('/ramdisk/hello.txt').read())

复制代码

* c$ J6 X( {" Q1 }

5 {9 V8 a8 ^, ?, U
2 |' [; r# H, ]9 U
! t$ H4 I! K4 h: S8 U, Z; W文件系统

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

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

. e1 B3 V; O. V- Z6 x7 S6 {/ N  |. dFAT

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

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

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

1. # ESP8266 and ESP32
   & o9 H) ?! v% K; M
2. import os
   ( M" L7 Y' v  V, w
3. os.umount('/')
   * L) i* O! w+ @( x
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   / ^( V, I- P9 f& c
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   * F. M! I; I2 l+ \
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    6 |. L1 e* R2 j( Q3 m4 s. l* h, O& V
12. os.chdir('/flash')

复制代码

) |. y4 V9 v+ d6 q4 D; I
* J$ p( ^$ Y! K2 p( ^) Z" [
Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   & e7 O; u& L& B% A/ e: k
2. import os
   3 z3 c  X5 ^$ \6 c
3. os.umount('/')
   ) A" x& o$ h! [& q, b3 C2 _
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   3 _; |  [5 ^2 g- R" d0 O
6. 
   
7. # STM32
   
8. import os, pyb
   $ r' m6 ~" W8 {& J9 Q
9. os.umount('/flash')
   - O+ Q3 k- c5 C3 ?
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    3 K+ f7 ]# r! Q. Y) u+ Q) L
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

& A# ^" T3 ^; o
0 T; e* b" F3 j: m' [; p

混合 (STM32)

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

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

1. import os, pyb
   1 E- N9 }- W# }4 P
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   # W8 K: m4 M4 K; c# _
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   , S! x" a) t; E: w) |: R
9. os.chdir('/flash')

复制代码

  A4 g1 N  E' [& `

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

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

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

复制代码

4 L2 q! b: ]9 W5 y; z

来 boot.py挂载数据分区。

! i) \# u+ V! P- }" U' h混合动力（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')

复制代码

: {3 @+ {% c$ D8 e

; w; h( C/ a( L% ?- ~