Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/homebridge-plugins/homebridge-virtual-device
Homebridge plugin which provides HomeKit support for virtual devices.
https://github.com/homebridge-plugins/homebridge-virtual-device
Last synced: 14 days ago
JSON representation
Homebridge plugin which provides HomeKit support for virtual devices.
- Host: GitHub
- URL: https://github.com/homebridge-plugins/homebridge-virtual-device
- Owner: homebridge-plugins
- License: apache-2.0
- Created: 2024-05-30T09:48:56.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-12-09T23:23:38.000Z (24 days ago)
- Last Synced: 2024-12-13T20:38:58.887Z (20 days ago)
- Language: TypeScript
- Homepage:
- Size: 546 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Homebridge Virtual Device
[](https://www.npmjs.com/package/homebridge-virtual-device)
[](https://github.com/mkz212/homebridge-virtual-device/releases)
[](https://www.npmjs.com/package/homebridge-virtual-device)
`homebridge-virtual-device` is a dynamic platform plugin for [Homebridge](https://homebridge.io) which provides HomeKit support for virtual devices.
## How it works
- Create virtual device (like switch, dimmer, blind, garage, leak, security, thermostat, etc.).
- For each device you can add timer to automatically turn off or turn on device after setted time.
- For dimmer and blind you can add dynamic timer - time depends of value setted in HomeKit.
- For each device you can add sensor (motion, contact, occupancy, leak) to activate for 3 sec. when main device is turned on or turned off (you can choose) - useful for notifications.
- All of that is useful in HomeKit / Apple Home automations.
## Install plugin
This plugin can be easily installed through Homebridge UI or via [NPM](https://www.npmjs.com/package/homebridge-virtual-device) "globally" by typing:
npm install -g homebridge-virtual-device
## Configure plugin
Configure the plugin through the settings UI or directly in the JSON editor.
Example config.json:
```json
{
"platforms": [
{
"platform": "Homebridge Virtual Plugin",
"devices": [
{
"name": "Device 1",
"type": "switch",
"timerType": "whenOn"
"timerTime": 60,
"sensor": "whenOff",
"sensorType": "motion"
},
{
"name": "Device 2",
"type": "dimmer",
"timerType": "disabled",
"sensor": "disabled"
}
]
}
]
}
```
- `platform` (string): Tells Homebridge which platform this config belongs to. Leave as is.
- `name` (string): Name of device, as it will display in HomeKit.
- `type` (string): Type of the device: switch, dimmer, blind, lock, security, thermostat, etc.
- `startupValue` (string): Select device state after startup / restart.
- `timerType` (string): Timer type: disabled, activated when device is on, activated when device is off.
- `timerTime` (integer): Set time for timer.
- `timerUnit` (string): Timer unit: miliseconds, seconds, minutes, hours, days.
- `timerReset` (boolean): Reset timer on each activity. When this option is enabled, each activity of the device will reset the timer (e.g. re-enabling the device even though it is already turned on).
- `timerDynamic` (booleand): Only for dimmer and blind. When this option is enabled, the timer will change the device value by 1, up to 0 or 100 (depending on the option selected in Timer). Example: if you set 5 minutes in Timer Time and the device is set to 3, then after the timer will be 15 minutes.
- `timerStartup` (integer): Set different time for timer on startup.
- `sensor` (string): Add additional sensor to device. It will actvate for 3 seconds. This is useful for automations.
- `sensorType` (string): Sensor type: motion, contact, occupancy, leak.
## Troubleshooting
General issues
Try:
- restart Homebridge / plugin bridge
- restart Apple hub
- remove device from cache (in Homebridge settings)
Child bridge
- It's recommended you run this plugin as a [child bridge](https://github.com/homebridge/homebridge/wiki/Child-Bridges).
## Contributing and support
- Test/use the plugin and [report issues and share feedback](https://github.com/mkz212/homebridge-virtual-device/issues).
- Contribute with your own bug fixes, code clean-ups, or additional features - [Pull Request](https://github.com/mkz212/homebridge-virtual-device/pulls).
## Acknowledgements
Thanks to the team behind Homebridge, your efforts do not go unnoticed.
## Disclaimer
Despite the efforts made, the operation of the plugin is without any guarantees and at your own risk.