Skip to content

Commit

Permalink
Merge pull request #2 from jcassel/DHTReactions
Browse files Browse the repository at this point in the history
Update to 0.1.6, update to documentation.
  • Loading branch information
jcassel committed Apr 8, 2024
2 parents 585d7c5 + fdf0fa4 commit b875e92
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 5 deletions.
6 changes: 5 additions & 1 deletion README.md
Expand Up @@ -40,7 +40,11 @@ Setting up a Reaction is simple. Follow these steps.
- __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.


Note that when creating a reaction the format must follow a few rules.
- All key words are case sensitive.
- on, off, toggle, IO, GC, WT are all key words used when creating a reaction.
- When identifying an IO Point, it must be 2 characters in length. Example: IO point 1 is "01"

## UI Samples
![Settings](/assets/img/SettingsExample.png)
Expand Down
8 changes: 6 additions & 2 deletions octoprint_SIOReaction/templates/sioreaction_settings.jinja2
Expand Up @@ -18,15 +18,19 @@
<h4>Command formating:</h4>
</div>
<div class="row-fluid">
One command per new line in the command text box. Each command line must be prefixed with
2 characters that indicate what type of command it is.
One command per new line in the command text box.
Each command line must be prefixed with 2 characters that indicate what type of command it is.
When using IO point numbers, you must use 2 digits. IO1 would be IO 01.
</div>
<div class="row-fluid">
<div class="span12"></div>
<div class="span12">"IO": Manupulate an IO point. This is only valid for configured output types.</div>
<div class="span12">
<div class="span4">Example (turns on IO point 11):</div><div class="span8 border"><strong>IO 11 on</strong></div>
</div>
<div class="span12">
<div class="span4">Example (toggles IO point 3):</div><div class="span8 border"><strong>IO 03 toggle</strong></div>
</div>
<div class="span12">IO supported actions 'on','off', and 'toggle'</div>
<div class="span12"></div>
<div class="span12">"GC": Send GCode to GCode queue. </div>
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Expand Up @@ -5,13 +5,13 @@
plugin_identifier = "SIOReaction"
plugin_package = "octoprint_SIOReaction"
plugin_name = "SIO Reaction"
plugin_version = "0.1.5"
plugin_version = "0.1.6"
plugin_description = "Sub Plugin for SIO Control (v1+). Create reactions to changes in IO, GCode, and more."
plugin_author = "jcassel"
plugin_author_email = "jcassel@softwaresedge.com"
plugin_url = "https://github.com/jcassel/OctoPrint-SIOReaction"
plugin_license = "AGPLv3"
# plugin_requires = []
#plugin_requires = []
plugin_requires = ["SIO-Control@https://github.com/jcassel/OctoPrint-Siocontrol/archive/main.zip"]
plugin_additional_data = []
plugin_additional_packages = []
Expand Down

0 comments on commit b875e92

Please sign in to comment.