Yamaha reciver controller interface

Aim of this project

The aim is to provide an intuitive interface for control of a home theatre receiver. The provided physical remote and web interface is not intuitive or very user friendly. The aim is to make the selection of various inputs and controls automated so that the use of the product is easier for the users.

API endpoints needed

• [x]Receiver on
• [x]Input select
  • Phono
  • Tuner
  • Airplay
  • Audio1 (Optical)
  • Audio2 (Analog)
  • AV1(HDMI 1) [Bluetooth input]
• [x]Receiver off (Standby)
• Sub ON/OFF
• [x]Get state from the Reciver, in case of manual changes. (refresh UI)
• [x]Volume Up
• [x]Volume Down
• [x]Volume Mute
• [x]Power Status

Build plan

1. Run stand alone tests using the npm package for the above input selections and criteria.
2. Build an Express API for the above endpoints
3. [] Build a front-end that uses the API.

Dependencies

• Yamaha Node, (npm)
• bluebird, promise library
• body-parser, node json body parser
• chalk, colorful logging
• express, web framework for node
• helmet, security package
• ping, node wrapper for ping command
• systeminformation, host information provider
• tcp-port-used, host checker provider
• validate.js, validation library

How to setup and run

• Move into the backend folder

cd backend

• Install backend packages

yarn install

• Start the backend

yarn start

• Optionally develop/run with nodemon (must be globally installed)

yarn dev

Endpoints

See ./backend/ENDPOINTS.md

Development notes

• The manual testing file in Insomnia format file is in /backend/Audio_API_Insomnia.json

TODO's

• Dockerise (docker-compose the front and backend together to a single container)
• Add support for front end advanced settings
  • setting the ip address of the reciever
  • setting the increment of the volume changes