使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  7 T8 B1 G. W+ ?( t

  • 虚拟FS

  • 块设备

    
    8 t6 G% k5 E9 J, z6 ]6 A

    • 内置块设备

      
      8 _' D" e/ D3 Y- w, Y

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
          K9 w4 K' j' _  ]& J

    • 自定义块设备

      
      , Q, }6 f. H" G8 Q

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      5 R% f$ M9 K: \6 {  {/ w
    
    
  
  1 t5 {6 D+ B: r" c

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

ESP32

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

" \! s9 b5 j! s! }1 S
1 Q; ?6 U; b1 B5 G自定义块设备

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

1. class RAMBlockDev:
   : F/ ~4 @: e* s, v9 K- O
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   ( X) S$ A+ P- W$ d+ C3 V) a
4.         self.data = bytearray(block_size * num_blocks)
   ' H1 f' N) O" p) P' w6 ^' D- X( z
5. 
   * r! Q, k3 A8 y
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   # l/ r+ }. N- n& e$ O
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   & A0 [1 [% b/ y, v. c
10.     def writeblocks(self, block_num, buf):
    " s  O; h$ S/ p9 I( q0 H  G- x
11.         for i in range(len(buf)):
    ( k& V7 }0 b0 T- o$ N: K
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    , a$ W8 X& P& ^3 ~! J
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
    ' N% Q( k* E  W, ]
18.             return self.block_size

复制代码

' `/ F% B* C; g
9 R: J, ]$ r. N8 X8 R1 W& U

它可以按如下方式使用：

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

复制代码

' U4 [8 L$ D4 f+ |" W2 j

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

1. class RAMBlockDev:
   * Z3 S' W1 q' l3 M  I6 E$ K4 H, m
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   / R: L( f" }7 h2 O3 g
8.         for i in range(len(buf)):
   7 h5 D1 L# u5 A0 K/ L; D7 _: P7 K7 @5 @
9.             buf[i] = self.data[addr + i]
   " X# M9 o! T  a) q' V
10. 
    ' A. [( `6 i8 N4 N8 L% l
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    ( q2 j4 w% N8 H; x, O" l( \  s; x
13.             # do erase, then write
    9 E* g' f8 {! u; J. j  h
14.             for i in range(len(buf) // self.block_size):
    $ A  d. {& ^+ U5 X2 @# W
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    , n  h% D& _; M
17.         addr = block_num * self.block_size + offset
      M. Y% O2 ~9 B6 u& r
18.         for i in range(len(buf)):
    , i; o$ A( e8 V
19.             self.data[addr + i] = buf[i]
    9 j- ?" d) N- C, u9 x+ E4 L
20. 
    . p; w$ k1 v, }4 h
21.     def ioctl(self, op, arg):
    . g% U6 `& [- D% I5 ]/ R8 Z+ i
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    9 E! ?4 i/ X. }. b% r
25.             return self.block_size
    4 O6 m2 c* |, {; u
26.         if op == 6: # block erase
    
27.             return 0

复制代码

7 S/ u# p- O$ M$ Z* l1 l5 l2 }

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

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   " ?0 Z8 l- n, Y4 v1 X' A5 n+ v
4. os.VfsLfs2.mkfs(bdev)
   ; v/ \$ {2 W6 h
5. os.mount(bdev, '/ramdisk')

复制代码

7 l+ ~8 X  N' F& i+ }
' s$ ~5 u5 o1 I$ [3 m* U( }

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   # R/ ]7 G6 M3 h# M# V
2.     f.write('Hello world')
   3 |2 `9 s) u2 j" c' H+ k( ?
3. print(open('/ramdisk/hello.txt').read())

复制代码

3 B$ z+ X, C2 X5 Z9 v7 j

6 |3 `  ]7 j) W% U# e1 B" _8 |* d

; E: U8 @# U; }* o0 |& H6 K文件系统

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

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

! m: Z( ]* l- KFAT

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

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

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

1. # ESP8266 and ESP32
   , X0 b6 P' |0 y8 f8 y
2. import os
   
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   & \1 A; q# {" x
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

: r! Z+ E' N* O4 T* \9 `
$ [" F( g" ~# K+ E9 w# n' t) ?

Littlefs

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

笔记

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

7 F" J5 F* H  z2 l

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

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

1. # ESP8266 and ESP32
   - i8 i8 {5 ~' X- ?2 a+ x' K
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   9 T3 f" x9 f+ O) h9 Z
5. os.mount(bdev, '/')
   4 g2 j; o& }7 g# V" h0 D1 }
6. 
   
7. # STM32
   ) [8 m5 ^3 T+ p% S/ c& q
8. import os, pyb
   9 V2 C# U; v; o+ n; s) Z+ n
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    ! c2 H2 [* @: M: {1 @7 r+ x
11. os.mount(pyb.Flash(start=0), '/flash')
    2 v8 Z# E* n1 S* K; o0 N
12. os.chdir('/flash')

复制代码

8 e. {; S/ R0 V5 J6 D5 s5 A5 h# B+ t


" ~# E: B# @, C7 q! T, A! d混合 (STM32)

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

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

1. import os, pyb
   9 s: K' q5 l1 _+ T6 R+ q1 D  x
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   6 e7 ~  a) }7 E% ?! H* S
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   & j; ]8 k! m' \9 M' F
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
     ~: `; f# ]6 [; u: Z
8. os.mount(p2, '/data')
   ' M( S) v3 n5 @+ w& ~
9. os.chdir('/flash')

复制代码

- _' x; a9 e. e- W* o/ g8 U
# T+ U7 C$ b  m" t

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

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

1. import os, pyb
   ; ^7 [, J+ d/ b* V7 c
2. p2 = pyb.Flash(start=256*1024)
   " w) E' v4 @) B1 p
3. os.mount(p2, '/data')

复制代码

. J" ~" E2 @9 {% g- V& q9 I0 \

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

复制代码

# d' t( |3 T/ r2 [. K4 Q

. i4 K( i9 Z2 [5 H; D# T. F

& ?2 e/ Y" F6 }+ }2 R