@kb1rma/libcomm14cux-ts 0.0.0

package/README.md

@@ -0,0 +1,154 @@
+# comm14cux-ts
+
+TypeScript library for communicating with the Lucas 14CUX engine ECU over its serial diagnostic port, using the Web Serial API.
+
+> **Status:** pre-release. The v1 goal is to mirror the public surface of libcomm14cux as closely as possible; every function of the C library has a corresponding method on `Ecu`.
+
+## Purpose
+
+The Lucas 14CUX was fitted to Rover V8 engines in Land Rover vehicles from 1990 to 1995, and to low-volume sports cars (TVR, Morgan, etc.) through the 1990s. Its diagnostic serial port gives direct access to the ECU's memory, which exposes live engine data, fault codes, fuel maps and the firmware ROM.
+
+The existing tool for this is [RoverGauge](https://github.com/colinbourassa/rovergauge), a Qt desktop app built on the C library [libcomm14cux](https://github.com/colinbourassa/libcomm14cux), both by Colin Bourassa. This project ports the library's protocol and data-decoding logic to TypeScript.
+
+This project is not affiliated with or endorsed by the author of libcomm14cux or RoverGauge.
+
+## Usage
+
+```ts
+import { Ecu, WebSerialTransport, AirflowType } from 'comm14cux-ts';
+
+const port = await navigator.serial.requestPort();
+const ecu = new Ecu(new WebSerialTransport(port));
+
+await ecu.connect();
+console.log(await ecu.getEngineRPM());
+console.log(await ecu.getMAFReading(AirflowType.Linearized));
+await ecu.disconnect();
+```
+
+Methods are named after the `c14cux_*` functions (`getCoolantTemp`, `getFuelMap`, `clearFaultCodes`, …). Where the C functions return `false`, these methods reject with an error from the `Comm14cuxError` family.
+
+## Scope
+
+Capabilities, matching what libcomm14cux provides:
+
+- **Live data:** engine RPM, road speed, coolant and fuel temperature, MAF reading, throttle position, short- and long-term lambda trims, main voltage, idle bypass motor position, target idle, injector pulse width, gear selection, CO trim voltage, MIL, fuel pump relay, purge valve and other output states
+- **Fault codes:** read and clear
+- **Fuel maps:** read any of the maps, the RPM table and the current map row/column indices
+- **ROM:** dump the 16 KB firmware image, read tune revision and ident
+- **Tests:** run the fuel pump; drive the idle air control motor
+- **Raw access:** read and write arbitrary memory addresses
+
+## Hardware
+
+The library needs the same interface cable as RoverGauge: a 5 V FTDI USB-to-serial cable with its Rx line inverted in the FTDI EEPROM and a ~390 Ω resistor between Rx and GND. See the [RoverGauge README](https://github.com/colinbourassa/rovergauge#building-interface-cable) for build instructions.
+
+**Recommended:** while programming the Rx inversion with FT_PROG (or `ft232r_prog` on Linux), also set the FTDI **latency timer to 1–2 ms**. The protocol waits for an echo of almost every command byte, and the default 16 ms latency timer delays each one. Web Serial cannot change this setting, so it has to be stored in the cable's EEPROM.
+
+## Design
+
+```
+┌─────────────────────────────────────────────┐
+│ Ecu            high-level, typed readings   │  getEngineRpm(), getFaultCodes(), dumpRom() …
+├─────────────────────────────────────────────┤
+│ Decoders       pure functions, no I/O       │  raw bytes → engineering units
+├─────────────────────────────────────────────┤
+│ Protocol       readMem / writeMem           │  command framing, echo checks, coarse-address cache
+├─────────────────────────────────────────────┤
+│ CommandQueue   one operation at a time      │  replaces libcomm14cux's mutex
+├─────────────────────────────────────────────┤
+│ Transport      bytes in / bytes out         │  WebSerialTransport │ SimulatedTransport
+└─────────────────────────────────────────────┘
+```
+
+### Transport
+
+A minimal interface so the protocol code never touches a platform API directly:
+
+```ts
+interface Transport {
+  open(): Promise<void>;
+  close(): Promise<void>;
+  write(data: Uint8Array): Promise<void>;
+  /** Resolves with exactly `length` bytes, or rejects with a TimeoutError. */
+  read(length: number, timeoutMs: number): Promise<Uint8Array>;
+}
+```
+
+- **`WebSerialTransport`** wraps a `SerialPort` and opens it at **7812 baud, 8N1, no flow control**. An option allows 15625 baud for ECUs running modified double-speed firmware. The default read timeout is 100 ms of silence, matching libcomm14cux.
+- **`SimulatedTransport`** emulates the ECU's side of the protocol over an in-memory address space. It is used for tests and for developing the UI without a car.
+
+Electron apps use `WebSerialTransport` as-is. Other transports (for example Node's `serialport`) can be added without changing the layers above.
+
+### Protocol
+
+All ECU access is memory reads and writes:
+
+| Step | Bytes sent | ECU response |
+|---|---|---|
+| Set coarse address | `(lenCode << 2) \| (addr >> 14)`, then `(addr >> 6) & 0xFF` | Echoes each byte |
+| Read | `0xC0 \| (addr & 0x3F)` | Streams the requested bytes (no echo) |
+| Write | `0x80 \| (addr & 0x3F)`, then the value | Echoes each byte |
+
+- A single read returns 1–16, 80, 100, 400 or 512 bytes. Longer reads are split into chunks.
+- When the next read uses the same length and falls in the same 64-byte block as the last coarse address, the coarse-address step is skipped. libcomm14cux compares a 64-byte window starting at the last (unaligned) address instead, which can read from the wrong block; this library deliberately does not.
+- Any echo mismatch or timeout fails the operation and clears the coarse-address cache.
+- Long reads (such as a ROM dump) can be stopped with `ecu.cancelRead()`, as in libcomm14cux.
+
+### CommandQueue
+
+The ECU can only handle one command sequence at a time. The queue serialises every public `Ecu` call, so a UI can poll live data and request a fuel map without interleaving bytes on the wire.
+
+### Decoders and Ecu
+
+Decoders are pure functions that turn raw memory into values (°F/°C, mph/kph, volts, percentages). They include the ROM revision detection that selects memory offsets for older and newer firmware. `Ecu` combines the queue, protocol and decoders into the public API.
+
+### Layout
+
+```
+src/
+  transport/        Transport interface, WebSerialTransport, SimulatedTransport
+  protocol/         Protocol (readMem / writeMem), read chunking
+  queue.ts          CommandQueue
+  decoders/         per-reading conversion functions (pure)
+  constants.ts      memory addresses, enums, ROM-revision tables
+  ecu.ts            public API
+  index.ts
+  ecu.*.test.ts     tests, by feature, through the public API
+  test-support/     shared test helpers (not published)
+```
+
+Tests import only from `src/index.ts`, as a user of the library would, and drive the `Ecu` against `SimulatedTransport` (or `WebSerialTransport` against a fake `SerialPort`). Wire-level behaviour is checked through `SimulatedTransport.written`.
+
+## Platform support
+
+Web Serial works in Chromium-based desktop browsers (Chrome, Edge, Opera), Firefox 151+ on desktop, and Chrome 148+ on Android. It does **not** work in Safari or any browser on iOS/iPadOS. The page must be served over HTTPS or from `localhost`.
+
+On Linux, the user needs permission to access the serial device (usually membership in the `dialout` group).
+
+## Safety
+
+Writing to ECU memory, running the fuel pump or driving the idle air control motor can affect a running engine. These functions are exposed deliberately and should be used with care. This software is provided with absolutely no warranty.
+
+## Credits and licence
+
+The protocol and decoding logic are derived from [libcomm14cux](https://github.com/colinbourassa/libcomm14cux) © Colin Bourassa, licensed under the GNU GPL v3.
+
+This project is therefore licensed under the **GNU General Public License v3.0 only** (`GPL-3.0-only`). Any application that includes this library must also be distributed under GPL-3.0-compatible terms, with its source code available.
+
+Parts of this project were written with the help of an AI assistant. The original libcomm14cux and RoverGauge projects do not accept AI-generated contributions, so nothing from this repository will be submitted to them.
+
+## Development
+
+Requires Node.js (see `.nvmrc`).
+
+```sh
+npm ci
+npm run lint          # ESLint + Prettier
+npm run type:check    # tsc --noEmit, strict
+npm test              # Vitest watch mode
+npm run test:coverage # enforces the coverage thresholds in vitest.config.ts
+npm run build         # emits dist/ with declarations and source maps
+```
+
+The behavioural specification, derived from libcomm14cux, is in [docs/test-specification.md](docs/test-specification.md).

package/dist/bytes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Reads an unsigned big-endian 16-bit value, the ECU's byte order.
+ *
+ * @param bytes - Buffer to read from.
+ * @param offset - Index of the high byte. Defaults to 0.
+ * @returns The value, 0 to 65535. A missing byte is treated as 0.
+ */
+export declare function be16(bytes: Uint8Array, offset?: number): number;
+//# sourceMappingURL=bytes.d.ts.map

package/dist/bytes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.d.ts","sourceRoot":"","sources":["../src/bytes.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,SAAI,GAAG,MAAM,CAE1D"}

package/dist/bytes.js

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: GPL-3.0-only
+// Copyright (C) 2026 comm14cux-ts contributors
+/**
+ * Reads an unsigned big-endian 16-bit value, the ECU's byte order.
+ *
+ * @param bytes - Buffer to read from.
+ * @param offset - Index of the high byte. Defaults to 0.
+ * @returns The value, 0 to 65535. A missing byte is treated as 0.
+ */
+export function be16(bytes, offset = 0) {
+    return ((bytes[offset] ?? 0) << 8) | (bytes[offset + 1] ?? 0);
+}
+//# sourceMappingURL=bytes.js.map

package/dist/bytes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../src/bytes.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,+CAA+C;AAE/C;;;;;;GAMG;AACH,MAAM,UAAU,IAAI,CAAC,KAAiB,EAAE,MAAM,GAAG,CAAC;IAChD,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AAChE,CAAC","sourcesContent":["// SPDX-License-Identifier: GPL-3.0-only\n// Copyright (C) 2026 comm14cux-ts contributors\n\n/**\n * Reads an unsigned big-endian 16-bit value, the ECU's byte order.\n *\n * @param bytes - Buffer to read from.\n * @param offset - Index of the high byte. Defaults to 0.\n * @returns The value, 0 to 65535. A missing byte is treated as 0.\n */\nexport function be16(bytes: Uint8Array, offset = 0): number {\n  return ((bytes[offset] ?? 0) << 8) | (bytes[offset + 1] ?? 0);\n}\n"]}

package/dist/constants.d.ts

@@ -0,0 +1,174 @@
+/** Baud rate of the 14CUX serial port. */
+export declare const BAUD = 7812;
+/** Baud rate used by ECUs running modified double-speed firmware. */
+export declare const BAUD_DOUBLE_SPEED = 15625;
+/** Number of engine speed ranges in the fuel maps. */
+export declare const FUEL_MAP_COLUMNS = 16;
+/** Number of engine load ranges in the fuel maps. */
+export declare const FUEL_MAP_ROWS = 8;
+/** Byte quantities that may be requested in a single read (`c14cux_readcount`). */
+export declare const ReadCount: {
+    readonly Count0: 16;
+    readonly Count1: 80;
+    readonly Count2: 100;
+    readonly Count3: 400;
+    readonly Count4: 512;
+};
+/** Length codes sent to the ECU for the fixed read quantities. */
+export declare const ReadCountValue: {
+    readonly Count1: 16;
+    readonly Count2: 17;
+    readonly Count3: 18;
+    readonly Count4: 19;
+};
+/** Sizes in bytes of fixed-size structures within the ROM. */
+export declare const DataSize: {
+    readonly ROM: 16384;
+    readonly FuelMap: 128;
+};
+/** Important memory offsets in the ECU's address space (`c14cux_memory_offset`). */
+export declare const MemoryOffset: {
+    readonly ROMAddress: 49152;
+    readonly RPMTable: 51200;
+    readonly Port1: 2;
+    readonly LongTermLambdaFuelingTrimOdd: 66;
+    readonly LongTermLambdaFuelingTrimEven: 70;
+    readonly ShortTermLambdaFuelingTrimOdd: 101;
+    readonly ShortTermLambdaFuelingTrimEven: 103;
+    readonly FaultCodes: 73;
+    readonly ThrottleMinimumPosition: 81;
+    readonly MainVoltage: 85;
+    readonly MassAirflowDirect: 87;
+    readonly ThrottlePosition: 95;
+    readonly CoolantTemp: 106;
+    readonly IdleBypassPosition: 109;
+    readonly EngineSpeedInstantaneous: 122;
+    readonly EngineSpeedFiltered: 124;
+    readonly InjectorPulseWidth: 130;
+    readonly Bits008A: 138;
+    readonly PurgeValveState: 150;
+    readonly Bits00DD: 221;
+    readonly TransmissionGear: 8192;
+    readonly RoadSpeed: 8195;
+    readonly FuelTemp: 8198;
+    readonly RowScaler: 8202;
+    readonly RPMLimit: 8204;
+    readonly IdleMode: 8263;
+    readonly MassAirflowLinear: 8269;
+    readonly TargetIdleSpeed: 8273;
+    readonly RevBMainVoltageFactorA: 51099;
+    readonly RevBMainVoltageFactorB: 51100;
+    readonly RevBMainVoltageFactorC: 51101;
+    readonly RevCMainVoltageFactorA: 51139;
+    readonly RevCMainVoltageFactorB: 51140;
+    readonly RevCMainVoltageFactorC: 51141;
+    readonly MAFRowScaler: 49607;
+    readonly Map0RowScalerInitValue: 49609;
+    readonly FuelMap0: 49152;
+    readonly NewFuelMap1: 49767;
+    readonly NewFuelMap2: 50041;
+    readonly NewFuelMap3: 50315;
+    readonly NewFuelMap4: 50589;
+    readonly NewFuelMap5: 50863;
+    readonly OldFuelMap1: 49727;
+    readonly OldFuelMap2: 50001;
+    readonly OldFuelMap3: 50275;
+    readonly OldFuelMap4: 50549;
+    readonly OldFuelMap5: 50823;
+    readonly TuneRevision: 65513;
+    readonly ChecksumFixer: 65515;
+    readonly TuneIdent: 65516;
+    readonly CurrentFuelMapId: 8236;
+    readonly FuelMapRowIndex: 91;
+    readonly FuelMapColumnIndex: 92;
+    readonly IdleAirControlStepCount: 117;
+    readonly FuelPumpTimer: 175;
+};
+/** Offset from the start of a fuel map to its row scaler. */
+export declare const FUEL_MAP_ROW_SCALER_OFFSET = 266;
+/** Fixed main-voltage coefficients for very old ECUs (1990 and earlier). */
+export declare const RevAMainVoltageFactor: {
+    readonly A: 100;
+    readonly B: 189;
+    readonly C: 24960;
+};
+/** Transmission gear selections. */
+export declare const Gear: {
+    readonly NoReading: 0;
+    readonly ParkOrNeutral: 1;
+    readonly DriveOrReverse: 2;
+    readonly ManualGearbox: 3;
+};
+/**
+ * Union of the {@link Gear} values.
+ */
+export type Gear = (typeof Gear)[keyof typeof Gear];
+/** The two engine banks. */
+export declare const Bank: {
+    readonly Odd: 0;
+    readonly Even: 1;
+};
+/**
+ * Union of the {@link Bank} values.
+ */
+export type Bank = (typeof Bank)[keyof typeof Bank];
+/** Types of lambda trim for fueling. */
+export declare const LambdaTrimType: {
+    readonly ShortTerm: 0;
+    readonly LongTerm: 1;
+};
+/**
+ * Union of the {@link LambdaTrimType} values.
+ */
+export type LambdaTrimType = (typeof LambdaTrimType)[keyof typeof LambdaTrimType];
+/** Fueling feedback modes. */
+export declare const FeedbackMode: {
+    readonly ClosedLoop: 0;
+    readonly OpenLoop: 1;
+};
+/**
+ * Union of the {@link FeedbackMode} values.
+ */
+export type FeedbackMode = (typeof FeedbackMode)[keyof typeof FeedbackMode];
+/** The two means of reading a value from the MAF. */
+export declare const AirflowType: {
+    readonly Direct: 0;
+    readonly Linearized: 1;
+};
+/**
+ * Union of the {@link AirflowType} values.
+ */
+export type AirflowType = (typeof AirflowType)[keyof typeof AirflowType];
+/** The two methods of interpreting a throttle position. */
+export declare const ThrottlePosType: {
+    readonly Absolute: 0;
+    readonly Corrected: 1;
+};
+/**
+ * Union of the {@link ThrottlePosType} values.
+ */
+export type ThrottlePosType = (typeof ThrottlePosType)[keyof typeof ThrottlePosType];
+/** Revisions of the ROM data layout (`c14cux_data_offset_rev`). */
+export declare const DataOffsetRev: {
+    readonly Unset: 0;
+    readonly RevA: 1;
+    readonly RevB: 2;
+    readonly RevC: 3;
+};
+/**
+ * Union of the {@link DataOffsetRev} values.
+ */
+export type DataOffsetRev = (typeof DataOffsetRev)[keyof typeof DataOffsetRev];
+/** States of the carbon canister purge valve. */
+export declare const PurgeValveState: {
+    readonly Closed: 0;
+    readonly Toggling: 1;
+    readonly Open: 2;
+};
+/**
+ * Union of the {@link PurgeValveState} values.
+ */
+export type PurgeValveState = (typeof PurgeValveState)[keyof typeof PurgeValveState];
+/** Default per-read silence timeout, matching libcomm14cux (100 ms). */
+export declare const DEFAULT_READ_TIMEOUT_MS = 100;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAKA,0CAA0C;AAC1C,eAAO,MAAM,IAAI,OAAO,CAAC;AAEzB,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,QAAQ,CAAC;AAEvC,sDAAsD;AACtD,eAAO,MAAM,gBAAgB,KAAK,CAAC;AAEnC,qDAAqD;AACrD,eAAO,MAAM,aAAa,IAAI,CAAC;AAE/B,mFAAmF;AACnF,eAAO,MAAM,SAAS;;;;;;CAMZ,CAAC;AAEX,kEAAkE;AAClE,eAAO,MAAM,cAAc;;;;;CAKjB,CAAC;AAEX,8DAA8D;AAC9D,eAAO,MAAM,QAAQ;;;CAGX,CAAC;AAEX,oFAAoF;AACpF,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwDf,CAAC;AAEX,6DAA6D;AAC7D,eAAO,MAAM,0BAA0B,MAAQ,CAAC;AAEhD,4EAA4E;AAC5E,eAAO,MAAM,qBAAqB;;;;CAIxB,CAAC;AAEX,oCAAoC;AACpC,eAAO,MAAM,IAAI;;;;;CAKP,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,OAAO,IAAI,CAAC,CAAC;AAEpD,4BAA4B;AAC5B,eAAO,MAAM,IAAI;;;CAA+B,CAAC;AACjD;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,OAAO,IAAI,CAAC,CAAC;AAEpD,wCAAwC;AACxC,eAAO,MAAM,cAAc;;;CAAyC,CAAC;AACrE;;GAEG;AACH,MAAM,MAAM,cAAc,GACxB,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAEvD,8BAA8B;AAC9B,eAAO,MAAM,YAAY;;;CAA0C,CAAC;AACpE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE5E,qDAAqD;AACrD,eAAO,MAAM,WAAW;;;CAAwC,CAAC;AACjE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEzE,2DAA2D;AAC3D,eAAO,MAAM,eAAe;;;CAAyC,CAAC;AACtE;;GAEG;AACH,MAAM,MAAM,eAAe,GACzB,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAEzD,mEAAmE;AACnE,eAAO,MAAM,aAAa;;;;;CAAmD,CAAC;AAC9E;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE/E,iDAAiD;AACjD,eAAO,MAAM,eAAe;;;;CAA+C,CAAC;AAC5E;;GAEG;AACH,MAAM,MAAM,eAAe,GACzB,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAEzD,wEAAwE;AACxE,eAAO,MAAM,uBAAuB,MAAM,CAAC"}

package/dist/constants.js

@@ -0,0 +1,122 @@
+// SPDX-License-Identifier: GPL-3.0-only
+// Derived from libcomm14cux (https://github.com/colinbourassa/libcomm14cux)
+// Copyright (C) Colin Bourassa. Licensed under the GNU GPL v3.
+// Ported to TypeScript and modified for comm14cux-ts, 2026.
+/** Baud rate of the 14CUX serial port. */
+export const BAUD = 7812;
+/** Baud rate used by ECUs running modified double-speed firmware. */
+export const BAUD_DOUBLE_SPEED = 15625;
+/** Number of engine speed ranges in the fuel maps. */
+export const FUEL_MAP_COLUMNS = 16;
+/** Number of engine load ranges in the fuel maps. */
+export const FUEL_MAP_ROWS = 8;
+/** Byte quantities that may be requested in a single read (`c14cux_readcount`). */
+export const ReadCount = {
+    Count0: 0x0010,
+    Count1: 0x0050,
+    Count2: 0x0064,
+    Count3: 0x0190,
+    Count4: 0x0200,
+};
+/** Length codes sent to the ECU for the fixed read quantities. */
+export const ReadCountValue = {
+    Count1: 0x10,
+    Count2: 0x11,
+    Count3: 0x12,
+    Count4: 0x13,
+};
+/** Sizes in bytes of fixed-size structures within the ROM. */
+export const DataSize = {
+    ROM: 0x4000,
+    FuelMap: 0x80,
+};
+/** Important memory offsets in the ECU's address space (`c14cux_memory_offset`). */
+export const MemoryOffset = {
+    ROMAddress: 0xc000,
+    RPMTable: 0xc800,
+    Port1: 0x0002,
+    LongTermLambdaFuelingTrimOdd: 0x0042,
+    LongTermLambdaFuelingTrimEven: 0x0046,
+    ShortTermLambdaFuelingTrimOdd: 0x0065,
+    ShortTermLambdaFuelingTrimEven: 0x0067,
+    FaultCodes: 0x0049,
+    ThrottleMinimumPosition: 0x0051,
+    MainVoltage: 0x0055,
+    MassAirflowDirect: 0x0057,
+    ThrottlePosition: 0x005f,
+    CoolantTemp: 0x006a,
+    IdleBypassPosition: 0x006d,
+    EngineSpeedInstantaneous: 0x007a,
+    EngineSpeedFiltered: 0x007c,
+    InjectorPulseWidth: 0x0082,
+    Bits008A: 0x008a,
+    PurgeValveState: 0x0096,
+    Bits00DD: 0x00dd,
+    TransmissionGear: 0x2000,
+    RoadSpeed: 0x2003,
+    FuelTemp: 0x2006,
+    RowScaler: 0x200a,
+    RPMLimit: 0x200c,
+    IdleMode: 0x2047,
+    MassAirflowLinear: 0x204d,
+    TargetIdleSpeed: 0x2051,
+    RevBMainVoltageFactorA: 0xc79b,
+    RevBMainVoltageFactorB: 0xc79c,
+    RevBMainVoltageFactorC: 0xc79d,
+    RevCMainVoltageFactorA: 0xc7c3,
+    RevCMainVoltageFactorB: 0xc7c4,
+    RevCMainVoltageFactorC: 0xc7c5,
+    MAFRowScaler: 0xc1c7,
+    Map0RowScalerInitValue: 0xc1c9,
+    FuelMap0: 0xc000,
+    NewFuelMap1: 0xc267,
+    NewFuelMap2: 0xc379,
+    NewFuelMap3: 0xc48b,
+    NewFuelMap4: 0xc59d,
+    NewFuelMap5: 0xc6af,
+    OldFuelMap1: 0xc23f,
+    OldFuelMap2: 0xc351,
+    OldFuelMap3: 0xc463,
+    OldFuelMap4: 0xc575,
+    OldFuelMap5: 0xc687,
+    TuneRevision: 0xffe9,
+    ChecksumFixer: 0xffeb,
+    TuneIdent: 0xffec,
+    CurrentFuelMapId: 0x202c,
+    FuelMapRowIndex: 0x005b,
+    FuelMapColumnIndex: 0x005c,
+    IdleAirControlStepCount: 0x0075,
+    FuelPumpTimer: 0x00af,
+};
+/** Offset from the start of a fuel map to its row scaler. */
+export const FUEL_MAP_ROW_SCALER_OFFSET = 0x10a;
+/** Fixed main-voltage coefficients for very old ECUs (1990 and earlier). */
+export const RevAMainVoltageFactor = {
+    A: 0x64,
+    B: 0xbd,
+    C: 0x6180,
+};
+/** Transmission gear selections. */
+export const Gear = {
+    NoReading: 0,
+    ParkOrNeutral: 1,
+    DriveOrReverse: 2,
+    ManualGearbox: 3,
+};
+/** The two engine banks. */
+export const Bank = { Odd: 0, Even: 1 };
+/** Types of lambda trim for fueling. */
+export const LambdaTrimType = { ShortTerm: 0, LongTerm: 1 };
+/** Fueling feedback modes. */
+export const FeedbackMode = { ClosedLoop: 0, OpenLoop: 1 };
+/** The two means of reading a value from the MAF. */
+export const AirflowType = { Direct: 0, Linearized: 1 };
+/** The two methods of interpreting a throttle position. */
+export const ThrottlePosType = { Absolute: 0, Corrected: 1 };
+/** Revisions of the ROM data layout (`c14cux_data_offset_rev`). */
+export const DataOffsetRev = { Unset: 0, RevA: 1, RevB: 2, RevC: 3 };
+/** States of the carbon canister purge valve. */
+export const PurgeValveState = { Closed: 0, Toggling: 1, Open: 2 };
+/** Default per-read silence timeout, matching libcomm14cux (100 ms). */
+export const DEFAULT_READ_TIMEOUT_MS = 100;
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,4EAA4E;AAC5E,+DAA+D;AAC/D,4DAA4D;AAE5D,0CAA0C;AAC1C,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,CAAC;AAEzB,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,CAAC;AAEvC,sDAAsD;AACtD,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAEnC,qDAAqD;AACrD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC;AAE/B,mFAAmF;AACnF,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,MAAM;CACN,CAAC;AAEX,kEAAkE;AAClE,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,IAAI;CACJ,CAAC;AAEX,8DAA8D;AAC9D,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,GAAG,EAAE,MAAM;IACX,OAAO,EAAE,IAAI;CACL,CAAC;AAEX,oFAAoF;AACpF,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,UAAU,EAAE,MAAM;IAClB,QAAQ,EAAE,MAAM;IAChB,KAAK,EAAE,MAAM;IACb,4BAA4B,EAAE,MAAM;IACpC,6BAA6B,EAAE,MAAM;IACrC,6BAA6B,EAAE,MAAM;IACrC,8BAA8B,EAAE,MAAM;IACtC,UAAU,EAAE,MAAM;IAClB,uBAAuB,EAAE,MAAM;IAC/B,WAAW,EAAE,MAAM;IACnB,iBAAiB,EAAE,MAAM;IACzB,gBAAgB,EAAE,MAAM;IACxB,WAAW,EAAE,MAAM;IACnB,kBAAkB,EAAE,MAAM;IAC1B,wBAAwB,EAAE,MAAM;IAChC,mBAAmB,EAAE,MAAM;IAC3B,kBAAkB,EAAE,MAAM;IAC1B,QAAQ,EAAE,MAAM;IAChB,eAAe,EAAE,MAAM;IACvB,QAAQ,EAAE,MAAM;IAChB,gBAAgB,EAAE,MAAM;IACxB,SAAS,EAAE,MAAM;IACjB,QAAQ,EAAE,MAAM;IAChB,SAAS,EAAE,MAAM;IACjB,QAAQ,EAAE,MAAM;IAChB,QAAQ,EAAE,MAAM;IAChB,iBAAiB,EAAE,MAAM;IACzB,eAAe,EAAE,MAAM;IACvB,sBAAsB,EAAE,MAAM;IAC9B,sBAAsB,EAAE,MAAM;IAC9B,sBAAsB,EAAE,MAAM;IAC9B,sBAAsB,EAAE,MAAM;IAC9B,sBAAsB,EAAE,MAAM;IAC9B,sBAAsB,EAAE,MAAM;IAC9B,YAAY,EAAE,MAAM;IACpB,sBAAsB,EAAE,MAAM;IAC9B,QAAQ,EAAE,MAAM;IAChB,WAAW,EAAE,MAAM;IACnB,WAAW,EAAE,MAAM;IACnB,WAAW,EAAE,MAAM;IACnB,WAAW,EAAE,MAAM;IACnB,WAAW,EAAE,MAAM;IACnB,WAAW,EAAE,MAAM;IACnB,WAAW,EAAE,MAAM;IACnB,WAAW,EAAE,MAAM;IACnB,WAAW,EAAE,MAAM;IACnB,WAAW,EAAE,MAAM;IACnB,YAAY,EAAE,MAAM;IACpB,aAAa,EAAE,MAAM;IACrB,SAAS,EAAE,MAAM;IACjB,gBAAgB,EAAE,MAAM;IACxB,eAAe,EAAE,MAAM;IACvB,kBAAkB,EAAE,MAAM;IAC1B,uBAAuB,EAAE,MAAM;IAC/B,aAAa,EAAE,MAAM;CACb,CAAC;AAEX,6DAA6D;AAC7D,MAAM,CAAC,MAAM,0BAA0B,GAAG,KAAK,CAAC;AAEhD,4EAA4E;AAC5E,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,MAAM;CACD,CAAC;AAEX,oCAAoC;AACpC,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,SAAS,EAAE,CAAC;IACZ,aAAa,EAAE,CAAC;IAChB,cAAc,EAAE,CAAC;IACjB,aAAa,EAAE,CAAC;CACR,CAAC;AAMX,4BAA4B;AAC5B,MAAM,CAAC,MAAM,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAW,CAAC;AAMjD,wCAAwC;AACxC,MAAM,CAAC,MAAM,cAAc,GAAG,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAW,CAAC;AAOrE,8BAA8B;AAC9B,MAAM,CAAC,MAAM,YAAY,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAW,CAAC;AAMpE,qDAAqD;AACrD,MAAM,CAAC,MAAM,WAAW,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAW,CAAC;AAMjE,2DAA2D;AAC3D,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,QAAQ,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAW,CAAC;AAOtE,mEAAmE;AACnE,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAW,CAAC;AAM9E,iDAAiD;AACjD,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAW,CAAC;AAO5E,wEAAwE;AACxE,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,CAAC","sourcesContent":["// SPDX-License-Identifier: GPL-3.0-only\n// Derived from libcomm14cux (https://github.com/colinbourassa/libcomm14cux)\n// Copyright (C) Colin Bourassa. Licensed under the GNU GPL v3.\n// Ported to TypeScript and modified for comm14cux-ts, 2026.\n\n/** Baud rate of the 14CUX serial port. */\nexport const BAUD = 7812;\n\n/** Baud rate used by ECUs running modified double-speed firmware. */\nexport const BAUD_DOUBLE_SPEED = 15625;\n\n/** Number of engine speed ranges in the fuel maps. */\nexport const FUEL_MAP_COLUMNS = 16;\n\n/** Number of engine load ranges in the fuel maps. */\nexport const FUEL_MAP_ROWS = 8;\n\n/** Byte quantities that may be requested in a single read (`c14cux_readcount`). */\nexport const ReadCount = {\n  Count0: 0x0010,\n  Count1: 0x0050,\n  Count2: 0x0064,\n  Count3: 0x0190,\n  Count4: 0x0200,\n} as const;\n\n/** Length codes sent to the ECU for the fixed read quantities. */\nexport const ReadCountValue = {\n  Count1: 0x10,\n  Count2: 0x11,\n  Count3: 0x12,\n  Count4: 0x13,\n} as const;\n\n/** Sizes in bytes of fixed-size structures within the ROM. */\nexport const DataSize = {\n  ROM: 0x4000,\n  FuelMap: 0x80,\n} as const;\n\n/** Important memory offsets in the ECU's address space (`c14cux_memory_offset`). */\nexport const MemoryOffset = {\n  ROMAddress: 0xc000,\n  RPMTable: 0xc800,\n  Port1: 0x0002,\n  LongTermLambdaFuelingTrimOdd: 0x0042,\n  LongTermLambdaFuelingTrimEven: 0x0046,\n  ShortTermLambdaFuelingTrimOdd: 0x0065,\n  ShortTermLambdaFuelingTrimEven: 0x0067,\n  FaultCodes: 0x0049,\n  ThrottleMinimumPosition: 0x0051,\n  MainVoltage: 0x0055,\n  MassAirflowDirect: 0x0057,\n  ThrottlePosition: 0x005f,\n  CoolantTemp: 0x006a,\n  IdleBypassPosition: 0x006d,\n  EngineSpeedInstantaneous: 0x007a,\n  EngineSpeedFiltered: 0x007c,\n  InjectorPulseWidth: 0x0082,\n  Bits008A: 0x008a,\n  PurgeValveState: 0x0096,\n  Bits00DD: 0x00dd,\n  TransmissionGear: 0x2000,\n  RoadSpeed: 0x2003,\n  FuelTemp: 0x2006,\n  RowScaler: 0x200a,\n  RPMLimit: 0x200c,\n  IdleMode: 0x2047,\n  MassAirflowLinear: 0x204d,\n  TargetIdleSpeed: 0x2051,\n  RevBMainVoltageFactorA: 0xc79b,\n  RevBMainVoltageFactorB: 0xc79c,\n  RevBMainVoltageFactorC: 0xc79d,\n  RevCMainVoltageFactorA: 0xc7c3,\n  RevCMainVoltageFactorB: 0xc7c4,\n  RevCMainVoltageFactorC: 0xc7c5,\n  MAFRowScaler: 0xc1c7,\n  Map0RowScalerInitValue: 0xc1c9,\n  FuelMap0: 0xc000,\n  NewFuelMap1: 0xc267,\n  NewFuelMap2: 0xc379,\n  NewFuelMap3: 0xc48b,\n  NewFuelMap4: 0xc59d,\n  NewFuelMap5: 0xc6af,\n  OldFuelMap1: 0xc23f,\n  OldFuelMap2: 0xc351,\n  OldFuelMap3: 0xc463,\n  OldFuelMap4: 0xc575,\n  OldFuelMap5: 0xc687,\n  TuneRevision: 0xffe9,\n  ChecksumFixer: 0xffeb,\n  TuneIdent: 0xffec,\n  CurrentFuelMapId: 0x202c,\n  FuelMapRowIndex: 0x005b,\n  FuelMapColumnIndex: 0x005c,\n  IdleAirControlStepCount: 0x0075,\n  FuelPumpTimer: 0x00af,\n} as const;\n\n/** Offset from the start of a fuel map to its row scaler. */\nexport const FUEL_MAP_ROW_SCALER_OFFSET = 0x10a;\n\n/** Fixed main-voltage coefficients for very old ECUs (1990 and earlier). */\nexport const RevAMainVoltageFactor = {\n  A: 0x64,\n  B: 0xbd,\n  C: 0x6180,\n} as const;\n\n/** Transmission gear selections. */\nexport const Gear = {\n  NoReading: 0,\n  ParkOrNeutral: 1,\n  DriveOrReverse: 2,\n  ManualGearbox: 3,\n} as const;\n/**\n * Union of the {@link Gear} values.\n */\nexport type Gear = (typeof Gear)[keyof typeof Gear];\n\n/** The two engine banks. */\nexport const Bank = { Odd: 0, Even: 1 } as const;\n/**\n * Union of the {@link Bank} values.\n */\nexport type Bank = (typeof Bank)[keyof typeof Bank];\n\n/** Types of lambda trim for fueling. */\nexport const LambdaTrimType = { ShortTerm: 0, LongTerm: 1 } as const;\n/**\n * Union of the {@link LambdaTrimType} values.\n */\nexport type LambdaTrimType =\n  (typeof LambdaTrimType)[keyof typeof LambdaTrimType];\n\n/** Fueling feedback modes. */\nexport const FeedbackMode = { ClosedLoop: 0, OpenLoop: 1 } as const;\n/**\n * Union of the {@link FeedbackMode} values.\n */\nexport type FeedbackMode = (typeof FeedbackMode)[keyof typeof FeedbackMode];\n\n/** The two means of reading a value from the MAF. */\nexport const AirflowType = { Direct: 0, Linearized: 1 } as const;\n/**\n * Union of the {@link AirflowType} values.\n */\nexport type AirflowType = (typeof AirflowType)[keyof typeof AirflowType];\n\n/** The two methods of interpreting a throttle position. */\nexport const ThrottlePosType = { Absolute: 0, Corrected: 1 } as const;\n/**\n * Union of the {@link ThrottlePosType} values.\n */\nexport type ThrottlePosType =\n  (typeof ThrottlePosType)[keyof typeof ThrottlePosType];\n\n/** Revisions of the ROM data layout (`c14cux_data_offset_rev`). */\nexport const DataOffsetRev = { Unset: 0, RevA: 1, RevB: 2, RevC: 3 } as const;\n/**\n * Union of the {@link DataOffsetRev} values.\n */\nexport type DataOffsetRev = (typeof DataOffsetRev)[keyof typeof DataOffsetRev];\n\n/** States of the carbon canister purge valve. */\nexport const PurgeValveState = { Closed: 0, Toggling: 1, Open: 2 } as const;\n/**\n * Union of the {@link PurgeValveState} values.\n */\nexport type PurgeValveState =\n  (typeof PurgeValveState)[keyof typeof PurgeValveState];\n\n/** Default per-read silence timeout, matching libcomm14cux (100 ms). */\nexport const DEFAULT_READ_TIMEOUT_MS = 100;\n"]}

package/dist/decoders/airflow.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Decodes the "direct" mass airflow reading, which changes linearly with
+ * sensor voltage but logarithmically with airflow.
+ *
+ * @param raw - The 10-bit reading, 0 to 1023.
+ * @returns Airflow as a fraction from 0 to 1 of the highest measurement.
+ * @throws {@link InvalidReadingError} if `raw` is above 1023.
+ */
+export declare function decodeMafDirect(raw: number): number;
+/**
+ * Decodes the "linearized" mass airflow reading, which changes linearly with
+ * airflow.
+ *
+ * @param raw - The reading, 0 to 17290.
+ * @returns Airflow as a fraction from 0 to 1 of the highest measurement.
+ * @throws {@link InvalidReadingError} if `raw` is above 17290.
+ */
+export declare function decodeMafLinear(raw: number): number;
+//# sourceMappingURL=airflow.d.ts.map

package/dist/decoders/airflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"airflow.d.ts","sourceRoot":"","sources":["../../src/decoders/airflow.ts"],"names":[],"mappings":"AAUA;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAMnD;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAMnD"}

package/dist/decoders/airflow.js

@@ -0,0 +1,36 @@
+// SPDX-License-Identifier: GPL-3.0-only
+// Derived from libcomm14cux (https://github.com/colinbourassa/libcomm14cux)
+// Copyright (C) Colin Bourassa. Licensed under the GNU GPL v3.
+// Ported to TypeScript and modified for comm14cux-ts, 2026.
+import { InvalidReadingError } from '../errors.js';
+const DIRECT_MAX = 1023;
+const LINEAR_MAX = 17290;
+/**
+ * Decodes the "direct" mass airflow reading, which changes linearly with
+ * sensor voltage but logarithmically with airflow.
+ *
+ * @param raw - The 10-bit reading, 0 to 1023.
+ * @returns Airflow as a fraction from 0 to 1 of the highest measurement.
+ * @throws {@link InvalidReadingError} if `raw` is above 1023.
+ */
+export function decodeMafDirect(raw) {
+    if (raw > DIRECT_MAX) {
+        throw new InvalidReadingError(`MAF direct reading out of range: ${raw}`);
+    }
+    return raw / DIRECT_MAX;
+}
+/**
+ * Decodes the "linearized" mass airflow reading, which changes linearly with
+ * airflow.
+ *
+ * @param raw - The reading, 0 to 17290.
+ * @returns Airflow as a fraction from 0 to 1 of the highest measurement.
+ * @throws {@link InvalidReadingError} if `raw` is above 17290.
+ */
+export function decodeMafLinear(raw) {
+    if (raw > LINEAR_MAX) {
+        throw new InvalidReadingError(`MAF linear reading out of range: ${raw}`);
+    }
+    return raw / LINEAR_MAX;
+}
+//# sourceMappingURL=airflow.js.map

package/dist/decoders/airflow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"airflow.js","sourceRoot":"","sources":["../../src/decoders/airflow.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,4EAA4E;AAC5E,+DAA+D;AAC/D,4DAA4D;AAE5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,MAAM,UAAU,GAAG,IAAI,CAAC;AACxB,MAAM,UAAU,GAAG,KAAK,CAAC;AAEzB;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,IAAI,GAAG,GAAG,UAAU,EAAE,CAAC;QACrB,MAAM,IAAI,mBAAmB,CAAC,oCAAoC,GAAG,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,OAAO,GAAG,GAAG,UAAU,CAAC;AAC1B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,IAAI,GAAG,GAAG,UAAU,EAAE,CAAC;QACrB,MAAM,IAAI,mBAAmB,CAAC,oCAAoC,GAAG,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,OAAO,GAAG,GAAG,UAAU,CAAC;AAC1B,CAAC","sourcesContent":["// SPDX-License-Identifier: GPL-3.0-only\n// Derived from libcomm14cux (https://github.com/colinbourassa/libcomm14cux)\n// Copyright (C) Colin Bourassa. Licensed under the GNU GPL v3.\n// Ported to TypeScript and modified for comm14cux-ts, 2026.\n\nimport { InvalidReadingError } from '../errors.js';\n\nconst DIRECT_MAX = 1023;\nconst LINEAR_MAX = 17290;\n\n/**\n * Decodes the \"direct\" mass airflow reading, which changes linearly with\n * sensor voltage but logarithmically with airflow.\n *\n * @param raw - The 10-bit reading, 0 to 1023.\n * @returns Airflow as a fraction from 0 to 1 of the highest measurement.\n * @throws {@link InvalidReadingError} if `raw` is above 1023.\n */\nexport function decodeMafDirect(raw: number): number {\n  if (raw > DIRECT_MAX) {\n    throw new InvalidReadingError(`MAF direct reading out of range: ${raw}`);\n  }\n\n  return raw / DIRECT_MAX;\n}\n\n/**\n * Decodes the \"linearized\" mass airflow reading, which changes linearly with\n * airflow.\n *\n * @param raw - The reading, 0 to 17290.\n * @returns Airflow as a fraction from 0 to 1 of the highest measurement.\n * @throws {@link InvalidReadingError} if `raw` is above 17290.\n */\nexport function decodeMafLinear(raw: number): number {\n  if (raw > LINEAR_MAX) {\n    throw new InvalidReadingError(`MAF linear reading out of range: ${raw}`);\n  }\n\n  return raw / LINEAR_MAX;\n}\n"]}

package/dist/decoders/engineSpeed.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Converts a crank pulse width to engine speed (`7500000 / pulseWidth`,
+ * truncated).
+ *
+ * @param pulseWidth - Pulse width in ECU timer ticks. Must not be 0.
+ * @returns Engine speed in revolutions per minute.
+ * @throws {@link InvalidReadingError} if `pulseWidth` is 0. libcomm14cux
+ * divides by zero here, which is undefined behaviour in C.
+ */
+export declare function pulseWidthToRpm(pulseWidth: number): number;
+/**
+ * Decodes the engine speed from the filtered pulse width. 0xFFFF is the ECU's
+ * initial value with the ignition on and the engine stopped, and means 0 RPM.
+ *
+ * @param pulseWidth - The filtered pulse width, 0 to 0xFFFF.
+ * @returns Engine speed in revolutions per minute.
+ * @throws {@link InvalidReadingError} if `pulseWidth` is 0.
+ */
+export declare function decodeEngineRpm(pulseWidth: number): number;
+//# sourceMappingURL=engineSpeed.d.ts.map

package/dist/decoders/engineSpeed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engineSpeed.d.ts","sourceRoot":"","sources":["../../src/decoders/engineSpeed.ts"],"names":[],"mappings":"AAOA;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAO1D;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAE1D"}

package/dist/decoders/engineSpeed.js

@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: GPL-3.0-only
+// Derived from libcomm14cux (https://github.com/colinbourassa/libcomm14cux)
+// Copyright (C) Colin Bourassa. Licensed under the GNU GPL v3.
+// Ported to TypeScript and modified for comm14cux-ts, 2026.
+import { InvalidReadingError } from '../errors.js';
+/**
+ * Converts a crank pulse width to engine speed (`7500000 / pulseWidth`,
+ * truncated).
+ *
+ * @param pulseWidth - Pulse width in ECU timer ticks. Must not be 0.
+ * @returns Engine speed in revolutions per minute.
+ * @throws {@link InvalidReadingError} if `pulseWidth` is 0. libcomm14cux
+ * divides by zero here, which is undefined behaviour in C.
+ */
+export function pulseWidthToRpm(pulseWidth) {
+    if (pulseWidth === 0) {
+        // libcomm14cux divides by zero here (undefined behaviour in C).
+        throw new InvalidReadingError('Pulse width of zero');
+    }
+    return Math.trunc(7500000 / pulseWidth);
+}
+/**
+ * Decodes the engine speed from the filtered pulse width. 0xFFFF is the ECU's
+ * initial value with the ignition on and the engine stopped, and means 0 RPM.
+ *
+ * @param pulseWidth - The filtered pulse width, 0 to 0xFFFF.
+ * @returns Engine speed in revolutions per minute.
+ * @throws {@link InvalidReadingError} if `pulseWidth` is 0.
+ */
+export function decodeEngineRpm(pulseWidth) {
+    return pulseWidth === 0xffff ? 0 : pulseWidthToRpm(pulseWidth);
+}
+//# sourceMappingURL=engineSpeed.js.map

package/dist/decoders/engineSpeed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engineSpeed.js","sourceRoot":"","sources":["../../src/decoders/engineSpeed.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,4EAA4E;AAC5E,+DAA+D;AAC/D,4DAA4D;AAE5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,UAAkB;IAChD,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;QACrB,gEAAgE;QAChE,MAAM,IAAI,mBAAmB,CAAC,qBAAqB,CAAC,CAAC;IACvD,CAAC;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,UAAU,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAAC,UAAkB;IAChD,OAAO,UAAU,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;AACjE,CAAC","sourcesContent":["// SPDX-License-Identifier: GPL-3.0-only\n// Derived from libcomm14cux (https://github.com/colinbourassa/libcomm14cux)\n// Copyright (C) Colin Bourassa. Licensed under the GNU GPL v3.\n// Ported to TypeScript and modified for comm14cux-ts, 2026.\n\nimport { InvalidReadingError } from '../errors.js';\n\n/**\n * Converts a crank pulse width to engine speed (`7500000 / pulseWidth`,\n * truncated).\n *\n * @param pulseWidth - Pulse width in ECU timer ticks. Must not be 0.\n * @returns Engine speed in revolutions per minute.\n * @throws {@link InvalidReadingError} if `pulseWidth` is 0. libcomm14cux\n * divides by zero here, which is undefined behaviour in C.\n */\nexport function pulseWidthToRpm(pulseWidth: number): number {\n  if (pulseWidth === 0) {\n    // libcomm14cux divides by zero here (undefined behaviour in C).\n    throw new InvalidReadingError('Pulse width of zero');\n  }\n\n  return Math.trunc(7500000 / pulseWidth);\n}\n\n/**\n * Decodes the engine speed from the filtered pulse width. 0xFFFF is the ECU's\n * initial value with the ignition on and the engine stopped, and means 0 RPM.\n *\n * @param pulseWidth - The filtered pulse width, 0 to 0xFFFF.\n * @returns Engine speed in revolutions per minute.\n * @throws {@link InvalidReadingError} if `pulseWidth` is 0.\n */\nexport function decodeEngineRpm(pulseWidth: number): number {\n  return pulseWidth === 0xffff ? 0 : pulseWidthToRpm(pulseWidth);\n}\n"]}