jurgendj / onkyo-webserver

Simple webservice, as a wrapper for controlling my Onkyo receiver from my home automation system

Onkyo control api server

Simple webservice, as a wrapper for controlling my Onkyo receiver. Basically I'm running small scripts on top of the eiscp library that I found on github (but which is no longer maintained / completed) these scripts can be triggered through a fastapi based web interface.

The service can be queried (swagger style) using http://localhost:8000/docs

install

1. create and activate the virtual environment:

py -m venv venv
./venv/scripts/activate

2. install the packages

pip install -r requirements.txt

Run server

The easiest way is to use the vsCode Task explorer -> vscode -> Run Fastapi webserver of manueel met het commando:

py -m venv venv
uvicorn server:app --reload

de reload parameter zorgt dat de server herstart wanneer server.py wordt aangepast.

Api Calls

Since the base eiscp project doesn't seem to be maintained anymore, and it it was not completed to support api calls that require parameters based on a specific template, I mainly rely on doing raw calls, using the description of onkyo protocol as found xls file from Micahel Elsdoerfer.

Credits

This project builds on top of the work done by Michael Elsdoerfer in his project : https://github.com/miracle2k/onkyo-eiscp for making my own scripts, I found the most usefull information in his xls file: [http://michael.elsdoerfer.name/onkyo/ISCP_AVR_134.xlsx]