Core API

HomeAutomation.HomeGenie Domain

Config Module


HomeAutomation.HomeGenie/Config

This module implements commands related to HomeGenie configuration.

Interfaces.List

Get the list of all enabled interfaces.

Syntax

/api/HomeAutomation.HomeGenie/Config/Interfaces.List
GET /api/HomeAutomation.HomeGenie/Config/Interfaces.List

Response

[ 
    { 
        Domain : 'HomeAutomation.X10',
        IsConnected : 'False' 
    },
    {
        Domain : 'HomeAutomation.ZWave',
        IsConnected : 'True' 
    }
]

Modules.Get

Get the module object with the specified <module_domain> and <module_address>.

Syntax

/api/HomeAutomation.HomeGenie/Config/Modules.Get/<module_domain>/<module_address>
GET /api/HomeAutomation.HomeGenie/Config/Modules.Get/HomeAutomation.PhilipsHue/2

Response

{
   "Name": "Light 2",
   "Description": "",
   "DeviceType": "Dimmer",
   "Domain": "HomeAutomation.PhilipsHue",
   "Address": "2",
   "Properties": [ 
       {
           "Name": "Status.ColorHsb",
           "Description": "",
           "Value": "0.6568627450980387,1,0.5340909090909092",
           "UpdateTime": "2015-02-08 22:49:49Z"
       },
       {
           "Name": "Status.LastLevel",
           "Description": "",
           "Value": "0",
           "UpdateTime": "2015-02-08 22:49:49Z"
       },
       {
           "Name": "Status.Level",
           "Description": "",
           "Value": "0",
           "UpdateTime": "2015-02-08 22:49:49Z"
       },
       {
           "Name": "HomeGenie.TurnOffDelay",
           "Description": "",
           "Value": "120",
           "UpdateTime": "2014-07-25 21:31:14Z"
       },
       {
           "Name": "Meter.Watts",
           "Description": "",
           "Value": "0",
           "UpdateTime": "2015-02-10 11:50:36Z"
       },
       {
           "Name": "VirtualMeter.Watts",
           "Description": "",
           "Value": "12",
           "UpdateTime": "2015-02-08 22:49:49Z"
       },
       {
           "Name": "VirtualModule.ParentId",
           "Description": "",
           "Value": "26",
           "UpdateTime": "2015-02-08 22:49:58Z"
       },
       {
           "Name": "Widget.DisplayModule",
           "Description": "",
           "Value": "homegenie/generic/colorlight",
           "UpdateTime": "2015-02-08 22:49:50Z"
       }   
   ],
   "RoutingNode": ""
}

Modules.List

Get all module objects.

Syntax

/api/HomeAutomation.HomeGenie/Config/Modules.List
GET /api/HomeAutomation.HomeGenie/Config/Modules.List

Response

