使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  : |$ y: r' L! y& i" e. H) J- v6 j

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      / _! g' @/ D1 j# L

  • 文件系统

    
    ) R6 f) H4 P! C6 U) Q

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      % g6 B. s7 v- M' w! i
    
    
  
  8 u( x6 d3 X+ }( s7 {

2 O1 ]) z1 p: g& u" Y

本教程介绍 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. 这实现了扩展接口。

! K, b8 x7 l+ x% h1 nESP32

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

自定义块设备

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

1. class RAMBlockDev:
   ; G) {% m1 B' n- O+ W6 w/ g7 ]
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   ' e$ O% ]7 b& Y% S8 t; C
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   + E# E3 @3 I. i: P
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]
   ' a  c  i$ n$ Q
9. 
   
10.     def writeblocks(self, block_num, buf):
    # S0 I, ]5 }; R- j$ Z) l
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    % x' k. G; b0 G$ K9 T% d
13. 
    ! d" d& h5 X8 w; }0 B( }" H2 \( v
14.     def ioctl(self, op, arg):
    5 c  F5 L& |. \4 p7 r
15.         if op == 4: # get number of blocks
    - }- A& p  a8 T1 ^
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    / s6 r' S6 T. \9 G1 k: \2 Z% e
18.             return self.block_size

复制代码

+ t! R& i+ c9 b% T0 b8 M0 b

它可以按如下方式使用：

1. import os
   
2. 
   1 B& }! N, \& z/ d+ y
3. bdev = RAMBlockDev(512, 50)
   8 @' G) @9 Q% z. w+ s$ x$ E
4. os.VfsFat.mkfs(bdev)
   9 ]3 d4 P7 {1 k4 y1 `% @/ w! s
5. os.mount(bdev, '/ramdisk')

复制代码

" O& C3 C, K+ |7 [0 K  _6 i8 S
+ l1 d" _5 z7 L% Q( K" N

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   $ [( w: q5 `2 _! R
3.         self.block_size = block_size
   9 g& ]; j' H8 l2 {0 Q
4.         self.data = bytearray(block_size * num_blocks)
   9 w, q9 K( |! L' z& S: Z+ F
5. 
   # V, H6 ]- a) i
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   & |6 h+ h9 S0 x
8.         for i in range(len(buf)):
   ! @. X2 G) M, q* V. l
9.             buf[i] = self.data[addr + i]
   : f/ G+ J# N8 P! A: D
10. 
    + ^( y+ z* e8 L4 e8 j' n
11.     def writeblocks(self, block_num, buf, offset=None):
    ) o! |' N/ x& O/ H
12.         if offset is None:
    - P4 K+ u; Y8 T! C
13.             # do erase, then write
      U) Z- X, Y8 H
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
    " U9 X* t) |* z3 ~  m9 S
18.         for i in range(len(buf)):
    - v. n4 }" w6 C1 z) ^
19.             self.data[addr + i] = buf[i]
    
20. 
    1 h8 W1 B( [0 K
21.     def ioctl(self, op, arg):
    / ]( |  F5 O: u, c6 r" n- D+ L$ Q6 G4 i
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

复制代码

' a* C0 S/ ?' g

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   - R3 L- k6 a5 C
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

) c' b; T$ E0 Z+ I8 ~9 i1 W

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   ) A3 V1 N: A) O
2.     f.write('Hello world')
   ( v! g$ x% k! u( |2 P
3. print(open('/ramdisk/hello.txt').read())

复制代码

  c7 r" G2 f$ m7 q. \4 I

文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   ; S3 W$ Q- V* @8 d) k5 p8 s" K' `
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   - m) v1 l& N8 F, b( u8 n7 F
6. 
   
7. # STM32
   % W- b: K9 |; B5 ]2 ~5 y, w3 [1 T
8. import os, pyb
   . v, Z: g) U/ u1 O6 P2 v8 a. h
9. os.umount('/flash')
   , c3 f/ V7 C+ p% d( D6 b
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    . Z6 n3 R1 r2 t$ k; G0 d
11. os.mount(pyb.Flash(start=0), '/flash')
    : R/ L$ T3 w) v" s4 K
12. os.chdir('/flash')

复制代码

) M# I) B# |6 V& d5 Z

Littlefs

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

笔记

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

( d& Z: G2 v* F( h6 F

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

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

1. # ESP8266 and ESP32
   
2. import os
   - D8 D7 n: }( A
3. os.umount('/')
   5 D# Y6 L8 e: q+ T5 c
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   2 Z& ]$ Z- }3 Y9 B! F  K  l7 g5 l
6. 
   5 o4 e4 _1 i# @7 x8 ]9 w
7. # STM32
   
8. import os, pyb
   . p$ K6 s( ^. _' h# J( o5 V: N
9. os.umount('/flash')
   " V! M" z3 o7 p/ O3 v4 `' G# t
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    * }/ y. K' ~2 v, `6 S' Z
12. os.chdir('/flash')

复制代码

- `5 h2 B$ o! U  t- f
- N7 q! K# Y, }

# @, X/ q6 n) p) A, I& K; F' D+ b混合 (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)
   7 S' T8 m/ k( j2 U' j) U5 B! J1 N
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   ( K, @  }5 V) R5 s1 v! o3 F3 [
6. os.VfsLfs2.mkfs(p2)
   1 {/ s; g( X  f9 ^8 s9 m
7. os.mount(p1, '/flash')
   0 X& D3 z$ m- V7 k9 D, J" {7 w; A' N
8. os.mount(p2, '/data')
   + J8 w0 C5 W5 z0 K9 G8 S2 d
9. os.chdir('/flash')

复制代码

+ R) }! H4 o2 A7 O6 J6 c, \

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

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

1. import os, pyb
   + @) ^$ s0 v5 }: U/ h
2. p2 = pyb.Flash(start=256*1024)
   # {: i( }! ~9 R. Z. P; O9 O
3. os.mount(p2, '/data')

复制代码

( J5 C+ J( ^4 U# k7 }$ a) C

来 boot.py挂载数据分区。

混合动力（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')

复制代码

" c1 m+ I( r: ?, x  W9 S
. o1 ^, o& |3 d

! h  y; a2 {! S9 t+ x