使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    

    • 内置块设备

      
      & \. o8 W5 L" K

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        " O7 [; v$ v% v

    • 自定义块设备

      
      

  • 文件系统

    
    

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      7 M+ {, J# P6 Z+ S; F
    
    2 {9 c6 q0 U8 \
  
  4 m1 {1 A9 f! W: e  [* a

5 ]: m- P5 K* ]

本教程介绍 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 U) q( e# [' q$ R块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

ESP8266

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

( Q5 r/ y9 C" T# R* K& dESP32

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

3 M1 Z3 F* T: i% Z4 }. W; n
自定义块设备

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

1. class RAMBlockDev:
   " y' I. {: X$ I/ P
2.     def __init__(self, block_size, num_blocks):
   ; J4 X7 J, A3 N5 g
3.         self.block_size = block_size
   
4.         self.data = bytearray(block_size * num_blocks)
   , ]) J3 t4 J2 F
5. 
   + }& Y& J' M" R: _6 k: M; X% m2 Q
6.     def readblocks(self, block_num, buf):
   
7.         for i in range(len(buf)):
     O" Q- e$ m6 \; f8 \
8.             buf[i] = self.data[block_num * self.block_size + i]
   + K8 I0 A5 Q8 Z8 w) i/ h" H
9. 
   - P+ Z$ n2 ^+ e9 }0 q7 x% X( N
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]
    
13. 
    0 u7 m& Y5 e5 V, U/ Y: w' @
14.     def ioctl(self, op, arg):
    
15.         if op == 4: # get number of blocks
    
16.             return len(self.data) // self.block_size
    : X3 a4 a' z5 j* g" A9 @
17.         if op == 5: # get block size
    % N, g6 t2 r: S) m0 \
18.             return self.block_size

复制代码

! F1 I# K4 E' u. T" J5 O
- Y3 A$ O) O+ O4 ?; w  M
' ^( N( o6 g# M

它可以按如下方式使用：

1. import os
   $ H7 S# V3 J1 K- A2 P
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   ) k4 J2 p# R: \/ T7 c! s; `  F
5. os.mount(bdev, '/ramdisk')

复制代码

7 }9 e# v& }( O9 |! N" l) B. o4 f6 d

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

1. class RAMBlockDev:
   0 W) y8 ~1 u! E+ t. a3 P
2.     def __init__(self, block_size, num_blocks):
   
3.         self.block_size = block_size
   & e  p* R2 w! ?/ v8 W$ _" W( l
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   ! ]5 ~6 l& M$ o
7.         addr = block_num * self.block_size + offset
   0 k. a" D0 P9 f6 |$ w, i1 k
8.         for i in range(len(buf)):
   ) d( B3 t' N/ }3 s
9.             buf[i] = self.data[addr + i]
   1 y$ ]: E$ A1 _  {) G2 y! e/ _
10. 
    
11.     def writeblocks(self, block_num, buf, offset=None):
    1 q' T/ h5 C3 O
12.         if offset is None:
    
13.             # do erase, then write
      a7 n  }) X4 S3 `$ r
14.             for i in range(len(buf) // self.block_size):
    ( T2 S' u/ I; D5 W' X2 A7 z
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    
17.         addr = block_num * self.block_size + offset
    : F1 b2 @, n& M, s
18.         for i in range(len(buf)):
    7 s9 {# H5 Q: A" m# i  e* s, F% }
19.             self.data[addr + i] = buf[i]
    ' {6 ~" u4 i& E1 y1 h; Q$ a9 e7 O
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    
23.             return len(self.data) // self.block_size
    4 x: A6 \' X& h- V4 B
24.         if op == 5: # block size
    
25.             return self.block_size
    
26.         if op == 6: # block erase
    ( L$ h' d. Q1 k( r& w. L/ y
27.             return 0

复制代码

' g$ K$ G& A) u0 l$ b# u7 c
/ O# e" ]1 k- v) e/ Q% G
3 u9 p+ M7 S! @

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

1. import os
   
2. 
   1 _; g( L% v" \: [# ?7 M' R' P
3. bdev = RAMBlockDev(512, 50)
   0 X! o& _) X( t& s( r* s% O
4. os.VfsLfs2.mkfs(bdev)
   6 U, S% \0 S2 g, Q( R, B
5. os.mount(bdev, '/ramdisk')

复制代码

$ m4 ^, V; N/ @! g$ ^
8 I* ]0 B. L; s4 p) i5 s6 K

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   / E( h4 O- G" e& A
3. print(open('/ramdisk/hello.txt').read())

复制代码

( t6 C& n3 }" g. g文件系统

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

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

FAT

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

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

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

1. # ESP8266 and ESP32
   4 b1 _! x0 i  y$ y9 j7 Z* L9 T
2. import os
   # Y' e, i6 J& `! r* K( y- U, l
3. os.umount('/')
   8 ]- P1 v1 N. \9 b: R
4. os.VfsFat.mkfs(bdev)
   
5. os.mount(bdev, '/')
   
6. 
   1 {8 ^2 m0 e4 E8 X  B: P/ s
7. # STM32
   # r. l9 s; \0 ~
8. import os, pyb
   
9. os.umount('/flash')
   
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    # p1 W, P# w5 d& t5 @/ c+ Z/ f1 Y4 J* C
12. os.chdir('/flash')

复制代码

0 Q* t! S) C, i* M2 _3 |' @
: c- Z$ G; B7 Z" {! M1 E2 ]
Littlefs

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

笔记

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

) f2 u) Y  T" |* ?

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

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

1. # ESP8266 and ESP32
   
2. import os
   # e. W  U3 A5 h
3. os.umount('/')
   + l# ^3 T: Y  x3 J, z
4. os.VfsLfs2.mkfs(bdev)
   ( o& R" r0 r& Q# }: n' [& C
5. os.mount(bdev, '/')
   ! G& O  b9 y) x" M1 J
6. 
   2 M' F$ \9 e" K) y+ s* q
7. # STM32
   : e& R5 q; R2 R, ], t; ~
8. import os, pyb
   4 u$ B- u# x0 z3 h9 ?/ h
9. os.umount('/flash')
   / U; {' R! i2 L  i! V# ?: O
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    / s+ ]+ x9 O) x( T7 E. j
12. os.chdir('/flash')

复制代码

+ E6 U- F6 B6 C4 m7 p( |混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   6 x+ U. u! c; W' O9 w9 T; r: @! g
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   2 q8 _: J2 U" \. K6 {
7. os.mount(p1, '/flash')
   + M+ j; Y8 h! T  ]- v" {
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

0 v, T# t  l. C8 j  q

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

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

1. import os, pyb
   1 ]5 T1 |* l1 a6 `
2. p2 = pyb.Flash(start=256*1024)
   + \9 E/ G4 t( n. ~( l' q
3. os.mount(p2, '/data')

复制代码

9 Q+ g( H; {6 i* T. i8 ?9 q
" }& e% `& m4 P8 O

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   $ i# C. i+ h/ q: |
3. os.mount(p, '/foo')

复制代码

0 M; T2 ]6 Q# W1 u
6 h! U" S; u/ I' V% T( o* D
! Z" Y1 A6 \$ x0 D9 x. }