使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    3 `. p1 _  @% }; w4 [4 U$ O. }- @! K

    • 内置块设备

      
      

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        

    • 自定义块设备

      
      $ l7 {; g! q8 \0 W

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    9 o  n1 b7 N$ [3 y% r
  
  

" `) _+ l! b+ m0 }9 Z( A

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

) ]8 }* C, a0 w1 C) }块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

3 w5 n7 e: y/ O7 x5 t) mESP8266

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

ESP32

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

自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   5 e1 E# J0 v6 o
5. 
   ! m& p# a. b$ L; c0 }
6.     def readblocks(self, block_num, buf):
   * q; [' i2 \0 u8 i, Q& j
7.         for i in range(len(buf)):
     I( I  q: Q* n" N, j
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)):
    
12.             self.data[block_num * self.block_size + i] = buf[i]
    $ K  }, M# _. u3 ]
13. 
    * m& {3 z( y0 ?* n# y1 ]7 j
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    ; v3 N. w1 a6 ~' V
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    . c! {& w+ m0 y' \
18.             return self.block_size

复制代码

, I  Q6 S6 X$ X" ?! O# n

它可以按如下方式使用：

1. import os
   
2. 
   1 W' g! c7 K: c1 w- E; y
3. bdev = RAMBlockDev(512, 50)
   ( V  k2 T" B5 h2 R; W- i
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

) K6 r9 V0 U0 k: @% F6 N4 \

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   " l0 \! P( u6 H  t" R3 a3 K9 z$ {8 y
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   ; I2 Z$ H% x" O3 l- E- y2 Y( |
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   % a1 ?3 R5 Q0 ~+ P2 U) s
8.         for i in range(len(buf)):
   9 O- C1 I1 M: f* w3 O
9.             buf[i] = self.data[addr + i]
   
10. 
    1 l4 c) V+ G$ @7 o9 |' G
11.     def writeblocks(self, block_num, buf, offset=None):
    & j& L# {6 {5 d: Y0 q6 b+ c/ K
12.         if offset is None:
    
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    * \" U: E/ @7 u: ?$ a
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    
18.         for i in range(len(buf)):
    ! m( e7 G7 p8 B
19.             self.data[addr + i] = buf[i]
    6 [2 m- w1 g! ^. N% o
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    9 E- J0 N4 l$ r1 Z
23.             return len(self.data) // self.block_size
    + ^; q# X4 v3 q# U" [
24.         if op == 5: # block size
    ) D6 [0 _0 `3 e( |2 _6 k/ p
25.             return self.block_size
    
26.         if op == 6: # block erase
    
27.             return 0

复制代码

2 |4 `8 c& H7 V6 E9 n  D+ f' X3 O

: J* a$ Z/ v+ y' s+ b3 ^9 b$ `

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

1. import os
   / Q. ~9 ?$ ^) A) U4 t5 U/ r* o
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   1 R, D1 k: l  w! w9 j0 H
5. os.mount(bdev, '/ramdisk')

复制代码

  Y  d% W, X8 D2 u- w  o

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   * r/ Y  h$ l7 P- ?; h
3. print(open('/ramdisk/hello.txt').read())

复制代码

; L+ c- B  g: v! N

4 o- M' d: _5 K8 t8 X
0 Q. ~3 D8 L0 _9 G/ T) d  _
文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   ; k2 n9 }' o3 H# n8 @/ ^
2. import os
   
3. os.umount('/')
   7 n& a$ n! c  P9 W! C! t, q7 u2 ?
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    $ Q( \, F4 ~+ W( k9 W
12. os.chdir('/flash')

复制代码

, ^- }2 U. z7 x( u* T
1 p. }) H# s) X' T! @3 m2 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
   ( C$ \! E# G$ S
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   ( {3 z/ T/ U8 R9 v! |
7. # STM32
   
8. import os, pyb
   ) m# P+ ]* Q4 {* u) I$ |) K
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    7 J" L' b8 {% G5 g
12. os.chdir('/flash')

复制代码

  a, z+ d  H5 ]) n

. _1 N7 T) b/ T8 b- h. W8 @混合 (STM32)

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

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

1. import os, pyb
   ' N4 }/ R; ]- Q3 m. k6 D0 `7 ^
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   3 h* C0 R+ ]6 j/ h
4. p2 = pyb.Flash(start=256*1024)
   ; e2 r8 i5 j: G
5. os.VfsFat.mkfs(p1)
   , l* ?- A6 U" \" v9 V% s
6. os.VfsLfs2.mkfs(p2)
   6 `( Q3 y3 l# u' h( ]
7. os.mount(p1, '/flash')
   : S8 n$ P9 f8 S9 z: g# a4 |
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

" h3 a3 M+ m$ _

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

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

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

复制代码

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   , r# N, _# M$ b& h  V8 a
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

0 c0 m' r, z; ^- B
8 W" n3 g$ H6 u! x7 z1 T4 E( c