使用文件系统

闪电

使用文件系统

内容

• 使用文件系统

  
  

  • 虚拟FS

  • 块设备

    
    ) K5 r5 F1 P, _

    • 内置块设备

      
      5 J8 J! [1 g& d! Y4 k8 N

      • STM32 / Pyboard

      • ESP8266

      • ESP32

        
        ; `+ a/ g8 a9 N6 y

    • 自定义块设备

      
      & h) k3 f. A. |, `

  • 文件系统

    
    6 A( b: P. M4 ~0 C" s1 r: V

    • FAT

    • Littlefs

    • 混合 (STM32)

    • 混合动力（ESP32）

      
      " V, `( }% o8 {, z- B
    
    
  
  & R' j' I9 C# }. K! A0 j$ f0 f

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

% U4 Z4 x  e4 L% v, m: R& i块设备

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

内置块设备

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

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

STM32 / Pyboard

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

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

* b+ P% E& v3 y. \" Y; D; H$ W' xESP8266

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

ESP32

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

" p( w" z4 {3 J5 i$ T6 f; ?
自定义块设备

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

1. class RAMBlockDev:
   
2.     def __init__(self, block_size, num_blocks):
   0 l. F' F3 I3 a( o. |% n$ K% C, i
3.         self.block_size = block_size
   0 X6 n  F4 z; E0 h# o
4.         self.data = bytearray(block_size * num_blocks)
   
5. 
   + p$ j" L0 K7 n* y! r% m
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. 
   7 ?( I2 o, t3 I' s
10.     def writeblocks(self, block_num, buf):
    8 K4 x8 S+ I2 D0 G" A+ Z+ [
11.         for i in range(len(buf)):
    ( M- L! X; g# T& N+ _; e9 t
12.             self.data[block_num * self.block_size + i] = buf[i]
    5 U/ T! B+ W" C+ ~9 \6 I- F
13. 
    % E& x5 I7 G7 A: G4 i
14.     def ioctl(self, op, arg):
    2 v7 ~1 O  B( l' {2 x" A' `) E. z
15.         if op == 4: # get number of blocks
    9 w: @2 ^- S8 O7 Y5 r4 Z6 }
16.             return len(self.data) // self.block_size
    $ o1 p- S& a  |2 n+ {4 P* t
17.         if op == 5: # get block size
    
18.             return self.block_size

复制代码

( Q! k! b8 s4 n

它可以按如下方式使用：

1. import os
   
2. 
   
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsFat.mkfs(bdev)
   & I) a0 `1 g) \. g. t2 e- G- \
5. os.mount(bdev, '/ramdisk')

复制代码

& M$ k  D. A' J4 w! ?

) N: j, e" W3 M' o5 e, h+ {

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

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)
   ; _: \% c  k1 A" T5 t0 Q0 L4 [
5. 
   
6.     def readblocks(self, block_num, buf, offset=0):
   ; V) z! a/ W8 w6 }
7.         addr = block_num * self.block_size + offset
   ) F4 W$ }# k* ^' v, @" s
8.         for i in range(len(buf)):
   3 Q' C  F/ l; S
9.             buf[i] = self.data[addr + i]
   : R$ E1 a2 \6 \3 u5 a& l& R
