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-20 15:56:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Signal Messenger: add text_mode and improvements (#33221)

Browse Source 
Co-authored-by: c0ffeeca7 <k0ffeeka7@gmail.com>
This commit is contained in:
r-xyz 2024-06-24 18:58:20 +02:00 committed by GitHub
parent 522f0387c3
commit 8644d77694
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 73 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
source/_integrations/signal_messenger.markdown
View File

@ -70,9 +70,80 @@ recipients:
{% endconfiguration %}
## Notification Service
### Examples
A few examples on how to use this integration to send notifications from automations.
#### Text message
```yaml
...
action:
service: notify.NOTIFIER_NAME
data:
message: "That's an example that sends a simple text message to the recipients specified in the configuration.yaml. If text mode is 'styled', you can use *italic*, **bold** or ~strikethrough~ ."
## Optional
data:
text_mode: styled
```
| Attribute | Optional | Default |Description |
| ----------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `text_mode` | *optional* | normal | Accepted values are `normal` or `styled`. If set to `styled`, additional text formatting is enabled (*`*italic*`*, **`**bold**`**, and ~~`~strikethrough~`~~). |
#### Text message with an attachment
This example assumes you have an image stored in the default `www`-folder in Home Assistant Operating System.
```yaml
...
action:
service: notify.NOTIFIER_NAME
data:
message: "Alarm in the living room!"
data:
attachments:
- "/config/www/surveillance_camera.jpg"
text_mode: styled
```
| Data attribute | Optional | Default |Description |
| ----------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `attachments` | **required** | - | List of paths of files to be attached. |
| `text_mode` | *optional* | normal | Accepted values are `normal` or `styled`. If set to `styled`, additional text formatting is enabled (*`*italic*`*, **`**bold**`**, and ~~`~strikethrough~`~~). |
#### Text message with an attachment from a URL
```yaml
...
action:
service: notify.NOTIFIER_NAME
data:
message: "Person detected on Front Camera!"
data:
verify_ssl: false
urls:
- "http://homeassistant.local/api/frigate/notifications/<event-id>/thumbnail.jpg"
text_mode: styled
```
| Data attribute | Optional | Default |Description |
| ----------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `urls` | **required** | - | List of URLs of files to be attached. |
| `verify_ssl` | *optional* | true | Accepted values are `true`, `false`. You can set it to `false` to ignore SSL errors. |
| `text_mode` | *optional* | normal | Accepted values are `normal` or `styled`. If set to `styled`, additional text formatting is enabled (*`*italic*`*, **`**bold**`**, and ~~`~strikethrough~`~~). |
**Notes:**
- To attach files from outside of Home Assistant, the URLs must be reachable and added to the [`allowlist_external_urls`](/integrations/homeassistant/#allowlist_external_urls) list.
- There is a 50MB size limit for attachments retrieved via URLs.
## Sending messages to Signal to trigger events
You can use Signal Messenger REST API as a Home Assistant trigger. In this example, we will make a simple chatbot. If you write anything to your Signal account linked to Signal Messenger REST API, the automation gets triggered, with the condition that the number (attribute source) is correct, to take action by sending a Signal notification back with a "Message received!".
You can use the Signal Messenger REST API as a Home Assistant trigger. In this example, we will make a simple chatbot. If you write anything to your Signal account linked to Signal Messenger REST API, the automation gets triggered, with the condition that the number (attribute source) is correct, to take action by sending a Signal notification back with a "Message received!".
To accomplish this, make sure the addon's `mode` parameter is set to `native` or `normal`, and edit the configuration of Home Assistant, adding a [RESTful resource](/integrations/rest/) as follows:
@ -87,6 +158,7 @@ To accomplish this, make sure the addon's `mode` parameter is set to `native` or
json_attributes:
- source #using attributes you can get additional information, in this case, the phone number.
```
You can create an automation as follows:
```yaml
@ -102,51 +174,3 @@ action:
data:
message: "Message received!"
```
## Examples
A few examples on how to use this integration as actions in automations.
### Text message
```yaml
...
action:
service: notify.NOTIFIER_NAME
data:
message: "That's an example that sends a simple text message to the recipients specified in the configuration.yaml"
```
### Text message with an attachment
This example assumes you have an image stored in the default `www`-folder in Home Assistant Operating System.
```yaml
...
action:
service: notify.NOTIFIER_NAME
data:
message: "Alarm in the living room!"
data:
attachments:
- "/config/www/surveillance_camera.jpg"
```
### Text message with an attachment from a URL
To attach files from outside of Home Assistant, the URLs must be added to the [`allowlist_external_urls`](/integrations/homeassistant/#allowlist_external_urls) list.
Note there is a 50MB size limit for attachments retrieved via URLs. You can also set `verify_ssl` to `false` to ignore SSL errors (default `true`).
```yaml
...
action:
service: notify.NOTIFIER_NAME
data:
message: "Person detected on Front Camera!"
data:
verify_ssl: false
urls:
- "http://homeassistant.local/api/frigate/notifications/<event-id>/thumbnail.jpg"
```