Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slametps/MMM-TelegramBot
TelegramBot module for remote-controlling MagicMirror
https://github.com/slametps/MMM-TelegramBot
Last synced: 22 days ago
JSON representation
TelegramBot module for remote-controlling MagicMirror
- Host: GitHub
- URL: https://github.com/slametps/MMM-TelegramBot
- Owner: slametps
- Created: 2017-10-16T15:47:20.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-24T07:44:11.000Z (about 7 years ago)
- Last Synced: 2024-08-04T10:02:43.179Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 25.4 KB
- Stars: 2
- Watchers: 1
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mmm - **MMM-TelegramBot**
README
# MMM-TelegramBot
TelegramBot module for MagicMirror
## Feature
- You can remote-control your `MagicMirror` and modules within `Telegram`.
- The Bot is implemented in this module thus you don't need to manage antoher daemon.
- Other module developers can add their commands easily. (See the Wiki : https://github.com/eouia/MMM-TelegramBot/wiki )
## Installation
### 1) Create Telegram Bot
**Ref : https://core.telegram.org/bots#6-botfather**
1. Open your browser in Desktop PC(or your mirror or your phone, anywhere) and Navigate to https://telegram.me/botfather
2. Click `Send Message` button, then your telegram will be opened in your phone or your PC which `Telegram` is already installed on. Meet `BotFather`.
3. Command `/newbot`, give a `name` to the bot created, give an `username`. `username` should end with `bot`. (e.g. `MyMagicMirrorBot` or `mystupidslave-bot`... )
4. After created, you can get API Token. It looks like `110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw`. Remember that.
5. Read messages from `BotFather`. You can find your bot and change chat room of your Bot. Type anything, but your bot will not react yet.
### 2) Install Module
1. In your mirror, open terminal and execute below;
```
cd ~/MagicMirror/modules
git clone https://github.com/eouia/MMM-TelegramBot.git
cd MMM-TelegramBot
npm install
```
### 3) Configuration (Pre-use)
1. Open `config.js` of `MagicMirror`, add these;
```
{
module: 'MMM-TelegramBot',
config: {
telegramAPIKey : '',
allowedUser : [''], // This is NOT the username of bot.
}
},
```
2. restart your `MagicMirror`.
### 4) Back to your Bot and test
1. Back to the chat room with your Bot in Telegram, try `/help` or `/commands`. Your bot will react!
2. Now,try `/mychatid`. This command will show the id of this chat room. The `chat id` looks like `12345678`. Remember that. We will use this id for admin.
### 5) Register admin Chat id
1. Open `config.js` again.
```
{
module: 'MMM-TelegramBot',
config: {
telegramAPIKey : '',
allowedUser : [''],
adminChatId : ,
}
},
```
2. Restart your `MagicMirror`.
3. You can get welcome message in your admin chat room. Now you can use Bot!
## More Information
See the [Wiki](https://github.com/eouia/MMM-TelegramBot/wiki)