使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    : L: J$ h" P8 l% u& u, C/ X# @9 X

    • 内置块设备

      
      " |2 `4 ?7 g: K9 U; i6 y3 I

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        7 @9 S+ D; D% d5 \0 z

    • 自定义块设备

      
      ! T' \7 B1 C/ x

  • 文件系统

    
    9 b" |3 z# x+ F

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      
    
    0 a5 N3 W/ w7 P/ I: R: N+ e
  
  

' P; d) ?( Y. L9 @

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

% N' N3 O1 y5 `0 }* O1 `7 D块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

: h" j4 q2 F; @2 K/ ?4 o: J; |ESP8266

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

  J" W- {; P4 J3 l( [6 xESP32

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)
   # P5 m; w+ e5 }. |" d/ j9 a
5. 
   8 t% k' K. ?/ d  h. X" N$ V8 P$ G3 Y
6.     def readblocks(self, block_num, buf):
   % m- R8 F& {) e: e
7.         for i in range(len(buf)):
   
8.             buf[i] = self.data[block_num * self.block_size + i]
   + n- m, t. J* p
9. 
   
10.     def writeblocks(self, block_num, buf):
    ; h$ p+ k0 \- ]  ^+ v
11.         for i in range(len(buf)):
    , b# N! p# h# O# z# g: y
12.             self.data[block_num * self.block_size + i] = buf[i]
    
13. 
    ' v2 v9 g  [; v  _- @; c
14.     def ioctl(self, op, arg):
    4 \/ Q- Q. j( _0 j8 {
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    
17.         if op == 5: # get block size
    & B3 T; M/ o. ?4 r; W
18.             return self.block_size

复制代码

$ u' Z- r$ i$ e* X+ M- w5 W
( y- x/ c& z) ]4 z
1 I+ A( p# R" x# v6 N" b/ E

它可以按如下方式使用：

1. import os
   4 p! Z1 \6 X3 t  W2 S
2. 
   % T& ~4 V8 V" c7 {
3. bdev = RAMBlockDev(512, 50)
   ! I$ s- e. y+ {; B- y
4. os.VfsFat.mkfs(bdev)
   2 ~# X; T  Z. L0 ~7 A
5. os.mount(bdev, '/ramdisk')

复制代码

( Q0 j& u1 f, N& v, M6 g
4 N0 F3 Y/ h# d7 r! ~8 u; A
$ `$ V' h. |' e# M( J

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

1. class RAMBlockDev:
   0 z1 |- k2 r  g# p
2.     def __init__(self, block_size, num_blocks):
   . |/ S2 o! s5 R4 Z2 M
3.         self.block_size = block_size
   : }: E' S* P! H" ~: I9 k. \& D
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
   6 I+ D5 H; F0 a; K7 U3 F" m5 R
8.         for i in range(len(buf)):
   , r4 [& j% [1 O
9.             buf[i] = self.data[addr + i]
   2 y, Y% ?/ U% B  K5 @  l/ b
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    6 p$ t1 F% b3 e! N' q
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
    
18.         for i in range(len(buf)):
    * h& o3 k1 E" L/ C( l
19.             self.data[addr + i] = buf[i]
    % y7 L5 |2 X# [+ g& n% H" i
20. 
    - [/ a' r+ q2 `; X: w
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    : O6 P7 c5 z( N0 y: G* e6 c9 T. d3 C( [
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    1 n& z: n4 h- r& u: m9 P  f
27.             return 0

复制代码

" b. H5 F) q6 I0 {+ e

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

1. import os
   
2. 
   6 N( _& {* z& \0 S8 a* @
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/ramdisk')

复制代码

& Y" S, o8 G3 l9 T1 q! O9 S4 ?1 K

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   * [( k, S# N$ v! A. X
2.     f.write('Hello world')
   
3. print(open('/ramdisk/hello.txt').read())

复制代码

3 E0 K) S% Q1 ]: K0 ]# S
9 O) J1 w' S- g7 S! m5 X


文件系统

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

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

0 _, P1 I+ K$ W& U" K  gFAT

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

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

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

1. # ESP8266 and ESP32
   
2. import os
   
3. os.umount('/')
   * [( k$ y0 R4 d% ~; f4 L6 h
4. os.VfsFat.mkfs(bdev)
   % A  l1 L% D& E$ W2 C+ R
5. os.mount(bdev, '/')
   & R7 z6 }! }$ [4 k, Y$ d% f" x  p
6. 
   3 n/ ?! p. M) }( q- N
7. # STM32
   
8. import os, pyb
   6 e8 U% m# j" s/ C9 C0 Q3 a  @  Q
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    6 n3 O" @9 P& R6 F- |, @/ y' u5 r
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

% b7 x! P/ ^. Q

& d+ c9 K8 B* g0 D: T# F: |
Littlefs

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

笔记

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

6 y4 w, V$ R. r

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

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

1. # ESP8266 and ESP32
   $ l1 n+ H- }+ R% D3 V2 K  q7 Z
2. import os
   6 q% _+ O" O1 x+ F+ h
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   6 k/ b% j2 _  |/ b
7. # STM32
   ) C0 ^8 b( r2 N8 y; p2 j) N
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    $ n9 F2 V' u1 l" J  Y3 I; Z4 ]# F
11. os.mount(pyb.Flash(start=0), '/flash')
    # @/ J' a, t& V
12. os.chdir('/flash')

复制代码

  G2 ?1 d7 \* W+ B/ A
' o! b$ Q) Q0 P& f! [
混合 (STM32)

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

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

1. import os, pyb
   . _- S; [. [6 J  q
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   9 K( g7 G  ?6 V5 a$ f3 j
5. os.VfsFat.mkfs(p1)
   * a( R/ u9 o; Y3 s6 U, _0 \
6. os.VfsLfs2.mkfs(p2)
   
7. os.mount(p1, '/flash')
   ; v6 F  ~, ]5 |4 }) m/ G
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

  D0 B* Y: X0 Q$ ]  d9 E
% g; K. b7 R. C
$ }" I! s3 s( N+ A* C) z3 l9 `

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

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

1. import os, pyb
   ) Q; L. A5 x2 c  z. P
2. p2 = pyb.Flash(start=256*1024)
   - G1 L2 r& ~/ }( z2 g! L
3. os.mount(p2, '/data')

复制代码

0 ?- ?$ F8 }0 n
: T$ U( N' M4 _! \3 s- ^+ |
- d& Z1 K- w( b" h: G+ e2 {0 }

来 boot.py挂载数据分区。

1 r! ~- H3 x5 }3 B- I混合动力（ESP32）

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

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

1. import esp32, os
     q( l8 \5 X- Q0 x9 T
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   
3. os.mount(p, '/foo')

复制代码

% ]7 D* g/ S5 M) H" N& A9 [

) G% U7 U' R1 i  c! O5 }
6 u$ {( y0 ?' G0 s+ o  Q& _/ @" x

! [/ \" t1 o! [# x5 K% v* V