free_mobile platform documentation

There is also a picture and a logo
This commit is contained in:
hydreliox 2016-01-12 09:02:12 +01:00
parent 43c201ef01
commit cae34e7664
3 changed files with 49 additions and 0 deletions

View File

@ -0,0 +1,49 @@
---
layout: component
title: "Free Mobile"
description: "Instructions how to add user notifications to Home Assistant."
date: 2016-01-12 08:36
sidebar: true
comments: false
sharing: true
footer: true
logo: free_mobile.png
ha_category: Notifications
featured: true
---
[Free Mobile](http://mobile.free.fr/) is a French mobile operator who provide to customers an API to send SMS on their own cell phone.
### Configuration
```yaml
# Example configuration.yaml entry
notify:
platform: free_mobile
username: YOUR_ACCOUNT_ID
access_token: TOKEN
```
Configuration variables:
- **username** (*Required*): This is the id given by FreeMobile to access to your online account.
- **access_token** (*Required*): You can get this token by activating the SMS API in your online account.
### Usage
Before doing anything, you have to activate the SMS API option in your Free Mobile account (In "Gérer mon compte -> Mes Options"). Activating this option will automatically generate a token which is required in your configuration.
<p class='img'>
<img src='/images/components/free_mobile/token.png' />
</p>
This API only send classic SMS and only on the cell phone of the account owner. So you only have to provide a text message in your payload.
**Warning** : if you disable and re-enable the SMS API option, please be sure to update your token in your configuration
#### Example service payload
```json
{
"message": "Hello World"
}
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 182 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB