https://github.com/scottgibb/led-strip-controller-octoprint

A collection of simple scripts for octoprint to along with the LED Strip Controller Project.
https://github.com/scottgibb/led-strip-controller-octoprint

led octolapse octoprint python scripts shell telegram

Last synced: about 1 month ago
JSON representation

A collection of simple scripts for octoprint to along with the LED Strip Controller Project.

• Host: GitHub
• URL: https://github.com/scottgibb/led-strip-controller-octoprint
• Owner: ScottGibb
• License: gpl-3.0
• Created: 2023-08-18T23:56:24.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-28T14:23:42.000Z (almost 3 years ago)
• Last Synced: 2025-01-23T18:50:25.927Z (over 1 year ago)
• Topics: led, octolapse, octoprint, python, scripts, shell, telegram
• Language: Python
• Homepage:
• Size: 1.96 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Octoprint LED Strip Controller Integration Script

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![MegaLinter](https://github.com/ScottGibb/LED-Strip-Controller-Octoprint/actions/workflows/mega_linter.yaml/badge.svg)](https://github.com/ScottGibb/LED-Strip-Controller-Octoprint/actions/workflows/mega_linter.yaml) [![release-please](https://github.com/ScottGibb/LED-Strip-Controller-Octoprint/actions/workflows/release_please.yaml/badge.svg)](https://github.com/ScottGibb/LED-Strip-Controller-Octoprint/actions/workflows/release_please.yaml)

![Languages and Tools](docs/Languages_and_Tools.png)

## Summary

This repository contains the scripts necessary for the integration of the LED Strip Controller project into Octoprint. The architecture of the system is such that a Python Script is used to control the LEDs assigned to the 3D printer shelf over an IP socket. This Python script can be called directly

from the Telegram Plugin linked below, however, the Octolapse plugin does not interact with python scripts. Therefore basic bash scripts are used to call the python script and the bash script is called by Octolapse.

## System Architecture

The architecture of the system as of the 28/08/2023 is shown below:

![System Architecture](docs/System_Architecture.png)

## Repository Structure

At the moment the project requires the communications python code which is copied directly from the software repository, this should be replaced with a submodule in the future. Which uses Google Brotobuff for multiple language support.

## Octoprint Links

- [Octoprint](https://octoprint.org/)

- [Telegram Plugin](https://plugins.octoprint.org/plugins/telegram/)

- [Octolapse Plugin](https://plugins.octoprint.org/plugins/octolapse/)

## LED Strip Controller Repository Links

The rest of the LED Strip Controller project can be found at the following links:

- [Manifest](https://github.com/ScottGibb/LED-Strip-Controller-Manifest) This repository contains the manifest file for the LED Strip Controller project. Which allows the cloning of all the repositories in one go.

- [Hardware](https://github.com/ScottGibb/LED-Strip-Controller-Hardware) This repository contains the hardware design files for the LED Strip Controller project.

- [Firmware](https://github.com/ScottGibb/LED-Strip-Controller-Firmware) This repository contains the firmware for the LED Strip Controller project.

- [Software](https://github.com/ScottGibb/LED-Strip-Controller-Software) This repository contains the software for the LED Strip Controller project.