Skip to content

Commit

Permalink
add horizontal rules in reference
Browse files Browse the repository at this point in the history
  • Loading branch information
bsubbaraman committed Oct 29, 2024
1 parent 37cdf87 commit 51f9ad8
Show file tree
Hide file tree
Showing 20 changed files with 107 additions and 51 deletions.
43 changes: 37 additions & 6 deletions content/docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ A `fab` object represents a 3D printer. It is comprised of the following informa
### Parameters
- config: a json object specifying requisite machine information

---

## autoHome
Autohome the machine (with a `G28` command) and zero the extruder position (with a `G92 E0` command).

Expand All @@ -25,6 +27,7 @@ Autohome the machine (with a `G28` command) and zero the extruder position (with
### Parameters
None

---

## setNozzleT
Set the printer's nozzle temperature. By default, this command will wait for the nozzle temperature to reach the target temperature.
Expand All @@ -38,6 +41,7 @@ Most firmware won't wait for temperatures less than 40C since they will never be
- temperature: Number, the temperature to heat the nozzle to in degrees Celcius
- wait: Boolean, optional parameter to wait for the target temperature to be reached before proceeding. True by default.

---

## setBedT
Set the printer's bed temperature. By default, this command will wait for the bed temperature to reach the target temperature.
Expand All @@ -51,6 +55,8 @@ Most firmware won't wait for temperatures less than 40C since they will never be
- temperature: Number, the temperature to heat the bed to in degrees Celcius
- wait: Boolean, optional parameter to wait for the target temperature to be reached before proceeding. True by default.

---

## setTemps
Set the printer nozzle and bed temperature at the same time. By default, this command will wait for the temperatures to reach the target temperature. This command is faster than setting the nozzle and bed temperatures independently, as both will heat simultaneously.

Expand All @@ -64,6 +70,8 @@ Most firmware won't wait for temperatures less than 40C since they will never be
- bedTemperature: Number, the temperature to heat the bed to in degrees Celcius
- wait: Boolean, optional parameter to wait for the target temperature to be reached before proceeding. True by default.

---

## moveTo
Move directly to an absolute (x,y,z) position without extruding material.

Expand All @@ -76,6 +84,8 @@ Move directly to an absolute (x,y,z) position without extruding material.
- z: Number, the z position to move to (in current units, mm by default)
- v: Number, optional, the speed to move at (in current units/sec, 25 mm/sec by default)

---

## moveToX
Move directly to an absolute X position without extruding material.

Expand All @@ -86,6 +96,8 @@ Move directly to an absolute X position without extruding material.
- x: Number, the x position to move to (in current units, mm by default)
- v: Number, optional, the speed to move at (in current units/sec, 25 mm/sec by default)

---

## moveToY
Move directly to an absolute Y position without extruding material.

Expand All @@ -96,6 +108,8 @@ Move directly to an absolute Y position without extruding material.
- y: Number, the y position to move to (in current units, mm by default)
- v: Number, optional, the speed to move at (in current units/sec, 25 mm/sec by default)

---

## moveToZ
Move directly to an absolute Z position without extruding material.

Expand All @@ -106,6 +120,8 @@ Move directly to an absolute Z position without extruding material.
- z: Number, the z position to move to (in current units, mm by default)
- v: Number, optional, the speed to move at (in current units/sec, 25 mm/sec by default)

---

## moveToE
Move directly to an absolute E position.

Expand All @@ -116,12 +132,22 @@ Move directly to an absolute E position.
- e: Number, the e position to move to (in current units, mm by default)
- v: Number, optional, the speed to move at (in current units/sec, 25 mm/sec by default)

---

## move
Move relative to the current position without extruding material.

### Syntax
```fab.move(dx, dy, dz, [velocity])```

### Parameters
- dx: Number, the relative x distance to move (in current units, mm by default)
- dy: Number, the relative y distance to move (in current units, mm by default)
- dz: Number, the relative z distance to move (in current units, mm by default)
- v: Number, optional, the speed to move at (in current units/sec, 25 mm/sec by default)

---

## moveX
Move in X relative to the current position without extruding material.

Expand All @@ -132,6 +158,8 @@ Move in X relative to the current position without extruding material.
- dx: Number, the relative x distance to move (in current units, mm by default)
- v: Number, optional, the speed to move at (in current units/sec, 25 mm/sec by default)

- dx: Number, the relative x distance to move (in current units, mm by default)

## moveY
Move in Y relative to the current position without extruding material.

Expand All @@ -142,6 +170,8 @@ Move in Y relative to the current position without extruding material.
- dy: Number, the relative y distance to move (in current units, mm by default)
- v: Number, optional, the speed to move at (in current units/sec, 25 mm/sec by default)

---

## moveZ
Move in Z relative to the current position without extruding material.

Expand All @@ -152,6 +182,8 @@ Move in Z relative to the current position without extruding material.
- dz: Number, the relative z distance to move (in current units, mm by default)
- v: Number, optional, the speed to move at (in current units/sec, 25 mm/sec by default)

---

## moveE
Move in E relative to the current position.

Expand All @@ -162,12 +194,7 @@ Move in E relative to the current position.
- de: Number, the relative e distance to move (in current units, mm by default)
- v: Number, optional, the speed to move at (in current units/sec, 25 mm/sec by default)


### Parameters
- dx: Number, the relative x distance to move(in current units, mm by default)
- dy: Number, the relative y position to move (in current units, mm by default)
- dz: Number, the relative z position to move (in current units, mm by default)
- x: Number, optional, the speed to move at (in current units/sec, 25 mm/sec by default)
---

## travelTo
Travel directly to an absolute (x,y,z) position with a z-hop (popping the nozzle away from the bed before moving, and restoring z position upon arrival), without extruding material.
Expand All @@ -183,6 +210,8 @@ The hop distance is set in the current working units, and is 2mm by default. Edi
- z: Number, the z position to move to (in current units, mm by default)
- v: Number, optional, the speed to move at (in current units/sec, 25 mm/sec by default)

---

## moveExtrude
Move directly to an absolute (x,y,z) position while extruding material. Default extrusion amounts are calculated if not specified.

Expand All @@ -197,3 +226,5 @@ Move directly to an absolute (x,y,z) position while extruding material. Default
- extrusion: Number, optional. Interpreted as either (a) the total amount of filament to be deposited over the move, or (b) a multiplication value to modify default caluclations, depending on value of `[multiplication]` parameter
- multiplication: Boolean, optional. If true, `extrusion` value is used as a multiplication modifier to default extrusion calculation. If fase, `extrusion` value is used a total amount of filament to deposit in mm. False by default.

---

2 changes: 1 addition & 1 deletion public/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<link rel="canonical" href="http://localhost:1313/404.html">
<link rel="stylesheet" href="/book.min.407d69d0a45364c0178383056043dffb34da6b2423d90861313ca049cea737e1.css" integrity="sha256-QH1p0KRTZMAXg4MFYEPf&#43;zTaayQj2QhhMTygSc6nN&#43;E=" crossorigin="anonymous">
<script defer src="/flexsearch.min.js"></script>
<script defer src="/en.search.min.13115b1c563b615482806aa6fff9aa2366b06f9c34789e34bcccda444b8c7825.js" integrity="sha256-ExFbHFY7YVSCgGqm//mqI2awb5w0eJ40vMzaREuMeCU=" crossorigin="anonymous"></script>
<script defer src="/en.search.min.b726de4a7cd71eac112295f5b0dda153259418c24b72f8010adbac418098455f.js" integrity="sha256-tybeSnzXHqwRIpX1sN2hUyWUGMJLcvgBCtusQYCYRV8=" crossorigin="anonymous"></script>
<!--
Made with Book Theme
https://github.com/alex-shpak/hugo-book
Expand Down
2 changes: 1 addition & 1 deletion public/categories/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<link rel="canonical" href="http://localhost:1313/categories/">
<link rel="stylesheet" href="/book.min.407d69d0a45364c0178383056043dffb34da6b2423d90861313ca049cea737e1.css" integrity="sha256-QH1p0KRTZMAXg4MFYEPf&#43;zTaayQj2QhhMTygSc6nN&#43;E=" crossorigin="anonymous">
<script defer src="/flexsearch.min.js"></script>
<script defer src="/en.search.min.13115b1c563b615482806aa6fff9aa2366b06f9c34789e34bcccda444b8c7825.js" integrity="sha256-ExFbHFY7YVSCgGqm//mqI2awb5w0eJ40vMzaREuMeCU=" crossorigin="anonymous"></script>
<script defer src="/en.search.min.b726de4a7cd71eac112295f5b0dda153259418c24b72f8010adbac418098455f.js" integrity="sha256-tybeSnzXHqwRIpX1sN2hUyWUGMJLcvgBCtusQYCYRV8=" crossorigin="anonymous"></script>
<link rel="alternate" type="application/rss+xml" href="http://localhost:1313/categories/index.xml" title="p5.fab" />
<!--
Made with Book Theme
Expand Down
2 changes: 1 addition & 1 deletion public/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<link rel="canonical" href="http://localhost:1313/docs/">
<link rel="stylesheet" href="/book.min.407d69d0a45364c0178383056043dffb34da6b2423d90861313ca049cea737e1.css" integrity="sha256-QH1p0KRTZMAXg4MFYEPf&#43;zTaayQj2QhhMTygSc6nN&#43;E=" crossorigin="anonymous">
<script defer src="/flexsearch.min.js"></script>
<script defer src="/en.search.min.13115b1c563b615482806aa6fff9aa2366b06f9c34789e34bcccda444b8c7825.js" integrity="sha256-ExFbHFY7YVSCgGqm//mqI2awb5w0eJ40vMzaREuMeCU=" crossorigin="anonymous"></script>
<script defer src="/en.search.min.b726de4a7cd71eac112295f5b0dda153259418c24b72f8010adbac418098455f.js" integrity="sha256-tybeSnzXHqwRIpX1sN2hUyWUGMJLcvgBCtusQYCYRV8=" crossorigin="anonymous"></script>
<link rel="alternate" type="application/rss+xml" href="http://localhost:1313/docs/index.xml" title="p5.fab" />
<!--
Made with Book Theme
Expand Down
2 changes: 1 addition & 1 deletion public/docs/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<link>http://localhost:1313/docs/reference/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://localhost:1313/docs/reference/</guid>
<description>Reference # Full reference incoming&amp;hellip;</description>
<description>Reference # Fab # A class to describe a fabrication machine.&#xA;A fab object represents a 3D printer. It is comprised of the following information:&#xA;workEnvelope: maximum X, Y, and Z dimensions of the machine nozzleDiameter: Diameter of the nozzle in mm filamentDiameter: Diameter of filament in mm name: a human readable string to identify this machine Syntax # fab([config])&#xA;Parameters # config: a json object specifying requisite machine information autoHome # Autohome the machine (with a G28 command) and zero the extruder position (with a G92 E0 command).</description>
</item>
</channel>
</rss>
2 changes: 1 addition & 1 deletion public/docs/machine-compatibility/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<link rel="canonical" href="http://localhost:1313/docs/machine-compatibility/">
<link rel="stylesheet" href="/book.min.407d69d0a45364c0178383056043dffb34da6b2423d90861313ca049cea737e1.css" integrity="sha256-QH1p0KRTZMAXg4MFYEPf&#43;zTaayQj2QhhMTygSc6nN&#43;E=" crossorigin="anonymous">
<script defer src="/flexsearch.min.js"></script>
<script defer src="/en.search.min.13115b1c563b615482806aa6fff9aa2366b06f9c34789e34bcccda444b8c7825.js" integrity="sha256-ExFbHFY7YVSCgGqm//mqI2awb5w0eJ40vMzaREuMeCU=" crossorigin="anonymous"></script>
<script defer src="/en.search.min.b726de4a7cd71eac112295f5b0dda153259418c24b72f8010adbac418098455f.js" integrity="sha256-tybeSnzXHqwRIpX1sN2hUyWUGMJLcvgBCtusQYCYRV8=" crossorigin="anonymous"></script>
<!--
Made with Book Theme
https://github.com/alex-shpak/hugo-book
Expand Down
2 changes: 1 addition & 1 deletion public/docs/quickstart/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<link rel="canonical" href="http://localhost:1313/docs/quickstart/">
<link rel="stylesheet" href="/book.min.407d69d0a45364c0178383056043dffb34da6b2423d90861313ca049cea737e1.css" integrity="sha256-QH1p0KRTZMAXg4MFYEPf&#43;zTaayQj2QhhMTygSc6nN&#43;E=" crossorigin="anonymous">
<script defer src="/flexsearch.min.js"></script>
<script defer src="/en.search.min.13115b1c563b615482806aa6fff9aa2366b06f9c34789e34bcccda444b8c7825.js" integrity="sha256-ExFbHFY7YVSCgGqm//mqI2awb5w0eJ40vMzaREuMeCU=" crossorigin="anonymous"></script>
<script defer src="/en.search.min.b726de4a7cd71eac112295f5b0dda153259418c24b72f8010adbac418098455f.js" integrity="sha256-tybeSnzXHqwRIpX1sN2hUyWUGMJLcvgBCtusQYCYRV8=" crossorigin="anonymous"></script>
<!--
Made with Book Theme
https://github.com/alex-shpak/hugo-book
Expand Down
Loading

0 comments on commit 51f9ad8

Please sign in to comment.