https://github.com/opsdroid/skill-homeassistant
💬 A skill for opsdroid to interact with Home Assistant
https://github.com/opsdroid/skill-homeassistant
Last synced: 17 days ago
JSON representation
💬 A skill for opsdroid to interact with Home Assistant
- Host: GitHub
- URL: https://github.com/opsdroid/skill-homeassistant
- Owner: opsdroid
- License: apache-2.0
- Created: 2017-09-07T11:49:29.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-10-04T18:43:06.000Z (over 6 years ago)
- Last Synced: 2025-04-27T16:25:00.660Z (11 months ago)
- Language: Python
- Homepage:
- Size: 34.2 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# opsdroid skill homeassistant
A skill for [opsdroid](https://github.com/opsdroid/opsdroid) to interact with [Home Assistant](https://home-assistant.io/). The skill provides a notification service and the ability to
pass opsdroid message through to the [conversation component](https://www.home-assistant.io/components/conversation/) in Home Assistant.
## Requirements
- A homeassistant installation.
To use the opsdroid notification you must configure the [rest notify component](https://home-assistant.io/components/notify.rest/) in homeassistant to point to opsdroid.
```yaml
# Home Assistant configuration file
notify:
- name: opsdroid
platform: rest
method: POST
resource: http://:/skill/homeassistant/notify
```
To use the conversation passthrough you must have the conversation component enabled in Home Assistant.
```yaml
# Home Assistant configuration file
conversation:
```
## Configuration
```yaml
skills:
- name: homeassistant
# Notification settings
room: "#homeassistant" # (Optional) room to send notifications to
# Conversation component passthrough settings
conversation-passthrough: false # Enable/disable the conversation component passthrough
hass-url: "http://127.0.0.1:8123" # The URL of your Home Assistant
hass-password: "YOURPASSWORD" # Your Home Assistant auth password
```
## Usage
#### Notification
When a notification is triggered in homeassistant it will be sent to opsdroid.
> opsdroid: Here is your homeassistant notification
#### Conversation component passthrough
When this is enabled all messages will be passed through to the Home Assistant conversation component.
> user: turn on the bedroom light
>
> opsdroid: ok
>
> *Light comes on*