Garadget 3P Plugin

Getting Started

This is a HomeSeer HS3 plugin for the ‘Garadget’ open source garage door monitor and control system (http://www.garadget.com/), this plugin has been developed and will communication with Garadget units via the Particle Cloud API (not the LAN). This plugin is to be installed by the updater and once installed then go into the Plugins > Manage page, you should now see the  plugin in the list of plugins. Please now enable this plugin by clicking the switch as you would any other plugin.

Upon enabling the plugin you should see some entries in the HomeSeer log similar to this:


Jan-12 18:46:58                 Plug-In        Finished initializing plug-in Garadget 3P
Jan-12 18:46:58                 Garadget 3P        Plugin Loaded For First Time - Please Enter Details
Jan-12 18:46:56                 Garadget 3P        Garadget 3P Plugin Started
Jan-12 18:46:56                 Info                Plugin Garadget 3P has connected. IP:127.0.0.1:29698

As the HomeSeer log suggests some details need to be added before it is able to communicate with the Particle Cloud API. Please setup your Garadget unit initially via the Garadget application and keep note of your login username and password. Go into the Plug-ins > Garadget 3P and click on the instance you are wishing to configure. The first page should contain a picture of a door and then there should be a tab labelled settings. Inside that tab it should look like this:

As the fields suggest they should be updated with both your Garadget username and password, when you have done this please press ‘Update Changes’. The plugin will then attempt to make a connection with the device and the panel below should show whether or not it has been successful. If it has been successful then it should attempt to gather a list of connected devices from the Garadget/Particle API. You can have more than one device connected to an account but only one can be connected to the plugin at a time, the plugin however is multi instance so if another instance is launched then you can use another instance to communicate with another unit.

If successful at getting a list of devices then the field below should look like this;

These will be all of the units it has found from the API, you then need to select one that you wish the plugin to be attributed to and press ‘Select’. Then the table should change to a green row and the plugin will attempt to talk to the unit and download it’s settings. If it is successful at doing this then the division below this will look like this.

Please see the tooltips for guidance over which settings these relate to, these are taken from the Garadget site and contain details of what they mean. If you need other settings added for specific durations then please post and I will add them to the drop lists. If you need to change any of the settings then change the drop list and press the Update Changes button.

The other web page available in this plugin is a status page for the door itself, it will contain a picture of a door and some controls on the bottom of the page. These controls will control the door providing it has been set up correctly, they are simple that they have been set up to mirror the options available in the existing Garadget firmware.

Devices

HomeSeer will create a group of devices for the plugin to control, these devices in the main will be self explanatory. You should find that the devices look as follows:

  1. Root Device - This device has limited function but will change it’s state to ‘Communication Error’ if there are communication issues between the plugin and the Garadget unit.
  2. Garage Door Operation - This device represents whether or not the status of the unit has detected whether the door itself is open, closed, stopped, opening or closing. The three control methods will call into the unit and allow the signal be sent to open, close or stop the door..
  3. Garade Door Status Time - The unit reports a time back and that is the time that the unit has been in it’s current state, so if this device reports five minutes and the second device is door open then it believes that the door has been open for five minutes. Please note that the Garadget unit reports the time back in a string format ‘time in that status 0-119s, 2-119m, 2-47h, 2+d’. I have therefore had to make a decision over how this is represented in HomeSeer, I have decided that HomeSeer should report the time in minutes and as such if the door has been closed for two days then it will report 2 x 60 x 24 = 2880 minutes. Please consider this in your events if you are using this as a condition or trigger.

All devices contain value/graphics pairs that have been taken from the HomeSeer contemporary image set. You are free to change them to whatever images you feel suitable by editing the pairs in the plugin pages. All of the devices should change status and can be used in events to display screens, obtain images or whatever actions you feel appropriate.

Event Actions/Triggers

At the time of writing (12/01/17) there are no event actions and no triggers, control through events will be through changes to the devices.

Issues/Warnings

Scripting Functions

There are no functions available in the plugin in terms of scripting, this is because of the existing functions available in the events I feel already cater for the options. If there is a specific function requested then this can be considered.

Issues

Please post any issues/comments/requests to the appropriate HomeSeer message board thread and I will try and answer them accordingly - https://forums.homeseer.com/showthread.php?t=186223