diff options
| author | Scott Shawcroft <scott.shawcroft@gmail.com> | 2018-02-20 17:34:59 -0800 |
|---|---|---|
| committer | Scott Shawcroft <scott.shawcroft@gmail.com> | 2018-02-20 17:34:59 -0800 |
| commit | 20dd3b1e434f57a0609fd5306f47863396d1022e (patch) | |
| tree | 47d7be30787716fcd95e01723942cdff06b0bd85 /docs/library/machine.SD.rst | |
| parent | ee90056866d2a8a1e0eec21f0ce5c60b741ea411 (diff) | |
Delete a bunch of docs, drivers and examples not relevant to CircuitPython.
This fixes #345 and fixes #215.
Diffstat (limited to 'docs/library/machine.SD.rst')
| -rw-r--r-- | docs/library/machine.SD.rst | 42 |
1 files changed, 0 insertions, 42 deletions
diff --git a/docs/library/machine.SD.rst b/docs/library/machine.SD.rst deleted file mode 100644 index 608e95831..000000000 --- a/docs/library/machine.SD.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. currentmodule:: machine -.. _machine.SD: - -class SD -- secure digital memory card -====================================== - -The SD card class allows to configure and enable the memory card -module of the WiPy and automatically mount it as ``/sd`` as part -of the file system. There are several pin combinations that can be -used to wire the SD card socket to the WiPy and the pins used can -be specified in the constructor. Please check the `pinout and alternate functions -table. <https://raw.githubusercontent.com/wipy/wipy/master/docs/PinOUT.png>`_ for -more info regarding the pins which can be remapped to be used with a SD card. - -Example usage:: - - from machine import SD - import os - # clk cmd and dat0 pins must be passed along with - # their respective alternate functions - sd = machine.SD(pins=('GP10', 'GP11', 'GP15')) - os.mount(sd, '/sd') - # do normal file operations - -Constructors ------------- - -.. class:: SD(id,... ) - - Create a SD card object. See ``init()`` for parameters if initialization. - -Methods -------- - -.. method:: SD.init(id=0, pins=('GP10', 'GP11', 'GP15')) - - Enable the SD card. In order to initialize the card, give it a 3-tuple: - ``(clk_pin, cmd_pin, dat0_pin)``. - -.. method:: SD.deinit() - - Disable the SD card. |