10. 
    9 @9 I8 Y% [. \3 A  r# q- J" v
11.     def writeblocks(self, block_num, buf, offset=None):
    
12.         if offset is None:
    . d# m6 k/ l1 D3 ~! F
13.             # do erase, then write
    , V8 a. _+ U* e5 o! @- l
14.             for i in range(len(buf) // self.block_size):
    ; c, M* Y) |1 [9 [" ]$ T# U
15.                 self.ioctl(6, block_num + i)
    
16.             offset = 0
    & E( _+ J7 ]& W# @& h6 k
17.         addr = block_num * self.block_size + offset
    ( m, K3 k' R) w1 G! M
18.         for i in range(len(buf)):
    
19.             self.data[addr + i] = buf[i]
    7 l( y; `- k, ~0 f
20. 
    
21.     def ioctl(self, op, arg):
    
22.         if op == 4: # block count
    ; {) N/ m; H- a# u
23.             return len(self.data) // self.block_size
    
24.         if op == 5: # block size
    $ _7 H) ~" a6 ~; _- l4 R4 g# _8 }! _9 ]
25.             return self.block_size
    : }/ s4 C8 X) o
26.         if op == 6: # block erase
    
27.             return 0

复制代码

; M! ~4 O' w" y. {0 y; ?0 B. s3 j

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

1. import os
   . y7 U4 f7 f0 X" {7 A6 p; c
2. 
   5 Z. c. u4 z5 g& t/ L
3. bdev = RAMBlockDev(512, 50)
   
4. os.VfsLfs2.mkfs(bdev)
   + O7 z% ?; O$ g" ^( ^( C
5. os.mount(bdev, '/ramdisk')

复制代码

1 o% {8 u8 K* s4 p9 J
  X- r, R, _% e

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

1. with open('/ramdisk/hello.txt', 'w') as f:
   
2.     f.write('Hello world')
   6 ?+ J9 l+ ^0 l5 x; [$ U& O$ X
3. print(open('/ramdisk/hello.txt').read())

复制代码

' I9 q" U6 P8 c
# v+ v- G! w4 o* D' P' a. l文件系统

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('/')
   
4. os.VfsFat.mkfs(bdev)
   0 Z: s: [3 E5 A7 D8 P3 W
5. os.mount(bdev, '/')
   
6. 
   7 y+ E( L0 i9 R1 }' J8 k
7. # STM32
   
8. import os, pyb
   
9. os.umount('/flash')
   ; Y& |0 L0 ~! \1 ~
10. os.VfsFat.mkfs(pyb.Flash(start=0))
    ; l( M3 u) c! e& _5 H" ]% y
11. os.mount(pyb.Flash(start=0), '/flash')
    
12. os.chdir('/flash')

复制代码

+ t% U" x! N$ l- f7 X: |

- g1 V/ C* q' ?% O0 C5 R8 o/ v; O
# t( s3 m& k: p( ]" c; y& _Littlefs

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

笔记

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

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

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

1. # ESP8266 and ESP32
   & o1 P/ d. R9 f1 N
2. import os
   
3. os.umount('/')
   
4. os.VfsLfs2.mkfs(bdev)
   0 w& ^" g9 q- F
5. os.mount(bdev, '/')
   ; h. ~% f/ V2 B/ r6 E  h
6. 
   : _! O2 }7 \1 R) `' @
7. # STM32
   / H4 @! J9 {+ m4 `) ~# ~
8. import os, pyb
   
9. os.umount('/flash')
     K# |* I9 Z2 ~! h6 J4 ^2 h
10. os.VfsLfs2.mkfs(pyb.Flash(start=0))
    
11. os.mount(pyb.Flash(start=0), '/flash')
    * x& \  _0 M: r0 P3 h
12. os.chdir('/flash')

复制代码

8 t# l5 t' f5 K7 u% B

  C) N% s$ K+ |# Z4 [8 {. N' j8 G
混合 (STM32)

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

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

1. import os, pyb
   
2. os.umount('/flash')
   
3. p1 = pyb.Flash(start=0, len=256*1024)
   
4. p2 = pyb.Flash(start=256*1024)
   & R5 X: x: }' `4 O
5. os.VfsFat.mkfs(p1)
   
6. os.VfsLfs2.mkfs(p2)
   8 d/ E, P9 t4 r% V* _: ]) T
7. os.mount(p1, '/flash')
   5 s, g% F" b* R( {# E1 o6 n
8. os.mount(p2, '/data')
   
9. os.chdir('/flash')

复制代码

& o. p" g- O8 A& |/ W* y% n

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

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

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

复制代码

. b) N$ a: M. x

来 boot.py挂载数据分区。

混合动力（ESP32）

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

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

1. import esp32, os
   6 I) ]9 x3 c" W* y/ ]! G
2. p = esp32.Partition.find(esp32.Partition.TYPE_DATA, label='foo')
   1 E. s! ?9 `* r
3. os.mount(p, '/foo')

复制代码

! @7 v# V0 ~; L
3 \4 i! u  O  g1 G2 e