martin
/
mopidy-raspberrypi-gpio
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
54 Commits
2 Branches
5 Tags
83 KiB
Python 100%
 
Go to file
Philip Howard b4f6137f65
Drop Pirate Audio default pin config for #9 
This config is set by the Pirate Audio install script- https://github.com/pimoroni/pirate-audio/blob/master/mopidy/install.sh

Since this library is device agnostic, these defaults don't have to be here, and shouldn't be here. Users should have to explicitly configure and enable the plugin.

See #9 for an example of the default pin config being unexpectedly loaded and causing the plugin to bail.
 		2020-07-17 11:49:35 +01:00
.circleci Poke CircleCI to recompile config 2020-01-23 11:55:28 +00:00
mopidy_raspberry_gpio Drop Pirate Audio default pin config for #9 2020-07-17 11:49:35 +01:00
tests Add test for play_stop for #6 2020-07-15 11:50:51 +01:00
.gitignore Update project to match cookiecutter-mopidy-ext 2020-01-23 11:55:27 +00:00
CHANGELOG.rst Prep for v1.0.2 2020-07-15 11:54:59 +01:00
LICENSE Initial commit from CookieCutter project 2019-10-10 11:22:34 +01:00
MANIFEST.in Update project to match cookiecutter-mopidy-ext 2020-01-23 11:55:27 +00:00
README.rst Document Mopidy user permissions for #9 2020-07-17 10:38:41 +01:00
pyproject.toml Update project to match cookiecutter-mopidy-ext 2020-01-23 11:55:27 +00:00
setup.cfg Prep for v1.0.2 2020-07-15 11:54:59 +01:00
setup.py black . 2020-01-23 11:55:27 +00:00
tox.ini Show diff for black 2020-07-14 14:51:05 +01:00

README.rst 

****************************
Mopidy-Raspberry-GPIO
****************************

.. image:: https://img.shields.io/pypi/v/Mopidy-Raspberry-GPIO.svg
    :target: https://pypi.org/project/Mopidy-Raspberry-GPIO/
    :alt: Latest PyPI version

.. image:: https://img.shields.io/circleci/build/gh/pimoroni/mopidy-raspberry-gpio
    :target: https://circleci.com/gh/pimoroni/mopidy-raspberry-gpio
    :alt: CircleCI build status

.. image:: https://img.shields.io/codecov/c/gh/pimoroni/mopidy-raspberry-gpio
    :target: https://codecov.io/gh/pimoroni/mopidy-raspberry-gpio
    :alt: Test coverage

Mopidy extension for GPIO input on a Raspberry Pi


Installation
============

Ensure Mopidy has access to GPIO::

    sudo usermod -a -G gpio mopidy

Install by running::

    python3 -m pip install Mopidy-Raspberry-GPIO

Or, if available, install the Debian/Ubuntu package from `apt.mopidy.com
<https://apt.mopidy.com/>`_.


Configuration
=============

Before starting Mopidy, you must add configuration for
Mopidy-Raspberry-GPIO to your Mopidy configuration file::

    [raspberry-gpio]
    enabled = true
    bcm5 = play_pause,active_low,250
    bcm6 = volume_down,active_low,250
    bcm16 = next,active_low,250
    bcm20 = volume_up,active_low,250

Each bcmN entry corresponds to the BCM pin of that number.

You must assign an event, mode and bouncetime (ms) to your desired pins.

Supported events:

- play_pause
- volume_up
- volume_down
- next
- prev

Supported modes:

- active_low - configures the pin with a pull-up and triggers when it reads 0/low (RECOMMENDED)
- active_high - configures the pin as a pull-down and triggers when it reads 1/high

Events volume_up and volume_down both support an (optional) "step" option, which controls the amount (in percent) that the volume is adjusted with each button press.

Eg::

    [raspberry-gpio]
    enabled = true
    bcm5 = play_pause,active_low,250
    bcm6 = volume_down,active_low,250,step=1
    bcm16 = next,active_low,250
    bcm20 = volume_up,active_low,250,step=1


Project resources
=================

- `Source code <https://github.com/pimoroni/mopidy-raspberry-gpio>`_
- `Issue tracker <https://github.com/pimoroni/mopidy-raspberry-gpio/issues>`_
- `Changelog <https://github.com/pimoroni/mopidy-raspberry-gpio/blob/master/CHANGELOG.rst>`_


Credits
=======

- Original author: `Phil Howard <https://github.com/pimoroni>`__
- Current maintainer: `Phil Howard <https://github.com/pimoroni>`__
- `Contributors <https://github.com/pimoroni/mopidy-raspberry-gpio/graphs/contributors>`_