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

Update Todoist calendar component configuration (#7080)

Browse Source
This commit is contained in:
Klaas Schoute 2018-10-25 22:47:10 +02:00 committed by Franck Nijhof
parent 8094899a56
commit cfdd302b5f
1 changed files with 27 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
source/_components/calendar.todoist.markdown
View File

@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.54 ha_release: 0.54
--- ---
This platform allows you to connect to your [Todoist Projects](https://todoist.com) and generate binary sensors. A different sensor will be created for each individual project, or you can specify "custom" projects which match against criteria you set (more on that below). These sensors will be `on` if you have a task due in that project or `off` if all the tasks in the project are completed or if the project doesn't have any tasks at all. All tasks get updated roughly every 15 minutes. This platform allows you to connect to your [Todoist Projects](https://todoist.com) and generate binary sensors. A different sensor will be created for each individual project, or you can specify "custom" projects which match against criteria you set (more on that below). These sensors will be `on` if you have a task due in that project or `off` if all the tasks in the project are completed or if the project doesn't have any tasks at all. All tasks get updated roughly every 15 minutes.
### {% linkable_title Prerequisites %} ### {% linkable_title Prerequisites %}
@ -28,18 +27,35 @@ To integrate Todoist in Home Assistant, add the following section to your `confi
# Example configuration.yaml entry # Example configuration.yaml entry
calendar: calendar:
- platform: todoist - platform: todoist
token: API_token_created_from_steps_above token: YOUR_API_TOKEN
``` ```
Configuration variables: Configuration variables:
token:
- **token** (*Required*): The API token used to authorize Home Assistant to access your projects. description: The API token used to authorize Home Assistant to access your projects. Above you have more info about it.
- **custom_projects** (*Optional*): Details on any "custom" binary sensor projects you want to create. required: true
- **name** (*Required*): The name of your custom project. Only required if you specify that you want to create a custom project. type: string
- **due_date_days** (*Optional*): Only include tasks due within this many days. If you don't have any tasks with a due date set, this returns nothing. custom_projects:
- **labels** (*Optional*): Only include tasks with at least one of these labels (i.e., this works as an `or` statement).. description: Details on any "custom" binary sensor projects you want to create.
- **include_projects** (*Optional*): Only include tasks in these projects. Tasks in all other projects will be ignored. required: false
type: list
keys:
name:
description: The name of your custom project. Only required if you specify that you want to create a custom project.
required: true
type: string
due_date_days:
description: Only include tasks due within this many days. If you don't have any tasks with a due date set, this returns nothing.
required: false
type: integer
include_projects:
description: Only include tasks in these projects. Tasks in all other projects will be ignored.
required: false
type: list
labels:
description: Only include tasks with at least one of these labels (i.e., this works as an `or` statement).
required: false
type: list
### {% linkable_title Custom Projects %} ### {% linkable_title Custom Projects %}
Creating custom projects is super-easy and quite powerful. All you need to run the basic Todoist projects is your API token, but if you wanted, you could go even deeper. Here's an example: Creating custom projects is super-easy and quite powerful. All you need to run the basic Todoist projects is your API token, but if you wanted, you could go even deeper. Here's an example:
@ -48,7 +64,7 @@ Creating custom projects is super-easy and quite powerful. All you need to run t
# Example configuration.yaml entry # Example configuration.yaml entry
calendar: calendar:
- platform: todoist - platform: todoist
token: !secret todoist_token token: YOUR_API_TOKEN
custom_projects: custom_projects:
- name: 'All Projects' - name: 'All Projects'
- name: 'Due Today' - name: 'Due Today'