[{
   "Name": "Light 1",
   "Description": "",
   "DeviceType": "Dimmer",
   "Domain": "HomeAutomation.PhilipsHue",
   "Address": "1",
   "Properties": [ 
       {
           "Name": "Status.ColorHsb",
           "Description": "",
           "Value": "0.6568627450980387,1,0.5340909090909092",
           "UpdateTime": "2015-02-08 22:49:49Z"
       },
       {
           "Name": "Status.LastLevel",
           "Description": "",
           "Value": "0.2",
           "UpdateTime": "2015-02-08 22:49:49Z"
       },
       {
           "Name": "Status.Level",
           "Description": "",
           "Value": "0.8",
           "UpdateTime": "2015-02-08 22:49:49Z"
       },
       {
           "Name": "HomeGenie.TurnOffDelay",
           "Description": "",
           "Value": "120",
           "UpdateTime": "2014-07-25 21:31:14Z"
       },
       {
           "Name": "Meter.Watts",
           "Description": "",
           "Value": "9.43",
           "UpdateTime": "2015-02-10 11:50:36Z"
       },
       {
           "Name": "VirtualMeter.Watts",
           "Description": "",
           "Value": "12",
           "UpdateTime": "2015-02-08 22:49:49Z"
       },
       {
           "Name": "VirtualModule.ParentId",
           "Description": "",
           "Value": "26",
           "UpdateTime": "2015-02-08 22:49:58Z"
       },
       {
           "Name": "Widget.DisplayModule",
           "Description": "",
           "Value": "homegenie/generic/colorlight",
           "UpdateTime": "2015-02-08 22:49:50Z"
       }   
   ],
   "RoutingNode": ""
},
// { ... }, ...., { ... } 
{
   "Name": "Security Alarm System",
   "Description": "",
   "DeviceType": "Program",
   "Domain": "HomeAutomation.HomeGenie.Automation",
   "Address": "90",
   "Properties": [ 
       {
           "Name": "ConfigureOptions.Email.Recipients",
           "Description": "3. Comma separated list of recipients e-mails for alarm notifications",
           "Value": "",
           "UpdateTime": "2015-02-08 20:06:11Z"
       },
       {
           "Name": "ConfigureOptions.System.ArmDelay",
           "Description": "1. Arm Delay (seconds)",
           "Value": "10",
           "UpdateTime": "2015-02-08 20:05:45Z"
       },
       {
           "Name": "ConfigureOptions.System.SirenMaxTime",
           "Description": "2. Sirens Max Time (seconds, 0=infinite)",
           "Value": "30",
           "UpdateTime": "2015-02-08 20:05:45Z"
       },
       {
           "Name": "ConfigureOptions.Trigger.ArmedProgram",
           "Description": "4. Program to run when armed",
           "Value": "",
           "UpdateTime": "2015-02-08 20:06:11Z"
       },
       {
           "Name": "ConfigureOptions.Trigger.DisarmedProgram",
           "Description": "5. Program to run when disarmed",
           "Value": "",
           "UpdateTime": "2015-02-08 20:06:11Z"
       },
       {
           "Name": "ConfigureOptions.Trigger.TriggeredProgram",
           "Description": "6. Program to run when triggered",
           "Value": "",
           "UpdateTime": "2015-02-08 20:06:11Z"
       },
       {
           "Name": "HomeGenie.SecurityArmed",
           "Description": "",
           "Value": "0",
           "UpdateTime": "2015-02-08 20:06:12Z"
       },
       {
           "Name": "HomeGenie.SecurityTriggered",
           "Description": "",
           "Value": "0",
           "UpdateTime": "2015-02-08 20:06:12Z"
       },
       {
           "Name": "Program.Status",
           "Description": "",
           "Value": "Running",
           "UpdateTime": "2015-02-08 20:06:12Z"
       },
       {
           "Name": "Status.Level",
           "Description": "",
           "Value": "0",
           "UpdateTime": "2015-02-08 20:06:12Z"
       },
       {
           "Name": "VirtualModule.ParentId",
           "Description": "",
           "Value": "90",
           "UpdateTime": "2015-02-09 09:03:55Z"
       },
       {
           "Name": "Widget.DisplayModule",
           "Description": "",
           "Value": "homegenie/generic/securitysystem",
           "UpdateTime": "2015-01-26 08:00:37Z"
       }   ],
   "RoutingNode": ""
}]

Groups.List

Get the groups list with associated modules reference.

Syntax

/api/HomeAutomation.HomeGenie/Config/Groups.List
GET /api/HomeAutomation.HomeGenie/Config/Groups.List

Response

[{
    "Name":"Dashboard",
    "Modules": [
        {"Address":"34","Domain":"HomeAutomation.HomeGenie.Automation"},
        {"Address":"1","Domain":"HomeAutomation.EnergyMonitor"},
        {"Address":"36","Domain":"HomeAutomation.HomeGenie.Automation"},
        {"Address":"90","Domain":"HomeAutomation.HomeGenie.Automation"},
        {"Address":"Eden Sensor Board","Domain":"HomeGenie.UI.Separator"},
        {"Address":"1","Domain":"HomeAutomation.BasicThermostat"},
        {"Address":"CH0","Domain":"Components.MCP3008"},
        {"Address":"CH1","Domain":"Components.MCP3008"}
    ]
},
{
    "Name":"Color Lights",
    "Modules":[
        {"Address":"1","Domain":"HomeAutomation.PhilipsHue"},
        {"Address":"2","Domain":"HomeAutomation.PhilipsHue"},
        {"Address":"3","Domain":"HomeAutomation.PhilipsHue"}
}]

Groups.ModulesList

Get the list of all enabled interfaces.

Syntax

/api/HomeAutomation.HomeGenie/Config/Groups.ModulesList/<group_name>
GET /api/HomeAutomation.HomeGenie/Config/Groups.ModulesList/Dashboard

Response

The server response is a list of JSON formatted modules as already shown in Modules.List example.