An open API service indexing awesome lists of open source software.

https://github.com/seven-io/octoprint

Send SMS after OctoPrint job has finished.
https://github.com/seven-io/octoprint

octoprint octoprint-plugin seven-plugin

Last synced: 4 days ago
JSON representation

Send SMS after OctoPrint job has finished.

Awesome Lists containing this project

README

          


seven logo

seven SMS for OctoPrint


Send an SMS via the seven gateway when an OctoPrint print job finishes.


MIT License
OctoPrint 1.5+
Python 3.7+

---

## Features

- **Job-Completion SMS** - Get notified when a print finishes (success or fail)
- **Templated Body** - Customise the SMS text with placeholders for printer name and status
- **Flash SMS Support** - Optional flash messages that bypass the recipient's inbox

Forked from [`OctoPrint-EmailNotifier`](https://github.com/anoved/OctoPrint-EmailNotifier).

## Prerequisites

- [OctoPrint](https://octoprint.org/) 1.5 or newer
- A [seven account](https://www.seven.io/) with API key ([How to get your API key](https://help.seven.io/en/developer/where-do-i-find-my-api-key))

## Installation

### Plugin Manager (recommended)

Open the bundled [Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html) and install from URL:

```
https://github.com/seven-io/octoprint/archive/master.zip
```

### Manual

Download the [latest release](https://github.com/seven-io/octoprint/archive/master.zip), unpack it into your OctoPrint plugins directory and restart OctoPrint.

## Configuration

After install, go to **Settings > Plugins > seven** and configure:

| Field | Description |
|-------|-------------|
| `api_key` | seven API key (required) |
| `enabled` | Master switch for the plugin |
| `flash` | Send as [flash SMS](https://help.seven.io/en/flash-sms) |
| `message_template` | SMS body. Supports placeholders for printer name / status |
| `printer_name` | Identifier used inside `message_template` |
| `recipients` | Comma-separated list of recipient phone numbers |
| `sender` | Sender ID. Up to 11 alphanumeric or 16 numeric characters |

## Support

Need help? Feel free to [contact us](https://www.seven.io/en/company/contact/) or [open an issue](https://github.com/seven-io/octoprint/issues).

## License

[MIT](LICENSE)