使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    & a, C1 S, H" i4 @7 E: C2 L

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      

  • 文件系统

    
    4 q" B. p0 n& v( p: s  P

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    ' j( G2 |+ I, q$ c" o. e
  
  

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

# u; x# R( T5 V: a* F3 l, S4 T块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

  q6 B1 g7 L* {: y5 r  LESP8266

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

ESP32

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

自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   / A! u4 u* J9 ~$ m5 U
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   ; B2 ^/ q( L+ K: i
5. 
   
6.     def readblocks(self, block_num, buf):
   , ^( ~. Q" E4 j
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   7 p& c0 c$ e* O2 L% f: J5 U$ j' L
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    4 l+ P) i5 q" ]3 L
12.             self.data[block_num * self.block_size + i] = buf[i]
    6 J- ~+ ], [2 c- ^0 D4 a
13. 
    + [) K2 Y, I4 s4 a
14.     def ioctl(self, op, arg):
    $ @4 Z1 ~& a& f  p  D- ^
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    6 B  q! ?! j: l$ o9 e- N8 B
17.         if op == 5: # get block size
    1 A& r+ L/ S% }
18.             return self.block_size

复制代码

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

5 m3 _/ x4 M9 y2 g

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

1. class RAMBlockDev:
   * W0 @% Z6 A$ L' p( |
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   4 y2 `  m9 }5 m( i7 y4 N1 j
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]
   " v: ^5 p9 a* |, @! K6 Q
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    / Z  E* ]$ }9 r5 ~; R3 M7 \
12.         if offset is None:
    2 g8 C8 l! ^! }& w4 O" @% A; d
13.             # do erase, then write
    ' y8 z' ?, r6 _7 Y7 o1 n, i
14.             for i in range(len(buf) // self.block_size):
    6 B  a0 T6 e3 f3 p
15.                 self.ioctl(6, block_num + i)
    5 @: q! S3 K7 I! p( _, W5 W; \
16.             offset = 0
    / _' }; c! }- M2 k" P5 R% {
17.         addr = block_num * self.block_size + offset
    5 g8 `; e* @$ ]- O
18.         for i in range(len(buf)):
    
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
    ! W$ _0 i# J& D- j7 g. q4 \
25.             return self.block_size
    4 F8 B! v" k# v* u5 D0 X+ S/ f
26.         if op == 6: # block erase
    
27.             return 0

复制代码

, n: e& @( c" m1 _# P' E! N) ^
2 ?, g6 w. P4 Z; h3 E

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

1. import os
   " e4 Z9 }( P( z% O# z  [6 ?/ a
2. 
   
3. bdev = RAMBlockDev(512, 50)
   ( c5 i; l/ ~: w- H
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

! s% L9 z$ j& |4 a& Z: k3 j

/ s) R) D0 k: ^- `

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   : B7 s3 U7 R/ ~$ m6 k
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

: p1 G; p8 _! w' y7 V/ B
! e% n/ M5 i4 `8 J
) m. @6 a4 N) V+ Y: e& c
. s. a) R9 P5 ?) s
文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   $ b% M9 ^) z+ w, x7 w" m
2. import os
   $ x$ I' ^9 W( Q; \8 _9 ?  q
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   ' M& B6 K/ [5 H, S& I
6. 
   $ I% T  q' I3 n8 I
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    7 F# F! T) U; s# `. \! f
11. os.mount(pyb.Flash(start=0), '/flash')
    5 g, s! w" M* k% r! V% c
12. os.chdir('/flash')

复制代码

- T: d1 o& @5 ]. z
- X, A/ m8 o6 ?& J: _$ f

8 \6 [3 z: q& nLittlefs

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

笔记

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

! Z7 @% J& p& \

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   0 a7 S! N  _( I' {& s' K
7. # STM32
   . s( s% h1 ~1 Y8 p9 j4 k3 k  P
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')

复制代码

, S: q; ^. N3 y$ {6 m+ L6 K( n
8 c& s, R+ s' W
4 E" v" M/ c3 c( `5 V6 p& l  d混合 (STM32)

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

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

1. import os, pyb
   / {7 ^% K9 s' l& _2 f4 E/ F: t$ X. N
2. os.umount('/flash')
   4 O9 x& a3 e. a8 f" d4 r
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   & A! A# i# V1 A
6. os.VfsLfs2.mkfs(p2)
   ! V) Q3 I: ^2 @! u/ U) m
7. os.mount(p1, '/flash')
   ! Y$ I* z+ j! q  z8 r2 R
8. os.mount(p2, '/data')
   % x' A+ d1 }9 ?& S# J+ P
9. os.chdir('/flash')

复制代码

0 C& Q( F- x) s; S. r
$ p. g! f4 v7 n) F4 q$ [

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

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

1. import os, pyb
   6 j. L" |9 Z4 i: J
2. p2 = pyb.Flash(start=256*1024)
   1 ]# U% ~2 ^2 _$ I0 b8 R! L( L
3. os.mount(p2, '/data')

复制代码

9 ~9 I: r1 I8 r% j# w4 t% w

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

复制代码

2 u$ U1 H; x& i8 B7 b( w