@uboness/homebridge-virtual v0.2.2

Homebridge Virtual Plugin

Enables defining virtual accessories/devices.

!! Experimental !!

Settings

Light Switch Button Garage Door Lock Outlet Smoke Sensor Contact Sensor Motion Sensor Leak Sensor CO Sensor CO2 Sensor

Light

A virtual light.

Example:

{
  "id": "test",
  "name": "Test Light",
  "type": "light",
  "dimmer": true,
  "variant": "rgb"
}

Switch

A virtual switch. Can be configured to auto-close after a specific timeout.

Example:

{
    "id": "switch",
    "name": "Test Switch",
    "type": "switch",
    "turnOffAfter": 5000
}

Button

A virtual button accessory. Next to the main StatelessProgrammableSwitch button. This accessory will also create 3 additional swtiches:

• singlePress - will trigger a singlePress event for the button
• doublePress - will trigger a doublePress event for the button
• longPress - will trigger a longPress event for the button

Example:

Here, two momentary switches will be created:

• Turn On switch that will trigger the single press event of the button
• Turn Off switch that will trigger the double press event of the button

No switch will be created for the long press event.

{
    "id": "button",
    "type": "button",
    "name": "Test Button",
    "singlePress": "Turn On",
    "doublePress": "Turn Off"
}

Garage Door

A virtual garage door accessory.

Example:

{
  "id": "garage",
  "name": "Garage",
  "type": "garage-door",
  "openingTime": 10,
  "closingTime": 5
}

Lock

A virtual Lock accessory.

Example:

{
    "id": "test-lock",
    "type": "lock",
    "name": "Test Button"
}

Outlet

A virtual outlet accessory.

Example:

{
    "id": "test-outlet",
    "type": "outlet",
    "name": "Test Outlet"
}

Smoke Sensor

A virtual smoke sensor accessory. The sensor will have a switch to control the smoke alert - when the switch is turned on the smoke alert will be triggered.

Example:

{
    "id": "test-smoke-sensor",
    "type": "smoke-sensor",
    "name": "Test Smoke Sensor",
    "hasBattery": true
}

Contact Sensor

A virtual contact sensor accessory. The sensor will have a switch to control the contact alert - when the switch is turned on the contact alert will be triggered.

Example:

{
    "id": "test-contact-sensor",
    "type": "contact-sensor",
    "name": "Test Contact Sensor",
    "hasBattery": true
}

Motion Sensor

A virtual motion sensor accessory. The sensor will have a button to trigger a motion alert - The timeout parameter determines how long the sensor maintains its "detected" state, after which it will reset to "not detected". If a motion is triggered while the sensor is in a "detected" state, the timeout will reset - meaning, the motion state will be set to "not detected" after the timeout has passed since the last motion trigger.

Example:

{
    "id": "test-motion-sensor",
    "type": "motion-sensor",
    "name": "Test Motion Sensor",
    "timeout": 30,
    "hasBattery": true
}

Leak Sensor

A virtual leak sensor accessory. The sensor will have a switch to control the leak alert - when the switch is turned on the leak alert will be triggered.

Example:

{
    "id": "test-leak-sensor",
    "type": "leak-sensor",
    "name": "Test Leak Sensor",
    "hasBattery": true
}

CO Sensor

A virtual CO sensor accessory. The sensor will have a switch to control the CO alert - when the switch is turned on the CO alert will be triggered.

Example:

{
    "id": "test-co-sensor",
    "type": "co-sensor",
    "name": "Test CO Sensor",
    "hasBattery": true
}

CO2 Sensor

A virtual CO2 sensor accessory. The sensor will have a switch to control the CO2 alert - when the switch is turned on the CO2 alert will be triggered.

Example:

{
    "id": "test-co2-sensor",
    "type": "co2-sensor",
    "name": "Test CO2 Sensor",
    "hasBattery": true
}

Development

If not installed yet, install Homebridge

sudo npm install -g --unsafe-perm homebridge homebridge-config-ui-x

and

npm link

Build:

pn build

Run homebridge:

homebridge -D -I -U .homebridge