Skip to content

Commit

Permalink
more asciidoc work
Browse files Browse the repository at this point in the history
  • Loading branch information
timschmidt committed Nov 3, 2010
1 parent ad994e8 commit 9e2cde1
Show file tree
Hide file tree
Showing 2 changed files with 232 additions and 20 deletions.
89 changes: 83 additions & 6 deletions doc/manual.asciidoc
Expand Up @@ -331,8 +331,91 @@ Printer settings Button

=== Display options tab ===



=== Print tab ===

Connect to printer::

Power on::

Print::

Pause::

Kick::

Fan on::

Voltage::

Errors::

Info::

Echo::

GCode send::
Text entry field allowing user to manually send individual commands to the printer.

==== Interactive control tab ====

Jog pannel::

Temperature update interval::

Switch heat on::

Current temp::

Target temp::

Run extruder::

Reverse::

Speed::

Length::

Downstream speed multiplier::

Downstream extrusion multiplier::

Custom buttons::
These buttons do nothing by default, but can be assigned custom strings of GCode to be sent to the printer when clicked.

==== Communication logs tab ====

Communication log::

Errors / warnings::

Echo::

Auto scroll::

Log Files::

Clear logs when print starts::

Clear logs now::
Clears the log window immediately

==== Custom buttons tab ====

Button to edit::
Select which button to edit.

Button Label::
User-editable text label for the selected custom button.

Save::
Assigns current GCode to the selected button.

Test::
Sends the current GCode to the printer.

== Use ==
=== Launching ===

Expand Down Expand Up @@ -469,9 +552,3 @@ Go back to the 'interactive control' tab.
* To run the extruder, once at temperature, set the speed slider (in mm/minute ?), the length (in mm ?) and click the 'Run extruder' button. It will run for the distance specified in 'Length'.

to run it again, you click 'Run Extruder' again, it will de-select, but the motor will run anyways.

Still trying to figure out:

* what the 'Downstream Multipliers' do.
* what the 'lua' thing is about.

163 changes: 149 additions & 14 deletions doc/manual.html
Expand Up @@ -921,6 +921,154 @@ <h3 id="_gcode_tab">3.4. GCode tab</h3><div style="clear:left"></div>
<div class="paragraph"><p>(elaborate)</p></div>
<h3 id="_display_options_tab">3.5. Display options tab</h3><div style="clear:left"></div>
<h3 id="_print_tab">3.6. Print tab</h3><div style="clear:left"></div>
<div class="dlist"><dl>
<dt class="hdlist1">
Connect to printer
</dt>
<dt class="hdlist1">
Power on
</dt>
<dt class="hdlist1">
Print
</dt>
<dt class="hdlist1">
Pause
</dt>
<dt class="hdlist1">
Kick
</dt>
<dt class="hdlist1">
Fan on
</dt>
<dt class="hdlist1">
Voltage
</dt>
<dt class="hdlist1">
Errors
</dt>
<dt class="hdlist1">
Info
</dt>
<dt class="hdlist1">
Echo
</dt>
<dt class="hdlist1">
GCode send
</dt>
<dd>
<p>
Text entry field allowing user to manually send individual commands to the printer.
</p>
</dd>
</dl></div>
<h4 id="_interactive_control_tab">3.6.1. Interactive control tab</h4>
<div class="dlist"><dl>
<dt class="hdlist1">
Jog pannel
</dt>
<dt class="hdlist1">
Temperature update interval
</dt>
<dt class="hdlist1">
Switch heat on
</dt>
<dt class="hdlist1">
Current temp
</dt>
<dt class="hdlist1">
Target temp
</dt>
<dt class="hdlist1">
Run extruder
</dt>
<dt class="hdlist1">
Reverse
</dt>
<dt class="hdlist1">
Speed
</dt>
<dt class="hdlist1">
Length
</dt>
<dt class="hdlist1">
Downstream speed multiplier
</dt>
<dt class="hdlist1">
Downstream extrusion multiplier
</dt>
<dt class="hdlist1">
Custom buttons
</dt>
<dd>
<p>
These buttons do nothing by default, but can be assigned custom strings of GCode to be sent to the printer when clicked.
</p>
</dd>
</dl></div>
<h4 id="_communication_logs_tab">3.6.2. Communication logs tab</h4>
<div class="dlist"><dl>
<dt class="hdlist1">
Communication log
</dt>
<dt class="hdlist1">
Errors / warnings
</dt>
<dt class="hdlist1">
Echo
</dt>
<dt class="hdlist1">
Auto scroll
</dt>
<dt class="hdlist1">
Log Files
</dt>
<dt class="hdlist1">
Clear logs when print starts
</dt>
<dt class="hdlist1">
Clear logs now
</dt>
<dd>
<p>
Clears the log window immediately
</p>
</dd>
</dl></div>
<h4 id="_custom_buttons_tab">3.6.3. Custom buttons tab</h4>
<div class="dlist"><dl>
<dt class="hdlist1">
Button to edit
</dt>
<dd>
<p>
Select which button to edit.
</p>
</dd>
<dt class="hdlist1">
Button Label
</dt>
<dd>
<p>
User-editable text label for the selected custom button.
</p>
</dd>
<dt class="hdlist1">
Save
</dt>
<dd>
<p>
Assigns current GCode to the selected button.
</p>
</dd>
<dt class="hdlist1">
Test
</dt>
<dd>
<p>
Sends the current GCode to the printer.
</p>
</dd>
</dl></div>
</div>
<h2 id="_use">4. Use</h2>
<div class="sectionbody">
Expand Down Expand Up @@ -1218,23 +1366,10 @@ <h3 id="_launching">4.1. Launching</h3><div style="clear:left"></div>
</div></div>
</li>
</ul></div>
<div class="paragraph"><p>Still trying to figure out:</p></div>
<div class="ulist"><ul>
<li>
<p>
what the <em>Downstream Multipliers</em> do.
</p>
</li>
<li>
<p>
what the <em>lua</em> thing is about.
</p>
</li>
</ul></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2010-11-03 06:12:51 EDT
Last updated 2010-11-03 06:27:17 EDT
</div>
</div>
</body>
Expand Down

0 comments on commit 9e2cde1

Please sign in to comment.