Skip to content

Commit

Permalink
updated libraries & docs
Browse files Browse the repository at this point in the history
  • Loading branch information
akaJes committed Jun 5, 2018
1 parent f30982f commit 28f8128
Show file tree
Hide file tree
Showing 14 changed files with 251 additions and 39 deletions.
28 changes: 14 additions & 14 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "marlin-conf",
"version": "2.10.1-",
"version": "2.10.2",
"description": "configuration tool for Marlin project",
"main": "./index.js",
"scripts": {
Expand All @@ -13,7 +13,7 @@
"rebuild": "npm rebuild serialport --update-binary",
"prepublishOnly": "./node_modules/.bin/json -I -f package.json -e 'if(this.devDependencies)this.devDependenciesOff=this.devDependencies;this.devDependencies=undefined'",
"postpublish": "./node_modules/.bin/json -I -f package.json -e 'if(this.devDependenciesOff)this.devDependencies=this.devDependenciesOff;this.devDependenciesOff=undefined'",
"postinstall": "cd node_modules/ot ; npm i ; node_modules/.bin/grunt --force ; rm -r node_modules"
"postinstall-": "cd node_modules/ot ; npm i ; node_modules/.bin/grunt --force ; rm -r node_modules"
},
"build": {
"appId": "com.akajes.marlin.conf",
Expand All @@ -36,7 +36,7 @@
"nsis": {},
"mac": {
"target": [
"tar.gz"
"zip"
]
},
"dmg": {}
Expand Down Expand Up @@ -72,38 +72,38 @@
"highlight.js": "^9.11.0",
"jquery": "^3.3.1",
"jquery-ui-dist": "^1.12.1",
"js-yaml": "^3.11.0",
"js-yaml": "^3.12.0",
"jstree": "^3.3.5",
"marked": "^0.3.19",
"marked": "^0.4.0",
"mkdirp": "^0.5.1",
"moment": "^2.22.1",
"moment": "^2.22.2",
"nat-upnp": "git+https://github.com/MelvinTo/node-nat-upnp.git",
"node-machine-id": "^1.1.10",
"node-notifier": "^5.2.1",
"opn": "^5.3.0",
"ot": "git+https://github.com/Operational-Transformation/ot.js.git",
"platformio-node-helpers": "^0.4.3",
"platformio-node-helpers": "^0.5.2",
"qr-image": "^3.2.0",
"rtcmulticonnection-v3": "^3.4.4",
"serialport": "^6.2.0",
"simple-git": "^1.92.0",
"simple-git": "^1.95.1",
"socket.io": "^2.1.1",
"swig-templates": "^2.0.2",
"tether": "^1.4.4",
"tmp": "0.0.33",
"tty2html": "^1.0.0",
"universal-analytics": "^0.4.16",
"universal-analytics": "^0.4.17",
"vex-js": "^4.1.0",
"which": "^1.2.14",
"yauzl": "^2.9.1",
"which": "^1.3.1",
"yauzl": "^2.9.2",
"yazl": "^2.4.3"
},
"devDependencies": {
"devtron": "^1.4.0",
"electron": "latest",
"electron-builder": "latest",
"electron": "^2.0.1",
"electron-builder": "^20.15.1",
"eslint": "^4.18.1",
"json": "^9.0.6",
"nodemon": "^1.15.1"
"nodemon": "^1.17.5"
}
}
4 changes: 2 additions & 2 deletions views/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -1453,7 +1453,7 @@ Option|Description
`REPRAP_DISCOUNT_SMART_CONTROLLER`|[RepRapDiscount Smart Controller](http://reprap.org/wiki/RepRapDiscount_Smart_Controller). Usually sold with a white PCB.
`G3D_PANEL`|[Gadgets3D G3D LCD/SD Controller](http://reprap.org/wiki/RAMPS_1.3/1.4_GADGETS3D_Shield_with_Panel). Usually sold with a blue PCB.
`RIGIDBOT_PANEL`|[RigidBot Panel V1.0](http://www.inventapart.com/).
`ANET_KEYPAD_LCD`|[Anet Keypad LCD](http://www.anet3d.com/English/3D_Printer/107.html) for the Anet A3
`ANET_KEYPAD_LCD`|[Anet Keypad LCD](http://www.anet3d.com/prod_view.aspx?TypeId=10&Id=178) for the Anet A3

### Graphical LCDs

Expand All @@ -1468,7 +1468,7 @@ Option|Description
`REPRAP_DISCOUNT_FULL_GRAPHIC_SMART_CONTROLLER`|[RepRapDiscount Full Graphic Smart Controller](http://reprap.org/wiki/RepRapDiscount_Full_Graphic_Smart_Controller).
`MINIPANEL`|[MakerLab Mini Panel](http://reprap.org/wiki/Mini_panel) with graphic controller and SD support.
`BQ_LCD_SMART_CONTROLLER`|BQ LCD Smart Controller shipped with the BQ Hephestos 2 and Witbox 2.
`ANET_FULL_GRAPHICS_LCD`|[Anet Full Graphics LCD](http://www.anet3d.com/English/3D_Printer/107.html) for the Anet A3
`ANET_FULL_GRAPHICS_LCD`|[Anet Full Graphics LCD](http://www.anet3d.com/prod_view.aspx?TypeId=10&Id=178) for the Anet A3

### Keypads

Expand Down
8 changes: 8 additions & 0 deletions views/gcode/G005.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ parameters:
-
tag: pos
type: float
-
tag: F
optional: true
description: The maximum feedrate of the move between the start and end point (in current units per second). This value applies to all subsequent moves.
values:
-
tag: rate
type: float
-
tag: I
optional: false
Expand Down
4 changes: 2 additions & 2 deletions views/gcode/G029-ubl.md
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ examples:
G29 S1 ; Save UBL mesh points to EEPROM.
G29 F 10.0 ; Set Fade Height for correction at 10.0 mm.
G29 A ; Activate the UBL System.
M500 ; Save current setup. WARNING - UBL will be active at power up, before any `G28`.
M500 ; Save current setup. WARNING - UBL will be active at power up, before any G28.
-
pre: Use `G26` and `G29` commands to fine-tune a measured mesh
code: |
Expand All @@ -409,4 +409,4 @@ examples:
G29 L1 ; Load the mesh stored in slot 1 (from G29 S1)
G29 J ; No size specified on the J option tells G29 to probe the specified 3 points and tilt the mesh according to what it finds.
---
---
32 changes: 30 additions & 2 deletions views/gcode/M027.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
tag: m027
title: Report SD print status
brief: Print SD progress to serial
author: thinkyhead
author: thinkyhead,TheSFReader

experimental: false
requires: SDSUPPORT
Expand All @@ -11,14 +11,42 @@ group: sdcard
codes:
- M27

long: Report the current SD read position in the form "SD printing byte 123/12345".
long:
- With no parameter, report the current SD read position in the form "`SD printing byte 123/12345`." If no file is open the response is "`Not SD printing`."
- With 'S<seconds>', set the SD status auto-report interval. (Requires `AUTO_REPORT_SD_STATUS`)
- With 'C', get the currently open file's name (and long filename if possible). Print "`(no file)`" if no file is open.

notes:
- Requires [`SDSUPPORT`](/docs/configuration/configuration.html#sd-card)

parameters:
-
tag: S
optional: true
description: Interval between auto-reports. `S0` to disable.
values:
-
tag: seconds
type: int
-
tag: C
optional: true
description: Report the filename and long filename of the current file.


examples:
-
pre: Report current SD status
code: M27 S4
-
pre: Report SD status every 4 seconds
code: M27 S4
-
pre: Stop reporting SD status
code: M27 S0
-
pre: Report currently open filename
code: M27 C

---

15 changes: 13 additions & 2 deletions views/gcode/M104.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,23 @@ parameters:
-
tag: temp
type: float
-
tag: T
optional: true
description: Hotend index. If omitted, the currently active hotend will be used.
values:
-
tag: index
type: int


examples:
-
pre: Simple set target temperature
code: M104 S180
pre: Set target temperature for the active hotend
code: M104 S185
-
pre: Set target temperature for E1
code: M104 T1 S205
-
pre: '`AUTOTEMP`: Set autotemp range'
code: M104 F S180 B190
Expand Down
13 changes: 12 additions & 1 deletion views/gcode/M109.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,26 @@ parameters:
-
tag: temp
type: float
-
tag: T
optional: true
description: Hotend index. If omitted, the currently active hotend will be used.
values:
-
tag: index
type: int


examples:
-
pre: Set target temperature and wait (if heating)
pre: Set target temperature and wait (if heating up)
code: M109 S180
-
pre: Set target temperature, wait even if cooling
code: M109 R120
-
pre: Set target temperature for E1 and wait (if heating up)
code: M109 T1 R205
-
pre: '`AUTOTEMP`: Set autotemp range, wait for temp'
code: M109 F S180 B190
Expand Down
39 changes: 39 additions & 0 deletions views/gcode/M118.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
tag: m118
title: Serial print
brief: Send text to serial
author: thinkyhead

experimental: false
group: hosts

codes:
- M118

long: Send a message to the connected host for display in the host console or to perform a host action.

notes: The `E` and `A` parameters must precede the message.

parameters:
-
tag: string
optional: true
description: Message string. If omitted, a blank line will be sent.
-
tag: A1
optional: true
description: Prepend `// ` to denote a comment or action command. Hosts like OctoPrint can interpret such commands to perform special actions. See your host's documentation.
-
tag: E1
optional: true
description: Prepend `echo:` to the message. Some hosts will display echo messages differently when preceded by `echo:`.

examples:
-
pre: Echo "Yello World!" in the console
code: M118 E1 Yello World!
-
pre: Tell [OctoPrint](http://docs.octoprint.org/en/master/features/action_commands.html) to cancel the print job
code: M118 A1 action:cancel

---
27 changes: 21 additions & 6 deletions views/gcode/M150.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
tag: m150
title: Set RGB Color
brief: Set the color of the RGB LED, backlight, or LED strip.
title: Set RGB(W) Color
brief: Set the color of the RGB(W) LED, backlight, or LED strip.
author: thinkyhead

experimental: false
requires: BLINKM|RGB_LED
requires: BLINKM|RGB_LED|RGBW_LED|NEOPIXEL_LED|PCA9632
group: lcd

codes:
- M150

long: If you have an RGB light, either as part of a controller or installed separately, the `M150` command can be used to set its color.
long: If you have an RGB(W) light, either as part of a controller or installed separately, the `M150` command can be used to set its color.

notes: Requires `BLINKM` or `RGB_LED`.
notes: Requires `BLINKM`, `RGB_LED`, `RGBW_LED`, `NEOPIXEL_LED` or `PCA9632`.

parameters:
-
Expand All @@ -40,7 +40,22 @@ parameters:
-
tag: intensity
type: byte

-
tag: W
optional: true
description: White component from 0 to 255 (`RGBW_LED` or `NEOPIXEL_LED` only)
values:
-
tag: intensity
type: byte
-
tag: P
optional: true
description: Brightness from 0 to 255 (`NEOPIXEL_LED` only)
values:
-
tag: intensity
type: byte
examples:

---
Expand Down
1 change: 1 addition & 0 deletions views/gcode/M428.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ codes:
long: |
Use `M428` to set a persistent offset to the native home position and coordinate space by assigning the current position as the native home position. See the example below.
- The current position must be within 2cm from 0 or an endstop.
- The current position is set to the native home position.
- Any previous position shift from `G92` is cleared.
- The home offset is persistent — added to the current position until changed.
Expand Down
24 changes: 23 additions & 1 deletion views/gcode/M906.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,29 @@ parameters:
-
unit: mA
type: float
-
tag: I
optional: true
description: (>=1.1.9) Index for dual steppers. Use `I1` for X2, Y2, and/or Z2.
values:
-
unit: index
type: int
-
tag: S
optional: true
description: Auto current control on/off (Requires `MONITOR_DRIVER_STATUS`)
values:
-
type: bool
-
tag: T
optional: true
description: (>=1.1.9) Index (tool) number for the E axis. If not specified, the E0 extruder.
values:
-
unit: index
type: int
-
tag: X
optional: true
Expand All @@ -56,10 +72,16 @@ parameters:
unit: mA
type: float

example:
examples:
-
pre: Set the XYZ motor currents to 5mA
code: M906 X5 Y5 Z5
-
pre: Set the E1 motor current to 10mA
code: M906 T1 E10
-
pre: Set the X2 motor current to 5mA
code: M906 I1 X5

---

Loading

0 comments on commit 28f8128

Please sign in to comment.