initial commit

Author: mrfrase3

.eslintignore

@@ -0,0 +1,3 @@
+node_modules
+.eslintrc.js
+lib

.eslintrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  root: true,
+  extends: ['eslint:recommended', 'airbnb-base'],
+  plugins: ['import'],
+  parserOptions: {
+    project: './tsconfig.eslint.json',
+  },
+};

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+lib

README.md

@@ -0,0 +1,5 @@
+# upload-multitool
+
+**WIP:** This project is currently a work in progress
+
+A modern tool for uploading to micro controllers like Arduinos and ESP devices, written in typescript with automated tests.

package.json

@@ -0,0 +1,33 @@
+{
+  "name": "upload-multitool",
+  "version": "0.0.1",
+  "description": "Micro Controller Uploading Multitool",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha -r ts-node/register test/**/*.ts test/*.ts",
+    "build": "tsc"
+  },
+  "author": "Fraser Bullock",
+  "license": "UNLICENSED",
+  "devDependencies": {
+    "@types/chai": "^4.3.1",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^17.0.33",
+    "@typescript-eslint/eslint-plugin": "^5.23.0",
+    "@typescript-eslint/parser": "^5.23.0",
+    "axios": "^0.27.2",
+    "chai": "^4.3.6",
+    "eslint": "^8.15.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "mocha": "^10.0.0",
+    "serialport": "^10.4.0",
+    "ts-node": "^10.8.0",
+    "typescript": "^4.6.4",
+    "yaml": "^2.1.0"
+  },
+  "dependencies": {
+    "intel-hex": "^0.1.2"
+  }
+}

src/avr/avr-cpu-data.ts

@@ -0,0 +1,85 @@
+// referenced from the avrdude.conf
+
+interface CPUData {
+  signature: Buffer;
+  pageSize: number;
+  numPages: number;
+  timeout: number;
+  protocol: string;
+  delay1?: number;
+  delay2?: number;
+  stabDelay?: number;
+  cmdexeDelay?: number;
+  synchLoops?: number;
+  byteDelay?: number;
+  pollValue?: number;
+  pollIndex?: number;
+}
+
+interface CPUDefinitions {
+  [key: string]: CPUData;
+}
+
+const cpuDefs = {
+  atmega328p: {
+    signature: Buffer.from([0x1e, 0x95, 0x0f]),
+    pageSize: 128,
+    numPages: 256,
+    timeout: 400,
+    protocol: 'stk500v1',
+  } as CPUData,
+  atmega168: {
+    signature: Buffer.from([0x1e, 0x94, 0x06]),
+    pageSize: 128,
+    numPages: 128,
+    timeout: 400,
+    protocol: 'stk500v1',
+  } as CPUData,
+  atmega8: {
+    signature: Buffer.from([0x1e, 0x93, 0x07]),
+    pageSize: 64,
+    numPages: 128,
+    timeout: 400,
+    protocol: 'stk500v1',
+  } as CPUData,
+  atmega2560: {
+    signature: Buffer.from([0x1e, 0x98, 0x01]),
+    pageSize: 256,
+    numPages: 1024,
+    delay1: 10,
+    delay2: 1,
+    timeout: 0xc8, // 200
+    stabDelay: 0x64, // 100
+    cmdexeDelay: 0x19, // 25
+    synchLoops: 0x20, // 32
+    byteDelay: 0x00, // 0
+    pollValue: 0x53,
+    pollIndex: 0x03, // 3
+    protocol: 'stk500v2',
+  } as CPUData,
+  atmega1280: {
+    signature: Buffer.from([0x1e, 0x97, 0x03]),
+    pageSize: 256,
+    numPages: 512,
+    delay1: 10,
+    delay2: 1,
+    timeout: 0xc8, // 200
+    stabDelay: 0x64, // 100
+    cmdexeDelay: 0x19, // 25
+    synchLoops: 0x20, // 32
+    byteDelay: 0x00, // 0
+    pollValue: 0x53,
+    pollIndex: 0x03, // 3
+    protocol: 'stk500v2',
+  } as CPUData,
+  atmega32u4: {
+    signature: Buffer.from([0x43, 0x41, 0x54, 0x45, 0x52, 0x49, 0x4e]),
+    protocol: 'avr109',
+  } as CPUData,
+} as CPUDefinitions;
+
+export default (cpu?: string): CPUData => {
+  const cpuData = cpuDefs[cpu || ''];
+  if (!cpuData) throw new Error(`Unknown CPU: ${cpu}`);
+  return cpuData;
+};

src/avr/index.ts

@@ -0,0 +1,37 @@
+import { SerialPort } from 'serialport/dist/index.d';
+import { ProgramConfig } from '../index.d';
+
+import intelHex from 'intel-hex';
+import getCpuData from './avr-cpu-data';
+import STK500v1 from './stk500-v1';
+
+export const upload = async (serial: SerialPort, config: ProgramConfig) => {
+  const cpuData = getCpuData(config.cpu);
+  let uploader = null as STK500v1 | null;
+  switch (cpuData.protocol) {
+    case 'stk500v1':
+      uploader = new STK500v1(serial, { quiet: !config.verbose });
+      await uploader.bootload(
+        intelHex.parse(config.hex || '').data,
+        {
+          signature: cpuData.signature,
+          pageSize: cpuData.pageSize,
+          timeout: cpuData.timeout,
+        },
+      );
+      break;
+    default:
+      throw new Error(`Protocol ${cpuData.protocol} not supported`);
+  }
+};
+
+export const isSupported = (cpu: string) => {
+  try {
+    const cpuData = getCpuData(cpu);
+    return ['stk500v1'].includes(cpuData.protocol);
+  } catch (e) {
+    return false;
+  }
+};
+
+export default { upload, isSupported };