使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        ; N  T6 P9 {( C; M$ Q

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      , `$ u, `. H8 R; f
    
    ; C9 T9 S1 D/ l# a
  
  ( H0 Q$ L0 d1 c: m$ o

& L1 c$ M/ i  V, |

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

3 e! z: S: {% g' V1 m块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

* h% o+ E# g3 X9 d. e# PESP8266

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

- v- d  W9 a' ^3 {' G: n% m& k# eESP32

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

! Q  _) Y7 ?* q) W
, l8 p3 Z- H+ l- H$ [  G. H( H自定义块设备

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

1. class RAMBlockDev:
   $ O: b5 ~2 W# r7 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):
   
7.         for i in range(len(buf)):
   : V( [7 G, `- F4 w0 S( E9 O4 J" k
8.             buf[i] = self.data[block_num * self.block_size + i]
   & d: a0 q( z* s* d' u
9. 
   ; b: x% }$ @+ `
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    9 h- f+ K1 y) K9 {
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    ' a) `8 ?; M  p, z$ ?
14.     def ioctl(self, op, arg):
    ! T" I: a3 U/ D+ d
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    3 N( w- J2 C0 H, _+ ]) Q
18.             return self.block_size

复制代码

它可以按如下方式使用：

1. import os
   / P" l% _/ i: F, Z
2. 
   * |6 m+ ~7 p# i9 S
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

# z& }+ j: c1 O2 |% z: T

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   ! ~' P! m( q/ n
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)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    $ M. F. Z, ^" q" z, z
12.         if offset is None:
    ( J8 f0 h5 c6 |
13.             # do erase, then write
    5 M# }/ l4 [! O* z5 U7 ?
14.             for i in range(len(buf) // self.block_size):
    - N- j* j6 N9 B, f. s; ^# n
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    . @$ r; }: i' Z
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    5 S& x8 t" a' Q, y- F* @
20. 
    
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
    ' I/ i4 V1 \$ l4 h, v3 e
25.             return self.block_size
      x' {% L* f% a6 K
26.         if op == 6: # block erase
    
27.             return 0

复制代码

3 c; A9 B( s' m" A
6 s% E9 ~. g4 L0 S! x1 q# c

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

1. import os
   
2. 
   1 a3 Z! y2 s, Z3 h; X
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

  p2 f6 w5 _6 l/ s

/ c+ r0 p) _+ {9 w0 w0 s$ e

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   ' C. m" d/ d+ h4 B. Q, m
3. print(open('/ramdisk/hello.txt').read())

复制代码

# a8 i9 M: n) Z- J" ?9 U

1 P+ J# R" ?: e! m# P( R; T! v
0 T) y, W* q* |, J文件系统

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

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

3 |9 Q6 B6 B6 aFAT

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

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

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

1. # ESP8266 and ESP32
   / I, D( ?, S$ R2 x, u8 q( x1 R
2. import os
   6 C6 H5 U0 s4 [7 S9 Q  |
3. os.umount('/')
   % w4 @, B& L% T0 _0 T% a  }, q
4. os.VfsFat.mkfs(bdev)
   7 ?7 Y7 }/ f% k' J; d1 i
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   3 ]) k8 p8 p. d  z' u
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    ; I* ~* ?) `. o- H& c4 ^
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

5 ]! I4 J5 p/ K- `


Littlefs

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

笔记

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

1 |  A5 s6 S" P

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

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

1. # ESP8266 and ESP32
   ' C, N4 S/ y( G5 z$ T
2. import os
   
3. os.umount('/')
   5 H3 C% x  @- m0 o& c
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   2 o  K8 A% w! @- D& }" L! v0 F
9. os.umount('/flash')
   3 ~1 B  k0 G8 ~1 H' f1 s
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    . P4 m+ `  o6 S% V! u) v
11. os.mount(pyb.Flash(start=0), '/flash')
    ; x" ~( n7 F- c+ O
12. os.chdir('/flash')

复制代码

混合 (STM32)

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

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

1. import os, pyb
   , ~8 y: L) C" y1 ~7 j
2. os.umount('/flash')
   6 z: D$ D% }, H* i, `. m7 V; W
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   1 c' @8 u! E: F' Q0 y
6. os.VfsLfs2.mkfs(p2)
   ) b4 _- h2 z9 k$ ]( w: L1 ?
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   3 Z. g5 ]* D; G: i7 o" @
9. os.chdir('/flash')

复制代码

' t2 }2 k0 H% K4 t
) B9 k8 c. d$ q& c6 C( _

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

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

1. import os, pyb
   
2. p2 = pyb.Flash(start=256*1024)
   0 N) d  P( t& l: f, Q  ?5 l' v9 R
3. os.mount(p2, '/data')

复制代码

; @) w. h8 n0 ?* H5 c1 m
: b( ?- d- [2 n4 w7 v! i

来 boot.py挂载数据分区。

# H" ?9 Y1 c8 E! Z6 I0 ?# P4 J混合动力（ESP32）

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

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

1. import esp32, os
   / |' N; Q" l( n4 V3 B
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

6 D& ~: R9 j- A0 U
! y; d' p! W4 Q' ^3 Y' L