使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  ! h" [1 g( p& a/ M" r9 r0 c

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      , D7 `% y8 D" b3 R

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        & l! n" l- L- B1 V6 I

    • 自定义块设备

      
      

  • 文件系统

    
      i! l( b( |5 D. |7 E" s' Y9 [

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  8 J- v6 K% R6 P: V

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

9 X. E0 k& `( R) A) v' g( t  b* R块设备

块设备是实现 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指向默认分区。这实现了扩展接口。

自定义块设备

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

1. class RAMBlockDev:
   6 ?! ]  }- \) }" W2 h, q
2.     def __init__(self, block_size, num_blocks):
   ! H* s4 A9 g4 W3 o6 G, o. V# q3 B
3.         self.block_size = block_size
   ' I, w2 u# n$ d9 H) i" f' U5 w' X; f
4.         self.data = bytearray(block_size * num_blocks)
   / z: O7 f' w; _* s+ K
5. 
   ) y$ r5 n  l# C
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   5 l7 e$ d+ U; |$ x; A3 N5 t1 C
8.             buf[i] = self.data[block_num * self.block_size + i]
   3 v/ ?+ `; C, ^, O0 B3 K1 z$ l7 K
9. 
   1 x0 e- h& v& _1 u
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]
    $ b/ ^# C- d6 V  ]1 d4 L
13. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
      N! E5 ~8 j! L1 Q9 |2 v( ]
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    ; p. C2 C9 d* g9 @+ H
18.             return self.block_size

复制代码

' v1 E* V& b" p, A7 o
( I2 f" a# m, k- Q& }* Q! O

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   ; `% {5 ~6 ]) i. n, e
5. os.mount(bdev, '/ramdisk')

复制代码

$ L& }; J* s' X# v) a: B" M- E
6 u. o3 q5 V0 |( x

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

1. class RAMBlockDev:
   9 z" r) X0 Q/ c# W. a: u6 O& n
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   : L2 h' m* g8 I- {2 [
6.     def readblocks(self, block_num, buf, offset=0):
   $ U( f: t) y. `/ R" t$ j
7.         addr = block_num * self.block_size + offset
   & Y- ?% o7 c0 I6 E$ N
8.         for i in range(len(buf)):
   
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    1 B7 H3 k- @/ Y4 e
12.         if offset is None:
    0 d: K1 t" [2 l6 y9 n
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    , Y' Q8 f4 ]2 P* T! l
15.                 self.ioctl(6, block_num + i)
    : E  [2 M% P4 {8 ]- p0 C% X
16.             offset = 0
    2 e2 S, d, E" [: \: `! B' Q
17.         addr = block_num * self.block_size + offset
    8 g, r5 H( O) o# v; z
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    
20. 
    , {; J, N2 J, O( ?
21.     def ioctl(self, op, arg):
    9 N2 D  {8 m3 d0 [8 z
22.         if op == 4: # block count
    ) i+ \# w: L# R* D
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    5 d9 k% r* ~7 R; |
25.             return self.block_size
    " \9 {5 U: H( s$ r# M
26.         if op == 6: # block erase
    $ J8 y; X0 w$ X0 u
27.             return 0

复制代码

7 V$ t6 O0 z9 X6 i
. K9 D1 p  ^; a8 P' [/ R
3 w" s4 @: K. z) _

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

1. import os
   
2. 
     j% e% D0 X* W" i
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   ( |1 F) p( u* E/ b
5. os.mount(bdev, '/ramdisk')

复制代码

0 P9 V  r6 W. D1 V* R1 I  n

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   1 {: n3 ^) Y6 g9 ~: m' B
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

3 P6 r- {( J$ V$ l$ Z6 o5 q) j
% @0 v" S3 e2 _) c: R* t% b1 b) T

7 i/ y4 G6 ~( p文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   ( ?/ k; `& w+ x4 i) m
4. os.VfsFat.mkfs(bdev)
   2 P# {  a) n' n
5. os.mount(bdev, '/')
   ' }$ O. W* ]6 @1 H0 ^( ?  m/ m* O# R
6. 
   + H5 S2 x! N7 x; ^
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   : b) u5 y% h1 }! l/ _3 l
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    ) k9 o& _& U( c
11. os.mount(pyb.Flash(start=0), '/flash')
    . S1 D% }8 [0 b1 R8 `! h
12. os.chdir('/flash')

复制代码

" {* C! @' r$ j1 \# e" r


Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   * B; A) O( O( j) \. [, ]
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   " g" e) A4 u2 c. Q1 U4 I
6. 
   8 w/ p" A' q- ~; n- a- M
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   / s1 y9 ]( s, ~5 ~  _
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    ) x# J* w8 l: F( [7 i/ `
12. os.chdir('/flash')

复制代码

& a7 M! _- k7 D8 h
% u3 ]. d' h# o

. a1 A% I0 }! ~: M8 _1 S( t7 ?- i混合 (STM32)

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

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

1. import os, pyb
   9 P  ^8 ]4 ?' p. \) P, \# y
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   , \5 [& _) Q8 M( ~+ `4 o7 L& P
5. os.VfsFat.mkfs(p1)
   0 S0 Q; m( l# s+ H/ S/ {' N8 o. r3 o
6. os.VfsLfs2.mkfs(p2)
   0 `% i3 J$ L2 _
7. os.mount(p1, '/flash')
   6 h' ?+ i( Y( H+ \1 i- K
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

, ~# c7 x7 Q) q7 {2 v
$ t% p4 l0 I! B$ r+ ]: ]6 j" z
& |0 r' s! [% T( T! |# ^7 N

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

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

1. import os, pyb
   ; z4 E2 d+ k  d- [" B# P, l
2. p2 = pyb.Flash(start=256*1024)
   
3. os.mount(p2, '/data')

复制代码

' ^/ j) s8 c" ?8 N: h' m% {
3 v' a8 |7 k  a& @! c

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

复制代码

! z8 t& y& m! O& D

) _3 m; c/ N: l4 x, ?* F! W