@typecad/hal 1.0.0-alpha.6 → 1.0.0-alpha.8

package/dist/ota.js

@@ -0,0 +1,38 @@
+/**
+ * OtaClass — over-the-air firmware update (ESP-IDF esp_https_ota / esp_app_format).
+ *
+ * Lowered to native OTA HAL ops (ota.*): ESP-IDF's esp_https_ota downloads a
+ * firmware image over HTTPS and writes it to the OTA partition, then reboots
+ * into it. The runtime shim owns the session/progress/verification dance.
+ *
+ * Requires a network connection (WiFi) and that the partition table defines
+ * at least two OTA app slots (the framework's default partitions.csv does).
+ */
+export class OtaClass {
+    /** Download and apply a firmware image from an HTTPS URL, then reboot.
+     *  Blocks until the update is written and verified. Returns true on success
+     *  (the reboot happens inside the shim on success, so a true return means
+     *  the new firmware is about to boot). */
+    fromUrl(url) {
+        return otaFromUrl(url);
+    }
+    /** Begin a manual update session (caller writes chunks via write()). */
+    begin() {
+        return otaBegin();
+    }
+    /** Write a chunk of firmware data to the OTA partition. */
+    write(chunk) {
+        otaWrite(chunk);
+    }
+    /** Finalize the update: verify, set the boot partition, and reboot. */
+    apply() {
+        otaApply();
+    }
+}
+OtaClass.__instance_name = "OTA";
+export const OTA = new OtaClass();
+// ── Semantic primitives (resolved to ota.* HAL ops by the transpiler) ──
+export function otaFromUrl(url) { return false; }
+export function otaBegin() { return false; }
+export function otaWrite(chunk) { }
+export function otaApply() { }

package/dist/power.d.ts

@@ -8,6 +8,13 @@
 export declare class PowerClass {
     static readonly __instance_name = "Power";
     deepSleep(ms: number): void;
+    /** 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;
     lightSleep(): void;
     setCpuFrequency(mhz: number): void;
 }

package/dist/power.js

@@ -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.
  *
@@ -10,6 +10,15 @@ export class PowerClass {
     deepSleep(ms) {
         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, level) {
+        powerDeepSleepPin(pin, level);
+    }
     lightSleep() {
         powerLightSleep();
     }

package/dist/preferences.d.ts

@@ -1,3 +1,12 @@
+/**
+ * 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 declare class PreferencesClass {
     static readonly __instance_name = "Preferences";
     begin(name: string, readOnly?: boolean): void;
@@ -8,10 +17,10 @@ export declare class PreferencesClass {
     getInt(key: string, defaultValue?: number): number;
     putUInt(key: string, value: number): void;
     getUInt(key: string, defaultValue?: number): number;
-    putFloat(key: string, value: number): void;
-    getFloat(key: string, defaultValue?: number): number;
     putBool(key: string, value: boolean): void;
     getBool(key: string, defaultValue?: boolean): boolean;
+    putFloat(key: string, value: number): void;
+    getFloat(key: string, defaultValue?: number): number;
     putString(key: string, value: string): void;
     getString(key: string, defaultValue?: string): string;
 }

package/dist/preferences.js

@@ -1,54 +1,55 @@
-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 {
-    // 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, readOnly = false) {
-        rawCpp(`Preferences.begin(${name}.c_str(), ${readOnly});`);
+        preferencesBegin(name, readOnly);
     }
     end() {
-        rawCpp(`Preferences.end();`);
+        preferencesEnd();
     }
     clear() {
-        rawCpp(`Preferences.clear();`);
+        preferencesClear();
     }
     remove(key) {
-        rawCpp(`Preferences.remove(${key}.c_str());`);
+        preferencesRemove(key);
     }
     putInt(key, value) {
-        rawCpp(`Preferences.putInt(${key}.c_str(), ${value});`);
+        preferencesPutInt(key, value);
     }
     getInt(key, defaultValue = 0) {
-        rawCpp(`return Preferences.getInt(${key}.c_str(), ${defaultValue});`);
-        return 0;
+        return preferencesGetInt(key, defaultValue);
     }
     putUInt(key, value) {
-        rawCpp(`Preferences.putUInt(${key}.c_str(), ${value});`);
+        preferencesPutUInt(key, value);
     }
     getUInt(key, defaultValue = 0) {
-        rawCpp(`return Preferences.getUInt(${key}.c_str(), ${defaultValue});`);
-        return 0;
-    }
-    putFloat(key, value) {
-        rawCpp(`Preferences.putFloat(${key}.c_str(), ${value});`);
-    }
-    getFloat(key, defaultValue = 0) {
-        rawCpp(`return Preferences.getFloat(${key}.c_str(), ${defaultValue});`);
-        return 0;
+        return preferencesGetUInt(key, defaultValue);
     }
     putBool(key, value) {
-        rawCpp(`Preferences.putBool(${key}.c_str(), ${value});`);
+        preferencesPutBool(key, value);
     }
     getBool(key, defaultValue = false) {
-        rawCpp(`return Preferences.getBool(${key}.c_str(), ${defaultValue});`);
-        return false;
+        return preferencesGetBool(key, defaultValue);
+    }
+    putFloat(key, value) {
+        preferencesPutFloat(key, value);
+    }
+    getFloat(key, defaultValue = 0) {
+        return preferencesGetFloat(key, defaultValue);
     }
     putString(key, value) {
-        rawCpp(`Preferences.putString(${key}.c_str(), ${value}.c_str());`);
+        preferencesPutString(key, value);
     }
     getString(key, defaultValue = "") {
-        rawCpp(`return Preferences.getString(${key}.c_str(), ${defaultValue}.c_str());`);
-        return "";
+        return preferencesGetString(key, defaultValue);
     }
 }
 PreferencesClass.__instance_name = "Preferences";

package/dist/rmt.d.ts

@@ -0,0 +1,48 @@
+import type { Pin } from './gpio.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 declare class RmtChannel {
+    private _pin;
+    constructor(pin: RmtPin);
+    /** 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, queueDepth?: number): void;
+    /** Write bytes via the channel's bytes-encoder (timings fixed at txInit). */
+    txWriteBytes(bytes: number[] | Uint8Array): void;
+    /** Write raw RMT symbols — arbitrary [hiTicks, loTicks] pairs. */
+    txWriteSymbols(symbols: [number, number][]): void;
+    /** Block until the queued TX completes. */
+    txWaitDone(timeoutMs?: number): void;
+    /** Tear down the TX channel and release its slot. */
+    txDeinit(): void;
+    /** Initialize the channel for RX. Idempotent per pin. */
+    rxInit(resolutionHz: number): void;
+    /** Register a callback-by-name invoked when an RX burst completes. */
+    rxOnReceived(handler: string): void;
+    /** Start receiving. */
+    rxStart(): void;
+    /** Stop receiving. */
+    rxStop(): void;
+    /** Blocking read — returns flattened symbols [d0,l0,d1,l1,…] in ticks. */
+    rxRead(maxCount: number): number[];
+    /** Tear down the RX channel and release its slot. */
+    rxDeinit(): void;
+}
+export {};

package/dist/rmt.js

@@ -0,0 +1,81 @@
+// ---------------------------------------------------------------------------
+// @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 { rmtTxInit, rmtRxInit, rmtTxWriteBytes, rmtTxWriteSymbols, rmtTxWaitDone, rmtTxDeinit, rmtRxOnReceived, rmtRxStart, rmtRxStop, rmtRxRead, rmtRxDeinit, } from './emit.js';
+/**
+ * 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 {
+    constructor(pin) {
+        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, bit0Hi, bit0Lo, bit1Hi, bit1Lo, msbFirst = false, queueDepth = 4) {
+        rmtTxInit(this._pin, resolutionHz, bit0Hi, bit0Lo, bit1Hi, bit1Lo, msbFirst, queueDepth);
+    }
+    /** Write bytes via the channel's bytes-encoder (timings fixed at txInit). */
+    txWriteBytes(bytes) {
+        rmtTxWriteBytes(this._pin, bytes);
+    }
+    /** Write raw RMT symbols — arbitrary [hiTicks, loTicks] pairs. */
+    txWriteSymbols(symbols) {
+        rmtTxWriteSymbols(this._pin, symbols);
+    }
+    /** Block until the queued TX completes. */
+    txWaitDone(timeoutMs) {
+        rmtTxWaitDone(this._pin, timeoutMs);
+    }
+    /** Tear down the TX channel and release its slot. */
+    txDeinit() {
+        rmtTxDeinit(this._pin);
+    }
+    // ── RX ─────────────────────────────────────────────────────────────────────
+    /** Initialize the channel for RX. Idempotent per pin. */
+    rxInit(resolutionHz) {
+        rmtRxInit(this._pin, resolutionHz);
+    }
+    /** Register a callback-by-name invoked when an RX burst completes. */
+    rxOnReceived(handler) {
+        rmtRxOnReceived(this._pin, handler);
+    }
+    /** Start receiving. */
+    rxStart() {
+        rmtRxStart(this._pin);
+    }
+    /** Stop receiving. */
+    rxStop() {
+        rmtRxStop(this._pin);
+    }
+    /** Blocking read — returns flattened symbols [d0,l0,d1,l1,…] in ticks. */
+    rxRead(maxCount) {
+        return rmtRxRead(this._pin, maxCount);
+    }
+    /** Tear down the RX channel and release its slot. */
+    rxDeinit() {
+        rmtRxDeinit(this._pin);
+    }
+}

package/dist/temperature.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 declare class TemperatureClass {
+    static readonly __instance_name = "Temperature";
+    /** Read the on-chip die temperature in degrees Celsius. */
+    read(): number;
+}
+export declare const Temperature: TemperatureClass;
+export declare function tempRead(): number;

package/dist/temperature.js

@@ -0,0 +1,17 @@
+/**
+ * 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 {
+    /** Read the on-chip die temperature in degrees Celsius. */
+    read() {
+        return tempRead();
+    }
+}
+TemperatureClass.__instance_name = "Temperature";
+export const Temperature = new TemperatureClass();
+// ── Semantic primitive (resolved to temp.* HAL op by the transpiler) ──
+export function tempRead() { return 0; }

package/dist/timer.d.ts

@@ -3,33 +3,30 @@
  *
  * 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 declare class HardwareTimer {
     private _instance;
     constructor(instance: number);
-    /**
-     * 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;
-    /**
-     * Attaches an interrupt handler that executes when the timer overflows.
-     */
+    /** Attaches an interrupt handler that executes when the timer overflows. */
     onOverflow(handler: () => void): void;
-    /**
-     * Starts the timer.
-     */
+    /** Starts the timer. */
     start(): void;
-    /**
-     * Stops the timer.
-     */
+    /** Stops the timer. */
     stop(): void;
-    /**
-     * 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;
 }
 export declare const Timer0: HardwareTimer;
 export declare const Timer1: HardwareTimer;
 export declare const Timer2: HardwareTimer;
+export declare function hwtimerSetFrequency(instance: number, hz: number): void;
+export declare function hwtimerOnOverflow(instance: number, handler: string): void;
+export declare function hwtimerStart(instance: number): void;
+export declare function hwtimerStop(instance: number): void;

package/dist/timer.js

@@ -1,44 +1,37 @@
-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 {
     constructor(instance) {
         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) {
-        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) {
-        rawCpp(`Timer${this._instance}.onOverflow(${callback(handler)});`);
+        hwtimerOnOverflow(this._instance, callback(handler));
     }
-    /**
-     * Starts the timer.
-     */
+    /** Starts the timer. */
     start() {
-        rawCpp(`Timer${this._instance}.start();`);
+        hwtimerStart(this._instance);
     }
-    /**
-     * Stops the timer.
-     */
+    /** Stops the timer. */
     stop() {
-        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() {
         // "peripherals.timer" (singular) matches the board-resolver's array-key
         // derivation (TIMER_INSTANCES → peripherals.timer.<index>.*).
@@ -48,3 +41,8 @@ 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, hz) { }
+export function hwtimerOnOverflow(instance, handler) { }
+export function hwtimerStart(instance) { }
+export function hwtimerStop(instance) { }

package/dist/wifi.d.ts

@@ -0,0 +1,67 @@
+/** Normalized WiFi link status (mapped from esp_wifi events by the runtime shim). */
+export declare enum WiFiStatus {
+    Idle = 0,
+    Connecting = 1,
+    Connected = 2,
+    ConnectFailed = 3,
+    Disconnected = 4
+}
+export declare 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 declare class WiFiClass {
+    static readonly __instance_name = "WiFi";
+    /** Blocking at top level; cooperatively awaitable inside async functions. */
+    connect(ssid: string, password?: string, timeoutMs?: number): Promise<boolean>;
+    /** Fire-and-forget STA begin; poll status() / untilConnected(). */
+    connectAsync(ssid: string, password?: string): void;
+    untilConnected(timeoutMs?: number): Promise<boolean>;
+    untilDisconnected(): Promise<void>;
+    disconnect(): void;
+    isConnected(): boolean;
+    status(): WiFiStatus;
+    localIP(): string;
+    rssi(): number;
+    macAddress(): string;
+    hostname(name: string): this;
+    staticIP(ip: string, gateway: string, subnet: string, dns?: string): this;
+    autoReconnect(enabled: boolean): this;
+    powerSave(mode: "default" | "none"): 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;
+    saveCredentials(ssid: string, password: string): void;
+    connectSaved(timeoutMs?: number): boolean;
+    clearCredentials(): void;
+    onConnect(handler: () => void): void;
+    onDisconnect(handler: () => void): void;
+    startAP(ssid: string, password?: string): boolean;
+    apChannel(ch: number): this;
+    apHidden(hidden: boolean): this;
+    apMaxClients(n: number): this;
+    stopAP(): void;
+    apClientCount(): number;
+    apIP(): string;
+    scan(): number;
+    scanAsync(): Promise<void>;
+    scanCount(): number;
+    scanSSID(i: number): string;
+    scanRSSI(i: number): number;
+    scanEncryption(i: number): WiFiEncryption;
+    scanChannel(i: number): number;
+}
+export declare const WiFi: WiFiClass;