Control your accessories from Home Assistant with Siri and HomeKit. Set it up and poof, all of your supported accessories will be instantly controllable via Siri.
Home Assistant is a home automation platform already, so this plugin aims to just expose your devices in a way that you can control them with Siri. While you can integrate your accessories into HomeKit for automations, the goals of this plugin are strictly to allow Siri to be a frontend for your accessories.
When you set up the Home Assistant plugin, all you have to do is point it at your Home Assistant server. The plugin pulls all your devices and exposes them automatically. Easy peasey.
Here's a list of the devices that are currently exposed:
- Automations - on/off
- Alarm Control Panels - arm (home, away, night), disarm, triggered
- Binary Sensor - door, leak, moisture, motion, smoke, and window state
- Climate - current temperature, target temperature, heat/cool mode
- Cover - exposed as a garage door or window covering (see notes)
- Device Tracker - home/not home status appears as an occupancy sensor
- Fan - on/off/speed
- Group - on/off
- Input boolean - on/off
- Lights - on/off/brightness
- Lock - lock/unlock lock
- Media Players - exposed as an on/off switch
- Remotes - exposed as an on/off switch
- Scenes - exposed as an on/off switch
- Scripts - exposed as an on/off switch
- Sensors - air quality, carbon dioxide (CO2), humidity, light, temperature sensors
- Switches - on/off
- Vacuums - on/off
If your alarm control panel is setup to use a code, you must use homebridge_alarm_code
to specify the code.
Binary Sensors must have a device_class
set. Accepted device_class
es are gas
, moisture
, motion
, occupancy
, opening
and smoke
.
For binary sensors with the gas
device_class
you can also set homebridge_gas_type
to co
or co2
or to control how the entity is shown in Homebridge (co
is default).
For binary sensors with the opening
device_class
you can also set homebridge_opening_type
to window
to have the entity display as a window instead of a door to Homebridge.
Covers on your Home Assistant will appear as a garage door by default. In order
to do change this you may specify its type in the customize
section of your
Home Assistant's configuration.yaml
. Refer to the following example:
customize:
cover.lounge_main:
homebridge_cover_type: rollershutter
cover.garage:
homebridge_cover_type: garage_door
Device trackers will appear in HomeKit as a room occupancy sensor.
Groups will appear in HomeKit as switches.
If supported, lights will display brightness, hue, saturation, and/or color temperature.
By default, Homebridge will allow a color temperature between 50 and 400 mireds. You can override this for your specific light(s) by using homebridge_min_mireds
and homebridge_max_mireds
.
If your lock is setup to use a code, you must use homebridge_lock_code
to specify the code.
Media players on your Home Assistant will be added to your HomeKit as a switch. While this seems like a hack at first, it's actually quite useful. While you can't control everything a media player does, it will give you the ability to toggle them on or off.
There are some rules to know about how on/off treats your media player. If your media player supports play/pause, then turning them on and off via HomeKit will play and pause them. If they do not support play/pause but instead support on/off they will be turned on and off. If none of the above, HomeKit will play and stop.
You can specify the mode to run by setting homebridge_media_player_switch
to play_pause
, on_off
or play_stop
, respectively.
Scenes will appear to HomeKit as switches. To trigger them, you can simply say "turn on party time". In some cases, scene names are already reserved in HomeKit...like "Good Morning" and "Good Night". These scenes already exist and cannot be deleted. Simply add your Home Assistant scene to them and set the state you would like them to be when executed. That's most like the ON state. The switch will automatically turn off shortly after turning on.
Scripts containing only one service call will function exactly like scenes (see above).
Scripts containing more than one service call will be able to be turned off as well.
Air quality, carbon dioxide (CO2), humidity, light and temperature sensors are currently supported.
- Air quality sensors will be found if an entity has its unit of measurement set to
aqi
orhomebridge_sensor_type
is set toair_quality
on the entity. - Light sensors will be found if an entity has its unit of measurement set to
lux
orhomebridge_sensor_type
is set tolight
on the entity. - Temperature sensors will be found if an entity has its unit of measurement set to
°C
,℃
,°F
, or℉
. - Humidity sensors will be found if an entity has its unit of measurement set to
%
and has an entity ID containinghumidity
orhomebridge_sensor_type
is set tohumidity
on the entity. - Carbon Dioxide (CO2) sensors will be found if an entity has its unit of measurement set to
ppm
and has an entity ID containingco2
orhomebridge_sensor_type
is set toco2
on the entity.
You can make a switch appear as an outlet to Homebridge by setting homebridge_switch_type
to outlet
on the entity.
After installing and setting up Homebridge, you can install the Home Assistant plugin with:
npm install -g homebridge-homeassistant
Once installed, update your Homebridge's config.json
.
You can run sudo npm upgrade -g homebridge-homeassistant
to upgrade your installation at any time.
As with other Homebridge plugins, you configure the Home Assistant plugin by
adding it to your config.json
.
To avoid too much information in your log, just set logging
to false
as soon as everything works smoothly.
"platforms": [
{
"platform": "HomeAssistant",
"name": "HomeAssistant",
"host": "http://127.0.0.1:8123",
"password": "yourapipassword",
"supported_types": ["automation", "binary_sensor", "climate", "cover", "device_tracker", "fan", "group", "input_boolean", "light", "lock", "media_player", "remote", "scene", "script", "sensor", "switch", "vacuum"],
"default_visibility": "hidden",
"logging": true,
"verify_ssl": true
}
]
You can optionally whitelist the device types that are exposed to HomeKit with the supported_types
array. Just remove a device type that you don't want and they will be ignored.
If you have set up SSL using a self signed certificate, you will need to to set verify_ssl
to false
in your config.json
file to allow bypassing the Node.js certificate checks.
To control which entities are passed to Homebridge, you can set default_visibility
to hidden
or visible
.
If not specified, default_visibility
will be set to visible
.
Then, you can control individual entities within Home Assistant using homebridge_hidden
or homebridge_visible
.
Example "I want all of my devices to be hidden by default and I'll choose which ones are visible to Homebridge."
"platforms": [
{
"default_visibility": "hidden"
}
]
customize:
switch.example:
homebridge_visible: true
"I want all of my devices to be visible by default and I'll choose which ones are hidden from Homebridge."
"platforms": [
{
"default_visibility": "visible"
}
]
customize:
switch.example:
homebridge_hidden: true
You can also customize the name of a device by setting homebridge_name
like this:
customize:
switch.a_switch:
homebridge_name: My awesome switch
Finally, you can (optionally) specify the accessory information by setting homebridge_mfg
, homebridge_model
, and homebridge_serial
like this:
customize:
switch.a_switch:
homebridge_mfg: Leviton
homebridge_model: DZMX1-1LZ
homebridge_serial: 123456789
If you don't specify the accessory information, the data will be pulled from Home Assistant by default.
Battery tracking is supported for binary sensors, device trackers, locks, and sensors.
homebridge_battery_source
must be set to an entity with '%' as its unit of measurement.
homebridge_charging_source
must set to an entity with charging
as one of its possible states.
If homebridge_battery_source
is specified but homebridge_charging_source
is not, then HomeKit will consider the battery as not chargeable.
If necessary, you can create template sensors within Home Assistant to use for homebridge_battery_source
and homebridge_charging_source
.
- fork
- create a feature branch
- open a Pull Request