This bot is meant to be super easy platform to write Matrix bot functionality in Python. It uses matrix-nio library https://github.com/poljar/matrix-nio/ for Matrix communications.
Zero configuration except Matrix account info is needed. Everything else can be done with bot commands.
Type !help in room with this bot running to list active modules.
If you don't want some modules, just delete the files from modules directory or disable them with !bot disable command.
End-to-end encryption is currently not supported by bot but should be doable. Bot won't respond to commands in e2ee rooms. PR for enabling e2ee is welcome!
Support room: #hemppa:hacklab.fi - https://matrix.to/#/#hemppa:hacklab.fi
RSS Bridge is awesome project that creates RSS feeds for sites that don't have them: https://github.com/RSS-Bridge/rss-bridge
If you want bot to notify on new posts on a service, check out if RSS Bridge supports it! You can use the stock Matrix RSS bot to subscribe to feeds created by RSS bridge.
Bot management commands.
- !bot status - print bot status information
- !bot version - print version and uptime of the bot
- !bot quit - quit the bot process (Must be done as bot owner)
- !bot reload - reload all bot modules (Must be done as bot owner)
- !bot stats - show statistics on matrix users seen by bot
- !bot leave - ask bot to leave this room (Must be done as admin in room)
- !bot modules - list all modules including enabled status
- !bot enable [module] - enable module (Must be done as admin in room)
- !bot disable [module] - disable module (Must be done as admin in room)
Prints help on existing modules.
Simple example module that just echoes what user said.
- !echo Hello, world!
Aviation weather metar service access.
- !metar eftp
Aviation weather TAF service access.
- !taf eftp
Aviation NOTAM data access. Currently supports only Finnish airports - implement other countries where data is available.
- !notam efjm
Can access Teamup ( https://teamup.com/ ) calendar. Teamup has nice API and is easier to set up than Google so prefer it if possible. This bot polls the calendar every 5 minutes and notifies the room of any changes.
Howto:
- Create a calendar in Teamup https://teamup.com/
- Get api key at https://teamup.com/api-keys/request
- !teamup apikey [your api key]
- !teamup add [calendar id]
Commands:
- !teamup apikey [apikey] - set api key (Must be done as bot owner)
- !teamup - list upcoming events in calendar
- !teamup add [calendar id] - add calendar to this room (Must be done as room admin)
- !teamup del [calendar id] - delete calendar from this room (Must be done as room admin)
- !teamup list - list calendars in this room
- !teamup poll - poll now for changes (Must be done as bot owner)
Can access a google calendar in a room. This is a bit pain to set up, sorry.
To set up, you'll need to generate oauth2 credentials.json file - see https://console.developers.google.com/apis/credentials
Run the bot on local machine as OAuth2 wants to open localhost url in your browser. I haven't found out an easy way to do this on server.
There is a empty credentials.json file in the bot directory. Replace it with yours. When credentials.json is present, you must authenticate the bot to access calendar. There will be a link in console like this:
Please visit this URL to authorize this application: https://accounts.google.com/o/oauth2/auth?response_type=code&client_id=907....
Open the link and authenticate as needed. A new file token.pickle will be created in the directory and bot will read it in future. Save the token.pickle and ship it with the bot to your server.
Now the bot should be usable.
Use !googlecal add [calendar id] to add new calendar to a room. The bot lists availble calendar ID's on startup and you can find them in google calendar.
Commands:
- !googlecal - Show next 10 events in calendar
- !googlecal today - Show today's events
- !googlecal add [calendar id] - Add new calendar to room (Must be done as room admin)
- !googlecal del [calendar id] - Delete calendar from room (Must be done as room admin)
- !googlecal list - List calendars in this room
NOTE: disabled by default
Can schedule things to be done.
Commands:
- !cron daily [hour] [command] - Run command on start of hour (Must be done as room admin)
- !cron list - List commands in this room
- !cron clear - Clear command s in this room (Must be done as room admin)
- !cron time - Print the current datetime and time zone that the cron command will use (time zone set using the
TZenvironment variable)
Examples:
- !cron daily 19 "It is now 19 o clock"
- !cron daily 8 "!googlecal today"
Can search OpenStreetMaps for locations and send Matrix location events from them. Translates Matrix location events into OSM links.
Commands:
- !loc [location] - search for location
Example:
- !loc Tampere
This module is for interacting with the room that the commands are being executed on.
- !room servers: Lists the servers in the room
- !room joined: Responds with the joined members count
- !room banned: Lists the banned users and their provided reason
- !room kicked: Lists the kicked users and their provided reason
- !room state [event type] [optional state key]: Gets a state event with given event type and optional state key
When configured in a room, the bot will monitor a room for new users and send new users a welcome message 1:1. It will then notify bot owners of the new user. It will also, optionally, notify of user departure.
Commands:
- !welcome_room welcome_message [message] Sets the welcome message, along with other variables needed to detect new users.
- !welcome_room notify_departure [True/False] Sets whether bot owners will be notified of departure from room. Defaults to False.
- !welcome_room settings Shows the current settings for the welcome_room module.
As a server admin, the bot will monitor new user creation on the server and send the welcome message to new users 1:1. It will then notify bot owners of the new user.
Commands:
- !welcome_server welcome_message [message] Sets the welcome message, along with other variables needed to detect new users.
- !welcome_server settings Shows current settings for the welcome_server module
These have the same usage - you can add one or more accounts to a room and bot polls the accounts. New posts are sent to room. Polls only randomly every 30 to 60 minutes to keep traffic at minimum.
Commands:
Prefix with selected service, for example "!ig add accountname" or "!teamup list"
- add [accountname] - Add account to this room (Must be done as room admin)
- del [accountname] - Delete account from room (Must be done as room admin)
- list - List accounts in room
- poll - Poll for new items (Must be done as bot owner)
- clear - Clear all accounts from this room (Must be done as room admin)
- debug - Show some debug information for accounts in room
Polls instagram account(s). Uses instagram scraper library without any authentication or api key.
See: https://github.com/realsirjoe/instagram-scraper/
NOTE: disabled by default
This is a simple API to ask bot to send messages in Matrix using JSON file from external service.
You'll need an API endpoint (webserver) that contains a message queue. It must respond with following JSON to a HTTP GET request:
{
"messages":[
{
"to": "@example:matrix.org",
"title": "Room Title",
"message": "Hello from Hemppa"
},
{
"to": "@another:matrix.user",
"title": "Room 2 Title",
"message": "Second message"
}
]
}Normally you want to clear the messages when the endpoint is GETted or the messages will repeat every time bot updates itself.
These messages are sent to given Matrix users in private message with given room title. Messages are sent "best effort" - if sending fails, it will be logged to bot output log.
Then just:
- !mxma add http://url.to.the/endpoint.json
mxma requires all commands to be run as bot owner.
Watches all messages in a room and if a url is found tries to fetch it and spit out the title if found.
Defaults to off and needs to be activated on every room you want this.
You can choose to send titles as notices (as in Matrix spec) or normal messages (IRC users might prefer this). This is a global setting currently.
Commands:
- !url status - show current status
- !url title - spam titles to room
- !url description - spam descriptions
- !url both - spam both title and description
- !url off - stop spamming
- !url text - send titles as normal text (must be owner)
- !url notice - sends titles as notices (must be owner)
Example:
- !url status
NOTE: Disabled by default, i.e. you also need to enable it before activating it
Can be used to pre-configure shell commands run by bot. This is easy way to add security issues to your bot so be careful.
Pre-defined commands can be set only by bot owner, but anyone can run them. It's your responsibility as owner to make sure you don't allow running anything dangerous.
Commands have 5 second timeout so don't try to run long processes.
Environ variables seen by commands:
- MATRIX_USER: User who ran the command
- MATRIX_ROOM: Room the command was run (avoid using, may cause vulnerabilities)
Commands:
- !cmd run command - Run command "command" (Must be done as bot owner)
- !cmd add "cmdname" command - Add new named command "command" (Must be done as bot owner)
- !cmd remove "cmdname" - Remove named command (Must be done as bot owner)
- !cmd list - List named commands
- !cmd "cmdname" - Run a named command
Example:
- !cmd run "hostname"
- !cmd add systemstats "uname -a && uptime"
- !cmd systemstats
- !cmd add df "df -h"
- !cmd add whoami "echo You are $MATRIX_USER in room $MATRIX_ROOM."
Upload and send latest astronomy picture of the day to the room. See https://apod.nasa.gov/apod/astropix.html
Command:
- !apod - Sends latest Astronomy Picture of the Day to the room
- !apod YYYY-MM-DD - date of the APOD image to retrieve (ex. !apod 2020-03-15)
- !apod stats - show information about uri cache
- !apod clear - clear uri cache (Must be done as admin)
- !apod apikey [api-key] - set the nasa api key (Must be done as bot owner)
- !apod help - show command help
API Key:
The module uses a demo API Key which can be replaced by your own api key by setting the environment variable APOD_API_KEY or by setting the api key as a bot owner with command !apod apikey [apikey].
You can create one at https://api.nasa.gov/#signUp
Make queries to Wolfram Alpha
You'll need to get an appid from https://products.wolframalpha.com/simple-api/documentation/
Examples:
- !wa 1+1
- !wa airspeed of unladen swallow
Commands:
- !wa [query] - Query wolfram alpha
- !wa appid [appid] - Set appid (must be done as bot owner)
Open Glider Network maintains a unified tracking platform for gliders, drones and other aircraft.
Read more about OGN at https://www.glidernet.org/
FLOG module supports showing field logs for OGN receivers and can display live field log in a room.
It uses KTrax service. Please read https://ktrax.kisstech.ch/api-usage and request a API key for yourself.
Real life field log output looks something like:
Flights at ESGE today:
12:02-12:13 0:11 290m Ultralight SE-VSL
12:17-13:18 1:01 1080m ASG-32 MI SE-SKV VH
12:26-13:52 1:25 1090m DG-1000 SE-UMY VF
12:34-16:32 3:57 1710m Duo Discus xlt SE-UXF XF
Commands and examples:
(You must be room admin for all commands, except apikey which requires bot ownership)
- !flog apikey FLOG-123456 - Set api key
- !flog station EFJM - set the default station to track for this room
- !flog rmstation - remove station from this room
- !flog - Show field flog for the room's station (can be used by any user)
- !flog EFJM - Show field flog for any station (can be used by any user)
- !flog status - print status of this room
- !flog live - enable live field log for this room
- !flog rmlive - disable live field log for this room
- !flog timezone 3 - set timezone (relative to UTC, see API docs)
NOTE: disabled by default
If enabled, Jitsi calls created with Matrix clients will be sent as text messages to rooms, allowing non-matrix users to join them.
Send toots to Mastodon. You can login to Mastodon with the bot and toot with it.
Normal login is personal - it's mapped to your Matrix ID.
Room login overrides personal login and allows room admins to toot to a specified account.
You can limit usage to bot owners only or make it public.
Note: You can subscribe to Mastodon users and hashtags with stock RSS feed integration. Mastodon generates the feeds automatically!
Commands:
- !md status - print status of mastodon module
- !md login [instanceurl] [e-mail] [password] - log in your Matrix user to Mastodon instance (do in private chat!)
- !md toot [toot] - send a toot message. If said in a room with per-room login, user must be a admin in the room.
- !md logout - log out the user from the bot
- !md roomlogin [room] [instanceurl] [e-mail] [password] - same as login but assigns a per-room mastodon account (do in private chat!)
- !md roomlogout - Say in a room that has per-room login. This will remove the login. Must be room admin.
- !md setpublic - ANY user can use login command to login and use the Mastodon module (must be done as bot owner)
- !md setprivate - Only bot owners can use Mastodon module (default) (must be done as bot owner)
- !md clear - Clear all logins from the bot
Example commands:
- !md login https://my.instance/ [email protected] r00tm3
- !md roomlogin #myroom:matrix.org https://my.instance/ [email protected] r00tm3
Bridges two or more Matrix rooms together via relaybot.
Note: Room ID is not same as room alias! Rooms can exist without aliases so ID's are more flexible. Room id is usually in format !123LotOfRandomChars:server.org
To get room ID, it's in Element Web room settings | Advanced | Internal room ID
Before bridging the bot must be present on both rooms.
Commands:
- !relay bridge [roomid] - Bridge room with given ID to this room (must be done as bot owner)
- !relay list - List bridged rooms (and their index numbers) (must be done as bot owner)
- !relay unbridge [number] - Remove the given bridge number (must be done as bot owner)
File uploads, joins, leaves or other special events are not (yet) handled. Contributions welcome.
Relaybots are stupid. Please prefer real Matrix bridges to this. Sometimes there's no alternative.
With this module you can set up a room to print any uploaded files on a specified printer. The printer must be visible to bot via CUPS.
Commands (all can be done by bot owner only):
- !printing list - Lists available printers and their rooms
- !printing setroomprinter [printername] - Assignes given printer to this room
- !printing rmroomprinter - Deletes printer from this room
- !printing setpapersize [papersize] - Set global paper size. Default is A4. See printer settings for valid values.
The module sends the files to CUPS for printing so please see CUPS documentation on what works and what doesn't.
Tested formats: PDF, JPG, PNG
SVG files are printed as text currently, avoid printing them.
This module is disabled by default.
This module was written for asset (machines, tasks and todo) management by mis-using GitHub issues and labels. It has been designed to be used with hackerspace environment but can be extended to any purpose.
- Create labels to github that represent for example different machines and spaces. You can create any number of them.
- Define label colors for each type of asset. These are called domains in this module. For example set all machine labels to be #B60205 and space labels to be #0E8A16. These can be easily picked from color chooser.
- Edit the repository description and add a json block describing the label domains and their colors. For example:
Hackerspace machines, todo and stuff. domains={ "machines": "#B60205", "spaces" : "#0E8A16"}
Make sure you type the description on one line - this is a silly Github limitation.
- When creating issues, assign machine and/or space labels for them. For example, if a wood lathe is broken, create issue with labels "Wood lathe" and "Wood working room".
- !ghproj setrepo [repository] - Set repository for this room (room admin only)
- !ghproj repo - Shows which repository this room tracks
- !ghproj rmrepo - Remove repository from this room (room admin only)
- !ghproj [domain] - List machine statuses in this domain
Repository name must be in format TampereHacklab/Inventaario - you can use this as a example to see how the labels work.
- Create a Matrix user
- Log in as the newly created user (easiest is Element Web in private window)
- Get user's access token (In Element Web see Settings / Help & about)
Run something like (tested on Ubuntu):
sudo apt install python3-pip libcups2-dev libatlas-base-dev gcc
sudo pip3 install pipenv
pipenv shell
pipenv install --pre (this takes ages, go make a sandwich)
MATRIX_USER="@user:matrix.org" MATRIX_ACCESS_TOKEN="MDAxOGxvYlotofcharacters53CgYAYFgo" MATRIX_SERVER="https://matrix.org" JOIN_ON_INVITE=True BOT_OWNERS=@botowner:matrix.org
python3 bot.pyNOTE: The Pipfile does not define the python version as it is always strict and causes problems. See pypa/pipenv#1050 . Python 3.7 and 3.8 should both work fine.
First modify run.sh and make sure Hemppa starts successfully with it.
There's a systemd unit file you can use. It assumes hemppa is installed to /opt/hemppa and is run as user pi in group pi. Note: this is probably not the smartest way to do this, feel free to do a PR for better way.
If your user is not pi, modify hemppa.service first.
sudo ln -s `pwd` /opt/hemppa
sudo ln -s hemppa.service /lib/systemd/system
sudo systemctl daemon-reload
sudo systemctl enable hemppa.service
sudo systemctl start hemppa.service
sudo systemctl status hemppa.serviceStatus should show "Active: active (running)"
Create .env file and set variables:
MATRIX_USER=@user:matrix.org
MATRIX_ACCESS_TOKEN=MDAxOGxvYlotofcharacters53CgYAYFgo
MATRIX_SERVER=https://matrix.org
JOIN_ON_INVITE=True
BOT_OWNERS=@user1:matrix.org,@user2:matrix.org
DEBUG=False
TZ=America/New_YorkNote: without quotes!
Just run:
docker-compose upMATRIX_USER, MATRIX_ACCESS_TOKEN and MATRIX_SERVER should be self-explanatory.
Set JOIN_ON_INVITE (default true) to false if you don't want the bot automatically joining rooms.
You can get access token by logging in with Riot and looking from Settings / Help & About.
BOT_OWNERS is a comma-separated list of matrix id's for the owners of the bot.
Some commands require sender to be bot owner.
Typically set your own id into it.
OWNERS_ONLY is an optional variable once defined only the owners can operate the bot (this is a form of whitelisting)
LEAVE_EMPTY_ROOMS (default true) if this is set to false, the bot will stay in empty rooms
ATTENTION: Don't include bot itself in BOT_OWNERS if cron or any other module that can cause bot to send custom commands is used, as it could potentially be used to run owner commands as the bot itself.
To enable debugging for the root logger set DEBUG=True.
TZ takes any valid TZ database name value and sets the bot server to the appropriate zone.
Just write a python file with desired command name and place it in modules. See current modules for examples. No need to register it anywhere else.
Simple skeleton for a bot module:
class MatrixModule(BotModule):
async def matrix_message(self, bot, room, event):
args = event.body.split()
args.pop(0)
# Echo what they said back
self.logger.debug(f"room: {room.name} sender: {event.sender} wants an echo")
await bot.send_text(room, ' '.join(args))
def help(self):
return 'Echoes back what user has said'- matrix_start - Called once on startup
- async matrix_message - Called when a message is sent to room starting with !module_name
- matrix_stop - Called once before exit
- async matrix_poll - Called every 10 seconds
- help - Return one-liner help text
- get_settings - Must return a dict object that can be converted to JSON and sent to server
- set_settings - Load these settings. It should be the same JSON you returned in previous get_settings
You only need to implement the ones you need. See existing bots for examples.
Uses python logging facility to print information to the console. Customize it to your needs editing config/logging.yml.
See logging.config documentation for further information.
Use self.logger in your module to print information to the console.
Module settings are stored in Matrix account data.
If you want to send a m.text message that bot should always ignore, set "org.vranki.hemppa.ignore" property in the event. Bot will ignore events with this set. Set the bot_ignore parameter to True in sender functions to acheive this.
If you write a module that installs a custom message handler, use bot.should_ignore_event(event) to check if event should be ignored.
If you write a new module, please make a PR if it's something useful for others.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent