3d-printer-controller 中文文档教程

Question

3D printer controller

此模块可帮助您从 JavaScript（和 TypeScript）控制您的 3d 打印机。 该模块使用承诺，因此您可以等待电机移动完成。

Features

• Send custom GCode to the printer
• Move the nozzle to an absolute position
• Move the nozzle with a relative position
• Set the speed of movement in mm/s
• Get current position, get target position
• Auto home the nozzle on the specified axes.

Get started

1. Add the module to your dependencies: shell script npm i 3d-printer-controller --save
2. Create a printer instance in your code and call its .init() function:

   import {Printer} from "3d-printer-controller";

   (async () => {
       const myPrinter = new Printer("COM5", 115200, {x: 220, y: 220, z: 300});
       await myPrinter.init();
   })();

请注意，您应该提供正确大小的打印区域，以防您不希望打印机损坏。 如果要使用 await，则必须在异步函数中编写代码。

API

Cosntructor

new Printer(port: string, baudRate: number, maxPrintSize: Vector3D);
    // Vector3D is an object like {x: number, y: number, z: number}

示例：

const myPrinter = new Printer("COM5", 115200, {x: 220, y: 220, z: 300});

Initialise the 3D printer

await myPrinter.init();

您必须在使用打印机之前调用此方法。

Auto home

await myPrinter.autoHome(["X", "Y", "Z"]);

这会在 X、Y 和 Z 轴上自动归位喷嘴。

有一个特殊的功能可以自动将喷嘴定位在 X 和 Y 轴上。

await myPrinter.autoHomeXY();

Send GCode

您可以使用此函数发送 GCode 字符串或 GCode 字符串数组：

// string:
await myPrinter.sendGCode("G28");

// array:
await myPrinter.sendGCode([
    "G91",
    "G0 F4800",
    "G0 X10 Y40"
]);

Set the speed of the movement

await myPrinter.setSpeed(80);

以毫米/秒为单位设置移动速度。

Go to a specified position

您可以使喷嘴以毫米为单位到达指定位置。 您可以直接指定矢量或矢量的 X、Y（可选）、Z（可选）分量：

await myPrinter.goTo({x: 30, y: 60, z: 1}); // The nozzle goes to (30; 60; 1)
await myPrinter.goTo(50, 90, 2); // The nozzle goes to (50; 90; 2).
await myPrinter.goTo(30, 50); // The z value was not specified, so it goes remains the same as in the previous movement. The new position will be (30; 50; 2).

Get current position

const currentPos = await myPrinter.getCurrentPosition();
console.log(currentPos); // {x: number, y: number, z: number}

返回喷嘴的当前位置。 该值在喷嘴移动时发生变化。 一旦喷嘴完成其移动，这将等于目标位置。

Get target position

const targetPos = await myPrinter.getTargetPosition();
console.log(targetPos); // {x: number, y: number, z: number}

返回喷嘴的目标位置。

Get current position and target position at once

const posData = await myPrinter.getPositionData();
const currentPos = posData.currentPosition;
const targetPos = posData.targetPosition;

这种方法只是为了节省时间，当我们需要将两个位置都放在一个地方时（例如等待喷嘴完成运动时）。