@typecad/hal 0.1.0-alpha.2 → 1.0.0-alpha.10

package/src/power.ts

@@ -1,4 +1,4 @@
-import { powerDeepSleep, powerLightSleep, powerSetCpuFrequency } from './emit.js';
+import { powerDeepSleep, powerLightSleep, powerSetCpuFrequency, powerDeepSleepPin } from './emit.js';
 
 /**
  * PowerClass provides control over MCU power states and clock frequencies.
@@ -14,6 +14,16 @@ export class PowerClass {
     powerDeepSleep(ms);
   }
 
+  /** Enter deep sleep until `pin` reaches `level` (0 = low, 1 = high).
+   *
+   *  Lowers to ext0 wakeup (Xtensa ESP32/S3, RTC pins only) or the gpio-wakeup
+   *  variant (RISC-V C3/C6) depending on the target. `pin` must be RTC-capable;
+   *  the framework flags non-RTC pins at compile time. Wakeup resets the chip,
+   *  so this call never returns. */
+  deepSleepPin(pin: number, level: 0 | 1): void {
+    powerDeepSleepPin(pin, level);
+  }
+
   lightSleep(): void {
     powerLightSleep();
   }

package/src/preferences.ts

@@ -1,57 +1,86 @@
-import { rawCpp } from './emit.js';
+import {
+  preferencesBegin,
+  preferencesEnd,
+  preferencesClear,
+  preferencesRemove,
+  preferencesPutInt,
+  preferencesGetInt,
+  preferencesPutUInt,
+  preferencesGetUInt,
+  preferencesPutBool,
+  preferencesGetBool,
+  preferencesPutFloat,
+  preferencesGetFloat,
+  preferencesPutString,
+  preferencesGetString,
+} from './emit.js';
 
+/**
+ * Preferences — a persistent key/value store, lowered to native NVS
+ * (nvs_flash / nvs_open / nvs_set_* / nvs_get_*) by framework-esp32.
+ *
+ * No include() calls here — NVS headers are framework-owned and added via
+ * forcedIncludes when the program uses preferences.* ops. Method bodies pass
+ * parameters directly into semantic calls so the resolver can statically track
+ * every argument (matching the WiFi/HTTP HAL pattern).
+ */
 export class PreferencesClass {
   static readonly __instance_name = "Preferences";
-  // NOTE: no __includes here. The transpiler emits singleton __includes on
-  // every architecture with no filtering, and <Preferences.h> is ESP32-only —
-  // adding it would break AVR builds. The class is ESP32-only by convention.
 
   begin(name: string, readOnly: boolean = false): void {
-    rawCpp(`Preferences.begin(${name}.c_str(), ${readOnly});`);
+    preferencesBegin(name, readOnly);
   }
+
   end(): void {
-    rawCpp(`Preferences.end();`);
+    preferencesEnd();
   }
+
   clear(): void {
-    rawCpp(`Preferences.clear();`);
+    preferencesClear();
   }
+
   remove(key: string): void {
-    rawCpp(`Preferences.remove(${key}.c_str());`);
+    preferencesRemove(key);
   }
+
   putInt(key: string, value: number): void {
-    rawCpp(`Preferences.putInt(${key}.c_str(), ${value});`);
+    preferencesPutInt(key, value);
   }
+
   getInt(key: string, defaultValue: number = 0): number {
-    rawCpp(`return Preferences.getInt(${key}.c_str(), ${defaultValue});`);
-    return 0;
+    return preferencesGetInt(key, defaultValue);
   }
+
   putUInt(key: string, value: number): void {
-    rawCpp(`Preferences.putUInt(${key}.c_str(), ${value});`);
+    preferencesPutUInt(key, value);
   }
+
   getUInt(key: string, defaultValue: number = 0): number {
-    rawCpp(`return Preferences.getUInt(${key}.c_str(), ${defaultValue});`);
-    return 0;
-  }
-  putFloat(key: string, value: number): void {
-    rawCpp(`Preferences.putFloat(${key}.c_str(), ${value});`);
-  }
-  getFloat(key: string, defaultValue: number = 0): number {
-    rawCpp(`return Preferences.getFloat(${key}.c_str(), ${defaultValue});`);
-    return 0;
+    return preferencesGetUInt(key, defaultValue);
   }
+
   putBool(key: string, value: boolean): void {
-    rawCpp(`Preferences.putBool(${key}.c_str(), ${value});`);
+    preferencesPutBool(key, value);
   }
+
   getBool(key: string, defaultValue: boolean = false): boolean {
-    rawCpp(`return Preferences.getBool(${key}.c_str(), ${defaultValue});`);
-    return false;
+    return preferencesGetBool(key, defaultValue);
+  }
+
+  putFloat(key: string, value: number): void {
+    preferencesPutFloat(key, value);
   }
+
+  getFloat(key: string, defaultValue: number = 0): number {
+    return preferencesGetFloat(key, defaultValue);
+  }
+
   putString(key: string, value: string): void {
-    rawCpp(`Preferences.putString(${key}.c_str(), ${value}.c_str());`);
+    preferencesPutString(key, value);
   }
+
   getString(key: string, defaultValue: string = ""): string {
-    rawCpp(`return Preferences.getString(${key}.c_str(), ${defaultValue}.c_str());`);
-    return "";
+    return preferencesGetString(key, defaultValue);
   }
 }
 

