-
Notifications
You must be signed in to change notification settings - Fork 343
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding new Plugin SIO Reaction (#1277)
* Adding new Plugin SOIReaction (Sub-Plugin for SIO Control) to the repository. * Corrected the date as pointed out in commens on MR
- Loading branch information
Showing
3 changed files
with
97 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
You must have the [SIO Control PlugIn](https://plugins.octoprint.org/plugins/siocontrol/) installed for this to work. | ||
|
||
## 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. |
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.