Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding new Plugin SIO Reaction #1277

Merged
merged 2 commits into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions _plugins/SIOReaction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
layout: plugin
id: SIOReaction
title: SIO Reaction
description: Sub Plugin for SIO Control. Create Reactions to changes in IO, GCode, and more.

authors:
- jcassel
license: AGPLv3
date: 2024-02-11
homepage: https://github.com/jcassel/OctoPrint-SIOReaction
source: https://github.com/jcassel/OctoPrint-SIOReaction
archive: https://github.com/jcassel/OctoPrint-SIOReaction/archive/main.zip

tags:
- SIOControl SubPlugin
- sio
- gpio
- rpio
- pc
- linux
- gpiostatus
- pin
- pins
- atx
- control
- io
- power
- estop
- subplugin
- gpiocontrol
- relay
- enclosure
- button
- filament
- usb
- serial
- rs232
- led
- windows


screenshots:
- url: /assets/img/plugins/SIOReaction/SettingsExample.png
alt: SIO Reaction Settings
caption: SIO Reaction Settings
- url: /assets/img/plugins/SIOReaction/HelpScrn.png
alt: SIO Reaction Settings
caption: SIO Reaction Settings


featuredimage: /assets/img/plugins/SIOReaction/SettingsExample.png

compatibility:
python: ">=3,<4"

---

#### The Companion plugIn for the SIO Control

A simple but powerful addition to the SIO Control PlugIn. With this Sub PlugIn you can make full use of inputs and outputs available though SIO Control PlugIn + hardware.

Reactions are what happen when an IO point changes. What should happen is up to you.

Do things like:
- Use a physical button to tell your machine to home or start to heat up for the print you will be sending soon.
- Push a physical button and have a connected relay turn on, off or toggle state.
- Push a physical button and send GCode to the OctoPrint GCode queue.
- Have a relay turn on when specific GCode is seen.
- If a limit switch is hit, send some GCode to the GCode queue.


## Install

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

https://github.com/jcassel/OctoPrint-SIOReaction/archive/main.zip
jneilliii marked this conversation as resolved.
Show resolved Hide resolved

You must have the [SIO Control PlugIn](https://plugins.octoprint.org/plugins/siocontrol/) installed for this to work.
jneilliii marked this conversation as resolved.
Show resolved Hide resolved

## Configuration / Setup

Setting up a Reaction is simple. Follow these steps.

- Add a new Reaction row to the settings dialog. Push the Blue [+] button.
- Name your Reaction.
- Select the configured SIO point to react to (ignored for GCode Command Reaction types).
- Select the type of Reaction __React To__
- __NONE__ Effectivly disables the Reaction
- __In Change__ React when this IO Input point changes state
- __In Active__ React when this IO Input point changes from Not Active to Active
- __In Not Active__ React when this IO Input point Changes from Active to Not Active
- __Out Change__ React when this IO Output point changes state
- __Out Active__ React when this IO Output point changes from Not Active to Active
- __Out Not Active__ React when this IO Output point changes from Active to Not Active
- __GCode Command__ React when a specific GCode command is detected.
Binary file added assets/img/plugins/SIOReaction/HelpScrn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading