@typecad/hal 1.0.0-alpha.3 → 1.0.0-alpha.7

package/src/http.ts

@@ -0,0 +1,144 @@
+import {
+  httpBegin,
+  httpReset,
+  httpSetHeader,
+  httpSetTimeout,
+  httpSetMaxBody,
+  httpSetBody,
+  httpSetInsecure,
+  httpSetCaCert,
+  httpSend,
+  httpStatus,
+  httpOk,
+  httpBody,
+  httpContentLength,
+  httpResponseHeader,
+} from './emit.js';
+
+export enum HttpMethod {
+  GET = 0,
+  POST = 1,
+  PUT = 2,
+  DELETE = 3,
+  HEAD = 4,
+  PATCH = 5,
+}
+
+/**
+ * Fluent HTTP/S request builder, lowered to native ESP-IDF
+ * `esp_http_client` by framework-esp32 (TLS via esp-tls / mbedTLS bundle).
+ * Response fields are read from this object after send() — mirrors
+ * `await WiFi.connect(); WiFi.localIP()`.
+ *
+ * No `include()` calls here — ESP-IDF headers are framework-owned and added
+ * via forcedIncludes when the program uses http.* ops.
+ */
+export class HttpRequest {
+  private _method: string;
+  private _url: string;
+
+  constructor(method: string, url: string) {
+    this._method = method;
+    this._url = url;
+  }
+
+  header(name: string, value: string): this {
+    httpSetHeader(name, value);
+    return this;
+  }
+
+  timeout(ms: number): this {
+    httpSetTimeout(ms);
+    return this;
+  }
+
+  maxBody(bytes: number): this {
+    httpSetMaxBody(bytes);
+    return this;
+  }
+
+  body(data: string): this {
+    httpSetBody(data, false);
+    return this;
+  }
+
+  jsonBody(json: string): this {
+    httpSetBody(json, true);
+    return this;
+  }
+
+  /** Skip TLS certificate verification (development only). */
+  insecure(): this {
+    httpSetInsecure();
+    return this;
+  }
+
+  caCert(pem: string): this {
+    httpSetCaCert(pem);
+    return this;
+  }
+
+  /** Blocking at top level; cooperatively awaitable inside async functions. */
+  send(): Promise<boolean> {
+    httpBegin(this._method, this._url);
+    httpSend();
+    return Promise.resolve(false);
+  }
+
+  status(): number {
+    return httpStatus();
+  }
+
+  ok(): boolean {
+    return httpOk();
+  }
+
+  /** Response body as a C string (valid until the next request). */
+  text(): string {
+    return httpBody();
+  }
+
+  contentLength(): number {
+    return httpContentLength();
+  }
+
+  responseHeader(name: string): string {
+    return httpResponseHeader(name);
+  }
+}
+
+export class HttpClass {
+  static readonly __instance_name = "Http";
+
+  get(url: string): HttpRequest {
+    httpReset();
+    return new HttpRequest("GET", url);
+  }
+
+  post(url: string): HttpRequest {
+    httpReset();
+    return new HttpRequest("POST", url);
+  }
+
+  put(url: string): HttpRequest {
+    httpReset();
+    return new HttpRequest("PUT", url);
+  }
+
+  del(url: string): HttpRequest {
+    httpReset();
+    return new HttpRequest("DELETE", url);
+  }
+
+  head(url: string): HttpRequest {
+    httpReset();
+    return new HttpRequest("HEAD", url);
+  }
+
+  patch(url: string): HttpRequest {
+    httpReset();
+    return new HttpRequest("PATCH", url);
+  }
+}
+
+export const Http = new HttpClass();

package/src/i2c.ts

@@ -1,4 +1,4 @@
-import { i2cBegin, i2cEnd, i2cSetClock, i2cBeginTx, i2cWrite, i2cWriteBuffer, i2cEndTx, i2cRequestFrom, i2cAvailable, i2cRead, rawCpp } from './emit.js';
+import { i2cBegin, i2cEnd, i2cSetClock, i2cBeginTx, i2cWrite, i2cWriteBuffer, i2cEndTx, i2cRequestFrom, i2cAvailable, i2cRead, i2cReadBuffer, rawCpp } from './emit.js';
 import { include } from './include.js';
 
 export class I2CDevice {
@@ -10,6 +10,16 @@ export class I2CDevice {
     this._address = address;
   }
 
+  /** The 7-bit I2C address this accessor targets. Exposed so I2CDevice
+   *  structurally satisfies the @typecad/simulator II2CDeviceAccessor contract
+   *  (which declares `readonly address`), letting the same driver function be
+   *  typed against the contract and accept either a real board device or a
+   *  simulated one. The transpiler strips HAL class bodies to IR, so this
+   *  getter carries no runtime cost in the generated C++. */
+  get address(): number {
+    return this._address;
+  }
+
   writeByte(register: number, value: number): void {
     include("<Wire.h>");
     i2cBeginTx(this._bus, this._address);
@@ -41,9 +51,11 @@ export class I2CDevice {
     i2cWrite(this._bus, register);
     i2cEndTx(this._bus, false);
     i2cRequestFrom(this._bus, this._address, count, true);
-    rawCpp(`static uint8_t __buf[${count}];`);
-    rawCpp(`for (int __i = 0; __i < ${count}; __i++) __buf[__i] = ${this._bus}.read();`);
-    rawCpp(`return __buf;`);
+    // Drain the requested bytes 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.
+    i2cReadBuffer(this._bus, count, new Uint8Array(count));
     return new Uint8Array(count);
   }
 }

package/src/index.ts

@@ -19,7 +19,7 @@ export type { SPIBitOrder, SPIMode, SPISettings } from './types.js';
 export { include } from './include.js';
 export { board } from './board.js';
 export { callback } from './callback.js';
-export { rawCpp, boardResolve } from './emit.js';
+export { rawCpp, rawCppExpr, boardResolve } from './emit.js';
 export { HIGH, LOW, OUTPUT, INPUT, INPUT_PULLUP, INPUT_PULLDOWN, OUTPUT_OPEN_DRAIN, ANALOG, LED_BUILTIN, LSBFIRST, MSBFIRST, WDTO_15MS, WDTO_30MS, WDTO_60MS, WDTO_120MS, WDTO_250MS, WDTO_500MS, WDTO_1S, WDTO_2S, WDTO_4S, WDTO_8S } from './constants.js';
 export { delay, millis, micros, delayMicroseconds, map, constrain, TimingClass, Timing } from './timing.js';
 export { freeHeap, setInterval, setTimeout, clearInterval, clearTimeout } from './timing.js';
@@ -46,3 +46,11 @@ export { HardwareTimer, Timer0, Timer1, Timer2 } from './timer.js';
 export { FSClass, FS } from './fs.js';
 export { PowerClass, Power } from './power.js';
 export { AsyncClass, Async } from './async.js';
+export { WiFiClass, WiFi, WiFiStatus, WiFiEncryption } from './wifi.js';
+export { HttpClass, Http, HttpRequest, HttpMethod } from './http.js';
+export {
+  BleClass, Ble, BleServer,
+  BleValueType, BlePerm, BleStatus, BleAdvertisingMode, GATT,
+} from './ble.js';
+export type { GattCharacteristicDef, CharValue } from './ble.js';
+export { RmtChannel } from './rmt.js';

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);
   }