使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      4 w: A  n, S' B" z# _8 z

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        " L4 t' H' T6 Y. q* S; k% ]4 A- B

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    
  
  ; K, h# e. j5 K# P

. Q! I( ~$ p; _3 a$ x7 }

本教程介绍 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 s" _: @# f1 T! W块设备

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

  S* P- {& P% v8 v$ |! Q% E2 k0 X
7 S: O! D1 j9 W自定义块设备

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

1. class RAMBlockDev:
   7 L- v* S5 b, Q8 @, s6 T
2.     def __init__(self, block_size, num_blocks):
   " f& G! K  B" a2 V/ S( B
3.         self.block_size = block_size
   / |- Q) }# S, o* [1 H
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   0 V7 h7 K, \& e* p. @% f) I
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   
9. 
   ' Y; k9 U, X5 G
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]
    * M$ l1 A. ]2 h9 O1 u
13. 
    
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    ! G4 i" |0 S/ _
16.             return len(self.data) // self.block_size
    ( T/ N( t9 b; i+ T( v9 R7 E% S
17.         if op == 5: # get block size
    $ ~) ~0 S/ X" o* h
18.             return self.block_size

复制代码

- s9 Y0 @. R7 \

8 K1 H4 @: a" [  G

它可以按如下方式使用：

1. import os
   
2. 
   5 _0 M, B9 K9 c8 b7 b
3. bdev = RAMBlockDev(512, 50)
   & K8 J+ i1 ~: I% D
4. os.VfsFat.mkfs(bdev)
   ; g9 U8 r1 q; a: ^& R! k
5. os.mount(bdev, '/ramdisk')

复制代码

5 R, V8 ]/ U# |, U( N

% i- t6 k) ~7 r9 w2 n

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   3 j9 W, s; j* X  t1 R7 d
3.         self.block_size = block_size
   , q7 y8 Q( [4 z$ ]5 [$ y
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   3 ^  D* x. F/ H
6.     def readblocks(self, block_num, buf, offset=0):
   
7.         addr = block_num * self.block_size + offset
   2 ^/ a# z9 p1 l7 c: Z0 |
8.         for i in range(len(buf)):
   ) M5 H! r6 n& A% S0 t% Q0 ]9 O) g
9.             buf[i] = self.data[addr + i]
   
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    % k+ b. i9 X+ z
13.             # do erase, then write
    
14.             for i in range(len(buf) // self.block_size):
    
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    ( R8 V, _( Z& s+ f% \8 B6 o- Z. e
18.         for i in range(len(buf)):
    0 R6 M5 T5 s) `" d& Z( y$ [& c/ a
19.             self.data[addr + i] = buf[i]
    ; V0 R  G+ L  v: Y+ I' W
20. 
    6 W. N/ |. E9 C3 ]* H' R( m
21.     def ioctl(self, op, arg):
    5 n  Z2 ]2 I7 r# ]- u0 `  P
22.         if op == 4: # block count
    4 N8 G: A- _0 I: |
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    - l8 _1 ]# j! Q! C; b8 v1 @3 T
25.             return self.block_size
    * Z: j( v4 K1 c2 t
26.         if op == 6: # block erase
    + _9 G2 Y# _1 I3 l
27.             return 0

复制代码

4 ~: e6 b! a; Q2 |( g/ ~

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

1. import os
   , B- m. ]- m4 V, n
2. 
   
3. bdev = RAMBlockDev(512, 50)
   - X5 u+ \, G' p+ `) t$ L: P# k! z
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

: p3 c" U5 I! B: g! C: c
/ U- X5 `: ]7 l- U3 j+ N

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   5 s- L- B' G  j8 q8 m3 |# v
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

9 m& t: X) i/ ?2 g0 `: F& i9 J
2 h  p- m$ V5 p* }


文件系统

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

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

; n8 q  h: n4 v: \" C$ r& @+ uFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   2 {+ E& T/ u! e! U* n
3. os.umount('/')
   
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   
7. # STM32
   7 g9 B+ j. b; v- i# J& p
8. import os, pyb
   # n( M1 U; Q- f1 D! ?! _5 @7 g
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    9 z: {+ S2 L7 J5 v- |/ g
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

Littlefs

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

笔记

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

* V/ y, p) x; L+ q6 ^2 a. @( @

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   ' d" N8 o) g. W2 f# v8 n. O! d
4. os.VfsLfs2.mkfs(bdev)
   ! B* f4 r/ u9 A  r. Q5 `; N& d
5. os.mount(bdev, '/')
   
6. 
   $ a- E, N6 g% S4 h
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

; |' K' ?3 Z& P, s8 B: ~0 G
混合 (STM32)

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

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

1. import os, pyb
   ! ~6 z- _( l$ d' C( y' O
2. os.umount('/flash')
   2 B0 j! A+ [, y/ o! q
3. p1 = pyb.Flash(start=0, len=256*1024)
   $ \3 G' y! x! q& P' Z9 k
4. p2 = pyb.Flash(start=256*1024)
   7 ]% t9 [8 e5 e
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   1 K& j* y1 G7 z4 h; _, T' g- O! e
7. os.mount(p1, '/flash')
   
8. os.mount(p2, '/data')
   + ]( v/ j, `7 \! M9 v: ?
9. os.chdir('/flash')

复制代码

" l6 H: I" l8 r$ z

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

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

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

复制代码

来 boot.py挂载数据分区。

, }; B+ s( s& X9 u混合动力（ESP32）

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

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

1. import esp32, os
   + A3 y* o( a0 C/ X' d  j
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   . N; \& a) f  W4 n9 d
3. os.mount(p, '/foo')

复制代码

6 t+ j& e9 F! V1 Z3 J. e

( F8 C/ N" H! _+ z
- K3 g- W  F# n3 h: C. M/ G: y% ~
& Z$ k0 x8 F+ O  [! R) m" D
. h& Q3 r, r6 k2 D. F- E