@thi.ng/axidraw 0.2.0 → 0.2.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-10T14:04:38Z
+- **Last updated**: 2022-12-16T12:52:25Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -1,10 +1,10 @@
 <!-- This file is generated - DO NOT EDIT! -->
 
-# ![axidraw](https://media.thi.ng/umbrella/banners-20220914/thing-axidraw.svg?25c834ce)
+# ![@thi.ng/axidraw](https://media.thi.ng/umbrella/banners-20220914/thing-axidraw.svg?25c834ce)
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/axidraw.svg)](https://www.npmjs.com/package/@thi.ng/axidraw)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/axidraw.svg)
-[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella)
+[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 This project is part of the
 [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
@@ -16,6 +16,7 @@ This project is part of the
   - [thi.ng/geom support](#thinggeom-support)
   - [SVG support](#svg-support)
   - [Serial port support](#serial-port-support)
+  - [Draw control](#draw-control)
 - [Status](#status)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
@@ -28,7 +29,7 @@ This project is part of the
 
 ## About
 
-Minimal AxiDraw plotter/drawing machine controller for Node.js.
+Minimal AxiDraw plotter/drawing machine controller for Node.js
 
 This package provides a super-lightweight alternative to control an [AxiDraw
 plotter](https://axidraw.com/) directly from Node.js, using a small custom set
@@ -112,6 +113,22 @@ At some point it would also be worth looking into
 support to enable plotting directly from the browser. Right now this package is
 only aimed at Node.js though...
 
+### Draw control
+
+The main draw function provided by this package is async and can supports custom
+implementations to pause, resume or cancel the processing of further drawing
+commands. By the default
+[`AxiDrawControl`](https://docs.thi.ng/umbrella/axidraw/classes/AxiDrawControl.html)
+is used as default implementation.
+
+If a control is provided, it will be checked prior to processing each individual
+command. Drawing will be paused if the control state is in paused state and the
+control will be rechecked every N milliseconds for updates (configurable). In
+paused state, the pen will be automatically lifted (if it wasn't already) and
+when resuming it will be sent down again (if it was originally down). Draw
+commands are only sent to the machine if no control is provided at all or if the
+control is in the "continue" state.
+
 ## Status
 
 **ALPHA** - bleeding edge / work-in-progress
@@ -134,11 +151,8 @@ ES module import:
 
 For Node.js REPL:
 
-```text
-# with flag only for < v16
-node --experimental-repl-await
-
-> const axidraw = await import("@thi.ng/axidraw");
+```js
+const axidraw = await import("@thi.ng/axidraw");
 ```
 
 Package sizes (brotli'd, pre-treeshake): ESM: 1.67 KB
@@ -208,26 +222,26 @@ import { asAxiDraw } from "@thi.ng/geom-axidraw";
 import { map, range } from "@thi.ng/transducers";
 
 (async () => {
-	// create group of bezier-interpolated star polygons,
-	// with each path using a slightly different configuration
-	const geo = group({ translate: [100, 100] }, [
-		...map(
-			(t) =>
-				pathFromCubics(
-					asCubic(star(90, 6, [t, 1]), {
-						breakPoints: true,
-						scale: 0.66,
-					})
-				),
-			range(0.3, 1.01, 0.05)
-		),
-	]);
-
-	// connect to plotter
-	const axi = new AxiDraw();
-	await axi.connect();
-	// convert geometry to drawing commands & send to plotter
-	await axi.draw(asAxiDraw(geo, { samples: 40 }));
+    // create group of bezier-interpolated star polygons,
+    // with each path using a slightly different configuration
+    const geo = group({ translate: [100, 100] }, [
+        ...map(
+            (t) =>
+                pathFromCubics(
+                    asCubic(star(90, 6, [t, 1]), {
+                        breakPoints: true,
+                        scale: 0.66,
+                    })
+                ),
+            range(0.3, 1.01, 0.05)
+        ),
+    ]);
+
+    // connect to plotter
+    const axi = new AxiDraw();
+    await axi.connect();
+    // convert geometry to drawing commands & send to plotter
+    await axi.draw(asAxiDraw(geo, { samples: 40 }));
 })();
 ```
 
@@ -239,7 +253,7 @@ Other selected toots/tweets:
 
 ## Authors
 
-Karsten Schmidt
+- [Karsten Schmidt](https://thi.ng)
 
 If this project contributes to an academic publication, please cite it as:
 
@@ -254,4 +268,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-&copy; 2022 Karsten Schmidt // Apache Software License 2.0
+&copy; 2022 Karsten Schmidt // Apache License 2.0

package/api.d.ts

@@ -2,31 +2,31 @@ import type { IDeref } from "@thi.ng/api";
 import type { ILogger } from "@thi.ng/logger";
 import type { ReadonlyVec } from "@thi.ng/vectors";
 /** Start command sequence (configurable via {@link AxiDrawOpts}) */
-export declare type StartCommand = ["start"];
+export type StartCommand = ["start"];
 /** Stop command sequence (configurable via {@link AxiDrawOpts}) */
-export declare type StopCommand = ["stop"];
+export type StopCommand = ["stop"];
 /** Return plotter to initial XY position */
-export declare type HomeCommand = ["home"];
+export type HomeCommand = ["home"];
 /** Reset curr position as home (0,0) */
-export declare type ResetCommand = ["reset"];
+export type ResetCommand = ["reset"];
 /** Turn XY motors on/off */
-export declare type MotorCommand = ["on" | "off"];
+export type MotorCommand = ["on" | "off"];
 /** Pen config, min/down position, max/up position (in %) */
-export declare type PenConfigCommand = ["pen", number?, number?];
+export type PenConfigCommand = ["pen", number?, number?];
 /**
  * Pen up/down, optional delay (in ms), optional custom level/position. If
  * omitted, default values used from {@link AxiDrawOpts}. Using -1 as delay also
  * uses default.
  */
-export declare type PenUpDownCommand = ["u" | "d", number?, number?];
+export type PenUpDownCommand = ["u" | "d", number?, number?];
 /**
  * Move to abs pos (in worldspace coords, default mm), optional speed factor
  * (default: 1)
  */
-export declare type MoveXYCommand = ["m", ReadonlyVec, number?];
+export type MoveXYCommand = ["m", ReadonlyVec, number?];
 /** Explicit delay (in ms) */
-export declare type WaitCommand = ["w", number];
-export declare type DrawCommand = StartCommand | StopCommand | HomeCommand | ResetCommand | MotorCommand | PenConfigCommand | PenUpDownCommand | MoveXYCommand | WaitCommand;
+export type WaitCommand = ["w", number];
+export type DrawCommand = StartCommand | StopCommand | HomeCommand | ResetCommand | MotorCommand | PenConfigCommand | PenUpDownCommand | MoveXYCommand | WaitCommand;
 /**
  * Global plotter drawing configuration. Also see {@link DEFAULT_OPTS}.
  */

package/control.d.ts

@@ -1,5 +1,12 @@
 import type { IDeref, IReset } from "@thi.ng/api";
 import { AxiDrawState } from "./api.js";
+/**
+ * Default implementation with easy-to-use API to control the processing of draw
+ * commands via {@link AxiDraw.draw}.
+ *
+ * @remarks
+ * See {@link AxiDrawOpts.control} for further details.
+ */
 export declare class AxiDrawControl implements IDeref<AxiDrawState>, IReset {
     interval: number;
     state: AxiDrawState;

package/control.js

@@ -1,4 +1,11 @@
 import { AxiDrawState } from "./api.js";
+/**
+ * Default implementation with easy-to-use API to control the processing of draw
+ * commands via {@link AxiDraw.draw}.
+ *
+ * @remarks
+ * See {@link AxiDrawOpts.control} for further details.
+ */
 export class AxiDrawControl {
     constructor(interval = 1000) {
         this.interval = interval;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/axidraw",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Minimal AxiDraw plotter/drawing machine controller for Node.js",
   "type": "module",
   "module": "./index.js",
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/thi-ng/umbrella.git"
   },
-  "homepage": "https://github.com/thi-ng/umbrella/tree/master/packages/axidraw#readme",
+  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/axidraw#readme",
   "funding": [
     {
       "type": "github",
@@ -21,7 +21,7 @@
       "url": "https://patreon.com/thing_umbrella"
     }
   ],
-  "author": "Karsten Schmidt <k+npm@thi.ng>",
+  "author": "Karsten Schmidt (https://thi.ng)",
   "license": "Apache-2.0",
   "scripts": {
     "build": "yarn clean && tsc --declaration",
@@ -34,20 +34,20 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.5.1",
-    "@thi.ng/compose": "^2.1.20",
-    "@thi.ng/errors": "^2.2.5",
-    "@thi.ng/logger": "^1.4.4",
-    "@thi.ng/vectors": "^7.5.26",
+    "@thi.ng/api": "^8.6.1",
+    "@thi.ng/compose": "^2.1.22",
+    "@thi.ng/errors": "^2.2.6",
+    "@thi.ng/logger": "^1.4.5",
+    "@thi.ng/vectors": "^7.5.28",
     "serialport": "^10.5.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.5",
-    "@thi.ng/testament": "^0.3.6",
+    "@microsoft/api-extractor": "^7.33.7",
+    "@thi.ng/testament": "^0.3.7",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.20",
-    "typescript": "^4.8.4"
+    "typedoc": "^0.23.22",
+    "typescript": "^4.9.4"
   },
   "keywords": [
     "2d",
@@ -94,5 +94,5 @@
     "status": "alpha",
     "year": 2022
   },
-  "gitHead": "5178ea1d7f4b2de86cf5101bdd73f6567518c0bd\n"
+  "gitHead": "7b2af448da8a63fb21704a79cc4cdf1f3d7d7a64\n"
 }