https://github.com/cadair/octoprint-matrix-notifier-plugin

An octpront plugin for sending matrix notifications and snapshots.
https://github.com/cadair/octoprint-matrix-notifier-plugin

matrix octoprint octoprint-plugin

Last synced: 16 days ago
JSON representation

An octpront plugin for sending matrix notifications and snapshots.

• Host: GitHub
• URL: https://github.com/cadair/octoprint-matrix-notifier-plugin
• Owner: Cadair
• License: agpl-3.0
• Created: 2021-07-18T08:14:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T17:50:58.000Z (23 days ago)
• Last Synced: 2024-10-22T08:28:54.791Z (22 days ago)
• Topics: matrix, octoprint, octoprint-plugin
• Language: Python
• Homepage:
• Size: 366 KB
• Stars: 15
• Watchers: 3
• Forks: 8
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Matrix Notifier for OctoPrint

Send messages and snapshots to matrix rooms.

## Setup

Install via the bundled [Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)

or manually using this URL:

    https://github.com/Cadair/octoprint-matrix-notifier-plugin/archive/main.zip

## Configuration

The plugin can be configured via the octoprint UI. You will need the room alias or room id of the matrix room as well as your server address and an access token.

The easiest way to obtain an access token is to login with Element, copy the access token from the settings panel and then *do not logout*.

## Credits

This plugin is heavily inspired by [OctoSlack](https://github.com/fraschetti/Octoslack) and I used [Octoprint Signal Notifier](https://github.com/aerickson/OctoPrint_Signal-Notifier) to understand how to write an octoprint plugin and how to capture a snapshot from the camera.

## Developer Info

### Making a Release

1. Update the version number in `setup.py`, push to `main`.

1. Check the release draft on GitHub, make sure version number matches the

   `setup.py`.

1. Publish Release on GitHub.