使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    $ e0 v: e4 a" h( u* e/ ^) Q- _

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        * b" X+ I" D. Y" R  C; i

    • 自定义块设备

      
      

  • 文件系统

    
    ) S9 N5 S- _5 K4 G3 f8 W" v. H

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      ! t( s) r+ I* M3 Y# o3 x2 i2 ?
    
    2 ^  l7 U+ q5 w* q/ I3 A! y% R
  
  

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

: d6 b; t5 }" r% H/ DESP32

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

9 \- Y& i3 Z9 l! q' L
! e: z) `" ~' J5 f' [5 r自定义块设备

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

1. class RAMBlockDev:
   8 S' I' I- |5 b0 K# y6 k# C, N, q# P
2.     def __init__(self, block_size, num_blocks):
   & c9 q/ e3 r& v5 e+ K- W8 X5 \
3.         self.block_size = block_size
   1 E1 j$ w* Y! e; `4 Z
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   ' t- ]2 m. }! U; e
6.     def readblocks(self, block_num, buf):
   ) J, ?# _; s- i7 k7 a' r2 s( C
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   " I4 w# l4 O5 |/ f
9. 
   ' U' Z! N8 _( Y0 |% i
10.     def writeblocks(self, block_num, buf):
    
11.         for i in range(len(buf)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    0 C+ w: K. L& B# g
14.     def ioctl(self, op, arg):
    ) h" E& |; {6 W0 R% U6 g9 \
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    + _1 j5 }, H2 C1 @0 [
18.             return self.block_size

复制代码

3 C, Z2 {% p/ a
: C' x+ Y" d- k0 D5 K

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   2 S; i& u( u' A9 T' v: Z
5. os.mount(bdev, '/ramdisk')

复制代码

$ l' D. D* d( b: r8 i- ?+ h

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

1. class RAMBlockDev:
   - S6 d  N6 q( z4 T/ P* G
2.     def __init__(self, block_size, num_blocks):
   ( E  ]0 h0 v4 s& v
3.         self.block_size = block_size
   7 W+ S8 D6 r, R8 s( O0 d
4.         self.data = bytearray(block_size * num_blocks)
   0 ^$ _, T1 K6 q0 c+ x; p* G
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   " s) P0 I; d0 {& P; `  v
7.         addr = block_num * self.block_size + offset
   . @- c8 g& j# `0 g- v; n& M1 U
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    
13.             # do erase, then write
    ; ^$ a' O; c- U5 X
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    6 T2 M# P& }7 p
17.         addr = block_num * self.block_size + offset
    0 l( {9 c3 s2 B1 o
18.         for i in range(len(buf)):
    - l, a' M' P5 U1 J
19.             self.data[addr + i] = buf[i]
    / o- [) Q6 H- A5 c
20. 
    % R" B& k; G$ e. Y2 z
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
    7 d: M# ^4 |! I" B& `4 F/ P/ N
25.             return self.block_size
    ! G; ?5 b4 D: a4 g
26.         if op == 6: # block erase
    
27.             return 0

复制代码

& M/ H+ ]8 B7 |9 J

# c/ X8 o4 J9 Y5 c

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

1. import os
   + n& ~, N* }* i# @2 T2 l- K
2. 
   $ e1 v4 u  d+ S( N9 U0 D
3. bdev = RAMBlockDev(512, 50)
   8 z6 ]  g& X4 b9 h
4. os.VfsLfs2.mkfs(bdev)
   ! j: [( E" `+ \) ~1 R
5. os.mount(bdev, '/ramdisk')

复制代码

2 J0 [9 w1 k% Y8 J& }9 E$ f7 C

7 A9 N& o4 Z) o, s/ {

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   - K1 B2 z9 L8 h
3. print(open('/ramdisk/hello.txt').read())

复制代码

2 c2 }! d4 D* K* E6 K
9 ^! c$ m. v, ]' i+ j


  {  }/ w% b" `1 P& l3 r2 Q/ C4 s文件系统

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

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

! @' n- ~* T7 D5 ZFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   2 T; A# I$ D- Z- q; a) R$ A. g  i
4. os.VfsFat.mkfs(bdev)
   ) n( K  A0 i6 v' Q
5. os.mount(bdev, '/')
   - x. J3 A% y" }# M2 ~
6. 
   ) W7 Q4 F1 x0 b( o% Y( p$ T8 l% v
7. # STM32
   " z. @5 ]) l( B1 c
8. import os, pyb
   7 J2 }9 Q4 n- K/ @5 n  B% P- Y& a3 U
9. os.umount('/flash')
   7 Y0 O/ i: h- W( J/ X" n& `
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    ! T3 W  t6 T6 U5 m" k( C
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

* X; V/ o. b; g3 W/ D
: j7 N1 r" g$ J: O/ i
' _" x& {, Y# @1 |2 ~6 f0 M
& ^  y+ A8 z" ?7 L. a4 K/ s4 K9 jLittlefs

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
   % [* X; O* J( n! S* d* q  h
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   % h1 z& w+ c' I: q5 d; p, D
5. os.mount(bdev, '/')
   & }1 N2 L- a% Q  A- v, {0 T
6. 
   
7. # STM32
   / A3 w  W) g6 C, S+ a9 a
8. import os, pyb
   & ~7 @/ W0 M& D2 l2 Y
9. os.umount('/flash')
   ; s; a) C8 i! Y
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    ! _, k, W9 l: n' N* q/ r( l7 t
11. os.mount(pyb.Flash(start=0), '/flash')
    ! w1 m: `  N/ L3 f4 M
12. os.chdir('/flash')

复制代码

混合 (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)
   
4. p2 = pyb.Flash(start=256*1024)
   : a& r* K% }' F2 ]% ~. t% `
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   , ~0 i: H- k. w- h5 x
8. os.mount(p2, '/data')
   5 H9 N9 h+ v6 `) r
9. os.chdir('/flash')

复制代码

+ d( _$ [( P7 C# d( [+ R' B

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

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

1. import os, pyb
   % P8 z( K, R- w
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

0 i) h+ Y3 E- a0 [
5 z, j+ b! X1 b( Y/ r" Y6 k' Y+ a
- `0 k2 K- k5 O& X1 r3 q

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   % d! U/ u# W3 W6 v
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

! N3 s6 ~/ Z4 h7 h) K+ y$ I

0 e3 N; @/ i( B& Q

! I9 G, O  K, A+ P& Z
0 J  Q( C% U7 S* K* Q) A4 s

cvjklkj

cvjklkj