Skip to main content

CircuitPython library for SI4713 FM RDS transmitter.

Project description

Introduction

Documentation Status Discord Build Status

CircuitPython module for SI4713 FM RDS transmitter.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

See examples/simpletest.py for a demo of the usage.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you’ll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-si4713 --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-si4713-1.1.0.tar.gz (25.9 kB view details)

Uploaded Source

File details

Details for the file adafruit-circuitpython-si4713-1.1.0.tar.gz.

File metadata

  • Download URL: adafruit-circuitpython-si4713-1.1.0.tar.gz
  • Upload date:
  • Size: 25.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.3

File hashes

Hashes for adafruit-circuitpython-si4713-1.1.0.tar.gz
Algorithm Hash digest
SHA256 c5e90cac713301bb617680ccb53bcabd702f46c902bcd1746413c273e7e9e525
MD5 440ff4e072fcc9fcd0842c2f245f9181
BLAKE2b-256 a8a05ac015b4ca63f61d6d7e3fb625cf6173fc69c764a5060e5dd1360e32ed75

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page