Skip to content

Commit

Permalink
minor updates version# formatting of Setup.pu and text in help tab.
Browse files Browse the repository at this point in the history
  • Loading branch information
jcassel committed Feb 5, 2024
1 parent cee410f commit 7bc0a00
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 3 deletions.
42 changes: 40 additions & 2 deletions octoprint_SIOReaction/templates/sioreaction_settings.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,54 @@
<h3>SIO Reaction Settings</h3>
<ul class="nav nav-tabs" id="siocontrol_tabs">
<li class="active"><a data-toggle="tab" href="#SIOReactions">Reactions</a></li>
<!--<li><a data-toggle="tab" href="#Testing">Testing</a></li>-->
<li><a data-toggle="tab" href="#sior_Help">Help</a></li>
</ul>
<div class="tab-content">
<div id="sior_Help" class="tab-pane">
<div class="row-fluid">
Each reaction is run seperatly and each line in the commans of the Reaction is run seperately. They are run in the order that they are entered into the list.
You can add more than one reaction for the same IO point. GCODE reactions ignore the IO# (pin) setting and use the first line in the command list as the gcode
used to trigger the reaction.
</div>
<div class="row-fluid">
<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.
</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">IO supported actions 'on','off', and 'toggle'</div>
<div class="span12"></div>
<div class="span12">"GC": Send GCode to GCode queue. </div>
<div class="span12">
<div class="span4">Example (sends gcode to gcode queue):</div><div class="span8 border"><strong>GC M118 Text for Printer</strong></div>
</div>
<div class="span12"></div>
<div class="span12">React to sent GCode</div>
<div class="span12">
<div class="span4">Example (detects gcode "M80" was sent to OctoPrint and turns on IO pin 11):</div><div class="span8 border"><strong>M80<br/>IO 11 on</strong></div>
</div>
<div class="span12"></div>



</div>
</div>

<div id="SIOReactions" class="tab-pane active" >
<div class="span12 ">
<div class="row-fluid">
Add a row below for each reaction you want to create.
</div>
<div class="row-fluid">
You can add multiple commands to a reaction. One command per line.
You can add multiple commands to a reaction. One command per line. When configuring GCode Command reactions, the first command must be the GCode that the reaction will react to.
Command Lines must follow proper prefixing and format (See Help Tab).
</div>
</div>
<div class="span12 ">
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
plugin_package = "octoprint_SIOReaction"
plugin_name = "SIO Reaction"
plugin_version = "0.1.0"
plugin_description = "Sub Plugin for SIO Control (v1+). Allows configuration of reactions to events like IO changes, gcode and more."
plugin_description = "Sub Plugin for SIO Control (v1+). Create reactions to changes in IO, GCode, and more."
plugin_author = "jcassel"
plugin_author_email = "[email protected]"
plugin_url = "https://github.com/jcassel/OctoPrint-SIOReaction"
Expand Down

0 comments on commit 7bc0a00

Please sign in to comment.