使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  9 k& j- ^9 `4 X. K) i/ O

  • 虚拟FS

  • 块设备

    
    9 m1 T! N" q' {/ f  y+ y1 o0 L# l) R

    • 内置块设备

      
      6 {+ t5 n5 d# y) t" T5 ?4 ^: N

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        # k/ Y) U6 r4 i- i0 q; E2 O

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      5 x( Z5 k+ n6 k8 }
    
    ; Y2 m5 J3 H3 V1 x
  
  

6 z" ^  u& @' `* m3 u" s- u  L

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

+ u. L' `, d/ l. S块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

" V6 B4 B  O, v6 n  |( c  V4 H1 UESP8266

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

4 L1 R& S: Q/ j, K  lESP32

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

7 \7 r( g+ K0 ?1 i* w$ B. g自定义块设备

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

1. class RAMBlockDev:
   ; S1 j" R$ W( K: Z, j, |
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):
     U; }8 ^3 e+ G
7.         for i in range(len(buf)):
   & Y) r! |- n+ U3 |) k+ H, Q
8.             buf[i] = self.data[block_num * self.block_size + i]
   1 r& B! ~& b$ M( \1 I9 |: i
9. 
   8 Q3 y8 r3 P/ X9 l* i2 L
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    ( Q7 V( q+ b% A6 R8 a0 N. P# ]
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    
14.     def ioctl(self, op, arg):
    6 t9 ?* D2 W$ f
15.         if op == 4: # get number of blocks
    : @9 w# O2 |& q% ~- z7 v- j
16.             return len(self.data) // self.block_size
    ) A# n8 Y0 f  M7 D
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

8 o& B9 o& b: a; {. _1 m2 M

( n1 n! {1 V7 P

它可以按如下方式使用：

1. import os
   7 ^7 F% v$ [5 \7 n7 S
2. 
   / ]! U) w- @, \( p* x& g
3. bdev = RAMBlockDev(512, 50)
   ) Z& |9 a' k( [0 N7 w1 V7 T
4. os.VfsFat.mkfs(bdev)
   ; ?& R6 Z1 f, m4 F8 J
5. os.mount(bdev, '/ramdisk')

复制代码

/ S2 K5 Q3 [9 ^# W

) z( p4 Y1 o9 i0 G4 T; ]

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   ' q# ^# K# i2 z# @. z
3.         self.block_size = block_size
   2 p  s3 k2 g, u4 w
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   ( P& R& ~$ y; ?# Y: Q
6.     def readblocks(self, block_num, buf, offset=0):
   & B* b! A6 ^: w% g
7.         addr = block_num * self.block_size + offset
   0 s" T2 m; O: P
8.         for i in range(len(buf)):
   ! _  L' G( X: ]0 q# l0 l- A! Z
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    / H3 a! M9 C' `! B. y7 z
12.         if offset is None:
    
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
    3 C+ k# B' h( j
17.         addr = block_num * self.block_size + offset
    3 b5 R: q* p- H
18.         for i in range(len(buf)):
    # ?1 j% F& n" z5 C2 E
19.             self.data[addr + i] = buf[i]
    % D% G4 e/ g& h6 a/ F# w6 G
20. 
    0 X% T( N2 B, f
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
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

9 _/ K1 B; |) o9 \
/ p' I: K# c. z
  m6 [! y2 V9 \6 H: S4 i" O' a

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

1. import os
   4 e, M$ S& v4 s! X2 n6 e9 f+ v
2. 
   ! g9 A. E6 y, Z/ O7 z4 N; A
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   # T  y: t' ~$ q  Q
5. os.mount(bdev, '/ramdisk')

复制代码

% y9 A; e" u' \- K
, @& y; u9 J5 r( ~3 A/ f

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

, u: Q" d, w' |, I


文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   9 b' R* f& n' {( r) I7 Q4 P: L- U
2. import os
   4 I. {: q# S/ S, _
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   4 n# l0 w, B0 C" ^! S
6. 
   ; a) H" l9 W4 N  m0 B. K! Z1 u
7. # STM32
   . x" m2 t" P2 o6 t) L
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    8 V$ U, V$ }( y' L8 P2 ?$ {5 j
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

6 R! I7 R' Q% [9 w. ]5 G
7 O# \0 i+ J* h* [/ A9 Y
Littlefs

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

笔记

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

9 O( l1 Y& x1 O( \0 C: d

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   : v- ]8 t" N% \# y3 Y" |
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   $ A: A9 G2 V3 `
9. os.umount('/flash')
   2 G! R: W" P4 X3 o! F
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    2 }: X6 u  V8 _
12. os.chdir('/flash')

复制代码

混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   # N# Q- _, _+ G/ O, a
3. p1 = pyb.Flash(start=0, len=256*1024)
   6 j# J" A3 D& v
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   : s, G. M( ]1 w9 K9 C7 }
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   7 d6 V3 A: Q2 o$ |9 O" m0 ]6 ~* h
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

' g' c' k% p) Y  K

* C1 B0 W9 f! P, z# n

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

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

1. import os, pyb
   ' Z0 {8 o- h! P3 L
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

; h. j; B4 Z0 I5 r. I

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   % s  O% ^2 }0 {" y) O
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

$ _( G6 z* O$ ?! t9 Z, w7 F1 L


" O/ a4 G. c/ D5 Y, n& b- V! S

( J2 Z2 l" c5 i