refactor: remove intel-hex dependency and update hex file reading method

README.md

@@ -9,6 +9,7 @@ A modern, ESM-compatible, TypeScript implementation of the STK500v1 protocol for
 - Can be used in Node.js or browser environments
 - No dependency on avrdude or the Arduino IDE
 - TypeScript support for improved developer experience
+- **Built-in Intel HEX parsing** (no need for external parsing libraries)
 
 ## Installation
 
@@ -22,9 +23,8 @@ Here's a basic example of how to use stk500-esm to program an Arduino:
 
 ```typescript
 import { SerialPort } from "serialport";
-import intel_hex from "intel-hex";
-import Stk500 from "stk500-esm";
 import fs from "fs/promises";
+import Stk500 from "stk500-esm";
 
 const stk = new Stk500();
 
@@ -42,9 +42,8 @@ async function upload(path: string) {
     const hexData = await fs.readFile("path/to/your/sketch.hex", {
       encoding: "utf8",
     });
-    const hex = intel_hex.parse(hexData).data;
     serialPort = new SerialPort({ path, baudRate: board.baud });
-    await stk.bootload(serialPort, hex, board, false);
+    await stk.bootload(serialPort, hexData, board, false);
     console.log("Programming successful!");
   } catch (error) {
     console.error("Programming failed:", error);
@@ -83,11 +82,11 @@ 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, hex: Buffer, opt: Board, use_8_bit_addresses = false): Promise<void>`
+- `bootload(stream: NodeJS.ReadWriteStream, hexData: string | Buffer, opt: Board, use_8_bit_addresses = false): 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, hex: Buffer, pageSize: number, timeout: number, use_8_bit_addresses = false): Promise<void>`
-- `verify(stream: NodeJS.ReadWriteStream, hex: Buffer, pageSize: number, timeout: number, use_8_bit_addresses = false): Promise<void>`
+- `upload(stream: NodeJS.ReadWriteStream, hexData: string | Buffer, pageSize: number, timeout: number, use_8_bit_addresses = false): Promise<void>`
+- `verify(stream: NodeJS.ReadWriteStream, hexData: string | Buffer, pageSize: number, timeout: number, use_8_bit_addresses = false): Promise<void>`
 
 For more detailed API information, please refer to the TypeScript definitions or the source code.
 

examples/avr4809.ts

@@ -1,6 +1,5 @@
 import fs from "fs/promises";
 import { SerialPort } from "serialport";
-import intel_hex from "intel-hex";
 import Stk500 from "../src/index.js";
 
 const stk = new Stk500();
@@ -13,11 +12,6 @@ const board = {
   timeout: 400,
 };
 
-async function readHexFile(filePath) {
-  const data = await fs.readFile(filePath, { encoding: "utf8" });
-  return intel_hex.parse(data).data;
-}
-
 function createSerialPort(path, baudRate) {
   return new Promise((resolve, reject) => {
     const serialPort = new SerialPort({ path, baudRate });
@@ -38,7 +32,9 @@ async function closeSerialPort(serialPort) {
 async function upload(path) {
   let serialPort;
   try {
-    const hex = await readHexFile("arduino-1.0.6/168/avr4809.cpp.hex");
+    const hex = await fs.readFile("arduino-1.0.6/168/avr4809.cpp.hex", {
+      encoding: "utf8",
+    });
     serialPort = await createSerialPort(path, board.baudRate);
     await stk.bootload(serialPort, hex, board, true);
     console.log("Programming SUCCESS!");

examples/diecimila-duemilanove168.ts

@@ -1,6 +1,5 @@
 import fs from "fs/promises";
 import { SerialPort } from "serialport";
-import intel_hex from "intel-hex";
 import Stk500 from "../src/index.js";
 
 const stk = new Stk500();
@@ -13,11 +12,6 @@ const board = {
   timeout: 400,
 };
 
-async function readHexFile(filePath) {
-  const data = await fs.readFile(filePath, { encoding: "utf8" });
-  return intel_hex.parse(data).data;
-}
-
 function createSerialPort(path, baudRate) {
   return new Promise((resolve, reject) => {
     const serialPort = new SerialPort({ path, baudRate });
@@ -38,7 +32,9 @@ async function closeSerialPort(serialPort) {
 async function upload(path) {
   let serialPort;
   try {
-    const hex = await readHexFile("arduino-1.0.6/168/StandardFirmata.cpp.hex");
+    const hex = await fs.readFile("arduino-1.0.6/168/StandardFirmata.cpp.hex", {
+      encoding: "utf8",
+    });
     serialPort = await createSerialPort(path, board.baudRate);
     await stk.bootload(serialPort, hex, board, false);
     console.log("Programming SUCCESS!");

examples/duemilanove328.ts

@@ -1,6 +1,5 @@
 import fs from "fs/promises";
 import { SerialPort } from "serialport";
-import intel_hex from "intel-hex";
 import Stk500 from "../src/index.js";
 
 const stk = new Stk500();
@@ -13,11 +12,6 @@ const board = {
   timeout: 400,
 };
 
-async function readHexFile(filePath) {
-  const data = await fs.readFile(filePath, { encoding: "utf8" });
-  return intel_hex.parse(data).data;
-}
-
 function createSerialPort(path, baudRate) {
   return new Promise((resolve, reject) => {
     const serialPort = new SerialPort({ path, baudRate });
@@ -38,7 +32,10 @@ async function closeSerialPort(serialPort) {
 async function upload(path) {
   let serialPort;
   try {
-    const hex = await readHexFile("arduino-1.0.6/duemilanove328/StandardFirmata.cpp.hex");
+    const hex = await fs.readFile(
+      "arduino-1.0.6/duemilanove328/StandardFirmata.cpp.hex",
+      { encoding: "utf8" }
+    );
     serialPort = await createSerialPort(path, board.baudRate);
     await stk.bootload(serialPort, hex, board, false);
     console.log("Programming SUCCESS!");

examples/lgt8f328.ts

@@ -1,6 +1,5 @@
 import fs from "fs/promises";
 import { SerialPort } from "serialport";
-import intel_hex from "intel-hex";
 import Stk500 from "../src/index.js";
 
 const stk = new Stk500();
@@ -13,11 +12,6 @@ const board = {
   timeout: 400,
 };
 
-async function readHexFile(filePath) {
-  const data = await fs.readFile(filePath, { encoding: "utf8" });
-  return intel_hex.parse(data).data;
-}
-
 function createSerialPort(path, baudRate) {
   return new Promise((resolve, reject) => {
     const serialPort = new SerialPort({ path, baudRate });
@@ -38,7 +32,9 @@ async function closeSerialPort(serialPort) {
 async function upload(path) {
   let serialPort;
   try {
-    const hex = await readHexFile("arduino-2.3.3/lgt8f328/Blink.ino.hex");
+    const hex = await fs.readFile("arduino-2.3.3/lgt8f328/Blink.ino.hex", {
+      encoding: "utf8",
+    });
     serialPort = await createSerialPort(path, board.baudRate);
     await stk.bootload(serialPort, hex, board, false);
     console.log("Programming SUCCESS!");

examples/nano.ts

@@ -1,6 +1,5 @@
 import fs from "fs/promises";
 import { SerialPort } from "serialport";
-import intel_hex from "intel-hex";
 import Stk500 from "../src/index.js";
 
 const stk = new Stk500();
@@ -13,11 +12,6 @@ const board = {
   timeout: 400,
 };
 
-async function readHexFile(filePath) {
-  const data = await fs.readFile(filePath, { encoding: "utf8" });
-  return intel_hex.parse(data).data;
-}
-
 function createSerialPort(path, baudRate) {
   return new Promise((resolve, reject) => {
     const serialPort = new SerialPort({ path, baudRate });
@@ -38,7 +32,9 @@ async function closeSerialPort(serialPort) {
 async function upload(path) {
   let serialPort;
   try {
-    const hex = await readHexFile("arduino-2.3.3/nano/Blink.ino.hex");
+    const hex = await fs.readFile("arduino-2.3.3/nano/Blink.ino.hex", {
+      encoding: "utf8",
+    });
     serialPort = await createSerialPort(path, board.baudRate);
     await stk.bootload(serialPort, hex, board, false);
     console.log("Programming SUCCESS!");

examples/uno.ts

@@ -1,6 +1,5 @@
 import fs from "fs/promises";
 import { SerialPort } from "serialport";
-import intel_hex from "intel-hex";
 import Stk500 from "../src/index.js";
 
 const stk = new Stk500();
@@ -13,11 +12,6 @@ const board = {
   timeout: 400,
 };
 
-async function readHexFile(filePath) {
-  const data = await fs.readFile(filePath, { encoding: "utf8" });
-  return intel_hex.parse(data).data;
-}
-
 function createSerialPort(path, baudRate) {
   return new Promise((resolve, reject) => {
     const serialPort = new SerialPort({ path, baudRate });
@@ -38,7 +32,9 @@ async function closeSerialPort(serialPort) {
 async function upload(path) {
   let serialPort;
   try {
-    const hex = await readHexFile("arduino-1.0.6/uno/StandardFirmata.cpp.hex");
+    const hex = await fs.readFile("arduino-1.0.6/uno/StandardFirmata.cpp.hex", {
+      encoding: "utf8",
+    });
     serialPort = await createSerialPort(path, board.baudRate);
     await stk.bootload(serialPort, hex, board, false);
     console.log("Programming SUCCESS!");

package.json

@@ -1,6 +1,6 @@
 {
   "name": "stk500-esm",
-  "version": "1.0.1",
+  "version": "1.1.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",
@@ -30,7 +30,6 @@
     "@types/node": "^22.7.5",
     "eslint": "^9.12.0",
     "globals": "^15.10.0",
-    "intel-hex": "^0.2.0",
     "serialport": "^12.0.0",
     "tsx": "^4.19.1",
     "typescript": "^5.6.2",

src/index.ts

@@ -1,5 +1,6 @@
 import Constants from "./lib/constants.js";
 import sendCommand from "./lib/sendCommand.js";
+import { parseIntelHex } from "./lib/intelHexParser.js";
 
 interface Board {
   name: string;
@@ -200,13 +201,16 @@ class STK500 {
 
   async upload(
     stream: NodeJS.ReadWriteStream,
-    hex: Buffer,
+    hexData: string | Buffer,
     pageSize: number,
     timeout: number,
     use8BitAddresses = false
   ): Promise<void> {
     this.log("program");
 
+    // Parse the Intel HEX data
+    const { data: hex } = parseIntelHex(hexData);
+
     let pageaddr = 0;
     let writeBytes;
     let useaddr;
@@ -258,13 +262,16 @@ class STK500 {
 
   async verify(
     stream: NodeJS.ReadWriteStream,
-    hex: Buffer,
+    hexData: string | Buffer,
     pageSize: number,
     timeout: number,
     use8BitAddresses = false
   ): Promise<void> {
     this.log("verify");
 
+    // Parse the Intel HEX data
+    const { data: hex } = parseIntelHex(hexData);
+
     let pageaddr = 0;
     let writeBytes;
     let useaddr;
@@ -331,7 +338,7 @@ class STK500 {
 
   async bootload(
     stream: NodeJS.ReadWriteStream,
-    hex: Buffer,
+    hexData: string | Buffer,
     opt: Board,
     use8BitAddresses = false
   ): Promise<void> {
@@ -347,8 +354,20 @@ class STK500 {
     await this.verifySignature(stream, opt.signature, opt.timeout);
     await this.setOptions(stream, parameters, opt.timeout);
     await this.enterProgrammingMode(stream, opt.timeout);
-    await this.upload(stream, hex, opt.pageSize, opt.timeout, use8BitAddresses);
-    await this.verify(stream, hex, opt.pageSize, opt.timeout, use8BitAddresses);
+    await this.upload(
+      stream,
+      hexData,
+      opt.pageSize,
+      opt.timeout,
+      use8BitAddresses
+    );
+    await this.verify(
+      stream,
+      hexData,
+      opt.pageSize,
+      opt.timeout,
+      use8BitAddresses
+    );
     await this.exitProgrammingMode(stream, opt.timeout);
   }
 }