jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Expanding habitica docs with fetching tasks (#14251)

Browse Source
This commit is contained in:
Ilja Leiko 2021-02-24 19:35:05 +01:00 committed by GitHub
parent 882970eba8
commit dc727ae783
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
source/_integrations/habitica.markdown
View File

@ -15,20 +15,28 @@ This integration allows you to monitor and manage your Habitica profile. This in
There is currently support for the following device types within Home Assistant:
- Sensor - Allows you to view and monitor your player data from [Habitica](https://habitica.com/) in Home Assistant.
Player data: allows you to view and monitor your player data from [Habitica](https://habitica.com/) in Home Assistant. The following sensors will be available:
The sensors will automatically appear, after setup the Habitica component.
- Player's name
- Player's health points
- Player's max health
- Player's manna points
- Player's max manna points
- Player's experience
- Player's experience to the next level
- Player's level
- Player's gold pieces
- Player's class
To use the integration you should use this example configuration:
Tasks: allows you to view and monitor your tasks from [Habitica](https://habitica.com/) in Home Assistant. The following sensors will be available:
```yaml
# Minimum viable configuration.yaml entry
habitica:
- api_user: YOUR_USER_ID
api_key: YOUR_API_KEY
```
- Habits
- Daily tasks
- Todo tasks
- Rewards
{% include integrations/config_flow.md %}
You can specify several users, providing `api_user` and `api_key` for each.
At runtime you will be able to use API for each respective user by their Habitica's username.
You can override this by passing `name` key, this value will be used instead of the username.
If you are hosting your own instance of Habitica, you can specify a URL to it in `url` key.
@ -52,11 +60,6 @@ url:
required: false
type: string
default: https://habitica.com
sensors:
description: List of sensors to generate for this user. If you don't specify this entry then the default (all sensors) will be generated. If you specify this entry empty then no sensors will be generated.
required: false
type: list
default: all (`name`, `hp`, `maxHealth`, `mp`, `maxMP`, `exp`, `toNextLevel`, `lvl`, `gp`, `class`)
{% endconfiguration %}
### API Service Parameters