homebridge-commander v0.3.0

homebridge-commander

CLI plug-in for HomeBridge

By default homebridge-commander will execute the command listed in config.json with default arguments. The default arguments are the name of the command (given name from config.json), the type of command (powerstate, brightness, etc.) the action (get or set), and the value (only with set command).

See ExampleScript.sh in the example directory. This script can be used for all commands configurated. It is possible to have a seperate script for each command.

Command call:

 cmd command_name command_type action value
 
 example: 
 ExampleScript.sh SwitchName powerstate set true

The arguments can be turned off by setting the no_arg value to true

Supported types (More will be added soon)

• Switch
• Lightbulb
• Outlet
• Speaker
• Window Cover
• Temperature Sensor
• Humidity Sensor

Config.json settings

Platform config settings. See config.json in the example directory.

"platforms": [
         {
            "platform": "commander",
            "name": "PlatformName",
            "commands": [{
                "name" : "command_name",
                "type" : one of the following:
                         "switch"
                         "lightbulb"
                         "outlet"
                         "speaker"
                "cmd" : "path to command or command"
                "no_arg" : false
                "updaterate" : 5000
                }]
         }]

Switch

Switch has no additional settings.

Switch has the following command_types config:

Example of a switch command:

"commands": [{
    "name": "SwitchName",
    "type": "switch",
    "cmd" : "~/ExampleScript.sh"
    }

Lightbulb

Set the listed settings to true to have them active in Homekit

Lightbulb supports hue and saturation or colortemperture. When hue or saturation is set to true colortemperature will be disabled.

Use the Hue and Saturation for color settings and Color Temperature for ambient settings.

"brightness" : true,
"hue" : true,
"saturation" : true,

or

"brightness" : true,
"colortemperature" : true,

Lightbulb has the following command_types :

Example of a lightbulb command config (without Color Temperature):

"commands": [{
    "name": "LightBulbName",
    "type": "lightbulb",
    "cmd" : "~/ExampleScript.sh"
    "brightness" : true,
    "hue" : true,
    "saturation" : true,
    }

Outlet

Outlet has no additional settings.

Outlet has the following command_types :

Example of a switch command config:

"commands": [{
    "name": "OutletName",
    "type": "outlet",
    "cmd" : "~/ExampleScript.sh"
    }

Speaker

Set the listed settings to true to have them active in Homekit

"volume" : true,

Speaker has the following command_types :

Example of a speaker command config:

"commands": [{
    "name": "SpeakerName",
    "type": "speaker",
    "cmd" : "~/ExampleScript.sh"
    "volume" : true,
    }

Window Cover

Set the listed settings to true to have them active in Homekit

"holdposition" : true,
"targethorizontaltiltangle" : true,
"targetverticaltiltangle" : true,
"currenthorizontaltiltangle" : true,
"currentverticaltiltangle" : true,
"obstructiondetected" : true

Window Cover has the following command_types :

Example of a window cover command config:

"commands": [{
    "name": "WindowCoveringName",
    "type": "windowcovering",
    "cmd" : "~/ExampleScript.sh",
    "holdposition" : true,
    "targethorizontaltiltangle" : true,
    "targetverticaltiltangle" : true,
    "currenthorizontaltiltangle" : true,
    "currentverticaltiltangle" : true,
    "obstructiondetected" : true
    }

Temperature Sensor

Set the listed settings to true to have them active in Homekit

"statusactive" : true,
"statusfault" : true,
"statuslowbattery" : true,
"statustampered" : true

Temperature sensor has the following command_types :

Example of a temperature sensor command config:

"commands": [{
    "name": "TemperatureSensor",
    "type": "temperaturesensor",
    "cmd" : "~/ExampleScript.sh",
    "statusactive" : true,
    "statusfault" : true,
    "statuslowbattery" : true,
    "statustampered" : true,
    }

Humidity Sensor

Set the listed settings to true to have them active in Homekit

"statusactive" : true,
"statusfault" : true,
"statuslowbattery" : true,
"statustampered" : true

Humidity sensor has the following command_types :

Example of a humidity sensor command config:

"commands": [{
    "name": "HumiditySensor",
    "type": "humiditysensor",
    "cmd" : "~/ExampleScript.sh",
    "statusactive" : true,
    "statusfault" : true,
    "statuslowbattery" : true,
    "statustampered" : true,
    }

Custom Service

Adding the option "custom" to a command extra settings can be added. Only settings which are not already standard for the selected type can be added. The used arguments etc. are based on the arguments where this extra setting is supported.

With the custom option, services could be created which are not supported by HomeKit!

See the config.json and Examplescript for a starting point to add custom options.

Example where a standard speaker has a powerstate setting:

"commands": [{
    "name": "SpeakerCustomName",
    "type": "speaker",
    "custom": true,
    "volume": true,
    "powerstate": true,
    "cmd" : "~/ExampleScript.sh"
    }