package/src/register.ts

@@ -27,9 +27,21 @@ export type Bit = 0 | 1;
 export type Bits<N extends number = number> = number;
 
 /** Class decorator marking a struct as a memory-mapped register at `address`.
- *  Erased at transpile time — the class becomes a `volatile uint32_t*`. */
-export declare function register(address: number): ClassDecorator;
+ *  Erased at transpile time — the class becomes a `volatile uint32_t*`.
+ *
+ *  These carry real (inert) runtime bodies rather than `declare`, so the
+ *  `export { register, bits }` re-export in index.ts resolves under Node's ESM
+ *  loader, which validates that re-exported bindings exist at runtime. They are
+ *  never invoked: the cuttlefish transpiler detects them by name and lowers the
+ *  decorated struct away, so these stubs are only reached when the decorator
+ *  source is imported without transpilation (e.g. host-side tests). */
+export function register(_address: number): ClassDecorator {
+  return () => {};
+}
 
 /** Property decorator carrying the bit range [lo, hi] (inclusive) of a field
- *  within its register. Erased at transpile time. */
-export declare function bits(hi: number, lo: number): PropertyDecorator;
+ *  within its register. Erased at transpile time. See `register` for why these
+ *  have runtime bodies. */
+export function bits(_hi: number, _lo: number): PropertyDecorator {
+  return () => {};
+}

package/src/rmt.ts

