https://github.com/spoddify-mopped/spoddify-mopped-gpio

A plugin to control Spoddify Mopped using GPIO.
https://github.com/spoddify-mopped/spoddify-mopped-gpio

gpio plugin raspberry-pi spoddify-mopped

Last synced: about 1 month ago
JSON representation

A plugin to control Spoddify Mopped using GPIO.

• Host: GitHub
• URL: https://github.com/spoddify-mopped/spoddify-mopped-gpio
• Owner: spoddify-mopped
• Created: 2022-02-27T00:32:37.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T12:12:01.000Z (over 1 year ago)
• Last Synced: 2024-04-26T00:42:50.766Z (7 months ago)
• Topics: gpio, plugin, raspberry-pi, spoddify-mopped
• Language: TypeScript
• Homepage:
• Size: 554 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
[![npm Version](https://badgen.net/npm/v/spoddify-mopped-gpio)](https://www.npmjs.com/package/spoddify-mopped-gpio)

# Spoddify Mopped GPIO

Spoddify Mopped GPIO is a plugin to control [Spoddify Mopped](https://github.com/spoddify-mopped/spoddify-mopped) using GPIO.

- Volume rotary encoder

- Play / Pause

- Previous / Next

## Install

The installation requires that [Spoddify Mopped](https://github.com/spoddify-mopped/spoddify-mopped) is already installed.

You can install this plugin with:

```bash

npm install -g spoddify-mopped-gpio

```

## Config

This plugin is configured in the [`config.json`](https://github.com/spoddify-mopped/spoddify-mopped/wiki/Config-File) of Spoddify Mopped.

### Example:

```json

"plugins": {

    "spoddify-mopped-gpio": {

        "playPausePin": 15

    }

}

```

### Structure:

| Key                         | Description                       |

| --------------------------- | --------------------------------- |

| `playPausePin` _(optional)_ | GPIO pin of the play pause button |

| `nextPin` _(optional)_      | GPIO pin of the next button       |

| `previousPin` _(optional)_  | GPIO pin of the previous button   |

# Contributing

Contributing and pull requests are very welcome.

More information about contributing to this project can be found [here](CONTRIBUTING.md)