使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  * Q' Z2 ~7 C9 k5 f

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        * H9 a% w& g* y) E; }& t* c9 ~

    • 自定义块设备

      
      5 R% P. O. m* }) G& G

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      : h9 C( H7 \0 Q  t1 h' ]
    
    
  
  $ y7 y" U1 J6 |+ h# W/ I) U

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

: ?1 [. t7 j2 h# I! C% @ESP32

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

- O4 ^8 Y" l' Z: c+ g/ Y. t
自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   * @/ T1 y, B  r1 O) C* D6 ?8 U
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
     u! y) t5 a+ L: j6 O# N
5. 
   % p9 ?4 C$ U1 `
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   % K7 T+ q, i! \3 G
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)):
    / b. u4 d- o# C/ o% y6 K8 Z
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    9 e# Z: o* ^, E/ v6 M
14.     def ioctl(self, op, arg):
    8 @1 a* `( B9 |) I
15.         if op == 4: # get number of blocks
    " X4 t( T' g$ _( l: V
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

: F5 R/ A2 G2 W! }5 g" g- t
4 i# e: W8 W# S; I

它可以按如下方式使用：

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

复制代码

7 @3 B' r, h/ `1 Z, M! S$ H" L, H

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   , d+ _. O; R% J4 ^
3.         self.block_size = block_size
   3 d. E: d% ^4 `  V, j% s, M
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   9 e( A/ t* _; O! w1 ]% q
6.     def readblocks(self, block_num, buf, offset=0):
   " g+ h) u1 W8 d+ P$ a8 w, z8 z
7.         addr = block_num * self.block_size + offset
   
8.         for i in range(len(buf)):
   . [  }% }% R+ H6 [
9.             buf[i] = self.data[addr + i]
   
10. 
    , @6 x/ f6 b4 t- [
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    * j& ~6 {5 X' k7 p# e  e
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    & t$ w' O. r( G6 e
16.             offset = 0
    & D0 o1 z7 w. X9 M+ d% Z" W1 H
17.         addr = block_num * self.block_size + offset
    . L0 P9 i  D  Q: Z; C' N
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    3 W$ a2 Y9 b( j( W, j& R/ L
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    3 J+ F  v& o- r' W3 }
23.             return len(self.data) // self.block_size
    3 |4 h! a' c+ h3 S
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

9 E' Q9 B2 x3 n7 p, o

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

1. import os
   7 o3 D' ^( Y) X$ O  L2 G
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   # _/ m& p7 U6 q* e
5. os.mount(bdev, '/ramdisk')

复制代码

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   8 _3 n5 _: J; ]: C" s6 ^5 ^
2.     f.write('Hello world')
   ' T% \% q/ a0 }. I8 v" f
3. print(open('/ramdisk/hello.txt').read())

复制代码

( Z5 C/ m# A" I- d+ K4 i

7 l4 T$ b8 S( P  y

文件系统

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

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

$ `' f0 h' I% nFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   ( ]% p) s8 x8 `2 Z/ q& t) c
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
     ]- G( f5 @, z3 l% E+ i
5. os.mount(bdev, '/')
   ) u5 K/ l9 D  n) J% L5 U: o! e; n
6. 
   & p& j2 J, ^' g+ T0 P2 x
7. # STM32
   ' r4 _1 }, k( x
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    $ ^9 h) I" `% f
12. os.chdir('/flash')

复制代码

6 L: ?4 m* }7 }/ |0 z+ L% n( o
, t+ \5 N8 x7 O0 q  i% n
# `8 b- F' d$ Q1 l7 |6 x2 r8 A; U" p0 e$ z
" X7 Q) Z0 N- i) GLittlefs

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

笔记

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

# D' L) h  ~9 I7 b: e

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

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

1. # ESP8266 and ESP32
   : P! M% R4 m7 a- S  ]
2. import os
   ' {# W) k8 W/ q" n$ H
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   * j- q) V- \$ H& ]7 d9 c4 K
6. 
   3 a* m. }% _( Y" q1 g
7. # STM32
   * w7 x: _% ?# V! c6 U
8. import os, pyb
   ! v0 b& Y7 W/ P' v+ H
9. os.umount('/flash')
     E" S/ V4 Q. ^# h. F
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    , ^0 `; m; f" g( {  {; u
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

2 B& p4 W: V, o3 }( t( k: b

! y$ d+ O, w0 e) r7 i- a混合 (STM32)

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

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

1. import os, pyb
   4 M2 k2 K. }' `9 r: u0 r# M
2. os.umount('/flash')
   6 D$ Q) h& M/ ]; N
3. p1 = pyb.Flash(start=0, len=256*1024)
   8 L$ ^' }6 b( A; M" T
4. p2 = pyb.Flash(start=256*1024)
   / G, `$ h4 C' T8 h5 W
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   % V! G% [0 e5 S
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   ' o: b1 M' ~) x
9. os.chdir('/flash')

复制代码

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

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

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

复制代码

( M; G( Z) @3 S% a" k
8 j/ K3 k6 |; ?
3 M4 v+ `8 P8 R6 T0 ]0 Z$ g

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

复制代码

) ]1 \9 V* s6 W* U

/ ^: k4 x: m" W( c7 d: W# A9 U8 d4 ]


6 ]0 W$ E: w7 x/ ^  Q( d& C) P5 ?