Telegram Bot doc enhancements with callback queries and more notification options by azogue · Pull Request #2508 · home-assistant/home-assistant.io

azogue · 2017-04-25T18:41:54Z

Description:
Telegram Bot enhancements with callback queries and more notification options. Documentation of new parameters with yaml automation examples.

Pull request in home-assistant (if applicable): home-assistant/core#7294

mention-bot · 2017-04-25T18:41:55Z

@azogue, thanks for your PR! By analyzing the history of the files in this pull request, we identified @fabaff, @balloob and @icovada to be potential reviewers.

Landrash

Looks really good in general.
Some minor clean up is preferred and then this can be merged after parent PR is merged.

Landrash · 2017-04-27T14:46:25Z

+- **title** (*Optional*): Will be composed as '%title\n%message'.
+- **parse_mode** (*Optional*): Parser for the message text: 'html' or 'markdown'.
+- **timeout** (*Optional*): If this value is specified, use it as the definitive timeout (in seconds) for urlopen() operations.
+- **disable_notification** (*Optional*): Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound.


Might be good to include what web users receive.

Landrash · 2017-04-27T14:48:00Z

+```
+
+- **edit_message** or **edit_caption** (*Required*):
+    - **message_id** or **inline_message_id** (*Required*): id of the message to be edited.


A bit of extra indentation here.

Landrash · 2017-04-27T14:48:40Z

 To use notifications, please see the [getting started with automation page](/getting-started/automation/).

+### {% linkable_title Common message data parameters %}
+


Add

Configuration variables:

Landrash · 2017-04-27T14:48:57Z

+        callback_query_id: '{{ trigger.event.data.id }}'
+        show_alert: false
+```
+


Add

Configuration variables:

Landrash · 2017-04-27T14:49:11Z

+        - '/remove button'
+...
+```
+


Add

Configuration variables:

Landrash · 2017-04-27T14:51:52Z

+
+Text repeater:
+```yaml
+- alias: 'telegram bot that repeats text'


Preference of using capital letter of Telegram since it's used as a name throughout this documentation.

Landrash · 2017-04-27T14:52:05Z

+
+Message editor:
+```yaml
+- alias: 'telegram bot last sended msg edit'


Preference of using capital letter of Telegram since it's used as a name throughout this documentation.

Landrash · 2017-04-27T14:52:12Z

+
+Keyboard editor:
+```yaml
+- alias: 'telegram bot keyboard edit'


Preference of using capital letter of Telegram since it's used as a name throughout this documentation.

Landrash · 2017-04-27T14:52:32Z

