Repository files navigation

homebridge-http-switch is aHomebridge plugin with which you can configureHomeKit switches which forward any requests to a defined http server. This comes in handy when you already have homeautomated equipment which can be controlled via http requests. Or you have built your own equipment, for example some sortof lightning controlled with an wifi enabled Arduino board which than can be integrated via this plugin into Homebridge.

homebridge-http-switch supports three different type of switches. A normalstateful switch and two variants ofstateless switches (stateless andstateless-reverse) which differ in their original position. For stateless switchesyou can specify multiple urls to be targeted when the switch is turned On/Off.
More about on how to configure such switches can be read further down.

First of all you need to haveHomebridge installed. Refer to the repo forinstructions.
Then run the following command to installhomebridge-http-switch

sudo npm install -g homebridge-http-switch

The'On' characteristic from the'switch' service has the permission tonotify the HomeKit controller of statechanges.homebridge-http-switch supports two ways to send state changes to HomeKit.

The 'pull' way is probably the easiest to set up and supported in every scenario.homebridge-http-switch requests thestate of the switch in an specified interval (pulling) and sends the value to HomeKit.
Look forpullInterval in the list of configuration options if you want to configure it.

When using the 'push' concept, the http device itself sends the updated value tohomebridge-http-switch wheneverthe value changes. This is more efficient as the new value is updated instantly andhomebridge-http-switch does notneed to make needless requests when the value didn't actually change.
However because the http device needs to actively notify thehomebridge-http-switch there is more work neededto implement this method into your http device.

MQTT (Message Queuing Telemetry Transport) is a protocol widely used by IoT devices. IoT devices can publish messageson a certain topic to the MQTT broker which then sends this message to all clients subscribed to the specified topic.In order to use MQTT you need to setup a broker server (mosquitto is a solidopen source MQTT broker running perfectly on a device like the Raspberry Pi) and then instruct all clients topublish/subscribe to it.
Forshelly.cloud devices mqtt is the best and only option to implement push-updates.

For those of you who are developing the http device by themselves I developed a pretty simple 'protocol' based on httpto send push-updates.
How to implement the protocol into your http device can be read in the chapterNotification Server

The configuration can contain the following properties:

• name <string>required: Defines the name which is later displayed in HomeKit
• switchType <string>optional (Default:"stateful"): Defines the type of the switch:
  • "stateful": A normal switch and thus the default value.
  • "stateless": A stateless switch remains in only one state. If you switch it to on, it immediately goes back to off.Configuration example is furtherdown.
  • "stateless-reverse": Default position is ON. If you switch it to off, it immediately goes back to on.Configuration example is furtherdown.
  • "toggle": The toggle switch is a stateful switch however does not use thestatusUrl to determine the currentstate. It uses the last set state as the current state. Default position is OFF.
  • "toggle-reverse"": Same as"toggle" but switch default position is ON.

• onUrl <string | [string] |urlObject | [urlObject]>required: Defines the url(and other properties when using an urlObject) which is called when you turn on the switch.
• offUrl <string | [string] |urlObject | [urlObject]>required: Defines the url(and other properties when using an urlObject) which is called when you turn off the switch.
• statusUrl <string |urlObject>required: Defines the url(and other properties when using an urlObject) to query the current state from the switch. By default it expects the httpserver to return'1' for ON and'0' for OFF leaving out any html markup.
  You can change this usingstatusPattern option.

• serialNumber <string>optional (Default:"SW01"): Defines a custom serial number shown in the home app.
• statusPattern <string>optional (Default:"1"): Defines a regex pattern which is compared to the body of thestatusUrl.When matching the status of the switch is set to ON otherwise OFF.Some examples.
• statusCache <number>optional (Default:0): Defines the amount of time in milliseconds a queried stateof the switch is cached before a new request is made to the http device.
  Default is0 which indicates no caching. A value of-1 will indicate infinite caching.
• auth <object>optional: If your http server requires authentication you can specify your credential in thisobject. It uses those credentials for all http requests and thus overrides all possibly specified credentials insidean urlObject foronUrl,offUrl andstatusUrl.
  The object can contain the following properties:
  • username <string>required
  • password <string>required
  • sendImmediately <boolean>optional (Default:true): When set totrue the plugin will send thecredentials immediately to the http server. This is best practice for basic authentication.
    When set tofalse the plugin will send the proper authentication header after receiving an 401 error code(unauthenticated). The response must include a properWWW-Authenticate header.
    Digest authentication requires this property to be set tofalse!
• httpMethoddeprecated <string>optional: If defined it sets the http method foronUrl andoffUrl.This property is deprecated and only present for backwards compatibility. It is recommended to use an[urlObject] to set the http method per url.

• timeout <integer>optional (Default:1000): When using a stateless switch this timeout inmilliseconds specifies the time after which the switch is reset back to its original state.
• pullInterval <integer>optional: The property expects an interval inmilliseconds in which the pluginpulls updates from your http device. For more information readpulling updates.
  (This option is only supported whenswitchType is"stateful")

• mqtt <mqttObject>optional: Defines all properties used for mqtt connection.SeemqttObject.

• multipleUrlExecutionStrategy <string>optional (Default:"parallel"): Defines the strategy used whenexecuting multiple urls. The following are available:
  • "parallel": All urls are executed in parallel. No particular order is guaranteed. Execution as fast as possible.
  • "series": All urls are executed in the given order. Each url must complete first before the next one is executed.
    When using series execution you can also have a look at thedelay url.

• debug <boolean>optional: If set to true debug mode is enabled and the plugin prints more detailed information.

Below are two example configurations. One is using simple string urls and the other is using simple urlObjects.
Both configs can be used for a basic plugin configuration.

{"accessories": [        {"accessory":"HTTP-SWITCH","name":"Switch","switchType":"stateful","onUrl":"http://localhost/api/switchOn","offUrl":"http://localhost/api/switchOff","statusUrl":"http://localhost/api/switchStatus"        }       ]}

{"accessories": [        {"accessory":"HTTP-SWITCH","name":"Switch","switchType":"stateful","onUrl": {"url":"http://localhost/api/switchOn","method":"GET"          },"offUrl": {"url":"http://localhost/api/switchOff","method":"GET"          },"statusUrl": {"url":"http://localhost/api/switchStatus","method":"GET"          }        }       ]}

A urlObject can have the following properties:

• url <string>required: Defines the url pointing to your http server
• method <string>optional (Default:"GET"): Defines the http method used to make the http request
• body <any>optional: Defines the body sent with the http request. If value is not a string it will beconverted to a JSON string automatically.
• strictSSL <boolean>optional (Default:false): If enabled the SSL certificate used must be valid andthe whole certificate chain must be trusted. The default is false because most people will work with self signedcertificates in their homes and their devices are already authorized since being in their networks.
• auth <object>optional: If your http server requires authentication you can specify your credential in thisobject. When defined the object can contain the following properties:
  • username <string>required
  • password <string>required
  • sendImmediately <boolean>optional (Default:true): When set totrue the plugin will send thecredentials immediately to the http server. This is best practice for basic authentication.
    When set tofalse the plugin will send the proper authentication header after receiving an 401 error code(unauthenticated). The response must include a properWWW-Authenticate header.
    Digest authentication requires this property to be set tofalse!
• headers <object>optional: Using this object you can define any http headers which are sent with the httprequest. The object must contain only string key value pairs.
• requestTimeout <number>optional (Default:20000): Time in milliseconds specifying timeout (Time to waitfor http response and also setting socket timeout).
• repeat <number>optional (Default:1): Defines how often the execution of this urlObject shouldbe repeated.
  Notice that this property only has an effect on ulrObject specified inonUrl oroffUrl.Also have a look at themultipleUrlExecutionStrategy property. Using "parallel" execution could result inunpredictable behaviour.
• delayBeforeExecution <number>optional (Default:0): Defines the time in milliseconds to waitbefore executing the urlObject.
  Notice that this property only has an effect on ulrObject specified inonUrl oroffUrl.Also have a look at themultipleUrlExecutionStrategy property.

Below is an example of an urlObject containing the basic properties:

{"url":"http://example.com:8080","method":"GET","body":"exampleBody","strictSSL":false,"auth": {"username":"yourUsername","password":"yourPassword"  },"headers": {"Content-Type":"text/html"  }}

A mqttObject can have the following properties:

• host <string>required: Defines the host of the mqtt broker.
• port <number>optional (Default:1883): Defines the port of the mqtt broker.
• credentials <object>optional: Defines the credentials used to authenticate with the mqtt broker.
  • username <string>required
  • password <string>optional

• subscriptions <object | array>required: Defines an array (or one single object) of subscriptions.
  • topic <string>required: Defines the topic to subscribe to.
  • characteristic <string>required: Defines the characteristic this subscription updates.
  • messagePattern <string>optional: Defines a regex pattern. IfmessagePattern is not specified themessage received will be used as value. If the characteristic expects a boolean value it is tested if thespecified regex is contained in the received message. Otherwise the pattern is matched against the messageand the data from regex group can be extracted using the givenpatternGroupToExtract.
  • patternGroupToExtract <number>optional (Default:1): Defines the regex group of which data isextracted.

• protocol <string>optional (Default:"mqtt"): Defines protocol used to connect to the mqtt broker
• qos <number>optional (Default:1): Defines the Quality of Service (Notice, the QoS of the publishermust also be configured accordingly).
  In contrast to most implementations the default value is1.
  • 0: 'At most once' - the message is sent only once and the client and broker take no additional steps toacknowledge delivery (fire and forget).
  • 1: 'At least once' - the message is re-tried by the sender multiple times until acknowledgement isreceived (acknowledged delivery).
  • 2: 'Exactly once' - the sender and receiver engage in a two-level handshake to ensure only one copy of themessage is received (assured delivery).
