Differences

This shows you the differences between two versions of the page.

--- texting [2022/10/06 11:55]
matt
+++ texting [2022/10/07 15:41] (current)
vizycam [Testing and subscribing]
@@ Line 1: / Line 1: @@
-===== Texting Service =====
+====== Texting Service ======
-Connect to Vizy from anywhere using messaging services like Telegram. \\
+Wouldn't it be nice if your Vizy kept you informed throughout your day, such as when your dog jumps on the couch, when a car has pulled into your driveway, or when a unique bird species has visited your birdfeeder?  Text messages are a good way to keep you informed in this way.  Vizy could send you text updates, images, and/or videos directly to your phone regardless of your location.  So, which dog jumped on the couch?  (Barkley!  You're so busted...)
-You can easily interact with Vizy using your phone, receiving photo updates of newly detected bird species or a list of how many times a chosen objects have been seen in a given time period. Know exactly when your dog jumps on the couch or if there is there a car in the driveway. \\
-For another way to stay connected, friends and family can subscribe to Vizy for updates. \\
-The Texting Service also makes possible to access Vizy from anywhere using a single command. Using Vizy's already built [[wiki:remote|WebShare]] features, the texting service can be used to generate and retrieve the link to your ssh-tunnelled WebAddress. \\
-Once connected, there is a set of Vizy command keywords that can be sent to the chat to interact with your Vizy. It is also possible to add your own commands with a bit of python programming.
-*Note*: Setup __requires__ an internet connection and users to have a Telegram account. Telegram Bots are created using Telegram's Bot Father, your guide to all things bot creating, editing, and building.
+As of software version 0.2.111, Vizy supports text messaging through [[https://telegram.org/|Telegram]].
-==== Setup Connection ====
+  * Apps can respond to specific text commands that you send to Vizy (e.g. send me pictures of the most recent birdfeeder visitors) FIXME.
-Click on the ☰ icon in the upper right corner (Settings Menu) \\
+  * Apps can send you updates that you're interested in (e.g. cat is waiting to be let outside).
-Select **Texting**. \\
+  * You can subscribe/unsubscribe FIXME to these updates and so can your friends/family.
-{{:menu_with_texting_highlighted.png?200|}} \\
+  * Vizy can give you system information upon request, such as available RAM, CPU utilization, Web Share URL FIXME, etc.
+  * For more advanced users, you can add your own "text handlers" in Python FIXME.
+  * No fees (setup, monthly, etc.)
-If you have a Telegram Bot already setup, paste your Bot's Token into the textbox and click submit. \\
-On Success, Congradulations! You have connected Vizy to Telegram and all Vizy Commands Keywords are available through the chat. \\
+===== Setting things up =====
-Sending commands, such as 'help' or 'webshare', will cause your Bot to respond with the requested resource. \\
-{{:submit_token_with_new_apikey.png?nolink&300|}} {{::help_without_video_running.png?nolink&350|}}
+Setting up Telegram on your Vizy is straightforward.  It's a few steps and shouldn't take more than a few minutes.
+==== Sign-up for a Telegram account ====
+If you don't have a Telegram account, start by downloading the Telegram App on your phone. {{wiki:image_1223.jpg?25}}  Running the app will guide you through the sign-up process.
+==== Link your desktop/laptop to your Telegram account ====
+There's a copy-and-paste operation that's pretty clumsy from a smartphone, so we recommend linking your Telegram account to your desktop/laptop so you can take advantage of your computer's mouse.  If you're deft at copying and pasting on your smartphone, you can skip this step, but having access from your desktop/laptop is useful in general.
+Start by going [[https://web.telegram.org|here]] on your desktop/laptop.  It will ask you to input your phone number, and then it will guide you through the linking process.  There's some QR code stuff, and voila, you're accessing Telegram from your desktop/laptop.
+==== Create a new bot ====
+In the Telegram search box, search for ''@botfather'' and click on the **BotFather** in the search results to bring you into a dialog with the BotFather.
+{{wiki:image_1214.jpg}}
+Next, type the command ''/newbot'' and BotFather will guide you through creating a new bot.  At the end of this process, you will be given a token (outlined in red below).
+{{wiki:image_1225.jpg?400}}
+Copy the token into your clipboard.  Also, take note of the unique name you assigned to your bot.  (You can share this name with friends/family so that they can interact with your Vizy.)
+==== Copy the token into Vizy ====
+Point your browser to your Vizy.  (Please refer to the [[wiki:vizy_getting_started|getting started guide]] if you need help with connecting to your Vizy, etc.)  Click on the ☰ icon in the upper right corner and select **Texting**.
+{{wiki:image_1222.jpg?200}}
+Paste the token that you copied in the previous step into the **Token** box and click on **Submit**.
+{{wiki:image_1216.jpg?400}}
+If you're successful, you'll get a **Connected!** message.
+{{wiki:image_1217.jpg?400}}
+Congrats!
+(If you're unsuccessful, go back to the BotFather and make sure that you copied the token string in its entirety, but paying close attention not to copy extra spaces or other characters.)
+===== Testing and subscribing =====
+Go back to the Telegram browser tab and type **help**.  You should get a message similar to the one below.
+{{wiki:image_1226.jpg?500}}
+Type in **subscribe** and you will be subscribed to Vizy updates.  You can go back to the Vizy tab and bring up the **Texting** dialog and click on **Send test text**.
+{{wiki:image_1220.jpg?400}}
+And you should receive a test message similar to below.
+{{wiki:image_1221.jpg?350}}
+Congrats (again)!  You're now subscribed to Vizy text updates.
+===== Sharing your Vizy bot with friends/family =====
+This is easy, you just need to give them your bot's unique name.  If you forgot it, just go back to your dialog with BotFather and it should be there embedded in the conversation.
+Just tell them to bring up Telegram and search for ''@<your bot's unique name>'', and then type in ''subscribe''.
-If you do not have a Telegram Bot, easily create one in two steps using Telegram's BotFather. *Note*: You will need a Telegram Account to do this. \\
-Click 'Create Token (Bot Father)', where you'll be taken to a webpage inviting you to a conversation with The BotFather. You can download the Telegram app for your computer or continue through the web by clicking 'Send Message'. \\
-The BotFather is a versatile tool to control and modify any bots you create with Telegram. To get started, send '/start' in the chat. Beginning a word with a backslash such as '/start' is a Telegram Command, not to be confused with Vizy Command Keywords. \\
-After sending '/start', all you need to do is give your Bot a name and a username then BotFather will create your bot, including the Bot Token.
-{{:create_token_bot_father_highlighted.png?320|}}
-{{:use_telegrams_bot_father_to_create_a_bot_and_a_token.png?320|}} \\
-{{:bot_father_introduction.png?320|}}
-{{:bot_father_create_bot_highlight_apikey.png?nolink&320|}}
-Paste and Submit your Bot Token. \\
-The dialog with give a 'Connected!' success message or an 'Invalid Token Error' failure message. \\
-On failure, try resubmitting your token or reloading the page. \\
-On success, Vizy has connected to your Telegram Bot and it's time to try some commands! \\
-{{:submit_token_with_new_apikey.png?nolink&300|}}
-{{:wiki:remove_token_no_users_subscribed.png?nolink&335|}}
-{{::token_error_invalid_token.png?nolink&390|}}
 ==== Commands ====
 There are two Types of Vizy Commands: General and Application Specific. General Commands are always accessible while Application Specific commands only return if the given application is running on Vizy. All commands are single words sent in the chat. Telegram has its own set of commands that begin with a forwardslash '/' such as '/start'. See the Bot Father for examples.

Documentation

User Tools

Site Tools

Differences

Page Tools