MIG API

MIGService.Interfaces Domain


About MIG

MIG (Multi-protocol I/O Gateway) is a gateway between hardware pheripherals, services, multimedia protocols and the web. Pheripherals, services and multimedia protocols are commonly identified in MIG as Interfaces.

Interfaces can be entirely configured and controlled by using HTTP commands through MIG's web service gateway. HomeGenie itself relays on MIG for implementing its own web services and for serving UI html pages. See also Web API overview for further details.

Each interface in MIG implement own web service domain and modules, whose API are described in next chapters. This chapter describes API commands for the MIGService.Interfaces domain that is used to perform common configuration tasks on MIG's interfaces.

IsEnabled.Set

Enable or disable the MIG interface with the <interface_domain> domain.
Use a <value> of 0 to disable, 1 to enable.

Syntax

/api/MIGService.Interfaces/<interface_domain>/IsEnabled.Set/<value>
GET /api/MIGService.Interfaces/HomeAutomation.X10/IsEnabled.Set/1

Response

[{ "ResponseValue" : "OK" }]

IsEnabled.Get

Get whether or not the MIG interface with the <interface_domain> domain is enabled.

Syntax

/api/MIGService.Interfaces/<interface_domain>/IsEnabled.Get
GET /api/MIGService.Interfaces/HomeAutomation.X10/IsEnabled.Get

Response

[{ "ResponseValue" : "1" }]

Options.Set

Set the <option_name> option, of the interface with the <interface_domain> domain, with the given <option_value> value.

Syntax

/api/MIGService.Interfaces/<interface_domain>/Options.Set/<option_name>/<option_value>
GET /api/MIGService.Interfaces/HomeAutomation.X10/Options.Set/HouseCodes/A,B

Response

[{ "ResponseValue" : "OK" }]

Options.Get

Get the value of <option_name> option for the interface with the <interface_domain> domain.

Syntax

/api/MIGService.Interfaces/<interface_domain>/Options.Get/<option_name>
GET /api/MIGService.Interfaces/HomeAutomation.X10/Options.Get/HouseCodes

Response

[{ "ResponseValue" : "A,B" }]