@@ -0,0 +1,125 @@
+// ---------------------------------------------------------------------------
+// @typecad/hal — RMT (Remote Control Transceiver) ergonomic API
+// ---------------------------------------------------------------------------
+// Exposes RMT via a RmtChannel class, mirroring the I2CBus/I2CDevice pattern.
+// The transpiler only resolves semantic calls made inside class-method bodies
+// (free top-level calls emit verbatim), so every peripheral exposes its API
+// through a class whose methods call the positional semantic primitives in
+// emit.ts. The resolver collapses object literals, so HALOpIR fields must be
+// scalars; these methods destructure `opts` at the call site before forwarding.
+//
+// Channel identity is the GPIO pin (like pwm.ts's LEDC channel-per-pin model).
+
+import type { Pin } from './gpio.js';
+import {
+  rmtTxInit,
+  rmtRxInit,
+  rmtTxWriteBytes,
+  rmtTxWriteSymbols,
+  rmtTxWaitDone,
+  rmtTxDeinit,
+  rmtRxOnReceived,
+  rmtRxStart,
+  rmtRxStop,
+  rmtRxRead,
+  rmtRxDeinit,
+} from './emit.js';
+
+/** Pin identifier accepted by RmtChannel: a Pin object, raw GPIO number, or port name. */
+type RmtPin = Pin | number | string;
+
+/**
+ * RMT transceiver channel bound to a GPIO pin. One channel per pin; TX and RX
+ * are independent roles on the same channel object.
+ *
+ * ```ts
+ * const led = new RmtChannel(LED);
+ * led.txInit({ resolutionHz: 10_000_000, bit0: [4, 9], bit1: [9, 4] });
+ * led.txWriteBytes([0, 16, 0]);
+ * led.txWaitDone();
+ * ```
+ */
+export class RmtChannel {
+  private _pin: RmtPin;
+
+  constructor(pin: RmtPin) {
+    this._pin = pin;
+  }
+
+  // ── TX ─────────────────────────────────────────────────────────────────────
+  /** Initialize the channel for TX. Idempotent per pin. Bit timings are fixed
+   *  at init — ESP-IDF bakes them into the bytes-encoder and exposes no public
+   *  mutation API. Tick units are 1/resolutionHz seconds.
+   *
+   *  Args are positional scalars (not an opts object) because the transpiler's
+   *  method-body renderer folds scalar params but not property accesses on an
+   *  object param (opts.resolutionHz would render as a collapsed object + dead
+   *  property access). Mirrors how I2CBus.begin(address) takes a scalar. */
+  txInit(
+    resolutionHz: number,
+    bit0Hi: number, bit0Lo: number,
+    bit1Hi: number, bit1Lo: number,
+    msbFirst: boolean = false,
+    queueDepth: number = 4,
+  ): void {
+    rmtTxInit(
+      this._pin,
+      resolutionHz,
+      bit0Hi, bit0Lo,
+      bit1Hi, bit1Lo,
+      msbFirst,
+      queueDepth,
+    );
+  }
+
+  /** Write bytes via the channel's bytes-encoder (timings fixed at txInit). */
+  txWriteBytes(bytes: number[] | Uint8Array): void {
+    rmtTxWriteBytes(this._pin, bytes);
+  }
+
+  /** Write raw RMT symbols — arbitrary [hiTicks, loTicks] pairs. */
+  txWriteSymbols(symbols: [number, number][]): void {
+    rmtTxWriteSymbols(this._pin, symbols);
+  }
+
+  /** Block until the queued TX completes. */
+  txWaitDone(timeoutMs?: number): void {
+    rmtTxWaitDone(this._pin, timeoutMs);
+  }
+
+  /** Tear down the TX channel and release its slot. */
+  txDeinit(): void {
+    rmtTxDeinit(this._pin);
+  }
+
+  // ── RX ─────────────────────────────────────────────────────────────────────
+  /** Initialize the channel for RX. Idempotent per pin. */
+  rxInit(resolutionHz: number): void {
+    rmtRxInit(this._pin, resolutionHz);
+  }
+
+  /** Register a callback-by-name invoked when an RX burst completes. */
+  rxOnReceived(handler: string): void {
+    rmtRxOnReceived(this._pin, handler);
+  }
+
+  /** Start receiving. */
+  rxStart(): void {
+    rmtRxStart(this._pin);
+  }
+
+  /** Stop receiving. */
+  rxStop(): void {
+    rmtRxStop(this._pin);
+  }
+
+  /** Blocking read — returns flattened symbols [d0,l0,d1,l1,…] in ticks. */
+  rxRead(maxCount: number): number[] {
+    return rmtRxRead(this._pin, maxCount);
+  }
+
+  /** Tear down the RX channel and release its slot. */
+  rxDeinit(): void {
+    rmtRxDeinit(this._pin);
+  }
+}

package/src/spi.ts

