h3n3/NSPanel_HA_Blueprint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update and improve RTTTL Play docs and examples

Browse Source 
Solves #1912
Solves #1901
This commit is contained in:
Edward Firmo
2024-03-14 10:15:06 +01:00
parent 57fee3c1c6
commit 6b3fe0cf84
4 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api.md
View File

@@ -693,7 +693,7 @@ For example tones and further inspiration, you can visit examples of RTTTL songs
```yaml ```yaml
service: esphome.<your_panel_name>_rtttl_play service: esphome.<your_panel_name>_rtttl_play
data: data:
tone: "d=4,o=5,b=140:c,e,g,8p,c6,e6,g6,8p,c7,p" tone: "The Simpsons:d=4,o=5,b=160:c.6,e6,f#6,8a6,g.6,e6,c6,8a,8f#,8f#,8f#,2g,8p,8p,8f#,8f#,8f#,8g,a#.,8c6,8c6,8c6,c6"
``` ```
> [!NOTE] > [!NOTE]
> Replace `<your_panel_name>` with your specific panel name as configured in Home Assistant to ensure correct service execution. > Replace `<your_panel_name>` with your specific panel name as configured in Home Assistant to ensure correct service execution.

4
docs/howto.md
View File

@@ -292,7 +292,7 @@ By repeatedly calling this service whenever motion is detected, the panel can be
HA can send a RTTTL to the NSPanel, custom melodies are possible. HA can send a RTTTL to the NSPanel, custom melodies are possible.
The use this function, the following service is called: ***nspanel_play_rtttl*** The use this function, the following service is called: `rtttl_play`
You can find many RTTTL strings on the web, the important thing is that they must start with the name and then a colon. You can find many RTTTL strings on the web, the important thing is that they must start with the name and then a colon.
@@ -302,7 +302,7 @@ Here is an example:
The Simpsons:d=4,o=5,b=160:c.6,e6,f#6,8a6,g.6,e6,c6,8a,8f#,8f#,8f#,2g,8p,8p,8f#,8f#,8f#,8g,a#.,8c6,8c6,8c6,c6 The Simpsons:d=4,o=5,b=160:c.6,e6,f#6,8a6,g.6,e6,c6,8a,8f#,8f#,8f#,2g,8p,8p,8f#,8f#,8f#,8g,a#.,8c6,8c6,8c6,c6
``` ```
![image-20230320222454441](pics/image-20230320222454441.png) ![HA - Developer Tools - Services - RTTTL Play](pics/ha_developer_tools_services_rtttl_play.png)
More information: https://esphome.io/components/rtttl.html#common-beeps More information: https://esphome.io/components/rtttl.html#common-beeps

BIN
docs/pics/ha_developer_tools_services_rtttl_play.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 32 KiB

BIN
docs/pics/image-20230320222454441.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 18 KiB