Integrate your Akuvox SmartPlus mobile app with Home Assistant. With this integration you can access you door camera feeds, trigger door relays to open doors, be notified when doors are opened, and view your temporary keys (support for adding temporary keys comming soon).
Disclaimer: This integration is not affiliated with or endorsed by Akuvox. It is a community-contributed project and is provided as-is without any warranty or guarantee. Use it at your own discretion and responsibility.
For troubleshooting and general discussion please join the discussion in the Home Assistant forum.
If you find this integration useful, consider showing your support:
You door camera feeds are accessible as camera entities in Home Assistant.
Your door's relays are added as buttons in Home Assistant which allow you to trigger your doors to open remotely.
You can view your temporary access keys from the SmartPlus app in Home Assistant.
Whenever any of your doors are rung or opened, the akuvox_door_update
event is fired in Home Assistant. When you use the akuvox_door_update
even as an automation trigger, you will have access to data associated with the specific door ring/open event, accessible under: trigger.event.data
.
trigger.event.data.Location
The Location
value represents the name of the Akuvox door that was rung or opened, eg: Front Door
, Side Door
, etc.
trigger.event.data.CallType
The CallType value represents the door event type: |
CallType Value |
Meaning |
---|---|---|
Call |
Someone rang the door. | |
Face Unlock |
The door was opened via facial recognition. | |
Unlock on SmartPlus |
The door opened by a SmartPlus app account. |
trigger.event.data.Initiator
The Initiator value represents the name of the individual that triggered the event. |
Scenario | Value |
---|---|---|
Door opened by a SmartPlus account holder | John Smith |
|
Door rung by an unknown individual | Visitor |
trigger.event.data.PicUrl
The PicUrl
value contains a URL to the camera screenshot image taken at the time of the door ring/open event.
trigger.event.data.RelayName
The RelayName
value represents the name of the door relay that was opened (useful if your door has multiple relays), eg: Relay1
, Relay2
, etc.
trigger:
- platform: event
event_type: akuvox_door_update
event_data:
CaptureType: Call
variables:
door_name: "{{ trigger.event.data.Location }}"
condition: []
action:
# Play Ding Dong
- service: media_player.play_media
target:
entity_id: media_player.kitchen_speaker
data:
media_content_id: media-source://media_source/local/sounds/ding_dong.mp3
media_content_type: audio/mpeg
metadata:
title: ding_dong.mp3
media_class: music
navigateIds:
- {}
- media_content_type: app
media_content_id: media-source://media_source
- media_content_type: ""
media_content_id: media-source://media_source/local/sounds
# Wait 3 seconds
- delay:
hours: 0
minutes: 0
seconds: 3
milliseconds: 0
# Announce which door was rung
- service: tts.google_say
data:
entity_id: media_player.macbook_pro
message: Someone's at the {{ door_name }}
language: en
trigger:
- platform: event
event_type: akuvox_door_update
action:
- service: notify.notify
data:
title: Door Opened
mwessage: >-
{{ trigger.event.data.Location }} door opened by {{ trigger.event.data.Initiator }}
The easiest way to install Akuvox is though HACS (the Home Assistant Community Store)
If you don't have HACS installed yet, follow the official installation guide.
Add the Akuvox SmartPlus repository to HACS by clicking here:
Click ADD
:
Or:
custom_components
directory if it does not already exist.custom_components
named akuvox
.custom_components/akuvox/
directory in this repository.custom_components/akuvox
directory you created.Sigining in via SMS verification will sign you out from the SmartPlus app on your device. If you wish to stay signed in on the app and also use the integration in Home Assistant please use the App Tokens sign in method.
Continue sign-in with SMS Verification
and click NEXT
NEXT
to receive your SMS verification codeSUBMIT
Sigining in using your SmartLife app tokens will allow you to remain signed in to the SmartLife app on your device.
Obtain your auth_token
and token
values (for help with finding your tokens, please refer to the Finding you SmartPlus Account Tokens section below).
Enter your phone number, auth_token
and token
values and click SUBMIT
:
Once configured, Akuvox cameras & door buttons will appear as a device with a camera entity and a button entity, which when pressed triggers the door relay and opens the doors directly from Home Assistant.
Via the integration's CONFIGURE
button you can adjust the following:
Update your SmartLife account's tokens used to communicate with the Akuvox API. This is particularly useful if you logged into the SmartLife app on your device after adding the integration. For help accessing your account's tokens, please refer to the Finding you SmartPlus Account Tokens section below.
Choose between two options for akuvox_door_update
event handling:
To obtain your SmartPlus account tokens you can use an HTTP proxy (such as mitmproxy)
Connect your device to your HTTP proxy
Log out from your SmartPlus app, and then log in with your phone number and SMS code
Search for akuvox
, and you should see the servers_list
request. Click on it and in the Requests
tab you should find your auth_token
and token
values:
NOTE: If you see passwd
instead of auth_token
, please use the passwd
value as your auth_token
.