使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  5 O# f3 \6 G8 Y- w8 w3 K" G( X

  • 虚拟FS

  • 块设备

    
    8 I, f: Q+ b, {6 a6 F8 w

    • 内置块设备

      
      ; L1 u8 c, F* p! Q- M& w+ {" D

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      " [8 t4 b# O, j2 b! g8 F) L
    
    
  
  

( p. t4 \. }: @/ [' E2 r9 @

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

8 n4 r# b' r- V% v8 g3 I9 w块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

ESP32

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

自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   ) ]/ @5 d- d( e4 l' z
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf):
   ! K( b  i9 W  Q2 D  `
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    ) q) t% i% b4 D
12.             self.data[block_num * self.block_size + i] = buf[i]
    
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
    0 c; u+ A8 C0 K! _' R
18.             return self.block_size

复制代码

! x3 W& \4 H, z# i- F: O' Q

它可以按如下方式使用：

1. import os
   
2. 
   " ~# ?  ^( h6 m' v* ^
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   3 p& _' b! W' ~
5. os.mount(bdev, '/ramdisk')

复制代码

8 D( z. `: t1 K& ^' t. P# b
4 d3 H$ w$ i4 Z6 D/ t
( g' Y5 ?. S/ F4 P: [3 p9 a

支持简单接口和扩展接口（即 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)
   # K- n5 l& F" |& E" _7 E
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   8 M3 ~% Q% f) n+ \
7.         addr = block_num * self.block_size + offset
   & u% O0 Z$ Y9 z3 l, N  j
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   & z3 ^1 i+ ^) _9 o; b; k
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    8 ~+ u: _( D! @: \; A+ h
13.             # do erase, then write
    ; D* R9 z3 s  L/ A% S: ^  Q* Q
14.             for i in range(len(buf) // self.block_size):
    3 e3 }$ D4 }* ]4 Y+ h. z0 p
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    ' R2 n; [5 ~# t/ R
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    ( \3 A+ m7 h9 A4 D+ _$ F( I
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
    
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    / }6 @: i+ ~+ k/ j% d; `- r  ~* m
27.             return 0

复制代码

% h- j* V6 j, p4 y; ]
! C. |1 m$ q4 v: [1 |

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

1. import os
   2 c; n3 `7 s2 @# N, O
2. 
   
3. bdev = RAMBlockDev(512, 50)
   ! k# W: J7 c. W4 {! x
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

3 c4 }4 B7 z6 B* B; s

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   ( _' k6 y0 c' C0 K9 {
2.     f.write('Hello world')
     i# g% a7 n' d0 Y9 p
3. print(open('/ramdisk/hello.txt').read())

复制代码

9 X7 b0 k: e& Z/ o3 \  r



文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   & n! d$ f3 J) \; d  z$ t7 B+ C* [/ P
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   7 N7 ^6 Q( `/ j# i. t" W7 v
7. # STM32
   : u* q- C9 `1 Y) Y8 T7 m
8. import os, pyb
   / j; F) n7 B7 Y6 s
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

8 d- V( r" ?- y! o7 @; V7 f
& [! R9 I8 d) m0 n5 b
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
   ; n0 M- `* A4 X6 [
3. os.umount('/')
   " ]) U! w8 J5 ?/ B0 O
4. os.VfsLfs2.mkfs(bdev)
   % A$ E) p' @2 U6 |
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   2 {! j6 j! R/ I9 @
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    / s6 X" ^' m6 X7 Q; K! m7 D8 ^3 I4 z
11. os.mount(pyb.Flash(start=0), '/flash')
    4 P) U& k+ z  l0 @2 R: f6 z
12. os.chdir('/flash')

复制代码

- J$ V$ r0 S% t& M# F2 Z2 }7 e
" D* o( J/ a, P8 F: z& p. u2 a8 U0 z

混合 (STM32)

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

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

1. import os, pyb
   6 I. {3 \* {  S/ t1 _- z# B6 |/ S
2. os.umount('/flash')
   # N! v8 z, p+ D$ T2 |. o9 h
3. p1 = pyb.Flash(start=0, len=256*1024)
   ! S. B+ G9 k. ~3 V; F6 E
4. p2 = pyb.Flash(start=256*1024)
   1 _1 q) T$ {! }8 T; O' r
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   , P1 ~8 W0 b1 K$ t" ^! T
7. os.mount(p1, '/flash')
   - T2 q2 e: C( b$ R1 e
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

, D$ F& O: I9 J6 E
" q# ?/ b; d, S

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

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

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

复制代码

7 _: @* M# P1 B1 r6 Y5 n4 x" w
/ o2 t* p7 _. }
) ~9 Y. D) j3 _9 \- X, Z

来 boot.py挂载数据分区。

8 h# X+ \) q( ~" M混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   6 I' S  w" |) _% S( h
3. os.mount(p, '/foo')

复制代码

: U7 Q2 r0 F- d, ~