使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  5 Z. G& \* @( m, G

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      6 e8 F$ J4 x4 _- R. l

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      ; l; w) v. s8 o
    
    ) ]" `1 z$ s7 \9 [
  
  4 D0 v+ T( W& K- G& F

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

/ _4 r$ S) e! y2 K3 v. ]块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

6 i, S. j% i( \7 T4 b% Z5 L- LESP32

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

& P3 w9 C7 ^/ z; b1 Z) [4 K
自定义块设备

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

1. class RAMBlockDev:
   8 A' k; p' j% o7 ?) O
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   : j, I* p" l) H( n5 _
5. 
   1 `! W1 h' N$ b6 \% ]% }
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   - y- B1 q$ z& O* q
8.             buf[i] = self.data[block_num * self.block_size + i]
   4 ~# [" ?' T2 K
9. 
   9 n, f3 y* x, z# c$ B5 U* P
10.     def writeblocks(self, block_num, buf):
    0 f0 S8 r  q* G7 l4 N+ f, {3 e7 ?/ |
11.         for i in range(len(buf)):
    0 ^3 E, b3 ^8 Y4 Y" O0 F1 B
12.             self.data[block_num * self.block_size + i] = buf[i]
    7 O1 j3 {6 I; o+ D7 M4 n+ G
13. 
    , P& ?9 O2 M, e0 A
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    ; a4 s' q: o8 ?5 B1 N
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   2 `/ c' |- n8 t  h; S+ X2 |, U- }+ R
4. os.VfsFat.mkfs(bdev)
   6 Q* w# `- f$ Z( |
5. os.mount(bdev, '/ramdisk')

复制代码

& j* o+ b+ b8 e6 Z, c) j: K

4 H% I$ Y/ `2 Z6 O% `

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

1. class RAMBlockDev:
   ) k& K! A; j: W( v" s
2.     def __init__(self, block_size, num_blocks):
   # [  n. [: M+ C. Z) `+ |
3.         self.block_size = block_size
   4 b% ]; D% p1 `7 I6 d' u$ i! ]( y
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   3 q0 h9 j1 e4 ^6 x: Y# @
9.             buf[i] = self.data[addr + i]
   7 X+ M4 ?! ?; |) a  A3 ]# |( b+ P! O
10. 
    & L/ y$ W0 X7 T
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    % c7 ~. T  v2 \1 s/ h
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    7 J6 S% \( a9 B6 P9 R
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    . {* ?) f: t3 L. N# G  O
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    " x- o4 A+ |. @3 [
22.         if op == 4: # block count
    . Q7 E- c( z, M7 f
23.             return len(self.data) // self.block_size
    ( f! S+ `3 K6 j. |% H
24.         if op == 5: # block size
    
25.             return self.block_size
    * Z# O% |2 W/ C; u7 H/ P" I9 @
26.         if op == 6: # block erase
    1 s: @, }% }0 \' v- ~
27.             return 0

复制代码

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   + d7 `) i# [6 y4 O3 l4 R
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

& h& Q7 g' u6 Z( J, c

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

1. with open('/ramdisk/hello.txt', 'w') as f:
     _+ |8 p  E; D) x; P$ h/ c
2.     f.write('Hello world')
   " f" H8 H5 Q0 i- r
3. print(open('/ramdisk/hello.txt').read())

复制代码

( B2 C2 D, W% b$ ~


' y1 Q+ s- }8 p, t' P- @) _文件系统

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
   : j3 w, N3 z2 Z$ `$ s: T2 k/ m! S
3. os.umount('/')
   2 t" r* T- N& ?/ e) J" L3 |  r
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   / Z$ ~( _4 l; }, `% F
6. 
   ' f' a% G; j% R( P' n' ~% a0 A
7. # STM32
   4 D2 J# X) C; c6 D8 y6 @
8. import os, pyb
   - N$ ~+ l: \* c" {
9. os.umount('/flash')
   & Q. a9 A: t8 b+ T: I8 [4 Z; O3 J
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    , ^  b: y# S7 V7 P
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

! Z8 X1 b- N1 i. d
+ w" w7 x4 G6 C/ P

Littlefs

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

笔记

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

/ \: q; a9 ?7 l, }" J( I7 l

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

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

1. # ESP8266 and ESP32
   & o  g  k' ]; W" G6 u* d. B
2. import os
   
3. os.umount('/')
   0 v. d7 D6 E" o9 e# T9 a+ ?0 _
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   0 m. ~5 p' f0 S: J- I- A  K
6. 
   9 V" k6 x3 E8 c! W/ V
7. # STM32
   + I* @/ U+ m6 A) a' K
8. import os, pyb
   & R7 r9 e! Z7 Y
9. os.umount('/flash')
   * X; U& u% p% _/ Y6 E4 O0 l
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    1 E' q7 }% J! }, R& u7 p
12. os.chdir('/flash')

复制代码

$ ~0 o- `2 o- W, m
混合 (STM32)

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

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

1. import os, pyb
   
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)
   0 z% p" u8 l6 T1 Q" R& {& i
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   / m* H& |4 }$ ~0 U' Z! E
9. os.chdir('/flash')

复制代码

$ A2 \) Z3 i/ o% ?& L8 E8 C7 `  P

# x7 L8 i$ s, l/ e

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

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

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

复制代码

1 l' I# E  D2 A( C6 A: z# W3 ^
9 _+ L. ^# @! q0 \7 E5 i% K9 H3 f  K8 J

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   ; l. Y1 m: u5 `# q' x' h
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   , G+ O% ]' A3 `6 t
3. os.mount(p, '/foo')

复制代码

) C( C3 v: v- _% F

2 s6 ^% l* }. d3 a! t  o
9 `' M! U+ y3 i# y8 A+ m