Sleep As Android integration for Home Assistant

Igor

Last update: Dec 30, 2022

Related tags

Hardware python mqtt sleep-tracker homeassistant sleep-analysis sleep-as-android

Overview

Sleep As Android custom integration

This integration will allow you to get events from your SleepAsAndroid application in a form of the sensor states and events in Home assistant.

Installation & configuration

Requirements

You will need:

Home Assistant with configured MQTT integration
example of configuration.yaml:

mqtt:
  broker: mqtt.myserver
  port: 1883
  username: ha_user
  discovery: true

Sleep As android application
- go to Settings -> Services -> Automatization -> MQTT
- enable and configure MQTT

Installation

go to HACS -> Integrations
press + Explore & Add repositories button
type Sleep As Android in search field and click at integration name
press Install this repository to HACS button
press Install button (if you have outdated version of Home Assistant -- check integration version in Wiki )
restart Home Assistant
go to Home Assistant Settings -> Integrations -> Add Integration (right bottom conner)
type Sleep As Android in search field and click at integration name

Configuration

Component configuration

Name: name of the device/sensor and a prefix for the events. Will be used as a default prefix for devices and events.
Topic template: template for MQTT topic where Sleep as Android will publish event. %%%device%%% may be used in template to point to device name position. Examples:
- SleepAsAndroid/igor - no %%%device%%% in template just one device will be tracked and one device will be created for HomeAssistant
- SleepAsAndroid/%%%device%%% - all sub topics in SleepAsAndroid/ will be recognized as devices
- devices/%%%device%%%/SleepAsAndroidData - all subtopic in devices/ will be used as devices, data will be taken from /SleepAsAndroidData for every device, ie devices/igor/SleepAsAndroidData for device igor
QOS: quality of service for MQTT

Application configuration

To configure Sleep As Android for working with this integration:

Go to application settings
Find Services in integration section
Go to Automation
Find MQTT section

Then:

Enable it
URL is a URL for your MQTT server. It should look like tcp://mqtt_user:mqtt_password@mqtt_host:mqtt_port
Topic is a topic name where the application will publish events. See Topic template section of component configuration for details. Application settings MUST NOT have %%%device%%% macro. Use desired device name at postion of %%%device%%% of integration configuration. Examples related to integration configuration above: SleepAsAndroid/igor or devices/igor/SleepAsAndroidData. Device name will be "igor" in both cases.
Client ID is any ID. It is not used by integration and is not published to MQTT (now).

More details in Wiki.

Usage

blueprint (recommended)

import blueprint:
1. Got to Home Assistant settings
2. blueprints
3. import blueprint button
4. put blueprint URL
5. press preview button
6. press import button
create automatization based on blueprint:
- person and state is using to run actions only if person in state (to avoid run home automatization related to sleep tracking while vacation in Siberia, for example)
- add actions for evens

on device event

select Device in automatization trigger and use SleepAsAndroid device;
select trigger from a list.

on sensor state change

is an integration name in lower case without spaces from the Settings dialog. is a device name List of events is available at Sleep As Android documentation page

State of sensor sensor. _ will contain the recent event name, that got published by the application.

on event

is an integration name in lower case without spaces from the Settings dialog. If application publishes a new event, then integration fires event with payload:

" }">

{
  "event": "
   
    "
   
}

Troubleshooting

configuration.yaml:

logger:
  default: warning
  logs:
    custom_components.sleep_as_android: debug

Comments

Setup failed for sleep_as_android: Integration not found.
After update to version 1.2.4 getting such error in logs:

Logger: homeassistant.setup Source: setup.py:173 First occurred: 1:42:57 PM (1 occurrences) Last logged: 1:42:57 PM Setup failed for sleep_as_android: Integration not found.

In Integrations menu:

If delete Integration - new will not presented in Add menu.

Sleep sensor exists, but with state: unavailable.

Revert to v1.2.3 fix the problem.
bug CI
opened by hACKrus 13
No integration showing up
General information

Home Assistant

2021.12.4: Installation method (according to instructions): [X] Operating System [ ] Container [ ] Supervised [ ] Core

Integration

Installation method: [X] HACS [ ] manual from release [ ] manual from git Integration version:v1.6.0 Root topic:

Application settings

topic: [X] I can see MQTT messages from application at MQTT-server

How it works now?

After installing the SAA Integration and restarting HA, the SAA Integration is not available under Settings / Integrations

What do you expect?

N/A

Steps to reproduce

Install Integration through HACS as described

Restart HA

Go to Settings / Integrations / Add integration

Select / Search Slaap As Android

Debug log

No output generated, despite having added the debug setting to my config.yaml

Additional information
documentation
opened by KeerlITServices 9

Device, nor entity created in HA

General information

Integration

Integration version: v1.2.0 HASS version: 2021.3.4 Root topic: SleepAsAndroid

Application settings

configured Sleep as android to use SleepAsAndroid/roman topic topic:

[x] I can see MQTT messages from application at MQTT-server

How it works now?

The events are published by Sleep app to the broker and I can read them using mqtt client, However, the HASS integration doesn't create any device nor entity.

What do you expect?

Device and entity that would collect the events and states from the mqtt topic

Steps to reproduce

I followed all the steps as described in readme

Debug log

I can see logs like:

2[root@nas config]# grep sleep_as_android home-assistant.log | head -12
2021-04-22 13:11:41 WARNING (MainThread) [homeassistant.loader] You are using a custom integration sleep_as_android which has not been tested by Home Assistant. This component might cause stability problems, be sure to disable it if you experience issues with Home Assistant
2021-04-22 13:11:42 INFO (MainThread) [homeassistant.bootstrap] Setting up stage 2: {'persistent_notification', 'input_number', 'map', 'input_datetime', 'mqtt', 'media_source', 'script', 'dhcp', 'met', 'default_config', 'alarm_control_panel', 'logbook', 'input_select', 'influxdb', 'cover', 'input_boolean', 'mobile_app', 'blueprint', 'sun', 'group', 'sleep_as_android', 'ssdp', 'updater', 'zeroconf', 'tts', 'counter', 'scene', 'my', 'tag', 'switch', 'zone', 'input_text', 'sensor', 'tasmota', 'kodi', 'binary_sensor', 'zha', 'history', 'system_health', 'automation', 'hacs', 'timer', 'nodered'}
2021-04-22 13:11:42 DEBUG (MainThread) [homeassistant.setup] Dependency sleep_as_android will wait for dependencies ['mqtt']
2021-04-22 13:11:44 INFO (MainThread) [homeassistant.setup] Setting up sleep_as_android
2021-04-22 13:11:44 INFO (MainThread) [homeassistant.setup] Setup of domain sleep_as_android took 0.0 seconds
2021-04-22 13:11:44 INFO (MainThread) [custom_components.sleep_as_android] Setting up ea7971cef4d1354ff40a907b229a869f 
2021-04-22 13:11:44 DEBUG (MainThread) [homeassistant.core] Bus:Handling <Event component_loaded[L]: component=sleep_as_android>
2021-04-22 13:11:44 INFO (MainThread) [homeassistant.components.sensor] Setting up sensor.sleep_as_android
2021-04-22 13:11:44 DEBUG (MainThread) [custom_components.sleep_as_android.sensor] Subscribing to root topic 'SleepAsAndroid'
2021-04-22 13:11:44 DEBUG (MainThread) [custom_components.sleep_as_android.sensor] Subscribing to root topic is done!

Additional information

just wanted to say hi and thank you for the integration

opened by rplevka 9

No entity for sleep as android In Home Assistant

I have done all your passages in documentation: App Configuration: Home assistant Configuration: I restart but i have not entities why????? Id i see logs i can se connected client and After disconnected at the Same back issue??
documentation need more info

opened by hdjweb 9
Update Blueprint To Allow Utilizing New Sensor Attributes.

General information

Could I request an update to the Blueprint to allow entering a value for the the new attributes from Issue 30

(specifically the Label attribute) When using the Blueprint to create an automation, to create a Condition based on the Label. For example, only run if the Label matches, or Run Except if the Label Matches.
enhancement

opened by MikeKMiller 8
Old devices have no delete option
General information

Home Assistant

Version: 2022.11.1 Installation method (according to instructions): [x] Linux VM [ ] Operating System [ ] Container [ ] Supervised [ ] Core

Integration

Installation method: [x] HACS [ ] manual from release [ ] manual from git Integration version: 1.9.2 Root topic: nothing? not sure where to check that setting

Application settings

