[](https://pypi.python.org/pypi/volumio-buddy)
# volumio-buddy
# new release!
This release now supports Volumio 3! It's actually an almost complete rewrite of the code, now using Python 3 with asyncio. It doesn't support Volumio 2 anymore, because the underlying OS is too outdated for a smooth migration to Python 3 (Volumio 2 users can still use release 0.4.1).
## Introduction
Volumio-buddy is a python3 library and helper program for Volumio 3.
It is meant to run on the same host where the Volumio back-end runs and provides the following additional functionality:
- connect to volumio using the [websockets API](https://volumio.github.io/docs/API/WebSocket_APIs.html)
- support for GPIO pushbuttons to control volumio
- support for [rotary encoders](https://en.wikipedia.org/wiki/Incremental_encoder) to adjust the volume and to skip through a playlist
- RGB LED support
- [SSD1306 OLED](https://learn.adafruit.com/monochrome-oled-breakouts/arduino-library-and-examples) 128x64px screen support (I2C)
- Battery power monitoring with an [INA219](https://learn.adafruit.com/adafruit-ina219-current-sensor-breakout) chip.
## Installation instructions
The package assumes installation on a Debian based distribution for Raspberry Pi with `systemd` based init. If you don't use `systemd`, install the package with `make install` and start the `vbuddy` script manually in the virtual environment.
Edit `src/vbuddy` to reflect your hardware setup. The script ignores the display and battery monitoring components if they are not found, but you need to update the GPIO pin configuration and the I2C addresses, if you use different ones than I do.
If your buttons or rotary encoders need an internal pullup or pulldown resistor, edit `src/vbuddy.service` to include the commandline option `-p up` or `-p down` in the `ExecStart` line.
Install the service in a separate virtual environment using the following commands:
```
make .venv
. .venv/bin/activate
make service
sudo systemctl start vbuddy
```
Raw data
{
"_id": null,
"home_page": "https://github.com/foxey/volumio-buddy",
"name": "volumio-buddy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Volumio,Volumio3,GPIO,SSD1306,OLED,Rotary Encoder,SocketIO",
"author": "Michiel Fokke",
"author_email": "michiel@fokke.org",
"download_url": "https://files.pythonhosted.org/packages/d1/5a/560bbb18adb8d51f102322adad0f223842d61c4e19c3d22ac89de094d5c9/volumio-buddy-3.0.6.tar.gz",
"platform": null,
"description": "\n\n[](https://pypi.python.org/pypi/volumio-buddy)\n\n# volumio-buddy\n\n# new release!\n\nThis release now supports Volumio 3! It's actually an almost complete rewrite of the code, now using Python 3 with asyncio. It doesn't support Volumio 2 anymore, because the underlying OS is too outdated for a smooth migration to Python 3 (Volumio 2 users can still use release 0.4.1).\n\n## Introduction\n\nVolumio-buddy is a python3 library and helper program for Volumio 3.\nIt is meant to run on the same host where the Volumio back-end runs and provides the following additional functionality:\n- connect to volumio using the [websockets API](https://volumio.github.io/docs/API/WebSocket_APIs.html)\n- support for GPIO pushbuttons to control volumio\n- support for [rotary encoders](https://en.wikipedia.org/wiki/Incremental_encoder) to adjust the volume and to skip through a playlist\n- RGB LED support\n- [SSD1306 OLED](https://learn.adafruit.com/monochrome-oled-breakouts/arduino-library-and-examples) 128x64px screen support (I2C)\n- Battery power monitoring with an [INA219](https://learn.adafruit.com/adafruit-ina219-current-sensor-breakout) chip.\n\n## Installation instructions\n\nThe package assumes installation on a Debian based distribution for Raspberry Pi with `systemd` based init. If you don't use `systemd`, install the package with `make install` and start the `vbuddy` script manually in the virtual environment.\n\nEdit `src/vbuddy` to reflect your hardware setup. The script ignores the display and battery monitoring components if they are not found, but you need to update the GPIO pin configuration and the I2C addresses, if you use different ones than I do.\n\nIf your buttons or rotary encoders need an internal pullup or pulldown resistor, edit `src/vbuddy.service` to include the commandline option `-p up` or `-p down` in the `ExecStart` line.\n\nInstall the service in a separate virtual environment using the following commands:\n\n```\nmake .venv\n. .venv/bin/activate\nmake service\nsudo systemctl start vbuddy\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Hardware add-ons integration for Volumio 3",
"version": "3.0.6",
"project_urls": {
"Bug Tracker": "https://github.com/foxey/volumio-buddy/issues",
"Homepage": "https://github.com/foxey/volumio-buddy"
},
"split_keywords": [
"volumio",
"volumio3",
"gpio",
"ssd1306",
"oled",
"rotary encoder",
"socketio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ae09a56e4fba8517aca92a14473dea506a9a3bc87cc0198db0906cfcedfe730",
"md5": "f8a410605fe1933dc3398785c62ccbe5",
"sha256": "6c8b7ff5bc99648786ff00deb9c50f7dad4bc727c28b870b497b7da539900c68"
},
"downloads": -1,
"filename": "volumio_buddy-3.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8a410605fe1933dc3398785c62ccbe5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 78104,
"upload_time": "2024-01-21T13:17:27",
"upload_time_iso_8601": "2024-01-21T13:17:27.425553Z",
"url": "https://files.pythonhosted.org/packages/2a/e0/9a56e4fba8517aca92a14473dea506a9a3bc87cc0198db0906cfcedfe730/volumio_buddy-3.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d15a560bbb18adb8d51f102322adad0f223842d61c4e19c3d22ac89de094d5c9",
"md5": "d320dd90d79d94fa5b0dabff3e3c1153",
"sha256": "b6c21c481b6ea5fc941968f6af27d92cccf4368c8e5bd212497e8b73186143ac"
},
"downloads": -1,
"filename": "volumio-buddy-3.0.6.tar.gz",
"has_sig": false,
"md5_digest": "d320dd90d79d94fa5b0dabff3e3c1153",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 78084,
"upload_time": "2024-01-21T13:17:29",
"upload_time_iso_8601": "2024-01-21T13:17:29.058207Z",
"url": "https://files.pythonhosted.org/packages/d1/5a/560bbb18adb8d51f102322adad0f223842d61c4e19c3d22ac89de094d5c9/volumio-buddy-3.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-21 13:17:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "foxey",
"github_project": "volumio-buddy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "volumio-buddy"
}
JSON