@@ -1,4 +1,4 @@
-import { spiBegin, spiEnd, spiTransfer, spiBeginTx, spiEndTx, spiCsLow, spiCsHigh, spiSetMode, spiSetBitOrder, rawCpp } from './emit.js';
+import { spiBegin, spiEnd, spiTransfer, spiBeginTx, spiEndTx, spiCsLow, spiCsHigh, spiSetMode, spiSetBitOrder, spiReadBuffer, rawCpp } from './emit.js';
 import { include } from './include.js';
 import type { Pin } from './gpio.js';
 import type { SPIMode, SPISettings } from './types.js';
@@ -30,12 +30,15 @@ export class SPIDevice {
 
   readRegister(register: number, count: number): Uint8Array {
     include("<SPI.h>");
-    rawCpp(`digitalWrite(${this._cs}, LOW);`);
-    rawCpp(`${this._bus}.transfer(${register});`);
-    rawCpp(`static uint8_t __spi_buf[${count}];`);
-    rawCpp(`for (int i=0; i<${count}; i++) __spi_buf[i] = ${this._bus}.transfer(0x00);`);
-    rawCpp(`digitalWrite(${this._cs}, HIGH);`);
-    rawCpp(`return __spi_buf;`);
+    spiCsLow(this._cs);
+    spiTransfer(this._bus, register);
+    // Clock `count` dummy bytes and drain them into the caller's buffer
+    // (declared by the Uint8Array return marker as `uint8_t data[count]`).
+    // Using the semantic primitive — NOT rawCpp — keeps the buffer in user
+    // scope so it survives the return (no decayed pointer) and `data.length`
+    // / `data[i]` work, mirroring I2CDevice.readBytes.
+    spiReadBuffer(this._bus, count, new Uint8Array(count));
+    spiCsHigh(this._cs);
     return new Uint8Array(count);
   }
 

package/src/temperature.ts

@@ -0,0 +1,20 @@
+/**
+ * TemperatureClass — on-chip die temperature sensor.
+ *
+ * Lowered to the temp.* HAL op: ESP-IDF's temperature_sensor driver reads the
+ * internal die temperature in °C. Useful for thermal monitoring and
+ * compensation. No external components required.
+ */
+export class TemperatureClass {
+  static readonly __instance_name = "Temperature";
+
+  /** Read the on-chip die temperature in degrees Celsius. */
+  read(): number {
+    return tempRead();
+  }
+}
+
+export const Temperature = new TemperatureClass();
+
+// ── Semantic primitive (resolved to temp.* HAL op by the transpiler) ──
+export function tempRead(): number { return 0; }

package/src/timer.ts

@@ -1,12 +1,16 @@
-import { rawCpp, boardResolve } from './emit.js';
+import { boardResolve } from './emit.js';
 import { callback } from './callback.js';
 
 /**
  * HardwareTimer provides direct control over the board's hardware timers.
- * 
+ *
  * Hardware timers are distinct from the software-based setInterval/setTimeout
  * and are typically used for high-precision timing, PWM generation, or
- * interrupt-driven tasks.
+ * interrupt-driven tasks. Lowered to hwtimer.* HAL ops: ESP-IDF's GPTimer
+ * driver (driver/gptimer.h); Arduino's HardwareTimer (Timer0/1/2 on STM32).
+ *
+ * The instance index maps to the platform's timer numbering (ESP-IDF GPTimer
+ * unit 0..n, STM32 TIM0..n).
  */
 export class HardwareTimer {
   private _instance: number;
@@ -15,38 +19,27 @@ export class HardwareTimer {
     this._instance = instance;
   }
 
-  /**
-   * Sets the timer frequency in Hertz.
-   * Note: The actual frequency may be limited by the hardware's clock dividers.
-   */
+  /** Sets the timer frequency in Hertz. */
   setFrequency(hz: number): void {
-    rawCpp(`Timer${this._instance}.setFrequency(${hz});`);
+    hwtimerSetFrequency(this._instance, hz);
   }
 
-  /**
-   * Attaches an interrupt handler that executes when the timer overflows.
-   */
+  /** Attaches an interrupt handler that executes when the timer overflows. */
   onOverflow(handler: () => void): void {
-    rawCpp(`Timer${this._instance}.onOverflow(${callback(handler)});`);
+    hwtimerOnOverflow(this._instance, callback(handler));
   }
 
-  /**
-   * Starts the timer.
-   */
+  /** Starts the timer. */
   start(): void {
-    rawCpp(`Timer${this._instance}.start();`);
+    hwtimerStart(this._instance);
   }
 
-  /**
-   * Stops the timer.
-   */
+  /** Stops the timer. */
   stop(): void {
-    rawCpp(`Timer${this._instance}.stop();`);
+    hwtimerStop(this._instance);
   }
 
-  /**
-   * Returns the bit resolution of the timer (e.g., 8, 16, 32).
-   */
+  /** Returns the bit resolution of the timer (e.g., 8, 16, 32). */
   getBits(): number {
     // "peripherals.timer" (singular) matches the board-resolver's array-key
     // derivation (TIMER_INSTANCES → peripherals.timer.<index>.*).
@@ -57,3 +50,9 @@ export class HardwareTimer {
 export const Timer0 = new HardwareTimer(0);
 export const Timer1 = new HardwareTimer(1);
 export const Timer2 = new HardwareTimer(2);
+
+// ── Semantic primitives (resolved to hwtimer.* HAL ops by the transpiler) ──
+export function hwtimerSetFrequency(instance: number, hz: number): void {}
+export function hwtimerOnOverflow(instance: number, handler: string): void {}
+export function hwtimerStart(instance: number): void {}
+export function hwtimerStop(instance: number): void {}

package/src/types.ts

@@ -123,6 +123,7 @@ export type ArchitectureIdentifier =
   | 'esp32c3'
   | 'esp32c6'
   | 'rp2040'
+  | 'rp2350'
   | 'samd'
   | 'stm32'
   | 'nrf52'

package/src/wifi.ts

@@ -0,0 +1,221 @@
+import {
+  wifiConnect,
+  wifiConnectStart,
+  wifiDisconnect,
+  wifiStatus,
+  wifiIsConnected,
+  wifiLocalIp,
+  wifiRssi,
+  wifiMac,
+  wifiSetHostname,
+  wifiSetStaticIp,
+  wifiSetAutoReconnect,
+  wifiSetPowerSave,
+  wifiSetTxPower,
+  wifiOnEvent,
+  wifiApStart,
+  wifiApStop,
+  wifiApClientCount,
+  wifiApIp,
+  wifiApSetChannel,
+  wifiApSetHidden,
+  wifiApSetMaxClients,
+  wifiScan,
+  wifiScanStart,
+  wifiScanCount,
+  wifiScanSsid,
+  wifiScanRssi,
+  wifiScanEncryption,
+  wifiScanChannel,
+  wifiSaveCredentials,
+  wifiConnectSaved,
+  wifiClearCredentials,
+  wifiWaitConnected,
+  wifiWaitDisconnected,
+} from './emit.js';
+import { callback } from './callback.js';
+
+/** Normalized WiFi link status (mapped from esp_wifi events by the runtime shim). */
+export enum WiFiStatus {
+  Idle = 0,
+  Connecting = 1,
+  Connected = 2,
+  ConnectFailed = 3,
+  Disconnected = 4,
+}
+
+export enum WiFiEncryption {
+  Open = 0,
+  WEP = 1,
+  WPA = 2,
+  WPA2 = 3,
+  WPA3 = 4,
+  Enterprise = 5,
+}
+
+/**
+ * WiFi radio / link control, lowered to native ESP-IDF (`esp_wifi` /
+ * `esp_netif` / `esp_event` / `nvs_flash`) by framework-esp32.
+ *
+ * No `include()` calls here — ESP-IDF headers are framework-owned and added
+ * via forcedIncludes when the program uses wifi.* ops (the Preferences
+ * lesson: HAL files must not carry platform headers). Frameworks without a
+ * wifi lowering reject these ops with a diagnostic.
+ */
+export class WiFiClass {
+  static readonly __instance_name = "WiFi";
+
+  /** Blocking at top level; cooperatively awaitable inside async functions. */
+  connect(ssid: string, password?: string, timeoutMs: number = 15000): Promise<boolean> {
+    wifiConnect(ssid, password, timeoutMs);
+    return Promise.resolve(false);
+  }
+
+  /** Fire-and-forget STA begin; poll status() / untilConnected(). */
+  connectAsync(ssid: string, password?: string): void {
+    wifiConnectStart(ssid, password);
+  }
+
+  untilConnected(timeoutMs: number = 15000): Promise<boolean> {
+    wifiWaitConnected(timeoutMs);
+    return Promise.resolve(false);
+  }
+
+  untilDisconnected(): Promise<void> {
+    wifiWaitDisconnected();
+    return Promise.resolve();
+  }
+
+  disconnect(): void {
+    wifiDisconnect();
+  }
+
+  isConnected(): boolean {
+    return wifiIsConnected();
+  }
+
+  status(): WiFiStatus {
+    return wifiStatus() as WiFiStatus;
+  }
+
+  localIP(): string {
+    return wifiLocalIp();
+  }
+
+  rssi(): number {
+    return wifiRssi();
+  }
+
+  macAddress(): string {
+    return wifiMac();
+  }
+
+  hostname(name: string): this {
+    wifiSetHostname(name);
+    return this;
+  }
+
+  staticIP(ip: string, gateway: string, subnet: string, dns?: string): this {
+    wifiSetStaticIp(ip, gateway, subnet, dns);
+    return this;
+  }
+
+  autoReconnect(enabled: boolean): this {
+    wifiSetAutoReconnect(enabled);
+    return this;
+  }
+
+  powerSave(mode: "default" | "none"): this {
+    wifiSetPowerSave(mode);
+    return this;
+  }
+
+  /** Cap TX power in dBm (roughly 2–20). Safe to call before connect() —
+   *  the value is applied after the radio starts. */
+  txPower(dbm: number): this {
+    wifiSetTxPower(dbm);
+    return this;
+  }
+
+  saveCredentials(ssid: string, password: string): void {
+    wifiSaveCredentials(ssid, password);
+  }
+
+  connectSaved(timeoutMs: number = 15000): boolean {
+    return wifiConnectSaved(timeoutMs);
+  }
+
+  clearCredentials(): void {
+    wifiClearCredentials();
+  }
+
+  onConnect(handler: () => void): void {
+    wifiOnEvent("connect", callback(handler));
+  }
+
+  onDisconnect(handler: () => void): void {
+    wifiOnEvent("disconnect", callback(handler));
+  }
+
+  startAP(ssid: string, password?: string): boolean {
+    return wifiApStart(ssid, password);
+  }
+
+  apChannel(ch: number): this {
+    wifiApSetChannel(ch);
+    return this;
+  }
+
+  apHidden(hidden: boolean): this {
+    wifiApSetHidden(hidden);
+    return this;
+  }
+
+  apMaxClients(n: number): this {
+    wifiApSetMaxClients(n);
+    return this;
+  }
+
+  stopAP(): void {
+    wifiApStop();
+  }
+
+  apClientCount(): number {
+    return wifiApClientCount();
+  }
+
+  apIP(): string {
+    return wifiApIp();
+  }
+
+  scan(): number {
+    return wifiScan();
+  }
+
+  scanAsync(): Promise<void> {
+    wifiScanStart();
+    return Promise.resolve();
+  }
+
+  scanCount(): number {
+    return wifiScanCount();
+  }
+
+  scanSSID(i: number): string {
+    return wifiScanSsid(i);
+  }
+
+  scanRSSI(i: number): number {
+    return wifiScanRssi(i);
+  }
+
+  scanEncryption(i: number): WiFiEncryption {
+    return wifiScanEncryption(i) as WiFiEncryption;
+  }
+
+  scanChannel(i: number): number {
+    return wifiScanChannel(i);
+  }
+}
+
+export const WiFi = new WiFiClass();