refactor: update STK500 instantiation and modernized deprecated node …

…functions
barrenechea · Oct 9, 2024 · 3bee6f4 · 3bee6f4
1 parent 1d7424b
commit 3bee6f4
Show file tree

Hide file tree

Showing 12 changed files with 112 additions and 191 deletions.
diff --git a/README.md b/README.md
@@ -26,8 +26,6 @@ import { SerialPort } from "serialport";
 import fs from "fs/promises";
 import STK500, { type Board } from "stk500-esm";
 
-const stk = new STK500();
-
 const board: Board = {
   name: "Arduino Uno",
   baudRate: 115200,
@@ -42,8 +40,9 @@ async function upload(path: string) {
     const hexData = await fs.readFile("path/to/your/sketch.hex", {
       encoding: "utf8",
     });
-    serialPort = new SerialPort({ path, baudRate: board.baud });
-    await stk.bootload(serialPort, hexData, board);
+    serialPort = new SerialPort({ path, baudRate: board.baudRate });
+    const stk = new STK500(serialPort, board);
+    await stk.bootload(hexData);
     console.log("Programming successful!");
   } catch (error) {
     console.error("Programming failed:", error);
@@ -82,11 +81,12 @@ Replace `uno.ts` with the appropriate example file and `/dev/ttyACM0` with your
 
 The main class `STK500` provides the following methods:
 
-- `bootload(stream: NodeJS.ReadWriteStream, hexData: string | Buffer, opt: Board): Promise<void>`
-- `sync(stream: NodeJS.ReadWriteStream, attempts: number, timeout: number): Promise<Buffer>`
-- `verifySignature(stream: NodeJS.ReadWriteStream, signature: Buffer, timeout: number): Promise<Buffer>`
-- `upload(stream: NodeJS.ReadWriteStream, hexData: string | Buffer, pageSize: number, timeout: number, use8BitAddresses = false): Promise<void>`
-- `verify(stream: NodeJS.ReadWriteStream, hexData: string | Buffer, pageSize: number, timeout: number, use8BitAddresses = false): Promise<void>`
+- `constructor(stream: NodeJS.ReadWriteStream, board: Board, opts?: STK500Options)`
+- `bootload(hexData: string | Buffer): Promise<void>`
+- `sync(attempts: number): Promise<Buffer>`
+- `verifySignature(): Promise<Buffer>`
+- `upload(hexData: string | Buffer): Promise<void>`
+- `verify(hexData: string | Buffer): Promise<void>`
 
 For more detailed API information, please refer to the TypeScript definitions or the source code.
 

diff --git a/examples/avr4809.ts b/examples/avr4809.ts
@@ -2,8 +2,6 @@ import fs from "fs/promises";
 import { SerialPort } from "serialport";
 import STK500, { type Board } from "../src/index.js";
 
-const stk = new STK500();
-
 const board: Board = {
   name: "ATmega4809",
   baudRate: 19200,
@@ -37,7 +35,8 @@ async function upload(path) {
       encoding: "utf8",
     });
     serialPort = await createSerialPort(path, board.baudRate);
-    await stk.bootload(serialPort, hex, board);
+    const stk = new STK500(serialPort, board);
+    await stk.bootload(hex);
     console.log("Programming SUCCESS!");
   } catch (error) {
     console.error("Programming failed:", error);

diff --git a/examples/diecimila-duemilanove168.ts b/examples/diecimila-duemilanove168.ts
@@ -2,8 +2,6 @@ import fs from "fs/promises";
 import { SerialPort } from "serialport";
 import STK500, { type Board } from "../src/index.js";
 
-const stk = new STK500();
-
 const board: Board = {
   name: "Diecimila / Duemilanove 168",
   baudRate: 19200,
@@ -36,7 +34,8 @@ async function upload(path) {
       encoding: "utf8",
     });
     serialPort = await createSerialPort(path, board.baudRate);
-    await stk.bootload(serialPort, hex, board);
+    const stk = new STK500(serialPort, board);
+    await stk.bootload(hex);
     console.log("Programming SUCCESS!");
   } catch (error) {
     console.error("Programming failed:", error);

diff --git a/examples/duemilanove328.ts b/examples/duemilanove328.ts
@@ -2,8 +2,6 @@ import fs from "fs/promises";
 import { SerialPort } from "serialport";
 import STK500, { type Board } from "../src/index.js";
 
-const stk = new STK500();
-
 const board: Board = {
   name: "Duemilanove 328",
   baudRate: 57600,
@@ -37,7 +35,8 @@ async function upload(path) {
       { encoding: "utf8" }
     );
     serialPort = await createSerialPort(path, board.baudRate);
-    await stk.bootload(serialPort, hex, board);
+    const stk = new STK500(serialPort, board);
+    await stk.bootload(hex);
     console.log("Programming SUCCESS!");
   } catch (error) {
     console.error("Programming failed:", error);

diff --git a/examples/lgt8f328.ts b/examples/lgt8f328.ts
@@ -2,8 +2,6 @@ import fs from "fs/promises";
 import { SerialPort } from "serialport";
 import STK500, { type Board } from "../src/index.js";
 
-const stk = new STK500();
-
 const board: Board = {
   name: "LGT8F328",
   baudRate: 57600,
@@ -36,7 +34,8 @@ async function upload(path) {
       encoding: "utf8",
     });
     serialPort = await createSerialPort(path, board.baudRate);
-    await stk.bootload(serialPort, hex, board);
+    const stk = new STK500(serialPort, board);
+    await stk.bootload(hex);
     console.log("Programming SUCCESS!");
   } catch (error) {
     console.error("Programming failed:", error);

diff --git a/examples/nano.ts b/examples/nano.ts
@@ -2,8 +2,6 @@ import fs from "fs/promises";
 import { SerialPort } from "serialport";
 import STK500, { type Board } from "../src/index.js";
 
-const stk = new STK500();
-
 const board: Board = {
   name: "Arduino Nano",
   baudRate: 115200,
@@ -36,7 +34,8 @@ async function upload(path) {
       encoding: "utf8",
     });
     serialPort = await createSerialPort(path, board.baudRate);
-    await stk.bootload(serialPort, hex, board);
+    const stk = new STK500(serialPort, board);
+    await stk.bootload(hex);
     console.log("Programming SUCCESS!");
   } catch (error) {
     console.error("Programming failed:", error);

diff --git a/examples/uno.ts b/examples/uno.ts
@@ -2,8 +2,6 @@ import fs from "fs/promises";
 import { SerialPort } from "serialport";
 import STK500, { type Board } from "../src/index.js";
 
-const stk = new STK500();
-
 const board: Board = {
   name: "Arduino Uno",
   baudRate: 115200,
@@ -36,7 +34,8 @@ async function upload(path) {
       encoding: "utf8",
     });
     serialPort = await createSerialPort(path, board.baudRate);
-    await stk.bootload(serialPort, hex, board);
+    const stk = new STK500(serialPort, board);
+    await stk.bootload(hex);
     console.log("Programming SUCCESS!");
   } catch (error) {
     console.error("Programming failed:", error);

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "stk500-esm",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "A modern, ESM-compatible, TypeScript implementation of the STK500v1 protocol for programming Arduino boards directly from Node.js or the browser.",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -29,10 +29,10 @@
     "@eslint/js": "^9.12.0",
     "@types/node": "^22.7.5",
     "eslint": "^9.12.0",
-    "globals": "^15.10.0",
+    "globals": "^15.11.0",
     "serialport": "^12.0.0",
     "tsx": "^4.19.1",
-    "typescript": "^5.6.2",
+    "typescript": "^5.6.3",
     "typescript-eslint": "^8.8.1"
   }
 }