使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  / W! d* d; P5 k: Y' c

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      * J$ L% c( l& }- f1 J$ L$ o2 K

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        7 J/ U6 Y" y% \: F) @- h

    • 自定义块设备

      
      

  • 文件系统

    
    + F- ~% \  x" c8 u* f

    • 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 上，主文件系统挂载在 /。

% g8 N$ I8 S" w- N" r7 L& M% @块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

# c* x: \# w8 m( pESP32

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

9 M4 \/ `6 V9 m' b" H5 Y1 C) K
6 c4 a3 ]. [# l! H9 s! \3 B自定义块设备

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

1. class RAMBlockDev:
   6 F6 \% p8 R8 q7 |
2.     def __init__(self, block_size, num_blocks):
   1 N/ w2 A; s3 X+ ^5 _% N* L/ p) `
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   8 _8 W$ [( w4 T8 ^/ l+ J
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]
   + X- q& U! F! q! i& U. {7 [
9. 
   
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    8 q$ u. C0 s1 M9 q) f' K
13. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    % A  b' k5 U7 e& W. a( q
18.             return self.block_size

复制代码

5 ?7 c3 b2 O% f

它可以按如下方式使用：

1. import os
   
2. 
   + Q6 l) A) N$ J0 j' N. @
3. bdev = RAMBlockDev(512, 50)
   1 i6 X- a6 o; h' \
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

& H& v0 o8 o3 I

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
     ], j1 a  T, A
3.         self.block_size = block_size
   * [* |4 Y2 q/ X. t
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   " Y% L  ^0 _5 D$ p" A
6.     def readblocks(self, block_num, buf, offset=0):
   ' Q8 ~# }& t4 E3 o
7.         addr = block_num * self.block_size + offset
   6 r/ ]2 L* Z% h9 c5 o% j
8.         for i in range(len(buf)):
   0 l% i6 a# f0 S9 L1 x
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    ' Y# \9 ]2 j/ B
12.         if offset is None:
    
13.             # do erase, then write
    " h% f% B! D# k) @( t  v( R
14.             for i in range(len(buf) // self.block_size):
    
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)):
    ' ^  _4 \; h" m0 a: x
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
      B) i! o) {! _) S
24.         if op == 5: # block size
    & @$ s  T6 ~) T
25.             return self.block_size
    
26.         if op == 6: # block erase
    ) w" k' k/ ~: K0 ], a& z
27.             return 0

复制代码

# A: |4 C3 B$ H2 r" |1 N" W1 z

1 |% ]& f0 G! h

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

1. import os
   
2. 
   * b' N* a" ^  z, a
3. bdev = RAMBlockDev(512, 50)
   5 i$ w0 i0 d; x9 {% ], j6 ?! G0 k2 P& l
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

& q0 ?& p% e, a# [
2 I5 B- W0 z+ w$ p( W( s7 t

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   4 @( K* X) U% a. N/ [& ]' R4 `5 i1 e
2.     f.write('Hello world')
   " ]3 Q8 G, d$ E/ w
3. print(open('/ramdisk/hello.txt').read())

复制代码

" ~" s$ e2 E3 ~4 Z0 ~1 q! N

# w8 x  w3 U; O2 T

文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   ; S4 G# N9 X+ r; [4 G2 v: [5 [
2. import os
   0 w/ r7 {5 F* j) V3 W; I) R  ?
3. os.umount('/')
   % m/ U  E( t% y0 F( W. L; ?
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   & i, F, o" a( X2 {. ]. a: s
9. os.umount('/flash')
   7 P; o/ Q# R0 e
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    9 D5 j+ N  c+ o* Q
11. os.mount(pyb.Flash(start=0), '/flash')
    * D5 K( X# V8 A% \+ k# L6 }9 u9 S% H
12. os.chdir('/flash')

复制代码

Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   4 Y- y; W; {4 Y$ H7 }
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    3 H% j2 T: X/ ]" h* J  b
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

+ ?) B; f7 \2 a' X5 b" u% i: ]+ G* M
6 u7 L# m* Q7 n
) G, C& w* g# R1 R
7 \( g% Z: y# t混合 (STM32)

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

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

1. import os, pyb
   . f' e' s' G4 Y% H. m7 p, X
2. os.umount('/flash')
   9 O) h5 O. G* O6 O) o
3. p1 = pyb.Flash(start=0, len=256*1024)
   7 h5 `: ~. v: c3 }
4. p2 = pyb.Flash(start=256*1024)
   5 C: F- ]" t' V' I/ X+ C( t/ Q
5. os.VfsFat.mkfs(p1)
   , E6 I/ H6 y( Q5 N4 q: I2 t
6. os.VfsLfs2.mkfs(p2)
   ' S5 @& K5 d) `  t/ a
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

7 n; I; a$ g3 O  |

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

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

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

复制代码

% j' p& ]& I8 x- j6 h/ Z

来 boot.py挂载数据分区。

( d* x( K  _" [混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   * L$ V; I( i3 C6 w) c! ?& b, B4 z
3. os.mount(p, '/foo')

复制代码

' [0 Q, Q8 L! Y; X) q/ q! h: }4 J

3 Q* B/ ]8 v, \

, p& M1 T8 D/ l. k& C7 ^+ `