Giter Club home page Giter Club logo

matta-labs / moonraker-mattaos Goto Github PK

View Code? Open in Web Editor NEW
7.0 2.0 1.0 119 KB

Connect your Klipper printer to MattaOS and join us in creating AI-powered closed-loop control for 3D printing. As a bonus, securely access and control your machines from anywhere whilst using the latest in AI error detection.

Home Page: https://matta.ai

License: GNU Affero General Public License v3.0

Python 81.10% Shell 8.56% JavaScript 6.23% CSS 1.58% HTML 1.79% Dockerfile 0.75%
3d-printing ai artificial-intelligence error-detection machine-learning ml moonraker klipper-plugin

moonraker-mattaos's Introduction

Matta Logo

MattaOS for Klipper

Connect your Klipper-enabled printers to MattaOS, for remote control, AI-powered error detection, fleet management, and more!

๐Ÿง About

The plugin allows users to control their printers using our intuitive web-interface, MattaOS. MattaOS brings Matta's data engine to Klipper, managing printer and webcam data, enabling next-level AI error detection and print job inspection. All that is required is a simple nozzle camera, and a 3D printer running Klipper.

Matta is working towards building full AI-powered closed-loop control of 3D printing, enabling perfect quality, every time. By being an early user of our software, you help us build towards this goal!

โœจ Features

  • ๐Ÿ›œ Remote printer control via MattaOS, our intuitive web-interface.
  • โšก๏ธ Advanced error detection using Matta's cutting-edge AI.
  • ๐Ÿ“ˆ Keep track of your printing operations with printer analytics.
  • ๐Ÿ‘€ G-code viewer and analysis.
  • โš™๏ธ Controllable failure behaviour (notify, pause, stop).

Monitoring a print with MattaOS


๐Ÿš€ Plugin Installation

Before installing, please ensure you have Moonraker, the Python 3 based web server for communcation with Klipper, installed on your Pi. Moonraker comes pre-installed with both the MainsailOS and Fluidd Raspberry Pi images. If you do not have Moonraker installed, you can find the installation guide here.

We highly recommend using the MattaOS plugin with the MainsailOS Raspberry Pi image (available through the Raspberry Pi Imager).

It has also been tested on RaspberryPi OS wth KIAUH-installed prerequisites, but to a lesser extent.

Note: We, like others, have experienced Crowsnest breaking after updating packages. Recompile Crowsnest as per KwadFan's comment here to fix.

There are number of ways to install the plugin, please see below:

Download zip from URL

Copy the following URL to the latest version of Matta OS's OctoPrint plugin:

wget https://github.com/Matta-Labs/moonraker-mattaos/archive/refs/heads/main.zip
unzip ~/main.zip && mv ~/moonraker-mattaos-main ~/moonraker-mattaos
rm ~/main.zip

Install the plugin:

cd ~/moonraker-mattaos
bash install.sh

Note: if you have issues running the install.sh file run chmod +x ./install.sh.

Check the plugin is running with:

sudo systemctl status moonraker-mattaos

If not, start it manually with:

sudo systemctl enable moonraker-mattaos        
sudo systemctl daemon-reload
sudo systemctl start moonraker-mattaos  
sudo systemctl status moonraker-mattaos 

โœจ Thats it! Now the MattaOS plugin should be installed.

To uninstall, use the uninstall.sh script:

cd ~/moonraker-mattaos
./uninstall.sh

Note: if you have issues running the uninstall.sh file run chmod +x ./uninstall.sh.

Transfer plugin from computer

First, clone this repository onto your computer, then:

cd moonraker-mattaos
scp -r "../moonraker-mattaos" "<piusername@pihostname>:~/moonraker-mattaos"
rsync -avh "../moonraker-mattaos/." "<piusername@pihostname>:~/moonraker-mattaos/."

SSH into your Pi, then install the plugin with the install.sh script:

cd ~/moonraker-mattaos
./install.sh

Note: if you have issues running the install.sh file run chmod +x ./install.sh.

Check the plugin is running with:

sudo systemctl status moonraker-mattaos

If not, start it manually with:

sudo systemctl enable moonraker-mattaos        
sudo systemctl daemon-reload
sudo systemctl start moonraker-mattaos  
sudo systemctl status moonraker-mattaos 

