@thi.ng/axidraw 0.3.0 → 0.5.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-29T20:56:59Z
+- **Last updated**: 2023-02-05T14:42:21Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,23 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [0.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/axidraw@0.5.0) (2023-02-05)
+
+#### 🚀 Features
+
+- add speedUp config, rename speed => speedDown ([197d610](https://github.com/thi-ng/umbrella/commit/197d610))
+
+#### 🩹 Bug fixes
+
+- add [@thi.ng/date](https://github.com/thi-ng/umbrella/tree/main/packages/date) dependency ([bd35a9e](https://github.com/thi-ng/umbrella/commit/bd35a9e))
+  required by axidraw.ts
+
+## [0.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/axidraw@0.4.0) (2023-01-10)
+
+#### 🚀 Features
+
+- also send "reset" cmd in .reset() ([30fe365](https://github.com/thi-ng/umbrella/commit/30fe365))
+
 ## [0.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/axidraw@0.3.0) (2022-12-29)
 
 #### 🚀 Features

package/README.md

@@ -164,7 +164,7 @@ For Node.js REPL:
 const axidraw = await import("@thi.ng/axidraw");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 3.96 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 3.97 KB
 
 ## Dependencies
 
@@ -174,7 +174,7 @@ Package sizes (brotli'd, pre-treeshake): ESM: 3.96 KB
 - [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors)
 - [@thi.ng/logger](https://github.com/thi-ng/umbrella/tree/develop/packages/logger)
 - [@thi.ng/vectors](https://github.com/thi-ng/umbrella/tree/develop/packages/vectors)
-- [serialport](https://github.com/thi-ng/umbrella/tree/develop/packages/undefined)
+- [serialport](git://github.com/serialport/node-serialport.git)
 
 ## API
 
@@ -282,4 +282,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2022 Karsten Schmidt // Apache License 2.0
+© 2022 - 2023 Karsten Schmidt // Apache License 2.0

package/api.d.ts

@@ -72,11 +72,17 @@ export interface AxiDrawOpts {
      */
     stepsPerInch: number;
     /**
-     * Steps per second
+     * Steps per second for XY movements whilst pen down
      *
      * @defaultValue 4000
      */
-    speed: number;
+    speedDown: number;
+    /**
+     * Steps per second for XY movements whilst pen up
+     *
+     * @defaultValue 4000
+     */
+    speedUp: number;
     /**
      * Up position (%)
      *

package/axidraw.d.ts

@@ -75,6 +75,12 @@ export declare class AxiDraw implements IReset {
      * Sends a "moveto" command (absolute coords). Returns tuple of `[duration,
      * distance]` (distance in original/configured units)
      *
+     * @remarks
+     * Even though this method accepts absolute coords, all AxiDraw movements
+     * are relative. Depending on pen up/down state, movement speed will be
+     * either the configured {@link AxiDrawOpts.speedDown} or
+     * {@link AxiDrawOpts.speedUp}.
+     *
      * @param p
      * @param tempo
      */

package/axidraw.js

@@ -15,7 +15,8 @@ export const DEFAULT_OPTS = {
     refresh: 1000,
     unitsPerInch: 25.4,
     stepsPerInch: 2032,
-    speed: 4000,
+    speedDown: 4000,
+    speedUp: 4000,
     up: 60,
     down: 30,
     delayUp: 150,
@@ -37,6 +38,7 @@ export class AxiDraw {
     reset() {
         zero(this.pos);
         zero(this.targetPos);
+        this.send("R\r");
         return this;
     }
     /**
@@ -247,17 +249,24 @@ export class AxiDraw {
      * Sends a "moveto" command (absolute coords). Returns tuple of `[duration,
      * distance]` (distance in original/configured units)
      *
+     * @remarks
+     * Even though this method accepts absolute coords, all AxiDraw movements
+     * are relative. Depending on pen up/down state, movement speed will be
+     * either the configured {@link AxiDrawOpts.speedDown} or
+     * {@link AxiDrawOpts.speedUp}.
+     *
      * @param p
      * @param tempo
      */
     moveTo(p, tempo = 1) {
-        const { pos, targetPos, opts } = this;
+        const { pos, targetPos, opts, isPenDown } = this;
         // apply scale factor: worldspace units -> motor steps
         mulN2(targetPos, p, opts.stepsPerInch / opts.unitsPerInch);
         const delta = sub2([], targetPos, pos);
         set2(pos, targetPos);
         const maxAxis = Math.max(...abs2([], delta));
-        const duration = (1000 * maxAxis) / (opts.speed * tempo);
+        const duration = (1000 * maxAxis) /
+            ((isPenDown ? opts.speedDown : opts.speedUp) * tempo);
         this.send(`XM,${duration | 0},${delta[0] | 0},${delta[1] | 0}\r`);
         return [duration, (mag(delta) * opts.unitsPerInch) / opts.stepsPerInch];
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/axidraw",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Minimal AxiDraw plotter/drawing machine controller for Node.js",
   "type": "module",
   "module": "./index.js",
@@ -34,21 +34,23 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.6.2",
-    "@thi.ng/checks": "^3.3.6",
-    "@thi.ng/compose": "^2.1.23",
-    "@thi.ng/errors": "^2.2.7",
-    "@thi.ng/logger": "^1.4.6",
-    "@thi.ng/vectors": "^7.5.30",
+    "@thi.ng/api": "^8.7.0",
+    "@thi.ng/checks": "^3.3.8",
+    "@thi.ng/compose": "^2.1.25",
+    "@thi.ng/date": "^2.4.2",
+    "@thi.ng/errors": "^2.2.9",
+    "@thi.ng/logger": "^1.4.8",
+    "@thi.ng/transducers": "^8.3.31",
+    "@thi.ng/vectors": "^7.6.0",
     "serialport": "^10.5.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.7",
-    "@thi.ng/testament": "^0.3.8",
-    "rimraf": "^3.0.2",
+    "@microsoft/api-extractor": "^7.34.2",
+    "@thi.ng/testament": "^0.3.10",
+    "rimraf": "^4.1.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.22",
-    "typescript": "^4.9.4"
+    "typedoc": "^0.23.24",
+    "typescript": "^4.9.5"
   },
   "keywords": [
     "2d",
@@ -102,5 +104,5 @@
     "status": "alpha",
     "year": 2022
   },
-  "gitHead": "28bb74c67217a352d673b6efdab234921d4a370e\n"
+  "gitHead": "50ba9c87676fac60c46d2bc0e4d2c7711a374a68\n"
 }