Skip to content

Commit e325383

Browse files
Add sdcard to wiki (#199)
1 parent 0c85910 commit e325383

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

wiki/sdcard.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# sdcard
2+
3+
[sdcard](https://github.com/echo-lalia/MicroHydra/blob/main/src/lib/sdcard/mhsdcard.py) provides an interface to mount and unmount the SD Card device.
4+
5+
At its core, the module is a wrapper around the same interface that MicroPython uses.
6+
7+
It exposes a singular class, SDCard.
8+
9+
## constructor:
10+
11+
`sdcard.SDCard()`
12+
13+
> Create the class necessary for mounting the device.
14+
15+
> Args: None.
16+
17+
## mount:
18+
19+
`SDCard.mount()`
20+
21+
> Mounts the available sd card device at /sd in the filesystem.
22+
23+
> This method always returns `None`.
24+
25+
> If the sd card is already mounted, this method does nothing.
26+
27+
> Additionally, if an error is encountered, a message may be sent to `stdout`.
28+
29+
## deinit:
30+
31+
`SDCard.deinit()`
32+
33+
> Unmounts the mounted sd card device.
34+
35+
> Attempting to unmount a mounted device, may cause a system error. See [MicroPython's vfs.umount](https://docs.micropython.org/en/latest/library/vfs.html#vfs.umount) for details.

0 commit comments

Comments
 (0)