+
+Only acknowledges the 'NO' answer:
+```yaml
+- alias: 'telegram bot simply acknowledges'


Preference of using capital letter of Telegram since it's used as a name throughout this documentation.

Landrash · 2017-04-27T14:53:31Z

+            show_alert: false
+```
+
+For a more complex usage of the `telegram_bot` capabilities, using [AppDaemon](https://home-assistant.io/docs/ecosystem/appdaemon/tutorial/) is advised.


We wouldn't happen to have an example to link to except for the AppDaemon tool?

Thanks a lot for your review. I'm going to try again.

On the AppDaemon tool, it is my intention to link or include in the documentation a simple example, perhaps with the same behavior of the yaml examples. My uses are too complex to use as examples...

Do you think the screenshots are necessary too? (home-assistant/core#7294)

Also, I think I need to close the smtp PR (was accidentally merged with this one) and make it again. I don't know how to remove files from the PR, sorry!!

Thanks a lot!

azogue · 2017-05-03T14:23:37Z

@Landrash, I think I'm finished. Waiting for the home-assistant review to validate the new doc.

Do you want me to include the screenshots of the bot example?

Landrash · 2017-05-03T14:23:34Z

+
+A command looks like `/thecommand`, or `/othercommand with some args`.
+
+When received by hass it will fire a `telegram_command` event on the event bus with the following `event_data`:


Avoid using hass an write out Home Assistant.
There's a few more examples but I won't mark them.

azogue · 2017-05-05T18:12:47Z

@Landrash,
~~I've made a new PR (#2573) to avoid the conflicting files (I've screwed it up with this PR and a mix of local branches), I'm sorry~~
~~When reviewed, I will close this.~~

I think it's ready, finally.

…ments with callback queries and more notification options Telegram Bot doc changes for pull request #7294: some required fixes and an example of an AppDaemon app. Telegram Bot doc changes for pull request #7294: fix Telegram Bot doc changes for pull request #7294: minimal clarification about disabling notifications for Telegram web users Telegram Bot doc changes for pull request #7294: added new notification services (like in the `mediaplayer` component doc); added a description to how operates now the `notify.telegram` platform; changed service calls from `notify/telegram_bot` to `telegram_bot/EXPLICIT_NEW_SERVICE` in some of the yaml examples and in the appdaemon example. Telegram Bot doc changes for pull request #7294: added `parse_mode` global config variable in webhooks and polling platforms; fixed links to /components/notify.telegram Telegram Bot doc changes for pull request #7294: removed complex usage of telegram_bot services (moved to the telegram_bot doc); removed api_key from required params; removed multiple target feature (it can be done with the telegram_bot services or simply defining more than one notifier); added keyboard and inline_keyboard config vars to every type of notification. Telegram Bot doc changes for pull request #7294: change 'hass' to 'Home Assistant'

balloob · 2017-05-10T05:41:57Z

Thanks! 🎉

MartinHjelmare · 2017-05-21T10:19:17Z

-# Example configuration.yaml entry
+# Example configuration.yaml entry for the Telegram Bot
+telegram_bot:
+  platform: webhooks


I don't think we should assume that a user has exposed the install to the outside, which is required for webhooks. Better to suggest the polling platform.

MartinHjelmare · 2017-05-21T10:25:38Z

-Use Telegram on your mobile device to send messages or commands to your Home Assistant.
+Use Telegram on your mobile or desktop device to send and receive messages or commands to/from your Home Assistant.

+This component creates notification services to send, or edit previously sent, messages from a [Telegram Bot account](https://core.telegram.org/bots) configured either with the [polling](/_components/telegram_bot.polling.markdown) method or with the [webhooks](/_components/telegram_bot.webhooks.markdown) one, and trigger events when receiving messages.


The links for polling and webhooks are incorrect. They should target:
/components/telegram_bot.polling/
/components/telegram_bot.webhooks/

azogue mentioned this pull request Apr 25, 2017

Telegram Bot enhancements with callback queries and more notification options home-assistant/core#7294

Closed

1 task

Landrash requested changes Apr 27, 2017

View reviewed changes

Landrash added Enhancement new-feature This PR adds documentation for a new Home Assistant feature to an existing integration labels Apr 27, 2017

Landrash approved these changes May 3, 2017

View reviewed changes

This was referenced May 5, 2017

Telegram Bot enhancements with callback queries and new notification services home-assistant/core#7454

Merged

Telegram Bot enhancements with callback queries and new notification services #2573

Closed

balloob merged commit 68a6187 into home-assistant:next May 10, 2017

azogue deleted the telegram-callbacks branch May 10, 2017 16:47

MartinHjelmare reviewed May 21, 2017

View reviewed changes

MartinHjelmare mentioned this pull request May 21, 2017

Telegram docs adjustment #2676

Closed

azogue restored the telegram-callbacks branch May 21, 2017 10:36

		To use notifications, please see the [getting started with automation page](/getting-started/automation/).

		### {% linkable_title Common message data parameters %}


		A command looks like `/thecommand`, or `/othercommand with some args`.

		When received by hass it will fire a `telegram_command` event on the event bus with the following `event_data`:

Uh oh!

Conversation

azogue commented Apr 25, 2017

Uh oh!

mention-bot commented Apr 25, 2017

Uh oh!

Landrash left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

azogue commented May 3, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

azogue commented May 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

balloob commented May 10, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

azogue commented May 5, 2017 •

edited

Loading