feat(axidraw): add command fns, add COMMENT cmd

- add MOVE(), WAIT(), COMMENT() - add CommentCommand - update AxiDraw.draw() to log comments
thi-ng · Mar 17, 2023 · 0d64b55 · 0d64b55
1 parent 2c17115
commit 0d64b55
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 1 deletion.
diff --git a/packages/axidraw/src/api.ts b/packages/axidraw/src/api.ts
@@ -36,6 +36,9 @@ export type MoveXYCommand = ["m", ReadonlyVec, number?];
 /** Explicit delay (in ms) */
 export type WaitCommand = ["w", number];
 
+/** Ignored, but will be logged (if logging enabled) */
+export type CommentCommand = ["comment", string];
+
 export type DrawCommand =
 	| StartCommand
 	| StopCommand
@@ -45,7 +48,8 @@ export type DrawCommand =
 	| PenConfigCommand
 	| PenUpDownCommand
 	| MoveXYCommand
-	| WaitCommand;
+	| WaitCommand
+	| CommentCommand;
 
 /**
  * Global plotter drawing configuration. Also see {@link DEFAULT_OPTS}.
@@ -176,6 +180,32 @@ export const ON: MotorCommand = ["on"];
 
 export const OFF: MotorCommand = ["off"];
 
+/**
+ * Creates a {@link MoveXYCommand} command.
+ *
+ * @param pos
+ * @param speed
+ */
+export const MOVE = (pos: ReadonlyVec, speed = 1): MoveXYCommand => [
+	"m",
+	pos,
+	speed,
+];
+
+/**
+ * Creates a {@link WaitCommand}.
+ *
+ * @param delay
+ */
+export const WAIT = (delay = 1000): WaitCommand => ["w", delay];
+
+/**
+ * Creates a {@link CommentCommand}.
+ *
+ * @param msg
+ */
+export const COMMENT = (msg = ""): CommentCommand => ["comment", msg];
+
 /**
  * FSM state enum for (interactive) control for processing of drawing commands.
  * See {@link AxiDraw.draw} and {@link AxiDrawControl} for details.

diff --git a/packages/axidraw/src/axidraw.ts b/packages/axidraw/src/axidraw.ts
@@ -222,6 +222,9 @@ export class AxiDraw implements IReset {
 					[wait, dist] = this.moveTo(a, b);
 					$recordDist(dist);
 					break;
+				case "comment":
+					logger.info(`comment: ${a}`);
+					break;
 				default:
 					unsupported(`unknown command: ${$cmd}`);
 			}