JavaScript SDK

conduyt-js is the pure-TypeScript SDK. It runs everywhere JavaScript runs — Node.js, Bun, Deno, browsers — and ships ESM-first with full TypeScript types. The protocol primitives (wire/COBS/CRC8) are reimplemented in TypeScript; for a smaller browser bundle that uses the WASM-compiled Rust core instead, see the WASM SDK.

Install

npm install conduyt-js

Or with pnpm, bun, yarn — same package.

Quick start

Node.js / Bun (USB-Serial)

import { ConduytDevice } from 'conduyt-js'
import { SerialTransport } from 'conduyt-js/transports/serial'

const transport = new SerialTransport({ path: '/dev/cu.usbmodem14101', baudRate: 115200 })
const device = await ConduytDevice.connect(transport)

console.log('connected to', device.capabilities.firmwareName)

await device.pin(13).mode('output')
await device.pin(13).write(1)

await device.disconnect()

Browser (WebSerial)

import { ConduytDevice } from 'conduyt-js'
import { WebSerialTransport } from 'conduyt-js/transports/web-serial'

// Inside a click / keydown handler (WebSerial requires a user gesture).
// Don't call port.open() yourself — the transport opens the port internally
// using the baudRate option. Pre-opening throws "port is already open".
const port = await navigator.serial.requestPort()
const device = await ConduytDevice.connect(
  new WebSerialTransport({ port, baudRate: 115200 })
)

await device.pin(13).mode('output')
await device.pin(13).write(1)

Modules

The SDK ships typed wrappers for every CONDUYT firmware module. Import only what you need:

import { ConduytServo }    from 'conduyt-js/modules/servo'
import { ConduytNeoPixel } from 'conduyt-js/modules/neopixel'
import { ConduytOLED }     from 'conduyt-js/modules/oled'
import { ConduytDHT }      from 'conduyt-js/modules/dht'
import { ConduytEncoder }  from 'conduyt-js/modules/encoder'
import { ConduytStepper }  from 'conduyt-js/modules/stepper'
import { ConduytPID }      from 'conduyt-js/modules/pid'

Each constructor takes a connected ConduytDevice and resolves the module ID by name from the HELLO_RESP. See the per-module pages under Modules for command reference and examples.

Datastreams

Datastreams are firmware-side named values (sensor readings, knobs, status) that auto-stream to the host. They appear in HELLO_RESP.datastreams. Subscribe via the proxy returned by device.datastream(name):

// Read once
const raw = await device.datastream('temperature').read()

// Write a value (writable datastreams only)
await device.datastream('setpoint').write(22.5)

// Subscribe (async iterable)
for await (const value of device.datastream('temperature').subscribe()) {
  console.log('temp:', value)
}

Transports

Transport	Module	Where it works
Node.js Serial	`conduyt-js/transports/serial`	Node, Bun, Electron (uses the `serialport` package)
WebSerial	`conduyt-js/transports/web-serial`	Chrome / Edge / Opera browsers
BLE	`conduyt-js/transports/ble`	Browsers with WebBluetooth (Chrome / Edge desktop)
MQTT	`conduyt-js/transports/mqtt`	Node and browsers (uses the `mqtt` package)
WebSocket	`conduyt-js/transports/websocket`	Node and browsers
CLASP	`conduyt-js/transports/clasp`	Browser CLASP tunnel
Mock	`conduyt-js/transports/mock`	Tests. Captures sent bytes, lets you inject responses

For embedded targets that need a tiny binary instead of full TypeScript, use the WASM SDK directly.

TypeScript

Full types ship in the package. device.module('servo') returns a typed proxy so the IDE knows what commands the module accepts.

Versioning

The SDK follows the protocol version. 1.x SDKs only talk to firmware running protocol version 2 (the current spec). The protocol version byte is exported as PROTOCOL_VERSION for runtime checks.