Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jnewland/mpr-6zhmaut-api
JSON API wrapper for the RS-232 interface of the Monoprice 6 Zone Home Audio Multizone Controller and Amplifier Kit (MPR-6ZHMAUT)
https://github.com/jnewland/mpr-6zhmaut-api
home-automation
Last synced: about 16 hours ago
JSON representation
JSON API wrapper for the RS-232 interface of the Monoprice 6 Zone Home Audio Multizone Controller and Amplifier Kit (MPR-6ZHMAUT)
- Host: GitHub
- URL: https://github.com/jnewland/mpr-6zhmaut-api
- Owner: jnewland
- License: mit
- Created: 2015-11-08T15:17:21.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-04-28T12:56:26.000Z (over 2 years ago)
- Last Synced: 2023-04-10T15:07:06.272Z (over 1 year ago)
- Topics: home-automation
- Language: JavaScript
- Homepage: https://www.monoprice.com/product?p_id=10761
- Size: 30.3 KB
- Stars: 40
- Watchers: 14
- Forks: 24
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mpr-6zhmaut-api
> :warning: I no longer use this software, instead using [`remserial`](https://github.com/jnewland/remserial) and the [official Home Assistant integration](https://www.home-assistant.io/integrations/monoprice/) for the same device.
Monoprice sells this wacky [6 zone amp](https://www.monoprice.com/product?p_id=10761) with a serial interface. This tiny project wraps the serial interface with a JSON API.
[A detailed walk-through is available](https://chrisschuld.com/2019/07/decorating-the-monoprice-6-zone-home-audio-multizone-controller/) illustrating the process to use this API easily on a Raspberry Pi
## Installation
npm install
## Environment Variables
`DEVICE = ` - the serial port device name (defaults to /dev/ttyUSB0)
`BAUDRATE = ` - the baud rate to use to connect to the device (defaults to 9600)
`PORT = ` - port for API to listen on (defaults to 8181)
`AMPCOUNT = <1|2|3>` - the number of amps (you can slave up to two additional amps) (defaults to 1)
`REQUERY = ` - re-query the keypads before responding to a /zones request (defaults to false)
`CORS = ` - respond to a CORS request with an `Access-Control-Allow-Origin=*` (defaults to false)
## Running the server
PORT=8181 npm start
or using more environment variables:
PORT=8181 AMPCOUNT=2 REQUERY=false BAUDRATE=115200 CORS=false npm start
## Updating the Baud Rate
You can update the baud rate of the controller to one of the following rates: 9600, 19200, 38400, 57600, 115200, 230400
By default, at power loss, the device is set to run at 9600 BAUD. You can adjust it using the `updateBaudRate.js` via npm run-script *(or directly with node)*.
```
OLDBAUDRATE=9600 NEWBAUDRATE=115200 npm run-script baudrate
```
Notes:
+ To reset the baud rate remove power from the controller for 30 seconds - it will reset to 9600 BAUD
+ Running `npm run-script baudrate` with the incorrect connection baud rate will not cause it to lock so intialization scripting could be created to reset the baudrate before the API enables.
### Environment Variables for updateBaudRate.js
`DEVICE = ` - the serial port device name (defaults to /dev/ttyUSB0)
`OLDBAUDRATE = ` - the current baud rate of the controller (the rate used to initially connect to the device)
`NEWBAUDRATE = ` - the desired baud rate
## API
### GET /zones
```js
[
{
"zone": "11",
"pa": "00",
"pr": "01",
"mu": "00",
"dt": "00",
"vo": "15",
"tr": "10",
"bs": "10",
"bl": "10",
"ch": "01",
"ls": "00"
},
{
"zone": "12",
"pa": "00",
"pr": "01",
"mu": "00",
"dt": "00",
"vo": "15",
"tr": "10",
"bs": "10",
"bl": "10",
"ch": "01",
"ls": "00"
},
{
"zone": "13",
"pa": "00",
"pr": "01",
"mu": "00",
"dt": "00",
"vo": "15",
"tr": "10",
"bs": "10",
"bl": "10",
"ch": "01",
"ls": "00"
},
{
"zone": "14",
"pa": "00",
"pr": "01",
"mu": "00",
"dt": "00",
"vo": "10",
"tr": "10",
"bs": "12",
"bl": "10",
"ch": "02",
"ls": "00"
},
{
"zone": "15",
"pa": "00",
"pr": "01",
"mu": "00",
"dt": "00",
"vo": "20",
"tr": "07",
"bs": "07",
"bl": "10",
"ch": "01",
"ls": "00"
},
{
"zone": "16",
"pa": "00",
"pr": "01",
"mu": "00",
"dt": "00",
"vo": "21",
"tr": "07",
"bs": "07",
"bl": "10",
"ch": "01",
"ls": "00"
}
]
```
### GET /zones/:zone
Returns the current status of a specific zone.
```js
{
"zone": "11",
"pa": "00",
"pr": "01",
"mu": "00",
"dt": "00",
"vo": "15",
"tr": "10",
"bs": "10",
"bl": "10",
"ch": "01",
"ls": "00"
}
```
### GET /zones/:zone/:attribute
Return the value of a specific attribute in a zone as plain text.
Valid attributes are:
pa (send zone 1 to all outputs)
power / pr
mute / mu
do not disturb / dt
volume / vo
treble / tr
bass / bs
balance / bl
channel / source / ch
keypad status / ls
$ curl 192.168.1.254:8181/zones/11/bass
10
### POST /zones/:zone/:attribute
Update a zone's attribute using the plain-text value of the body.
pa (send zone 1 to all outputs)
power / pr
mute / mu
do not disturb / dt
volume / vo
treble / tr
bass / bs
balance / bl
channel / source / ch
Here's an example where we turn the bass of zone 11 up:
```
$ curl 192.168.1.254:8181/zones/11
{"zone":"11","pa":"00","pr":"01","mu":"00","dt":"00","vo":"15","tr":"10","bs":"10","bl":"10","ch":"01","ls":"00"}
$ curl -X POST -d '12' 192.168.1.254:8181/zones/11/bass
{"zone":"11","pa":"00","pr":"01","mu":"00","dt":"00","vo":"15","tr":"10","bs":"12","bl":"10","ch":"01","ls":"00"}
```
## Device Manual
The manual for the [6 zone amp](https://www.monoprice.com/product?p_id=10761) is available (via Monoprice)[https://downloads.monoprice.com/files/manuals/10761_Manual_141028.pdf]
## Contributions
* fork
* create a feature branch
* open a Pull Request