topic: sensor/SleepAsAndroid/%%%device%%% [x] I can see MQTT messages from application at MQTT-server

How it works now?

99.9% as expected, everything works great, except I have old devices that I can not delete from HA that have been changed out for other phones etc.

What do you expect?

The device to be deleteable in the devices screen

Steps to reproduce

Not sure, but I think

add phone as a sensor

change the device name

old device has no delete button in device list

Debug log

N/A

Additional information

Thank you for the great quality of life boost this is giving me!
enhancement
opened by thomasfinstad 6
Alarm Name As Part of Trigger

General information

Include Alarm Name as Part of Trigger Definition

Usage scenario

I use alarms in SleepAsAndroid for both Wake Up Alarms, as well as various reminders throughout the day. Being able to filter by specific Alarm Names would allow setting automations based on specific alarms.

The MQTT call from SleepAsAndroid includes value2 which usually contains the Alarm Name.
enhancement

opened by MikeKMiller 5
Integration doesn't create device or anything...
General information

Integration

Integration version: I tried the last one and the main branch from github

Last HACS version, last HA-OS version

Application settings

topic:

mqtt: broker: core-mosquitto port: 1883 discovery: true sleep_as_android: name: SleepAsAndroid topic_template: SleepAsAndroid/fbsleep

[x] I can see MQTT messages from application at MQTT-server

How it works now?

I can use the MQTT integration to send (and receive in MyMQTT on android), and I can subscribe manually to the above topic and send it from the SleepAsAndroid, but the HACS integration doesn't create any device or logs anything on log (I've set the logger to debug).
bug
opened by franzbischoff 5
Unable to prepare setup for platform sleep_as_android.sensor: Platform not found
General information

Integration

Integration version: v1.2.1 Root topic: Integration fails configuration checks

Application settings

topic: Can't check (application won't start) but believe it was default [ ] I can see MQTT messages from application at MQTT-server

How it works now?

Integration fails to load

What do you expect?

Integration should load!

Steps to reproduce

Install the integration

Debug log

Logger: homeassistant.setup Source: setup.py:311 First occurred: 12:00:55 PM (1 occurrences) Last logged: 12:00:55 PM Unable to prepare setup for platform sleep_as_android.sensor: Platform not found (cannot import name 'TRIGGER_BASE_SCHEMA' from 'homeassistant.components.device_automation' (/usr/src/homeassistant/homeassistant/components/device_automation/__init__.py)).

Additional information

Just upgraded to core-2021.7.0
bug
opened by TheRealWaldo 5

Fails to start with Home Assistant 2022.3.0b5 (unexpected keyword argument 'new_state')

General information

Home Assistant

Version: 2022.3.0b5 Installation method (according to instructions): [X] Operating System [ ] Container [ ] Supervised [ ] Core

Integration

Installation method: [X] HACS [ ] manual from release [ ] manual from git Integration version: v1.8.2 Root topic:

Application settings

topic: [X] I can see MQTT messages from application at MQTT-server

How it works now?

The integration used to work. (MQTT broker settings etc all fine and have not changed.)

Upon startup, the integration errors out with "TypeError: async_subscribe_topics() got an unexpected keyword argument 'new_state'"

Debug log