โœจ Thats it! Now the MattaOS plugin should be installed.

To uninstall, use the uninstall.sh script:

cd ~/moonraker-mattaos
./uninstall.sh

Note: if you have issues running the uninstall.sh file run chmod +x ./uninstall.sh.

Clone onto Pi via SSH

At first, you need to access the Raspberry Pi connected to the 3D printer which is running Klipper. This best way to do this is via ssh, e.g.

Note: the default username for Pis is pi.
Note: the default password for Pis is raspberry it should probably be changed if it is still the password.

git clone https://github.com/Matta-Labs/moonraker-mattaos.git
cd ~/moonraker-mattaos
bash install.sh

Note: if you have issues running the install.sh file run chmod +x ./install.sh.

Check the plugin is running with:

sudo systemctl status moonraker-mattaos

If not, start it manually with:

sudo systemctl enable moonraker-mattaos        
sudo systemctl daemon-reload
sudo systemctl start moonraker-mattaos  
sudo systemctl status moonraker-mattaos 

โœจ Thats it! Now the MattaOS plugin should be installed.

To uninstall, use the uninstall.sh script:

cd ~/moonraker-mattaos
./uninstall.sh

Note: if you have issues running the uninstall.sh file run chmod +x ./uninstall.sh.

๐Ÿ“ธ Nozzle Cameras

If you don't already have a nozzle camera installed, check our our camera-mounts repository to aid installation.

Also please feel free to contribute your own nozzle camera designs to the repo!

๐ŸŽˆ Usage and Configuration

Note: The plugin will only work if your Klipper-Moonraker-Frontend stack are working correctly. Please refer to the respective documentation to ensure this is the case

First sign-up for a free Matta account at https://os.matta.ai, then configure plugin settings to get started!

Create a new machine in MattaOS, copy the generated Authorisation token, then add this to the moonraker-mattaos.cfg file in your Pi, or using the helpful Mainsail config file editor. Then reboot your Pi with sudo reboot, or the restart the plugin using the power options in Mainsail.


Machine setup and plugin configuration workflow


Next go to http://<hostname>:5001 and follow the instructions to locate your extruder nozzle tip.


Nozzle coordinates finder usage


In moonraker-mattaos.cfg there are a few variables which need to be configured for use:

Mandatory configuration variables

Authorisation token (from MattaOS)
  1. Create a printer in MattaOS.
  2. Copy the Authorisation token from the new printer's setup page.
  3. Paste this into the auth_token variable in moonraker-mattaos.cfg
  4. Restart the plugin or reboot your Pi to connect!

WebRTC Stream URL*

This is the streaming URL of your nozzle-cam streamer. The plugin only supports WebRTC streaming. The default value should be fine.

This will be http://localhost/webcam/webrtc


Camera Snapshot URL*

This is the snapshot URL of your nozzle-cam streamer. The default value should be fine.

This will be http://localhost/webcam/?action=snapshot


Other configuration variables

Nozzle tip coordinates

These are set via using the nozzle finder application at http://<hostname>:5001.
Alternatively, if you know the coordinates of the nozzle tip in your images, you can set them manually here.

Webcam controls

These variables allow you to flip and rotate your webcam footage (for example if you have a camera mounted on its side for ease of integration).


Simply set these values to true or false, and see the changes reflected in the saved images in your MattaOS job history.



*required for AI-powered error detection


๐Ÿ”ท More About Matta

Matta info

At Matta, we are building AI to push the boundaries of manufacturing. We train neural networks using vision to become manufacturing copilots, enabling next-generation error correction, material qualitification and part QC.

Check out the demo of our first-iteration AI, Grey-1


๐Ÿ“ž Contact

Team Matta - @mattalabs - [email protected]

Project Link: https://github.com/Matta-Labs/moonraker-mattaos

(back to top)

moonraker-mattaos's People

Contributors

dougbrion avatar jet-tong avatar paralelopipet avatar tom-walkr avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

fernandopal

moonraker-mattaos's Issues

WebRTC does not working when installed within RaspberryPi OS

All plugin functionality works as expected when installing the prerequisites using KIAUH into a Raspberry Pi OS machine. However, WebRTC streaming does not work.

The camera-streamer is online, and all other features work (snapshot, stream, etc.)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.