• clientId <string>optional (Default:'mqttjs_' + Math.random().toString(16).substr(2, 8)): Defines clientId
• keepalive <number>optional (Default:60): Time in seconds to send a keepalive. Set to 0 to disable.
• clean <boolean>optional (Default:true): Set to false to receive QoS 1 and 2 messages while offline.
• reconnectPeriod <number>optional (Default:1000): Time in milliseconds after which a reconnect is tried.
• connectTimeout <number>optional (Default:30000): Time in milliseconds the client waits until theCONNECT needs to be acknowledged (CONNACK).

Below is an example of an mqttObject containing the basic properties for a switch service:

{"host":"127.0.0.1","port":1883,"credentials": {"username":"yourUsername","password":"yourPassword"  },"subscriptions": [    {"topic":"your/topic/here","characteristic":"On","messagePattern":"on"    }  ]}

SinceOFF is the only possible state you do not need to declareoffUrl andstatusUrl

{"accessories": [        {"accessory":"HTTP-SWITCH","name":"Switch","switchType":"stateless","timeout":1000,"onUrl":"http://localhost/api/switchOn"        }       ]}

SinceON is the only possible state you do not need to declareonUrl andstatusUrl

{"accessories": [        {"accessory":"HTTP-SWITCH","name":"Switch","switchType":"stateless-reverse","timeout":1000,"offUrl":"http://localhost/api/switchOff"        }       ]}

If you wish to do so you can specify an array of urls or urlObjects (onUrl oroffUrl) when your switch is astateless switch or areverse-stateless switch.
This is not possible with a normal stateful switch.

Below are two example configurations of an stateless switch with three urls.One is using simple string array and the other is using simple urlObject arrays.

{"accessories": [        {"accessory":"HTTP-SWITCH","name":"Switch","switchType":"stateless","onUrl": ["http://localhost/api/switch1On","http://localhost/api/switch2On","http://localhost/api/switch3On"          ]        }       ]}

{"accessories": [        {"accessory":"HTTP-SWITCH","name":"Switch","switchType":"stateless","onUrl": [            {"url":"http://localhost/api/switch1On"            },            {"url":"http://localhost/api/switch2On"            },            {"url":"http://localhost/api/switch3On"            }          ]        }       ]}

When using multiple urls and"series" asmultipleUrlExecutionStrategy you can also specify so called delay urls in theonUrl oroffUrl arrays. This could be used to guarantee a certain delay between two urls.
The delay url has the following pattern:"delay(INTEGER)" where 'INTEGER' is replaced with the delay in milliseconds.

Here is an example:

{"accessories": [        {"accessory":"HTTP-SWITCH","name":"Delayed Switch","switchType":"stateless","multipleUrlExecutionStrategy":"series","onUrl": ["http://localhost/api/switch1On","delay(1000)","http://localhost/api/switch2On"          ]        }       ]}

ThestatusPattern property can be used to change the phrase which is used to identify if the switch should be turned onor off. So when you want the switch to be turned on when your server sends"true" in the body of the http response youcould specify the following pattern:

{"statusPattern":"true"}

However using Regular Expressions much more complex patterns are possible. Let's assume your http enabled device respondswith the following json string as body, where one property has an random value an the other indicates the status of theswitch:

{"perRequestRandomValue":89723789,"switchState":true}

Then you could use the following pattern:

{"statusPattern":"{\n\"perRequestRandomValue\": [0-9]+,\n\"switchState\": true\n}"}

Note: ThestatusPattern must be placed on the same level as thestatusUrl property, not inside thestatusUrl object. See below for example.

{"statusUrl": {     },"statusPattern":"....",}

More on how to build regex patterns:https://www.w3schools.com/jsref/jsref_obj_regexp.asp

homebridge-http-switch can be used together withhomebridge-http-notification-server in order to receiveupdates when the state changes at your external program. For details on how to implement those updates and how toinstall and configurehomebridge-http-notification-server, please refer to theREADME of the repository first.

Down here is an example on how to configurehomebridge-http-switch to work with your implementation of thehomebridge-http-notification-server.

{"accessories": [        {"accessory":"HTTP-SWITCH","name":"Switch","notificationID":"my-switch","notificationPassword":"superSecretPassword","onUrl":"http://localhost/api/switchOn","offUrl":"http://localhost/api/switchOff","statusUrl":"http://localhost/api/switchStatus"        }       ]}

• notificationID is an per Homebridge instance unique id which must be included in any http request.
• notificationPassword isoptional. It can be used to secure any incoming requests.

To get more details about the configuration have a look at theREADME.

Available characteristics (for the POST body)

Down here are all characteristics listed which can be updated with an request to thehomebridge-http-notification-server

• characteristic "On": expects a booleanvalue