spudxdemon / st-monoprice-dual-relay-module

SmartThings device type and SmartApp for the Monoprice 11990 Dual Relay Adapter

Custom Device Type for Monoprice 11990 Dual Relay Module

The code in this repository will interface with the Monoprice 11990 module in a way that allows both switches to report near real-time status back to the SmartThings Hub. SmartThings ships with a "Z-Wave Device MultiChannel" device type that will (sorta) work, but you'll quickly find that switch 2 doesn't update it's status in the SmartThings app. This device type will do just that.

The bulk of the work for this was done by Eric Maycock for the Philio PAN04 module. All I did was remove the parts that didn't work with the Monoprice module and publish it. Special thanks go to him for all of his work.

Installation

Install the Custom Device Type

First, we need to install the custom device type into your SmartThings account. Don't worry, this won't hurt a bit.

1. Go ahead and install the module, and let SmartThings set it up as a "Z-Wave Device Multichannel".
2. Copy the code from monoprice-11990.groovy into your clipboard.
3. Log into your developer account at https://graph.api.smartthings.com/ You can sign up for a new account if you don't already have one. This site is referred to as "the IDE" from here out.
4. Click "My Device Types", then "New Device Type", then click the "From Code" tab.
5. Paste in the code you copied to your clipboard, and click the "Create" button.
6. From the resulting page, click the "Save" button, then click the "Publish" button, and click "For Me" from the dropdown.
7. You've now installed the custom device type, now you need to associate it with your Monoprice relay.

Associate the Custom Device Type with the Monoprice Relay Module

Once the custom device type is published in your own library, we need to actually associate it with your Monoprice device. We'll be doing all of this work in the IDE as well.

1. Click "My Devices". Click on the name of your Monoprice device. The device will have "Z-Wave Device MultiChannel" in the "Type" column.
2. Click the "Edit" button.
3. On the resulting page, click the "Type" dropdown. Scroll all the way to the bottom, and select "Monoprice 11990 Dual Relay Module".
4. Click the "Update" button.

Congratulations, you're done setting up the device! Go ahead and test it out by toggling the switches from the SmartThings app as well as from the switches themselves. Make sure everything's working as planned before moving onto the SmartApp installation.

Install the dual relay adapter SmartApp

SmartThings doesn't really allow you to interact with the individual switches on a multichannel device very well. So, we'll be creating two "virtual switches". These virtual switches will look like a normal on/off switch to the SmartThings app, but in reality will just be associated to one of the two switches on our relay.

Installing the virtual switches

1. From the IDE, click "My Devices", and click the "New Device" button.
2. In the "Name" field, add whatever you want this switch to be called, ie "Front Porch Light"
3. Leave "Label" and "Zigbee Id" blank.
4. For "Device ID", pick an ID that you haven't used before. I recommend using a UUID for this purpose.
5. Under "Type", select "Simulated Switch" from the dropdown.
6. Under "Version", select "Published".
7. Pick the correct values for your setup under "Location" and "Hub".
8. Leave "Group" blank.
9. Repeat steps 1-8 for your 2nd switch

Installing the SmartApp

1. Copy the code from dual-relay-adapter.groovy into your clipboard.
2. From the IDE, click "My SmartApps", then "New SmartApp", then click the "From Code" tab.
3. Paste in the code you copied to your clipboard, and click the "Create" button.
4. From the resulting page, click the "Save" button, then click the "Publish" button, and click "For Me" from the dropdown.
5. You've now installed the SmartApp to your account, now to set it up!

Configuring the SmartApp

1. Now, grab your phone, and open up the SmartThings app.
2. Touch the "Marketplace" icon in the lower right of the app -- it looks like an asterisk.
3. Touch the "SmartApps" tab at the top of the page.
4. Touch "My Apps", it's at the bottom of the list.
5. Touch "Dual Relay Adapter".
6. You'll be prompted with the question "Which Dual Relay Module?". Here, select whatever you named your relay (the one with two switches).
7. For the "Virtual Switch to link to Switch 1?" and "Virtual Switch to link to Switch 2?" questions, just pick the virtual switches that we created above.
8. Assign this instance of the SmartApp a name.
9. Touch "Done"

Congratulations, you've done it!!! You can now assign your virtual switches to a room, and toggle them on and off just like normal light switches. They can be used in other SmartApps and Routines, just like any other on/off switch.