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-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix format (#12814)

Browse Source 
* Fix format

* Update source/_integrations/remember_the_milk.markdown

Co-Authored-By: Franck Nijhof <git@frenck.dev>

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Fabian Affolter 2020-04-11 15:15:49 +02:00 committed by GitHub
parent 8e9f8e7a96
commit 7aab641b1d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
source/_integrations/remember_the_milk.markdown
View File

@ -7,7 +7,7 @@ ha_release: 0.57
ha_domain: remember_the_milk
---
The `Remember The Milk` (RTM) integration allows you to create tasks in [remember_the_milk](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., water the plants. The integration allows you to have several RTM accounts in parallel.
The `remember_the_milk` integration allows you to create tasks in [Remember The Milk (RTM)](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., water the plants. The integration allows you to have several RTM accounts in parallel.
## Setup
@ -15,7 +15,7 @@ The setup consists of two steps: getting an API key and registering your account
### Step 1: API key
To be able to use this component, you need a Remember The Milk account and you need to apply for your own [API key](https://www.rememberthemilk.com/services/api/keys.rtm). With the API key you will also receive your personal `shared secret`. Both of them need to be stored in your Home Assistant configuration:
To be able to use this integration, you need a Remember The Milk account and you need to apply for your own [API key](https://www.rememberthemilk.com/services/api/keys.rtm). With the API key you will also receive your personal shared secret. Both of them need to be stored in your Home Assistant configuration:
```yaml
# Example configuration.yaml entry
@ -42,7 +42,7 @@ remember_the_milk:
type: string
{% endconfiguration %}
### Step 2: registering your account
### Step 2: Registering your account
After saving the configuration, you need to (re-)start Home Assistant. On the first start you will notice a new "Configuration" panel appearing on the Home Assistant page. After opening the configuration page, follow the link "Remember The Milk login". This will take you to a login page where you have to log in with your normal Remember The Milk credentials. This will authorize Home Assistant to access your Remember The Milk account.
@ -52,13 +52,13 @@ If the registration was successful, the Configuration panel will disappear from
In the background Home Assistant downloaded a "token" from the Remember The Milk server which is stored in the `remember_the_milk.conf` file locally. So you only need to register once. After that the token is used to authenticate with the server.
## Creating/updating tasks with service ```create_task```
## Creating/updating tasks with service `create_task`
This integration offers a new service domain ```remember_the_milk``` with the services ```<account>_create_task```. You can call this service with the argument ```name``` and the optional parameter ```id``` to create a new task in your Remember The Milk account. You can call this service from your usual automations.
This integration offers a new service domain `remember_the_milk` with the services `<account>_create_task`. You can call this service with the argument `name` and the optional parameter `id` to create a new task in your Remember The Milk account. You can call this service from your usual automations.
If you set an ```id``` and a task with that id exists already, the existing task is updated, rather than creating a new task. This way you can change the name of the task. If you do not set an ```id```, a new task is created with every call. If you're using this from an automation, you could use the name of your automation as id or the entity that triggered the task to be created. This way you can later on update or complete this task.
If you set an `id` and a task with that id exists already, the existing task is updated, rather than creating a new task. This way you can change the name of the task. If you do not set an `id`, a new task is created with every call. If you're using this from an automation, you could use the name of your automation as id or the entity that triggered the task to be created. This way you can later on update or complete this task.
The task creation supports the "smart syntax", so to create a task with the tag "from_hass" which is due today you can create a task with the name ```test task created in Home Assistant ^today #from_hass```. More info about the smart syntax is available on the [Remember The Milk documentation](https://www.rememberthemilk.com/help/answer/basics-smartadd-howdoiuse).
The task creation supports the "smart syntax", so to create a task with the tag "from_hass" which is due today you can create a task with the name `test task created in Home Assistant ^today #from_hass`. More info about the smart syntax is available on the [Remember The Milk documentation](https://www.rememberthemilk.com/help/answer/basics-smartadd-howdoiuse).
**Note:**
At the moment, smart syntax is *not* supported when updating tasks. All smart syntax commands are ignored during the update and will end up as normal text in the name of the task.
@ -68,11 +68,11 @@ At the moment, smart syntax is *not* supported when updating tasks. All smart sy
| name | no | Name of the new task, you can use the smart syntax here. | "do this ^today #from_hass" |
| id | yes | Identifier for the task you're creating, can be used to update or complete the task later on | "myid" |
## Completing tasks with service ```complete_task```
## Completing tasks with service `complete_task`
Complete a tasks that was privously created from Home Assistant. You can not complete tasks that were created outside of Home Assistant.
If you have created your task with an ```id```, calling ```<account>_complete_task``` with the parameter ```id``` will then complete your task.
If you have created your task with an `id`, calling `<account>_complete_task` with the parameter `id` will then complete your task.
|Service data attribute | Optional | Description | Example |
|-----------------------|----------|-------------|---------|
@ -80,7 +80,9 @@ If you have created your task with an ```id```, calling ```<account>_complete_ta
## Automation example
Here's an example for an automation that creates a new task whenever ```sensor.mysensor``` is ```on``` and completes it when the sensor reports ```off```. This way it reminds you to switch it off. By using the ```entity_id``` as id for the task, you can use the same rule also for multiple sensors.
Here's an example for an automation that creates a new task whenever `sensor.mysensor` is `on` and completes it when the sensor reports `off`. This way it reminds you to switch it off. By using the `entity_id` as ID for the task, you can use the same rule also for multiple sensors.
{% raw %}
```yaml
- id: mysensor_on
@ -104,7 +106,8 @@ Here's an example for an automation that creates a new task whenever ```sensor.m
id: "{{trigger.entity_id}}"
```
{% endraw %}
## Disclaimer
This product uses the Remember The Milk API but is not endorsed or certified by Remember The Milk.
This integration uses the Remember The Milk API but is not endorsed or certified by Remember The Milk.