Homebridge-xs1 NPM

homebridge-xs1

Plugin for homebridge. It provides access to actuators and sensors attached to a EZcontrol XS1. It will identify all supported devices of your XS1 and make them available via homebridge/homekit.

Supported devices

Actuator types:

Switch
Light
Dimmer
Shutter

Sensor types:

Temperature
Hygrometer
Air quality

Installation

npm install -g homebridge-xs1

Configuration

Example

"platforms": [
        {
            "platform": "xs1",
            "name" : "Gateway",
            "host" : "192.168.1.3",
            "password" : "",
            "options": [
                { "xs1_name" : "light_tv", "new_name" : "Light TV room", "type" : "light" },
                { "xs1_name" : "shutter_living_room", "new_name" : "Living room shutter" },
                { "xs1_name" : "garage_door", "new_name" : "Garage door", "type" : "switch" },
                { "xs1_name" : "airquality_tv", "new_name" : "Air quality TV room", "mode" : "quality" },
                { "xs1_name" : "garden_pump", "type" : "disabled" }
            ]
        }
    ]

}

Explanation

platform: Has to be xs1
name: Friendly name for your XS1 device
host: Host address of your XS1 device
password: Password for xs1 access, if configured. Leave empty if no authentication is needed
options Contains optional settings to override settings stored in your XS1:
- xs1_name: Name of xs1 device identifying the device to override, mandatory
- new_name: Name that homebridge should use for the identified device
- type: Sets the type of the device, supported values:
  - switch: Sets actuator type to switch
  - light: Sets actuator type to light
  - dimmer: Sets actuator type to dimmer
  - shutter: Sets actuator type to shutter
  - temperature: Sets sensor type to temperature
  - hygrometer: Sets sensor type to hygrometer
  - air_quality: Sets sensor type to air_quality
  - disabled: Disables device; won't show up with homebridge
- mode: Only supported for sensor type air_quality:
  - quality: Will register a single sensor with type air quality
  - ppm: Will register a single sensor with type CO2 level
  - both: Will register both sensor types as listed above

Notes

Tested with XS1 firmware 4.0.0.5326
Actuator shutter supports full up and down only
Sensor air_quality is to be used with ppm value

Kudos

This plugin is based on code from planetk
EZcontrol for a great gateway device

Release notes

0.0.1 (12-NOV-2016): Initial release
0.0.2 (12-NOV-2016): Updated documentation
0.0.3 (12-NOV-2016): Updated documentation
0.0.4 (19-NOV-2016): Updated documentation + package.json
0.0.5 (20-NOV-2016): Added support for xs1 password authentication
0.0.6 (25-NOV-2016): Added support for sensors temperature, hygrometer and air_quality
0.0.7 (27-NOV-2016): Added option mode for air_quality sensor
0.0.8 (29-NOV-2016): Fix for temperature values < 0