2022-03-01 14:18:50 ERROR (MainThread) [homeassistant.components.sensor] Error while setting up sleep_as_android platform for sensor
Traceback (most recent call last):
  File "/hass/homeassistant/lib/python3.9/site-packages/homeassistant/helpers/entity_platform.py", line 249, in _async_setup_platform
    await asyncio.shield(task)
  File "/hass/.homeassistant/custom_components/sleep_as_android/sensor.py", line 48, in async_setup_entry
    await instance.subscribe_root_topic(async_add_entities)
  File "/hass/.homeassistant/custom_components/sleep_as_android/__init__.py", line 257, in subscribe_root_topic
    self._subscription_state = await subscribe_2021_07(
  File "/hass/.homeassistant/custom_components/sleep_as_android/__init__.py", line 235, in subscribe_2021_07
    return await subscription.async_subscribe_topics(
TypeError: async_subscribe_topics() got an unexpected keyword argument 'new_state'

Additional information

bug

opened by Steltek 4

Configuration not saved
General information

Home Assistant

2021.11.1: Installation method (according to instructions): [X] Operating System [ ] Container [ ] Supervised [ ] Core

Integration

Installation method: [X] HACS [ ] manual from release [ ] manual from git Integration version: v1.4.0 Root topic: SleepAsAndroid

Application settings

topic: bartfp3 [ X] I can see MQTT messages from application at MQTT-server

How it works now?

Configuration changes in name and/or topic are submitted. The integration reports success but values do not change from defaults.

What do you expect?

Values change to strings entered

Steps to reproduce

Integration

SleepAsAndroid

Configure

Submit

Debug log

2021-11-08 20:14:59 WARNING (SyncWorker_3) [homeassistant.loader] We found a custom integration sleep_as_android which has not been tested by Home Assistant. This component might cause stability problems, be sure to disable it if you experience issues with Home Assistant

Additional information

This is part of troubleshooting why the integration does not create a device for the app. MQTT explorer shows events being published to the broker. Home Assistant is able to read another sensor over MQTT.
bug
opened by bartsmit 4

Releases(v1.10.0)

v1.10.0(Dec 9, 2022)
Features

add button for removing device (1e00a34), closes #48 It just remove device. Device will be recreated after new message in MQTT topic, if topic was not changed in the integration settings.

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(12.41 KB)
v1.9.2(May 25, 2022)
Code improvements

async_get_registry is deprecated in Home Assistant 2022.06 and it will be deprecation warning in logs, so this release:

replace deprecated async_get_registry while entry setup by async_get (ecaed5d), closes #43

replace deprecated async_get_registry while sensor setup by async_get (f42ea63), closes #43

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(11.50 KB)
v1.9.1(May 11, 2022)
Bug Fixes

add pyhaversion to the integration requirements (168cf77), closes #42

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(12.15 KB)
v1.9.0(Mar 6, 2022)
Features

Translation

add Dutch translation (1853fcd) by @koen20

Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(12.14 KB)
v1.8.3(Mar 1, 2022)
Bug Fixes

fix subscription for 2022.3.0b* versions (be1900e), closes #39 only 2022.3.0b* version of Home Assistant is affected by #39, so this release marked as beta too.

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(11.09 KB)
v1.8.2(Feb 28, 2022)
Bug Fixes

adapt to new topic subscription mechanism in HA 2022.3 (7796cd7) HA will change subscription functions signature in 2022.3, so we should be ready for this update. With this release the integration for HA versions below 2022.3 will use old way of subscription and switch to new way after HA update.

You must upgrade the integration if you are going to use HA 2022.3. The integration may be updated at any time: before HA upgrade this release will use old mechanism, after upgrade -- will switch to new way automatically.

Support of HA versions below 2022.3 will be dropped in future.

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(10.68 KB)
v1.8.1(Feb 26, 2022)
Don't use this release with HA versions below 2022.3. Check versionin wiki for details.

Bug Fixes

Fix topic subscription for Home Assistant 2022.3.0 (1a8d1e1), closes #38

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(10.46 KB)
v1.8.0(Feb 21, 2022)
Bug Fixes

preload current options in settings dialogue (26be4ce, closes #33)

reload integration after settings update without Home Assistant restart (fd0b706, closes #33)

Translations

Polish translation by @Antoni-Czaplicki (d1bc75a, closes #36, 9149619, closes #35)

Russian translation by @IATkachenko (12d649c, 312af3e)

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(10.45 KB)
v1.7.0(Jan 12, 2022)
Features

set additional attributes for sensor from MQTT event by @IATkachenko (0c7cbd7), closes #30 Sensor now have additional attributes:

timestamp -- value1 from application event. It is usually timestamp of something. Meaning is depended on event. Please check Sleep As Android events documentation for mor details;

label -- value2 from application event. It is usually alarm label. You can use this attribute to tell one alarm from another.

If event have no value<N> field, then attribute will be set to unknown.

fire events independent on state change by @IATkachenko (95d371f) There was no second event if we got two events of same type one after other. But it could be, for example, two alarms events with different labels (value2). So we should fire HA event for every event from MQTT.

Bug Fixes

sensor: don't set RAW state if we have JSONDecodeError while processing MQTT message payload by @IATkachenko (dd6f744)

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(7.41 KB)
v1.7.0-b.0(Jan 11, 2022)
Features

set additional attributes for sensor from MQTT event by @IATkachenko (0c7cbd7), closes #30 Sensor have additional attributes:

timestamp -- value1 from application event. It is usually timestamp of something. Meaning is depended on event. Please check Sleep As Android events documentation for mor details;

label -- value2 from application event. It is usually alarm label. You can use this attribute to tell one alarm from another.

If event have no value<N> field, then attribute will be set to unknown.

fire events independent on state change by @IATkachenko (95d371f) There was no second event if we got two events of same type one after other. But it could be, for example, two alarms events with different labels (value2). So we should fire HA event for every event from MQTT.

Bug Fixes

sensor: don't set RAW state if we have JSONDecodeError while processing MQTT message payload by @IATkachenko (dd6f744)

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(7.42 KB)
v1.6.0(Nov 14, 2021)
Features

use cache for properties and methods by @IATkachenko (61d9ca8)

sensor: restore sensor state after HomeAssistant restart by @IATkachenko (49b46ce)

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(6.88 KB)
v1.5.0(Nov 14, 2021)
Features

add show_skip_next_alarm and before_alarm trigger events by @patrickhilker (bcf92a4)

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(6.73 KB)
v1.4.0(Sep 3, 2021)
Features

blueprint: added generator (7d13074)

Blueprint is available now. It allows you configure all actions related to sleep tracking in one automation (I had 6 before). More information is in "Usage" part of README and HomeAssistnat blueprints doc. If you need some additional features in this blueprint -- please open feature request issue!

drop legacy support

drop support of HA before 2021.7 (05940a8)

remove update routine for 1.2.4->1.3.0 (37d2edb)

There is no actions required if you updating HomeAssistant and integration in time. For other cases please check Wiki for additional info.

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(6.72 KB)
v1.3.1(Aug 24, 2021)
Bug Fixes

instance: correctly get device name without %%%device%%% macro (28d73c7), closes #17

Do you like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(7.65 KB)
v1.3.0(Aug 17, 2021)
Features

allow use templated topic (#14) (550aa14), closes #9 #8 Now you may use %%%device%%% macro to tell integration where it should find device name. Examples from README:

SleepAsAndroid/igor - no %%%device%%% in template just one device will be tracked and one device will be created for HomeAssistant

SleepAsAndroid/%%%device%%% - all sub topics in SleepAsAndroid/ will be recognized as devices (like v1.2.4)

devices/%%%device%%%/SleepAsAndroidData - all subtopic in devices/ will be used as devices, data will be taken from /SleepAsAndroidData for every device, ie devices/igor/SleepAsAndroidData for device igor

Like this integration? Please send us feedback in any suitable way: emoji at release page, starring project at GitHub , support at or , or just It will let me know that things that I make is helping other people.
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(7.55 KB)
v1.2.4(Aug 11, 2021)

Add support of before_smart_period event #12
Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(5.66 KB)
v1.2.3(Jul 8, 2021)
Bug Fixes

support all version of HA 2021.7+ and older at same time (86be444)

Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(6.14 KB)
v1.2.2(Jul 7, 2021)
WARNING

This release is not compatible with HA versions prior 2017.7

Bug Fixes

allow to work with HA 2021.7 (0171caf)

Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(5.98 KB)
v1.2.1(May 17, 2021)
Bug Fixes

manifest: set iot_class (1f4e73c)

write event to log if it is not in triggers list (fc5f03b)

Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(5.98 KB)
v1.2.0(Feb 7, 2021)
Features

create all devices in single integration (1cd906d), closes #2

Source code(tar.gz)
Source code(zip)
sleep_as_android.zip(5.08 KB)
v1.1.0(Dec 30, 2020)
Features

added support for device-based events in automatization triggers (a69c0d0)

Source code(tar.gz)
Source code(zip)
v1.0.1(Dec 30, 2020)
Bug Fixes

change settings dialog was fixed (23e1db9)

define available property (00b63f6)

set unique id based on name and topic (b92c03b)

Source code(tar.gz)
Source code(zip)
v1.0.0(Dec 30, 2020)

Integration initial version

Base version that allow use sensor and events. Configuration via Integrations page. For more details see README.
Source code(tar.gz)
Source code(zip)

Owner

Igor

GitHub

Home Assistant custom integration for e-distribución

e-Distribución is an energy distribution company that covers most of South Spain area. If you live in this area, you probably are able to register into their website to get some information about your power demand, energy consumption, or even cycle billing (in terms of consumptions).