91 lines
2.7 KiB
ReStructuredText
91 lines
2.7 KiB
ReStructuredText
Introduction
|
|
============
|
|
|
|
|
|
.. image:: https://readthedocs.org/projects/adafruitcircuitpythonfloppy/badge/?version=latest
|
|
:target: https://docs.circuitpython.org/projects/floppy/en/latest/
|
|
:alt: Documentation Status
|
|
|
|
|
|
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
|
|
:target: https://adafru.it/discord
|
|
:alt: Discord
|
|
|
|
|
|
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_floppy/workflows/Build%20CI/badge.svg
|
|
:target: https://github.com/adafruit/Adafruit_CircuitPython_floppy/actions
|
|
:alt: Build Status
|
|
|
|
|
|
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
|
|
:target: https://github.com/astral-sh/ruff
|
|
:alt: Code Style: Ruff
|
|
|
|
Interface with archaic spinning rust
|
|
|
|
|
|
Dependencies
|
|
=============
|
|
This driver depends on:
|
|
|
|
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
|
|
* `Adafruit Ticks <https://github.com/adafruit/adafruit_circuitpython_ticks>`_
|
|
|
|
Please ensure all dependencies are available on the CircuitPython filesystem.
|
|
This is easily achieved by downloading
|
|
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
|
|
or individual libraries can be installed using
|
|
`circup <https://github.com/adafruit/circup>`_.
|
|
|
|
|
|
Installing to a Connected CircuitPython Device with Circup
|
|
==========================================================
|
|
|
|
Make sure that you have ``circup`` installed in your Python environment.
|
|
Install it with the following command if necessary:
|
|
|
|
.. code-block:: shell
|
|
|
|
pip3 install circup
|
|
|
|
With ``circup`` installed and your CircuitPython device connected use the
|
|
following command to install:
|
|
|
|
.. code-block:: shell
|
|
|
|
circup install adafruit_floppy
|
|
|
|
Or the following command to update an existing version:
|
|
|
|
.. code-block:: shell
|
|
|
|
circup update
|
|
|
|
Usage Example
|
|
=============
|
|
|
|
See the `Examples page <examples.html>`_ for a full example. This example shows how to initialize a floppy and seek to track 1, but it omits the pin arguments to the Floppy constructor for brevity:
|
|
|
|
.. code-block:: python
|
|
|
|
import board
|
|
import adafruit_floppy
|
|
|
|
floppy = adafruit_floppy.MFMFloppy(...)
|
|
|
|
floppy.selected = True
|
|
floppy.spin = True
|
|
floppy.track = 1
|
|
|
|
Contributing
|
|
============
|
|
|
|
Contributions are welcome! Please read our `Code of Conduct
|
|
<https://github.com/adafruit/Adafruit_CircuitPython_floppy/blob/HEAD/CODE_OF_CONDUCT.md>`_
|
|
before contributing to help this project stay welcoming.
|
|
|
|
Documentation
|
|
=============
|
|
|
|
For information on building library documentation, please check out
|
|
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
|