Skip to content

An Octoprint monitor using the Adafruit Matrix Portal display.

License

Notifications You must be signed in to change notification settings

Wintaru/OctoMatrixPortal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 

Repository files navigation


OctoMatrixPortal

An Octoprint monitor using the Adafruit Matrix Portal display.

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License
  6. Contact

About The Project

product image

I wanted a way to monitor my printer in the other room at a glance and the Adafruit Matrix Portal is a great way to do just that!

Built With

There are myriad guides for getting Octoprint going, I run mine on a RaspberryPI 3, and the DisplayLayerProgress plugin is easy to find an enable once you have your octoprint instance going.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • A running instance of OctoPi connected to your printer
  • The DisplayLayerProgress plugin installed and enabled

Installation

  1. Connect your MatrixPortal to your computer, you may need to perform additional steps to get it ready for use (see Adafruit's wonderful guides).
  2. Copy code.py to your CIRCUITPYTHON drive
  3. Set up your secrets.py

Secrets

Aside from the usual things that your MatrixPortal will need in the secrets file (ssid, password, timezone), you will also need two additional settings.

  • octopi_host

  • octopi_api_key

    • This is a key you need to get, it is in your OctoPi's settings under API, Global API Key.

Usage

There are a few different configurations you can make:

ETA

The ETA defaults to being shown as the expected time of completion in 12h format. If you set USE_TWELVE_HOUR_FORMAT to false it will display using 24h format. If you set SHOW_ETA_AS_TIME to false it will instead show you how many Days/Hours/Minutes are left until the print is expected to be done. Note that these are estimates and will change as the print goes on.

Display Colors

There are 3 variables that let you change the display colors: TOP_ROW_COLOR, MID_ROW_COLOR and BOT_ROW_COLOR. Also included are helper color variables for standard web colors.

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Josh Donner - @wintaru - joshua.j.donner@gmail.com

Project Link: https://github.com/Wintaru/OctoMatrixPortal

About

An Octoprint monitor using the Adafruit Matrix Portal display.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages