使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        # M* g7 j# K$ r; T& P: t

    • 自定义块设备

      
      2 e7 |3 E4 Y$ K/ I

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      1 P. ]  y, Y9 J
    
    
  
  

+ h, ]9 K5 V, }# H6 z: w

本教程介绍 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 的虚拟设备（即它在开始时包含一个虚拟分区表）。

0 _) F9 T1 A" u- lESP8266

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

ESP32

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

0 {0 P9 ~+ n0 [, i7 Q% X
: m) B) x( p: E, y自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   2 |5 j% X# x% U5 j
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   ! `, f$ `: C6 K8 i6 M+ F
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   ! i- N9 L! k# J/ X, f4 I
10.     def writeblocks(self, block_num, buf):
    9 R5 v# e) K7 [
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    , q* i7 D% x9 L8 h# S
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
      K6 K/ Z; _- F0 n. l
18.             return self.block_size

复制代码

0 P1 z& ]) ]8 Q9 R: O
# I( `9 ^2 t* Y

它可以按如下方式使用：

1. import os
   
2. 
   ( {3 E) X! Z. M8 H
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   1 H  ]  T3 Q9 ]- U9 ]" w' L# h+ I5 I. q
5. os.mount(bdev, '/ramdisk')

复制代码

3 a; y3 O5 C. l

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

1. class RAMBlockDev:
   $ E- T$ p4 a, U* P' j
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   - o, C2 Z3 a' U/ v  C" f% A
6.     def readblocks(self, block_num, buf, offset=0):
   ! S; N4 d3 ~( O3 z% \2 g
7.         addr = block_num * self.block_size + offset
     s/ Q4 a  r+ w2 p1 {4 e" U* p
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    ; S& B/ \4 h2 W
12.         if offset is None:
    
13.             # do erase, then write
    1 M- {" k) z) }4 M+ e5 a/ b1 n
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
    9 t$ |' e0 i/ Q, K% F6 j
18.         for i in range(len(buf)):
    5 C# V2 c& V/ m9 i/ L: W
19.             self.data[addr + i] = buf[i]
    
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    0 B, F! R6 e; [: `2 F
23.             return len(self.data) // self.block_size
    ' u1 |% i) d) P
24.         if op == 5: # block size
    
25.             return self.block_size
    # b! X9 _1 f6 F% Y
26.         if op == 6: # block erase
    9 \/ j; C, f" H/ }8 c
27.             return 0

复制代码

* }: _6 W6 X) i" O2 r

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   4 B3 R( g6 L. [; T" D- d6 V
4. os.VfsLfs2.mkfs(bdev)
   2 p! y; t/ z" x- V; O: }
5. os.mount(bdev, '/ramdisk')

复制代码

) P# K4 h" U% o6 U8 ?' F; M

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   7 m6 T$ ~, r! k" p3 V6 T. f1 h
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

/ ?2 ~8 @  A4 a1 X5 S


文件系统

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

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

. h7 O6 T# D& U9 bFAT

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

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

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

1. # ESP8266 and ESP32
   $ w) I' |' m) M" E
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   & D: ^  {# m6 I4 `
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

( r( w- D+ j: ?0 c
' D- \0 ~$ ?& p6 ?0 t

! x0 f1 C8 J8 Y* P/ ~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
   4 {1 z% F. K+ V. o; M, f/ _8 {; G
3. os.umount('/')
   7 Y$ e/ l* H( l. }- a( ^% L* n
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   4 U! T# z4 V. A
6. 
   
7. # STM32
   7 u# q9 p% F) \2 c4 t, }* q
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

6 l, [- [) E. Y- v( y3 a. X' s


% ?6 g$ G( j2 e2 ]混合 (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)
   % O; V! n: b$ R/ A. A
4. p2 = pyb.Flash(start=256*1024)
     T* L1 B9 ^" l) G* K- Z$ B
5. os.VfsFat.mkfs(p1)
   ) d. \6 d1 M; M' M$ u" S
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   ) s+ {5 X7 t) ~9 X# o
9. os.chdir('/flash')

复制代码

3 T- k$ c3 N; L. z

. L6 `. r% p2 p. J+ j  e: U+ f

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

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

1. import os, pyb
   ( e. }" Q* s6 \1 T; q
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

0 E8 e, q; d3 O: d0 Y4 C7 t( l

来 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')

复制代码

" t0 q4 ^7 U4 v; w
) r3 m. N) X1 G4 Y* }

% n4 b3 x7 ^. M5 \
/ u5 ~& G- ~( @% w+ T( [1 p! s: ]/ V

cvjklkj

cvjklkj