jnewland / mpr-6zhmaut-api Goto Github PK

JSON API wrapper for the RS-232 interface of the Monoprice 6 Zone Home Audio Multizone Controller and Amplifier Kit (MPR-6ZHMAUT)

Home Page: https://www.monoprice.com/product?p_id=10761

License: MIT License

JavaScript 100.00%

home-automation

mpr-6zhmaut-api's Introduction

mpr-6zhmaut-api

⚠️ I no longer use this software, instead using remserial and the official Home Assistant integration for the same device.

Monoprice sells this wacky 6 zone amp with a serial interface. This tiny project wraps the serial interface with a JSON API.

A detailed walk-through is available illustrating the process to use this API easily on a Raspberry Pi

Installation

npm install

Environment Variables

DEVICE = <string> - the serial port device name (defaults to /dev/ttyUSB0)

BAUDRATE = <integer> - the baud rate to use to connect to the device (defaults to 9600)

PORT = <integer> - 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 = <true|false> - re-query the keypads before responding to a /zones request (defaults to false)

CORS = <true|false> - 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 = <string> - the serial port device name (defaults to /dev/ttyUSB0)

OLDBAUDRATE = <integer> - the current baud rate of the controller (the rate used to initially connect to the device)

NEWBAUDRATE = <integer> - the desired baud rate

API

GET /zones

[
  {
    "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.

{
  "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 is available (via Monoprice)[https://downloads.monoprice.com/files/manuals/10761_Manual_141028.pdf]

Contributions

fork
create a feature branch
open a Pull Request

mpr-6zhmaut-api's People

Contributors

Stargazers

Watchers

mpr-6zhmaut-api's Issues

Receive UnhandledPromiseRejectionWarning when attempting `npm start`

Hi there, just a few issues:

After I npm install and run PORT=8181 npm start, I receive this error. I tried adding .catch() methods onto async.until(). Can you help me understand what I need to resolve in order to run server? (see output below)
Additionally, what would be the best method code-wise to attempt to increase volume? Is this as simple as utilizing the POST method and passing along zone, attribute and new attribute value (attached to req.body as {"vo": "16"}?).

(node:5060) UnhandledPromiseRejectionWarning: Error: Error: No such file or directory, cannot open /dev/ttyUSB0
(node:5060) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:5060) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

Adding support for GlobalCache itach flex network serial port

Just providing a heads up that I'm starting work on providing support for the iTach Flex network serial port. I know I could replace it with a raspberry pi easier, but that would break the existing app my family has on their phones to control it (we don't even have the keypads installed).

Since the new model has a built in ethernet jack (that appears to be serial to TCP) this will also open the possibility to supporting them in the future (although tests of the free app shows that it's not the same protocol directly)

allow CORS option from API

need a way to easily expose CORS for the API

@jnewland - I'll submit a PR for this

Update serialport to latest

Update the serialport dependency to current to bypass some of the issues with the older release.

WARNING: the API is different

Multiple amps cause odd return when querying nonexistent

in my case I have two amps in series: master & slave 1

when querying a non-existent amp (>30\r) I receive a set of odd bytes on the receive line that are intermixed into the payload from the previous commands for amp one and amp two

I believe the fix is to environmentally set what your amp count is and react to that by not querying non existent amps. Related, the error never happens on the first amp, ONLY the second amp. I re-wired my amps by swapping their roles and the error maintained. As soon as I stopped querying amp 3 it worked great.

Also, I removed amp number two and left the code unchanged and it worked great. It only appears to be an issue on a two amp system when querying for three.

I'll submit a PR to deal with this.

@jnewland - great work on this; I love the encapsulation in node, makes it so easy to deal with on the PI

Excellent!

I have not tried your code but I am so happy you did this. I just bought two of these amps and was wondering if I was stuck with the wall interfaces or whether I could control them with my phone. This is the piece I was missing.

Two questions:

what kind of wire did you get? I am assuming a usb to serial, but did you have to create your own or is there an off-the-shelf?
If I have two amps set up in a master/slave config, do I need to connect to both serial ports or just the master?

Thanks!

Debian dev dependencies

Hi,

Thanks for this awesome looking project ;-)

I have a hard time bulding it on Debian :
https://gist.github.com/aurels/0f1f8d422a8f3a9319bf0086a8297779

I get the same result with npm and yarn.

I guess I have some build dependencies missing but I can't figure out which...
If I install libv8-dev, it uninstalls node.

Thanks !

Any idea what the "Do Not Disturb" setting actually does?

I know this is more about the device itself, but given the documentation only mentions this setting in the API, I thought someone this project's community might already have figured out what it does...