modbus-rs-wasm 0.12.0

package/dist/bundler/modbus-rs.d.ts

@@ -0,0 +1,645 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Browser-facing Modbus client that communicates over a WebSocket transport.
+ */
+export class WasmModbusClient {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Send a Diagnostics request (FC 8).
+     *
+     * `sub_function` is one of the `DiagnosticSubFunction` u16 codes.
+     * Returns a `Promise` resolving with `{ subFunction, data: Uint16Array }` or rejects on error.
+     */
+    diagnostics(sub_function: number, data: Uint16Array): Promise<any>;
+    /**
+     * Read the communication event counter (FC 11).
+     *
+     * Returns a `Promise` resolving with `{ status, eventCount }` or rejects on error.
+     */
+    get_comm_event_counter(): Promise<any>;
+    /**
+     * Read the communication event log (FC 12).
+     *
+     * Returns a `Promise` resolving with `{ status, eventCount, messageCount, events: Uint8Array }`
+     * or rejects on error.
+     */
+    get_comm_event_log(): Promise<any>;
+    /**
+     * Returns `true` if there are in-flight Modbus requests waiting for
+     * response/timeout resolution.
+     */
+    has_pending_requests(): boolean;
+    /**
+     * Returns `true` when the underlying WebSocket is open and the transport
+     * considers itself connected.
+     */
+    is_connected(): boolean;
+    /**
+     * Apply an AND/OR mask to a holding register at `address` (FC 22).
+     *
+     * Result register = (current & and_mask) | (or_mask & !and_mask).
+     * Returns a `Promise` resolving with `true` or rejects on error.
+     */
+    mask_write_register(address: number, and_mask: number, or_mask: number): Promise<any>;
+    /**
+     * Create a new Modbus master client and immediately start the background tick loop.
+     *
+     * # Arguments
+     * - `ws_url`           — WebSocket URL of the Modbus/TCP gateway (e.g. `"ws://192.168.1.1:8502"`).
+     * - `unit_id`          — Modbus unit ID / slave address of the target device (1–247).
+     * - `response_timeout_ms` — How long (ms) to wait before retrying or failing a request.
+     * - `retry_attempts`   — Number of retries before reporting an error to JS.
+     * - `tick_interval_ms` — How often (ms) the tick loop calls `poll()`. 20 ms is a safe default.
+     */
+    constructor(ws_url: string, unit_id: number, response_timeout_ms: number, retry_attempts: number, tick_interval_ms: number);
+    /**
+     * Read `quantity` coils starting at `address`.
+     *
+     * Returns a `Promise` that resolves with a `Uint8Array` (bit-packed coil bytes)
+     * or rejects with an error string on failure.
+     */
+    read_coils(address: number, quantity: number): Promise<any>;
+    /**
+     * Read Device Identification (FC 43 / MEI 0x0E).
+     *
+     * `read_device_id_code`: 1=Basic, 2=Regular, 3=Extended, 4=Specific.
+     * `object_id`: 0x00=VendorName, 0x01=ProductCode, 0x02=Revision, 0x03=VendorURL, etc.
+     * Returns a `Promise` resolving with `{ readDeviceIdCode, conformityLevel, moreFollows, objects }`
+     * or rejects on error.
+     */
+    read_device_identification(read_device_id_code: number, object_id: number): Promise<any>;
+    /**
+     * Read `quantity` discrete inputs starting at `address`.
+     *
+     * Returns a `Promise` that resolves with a `Uint8Array` (bit-packed)
+     * or rejects on error.
+     */
+    read_discrete_inputs(address: number, quantity: number): Promise<any>;
+    /**
+     * Read the exception status (FC 7) — serial-line only on most devices.
+     *
+     * Returns a `Promise` resolving with a status `number` or rejects on error.
+     */
+    read_exception_status(): Promise<any>;
+    /**
+     * Read the FIFO queue pointed to by `address` (FC 24).
+     *
+     * Returns a `Promise` resolving with a `Uint16Array` or rejects on error.
+     */
+    read_fifo_queue(address: number): Promise<any>;
+    /**
+     * Read a file record (FC 20).
+     *
+     * Returns a `Promise` resolving with `Array<{ fileNumber, recordNumber, data: Uint16Array }>`
+     * or rejects on error.
+     */
+    read_file_record(file_number: number, record_number: number, record_length: number): Promise<any>;
+    /**
+     * Read `quantity` holding registers starting at `address`.
+     *
+     * Returns a `Promise` that resolves with a `Uint16Array` (register values)
+     * or rejects with an error string on failure.
+     */
+    read_holding_registers(address: number, quantity: number): Promise<any>;
+    /**
+     * Read `quantity` input registers starting at `address`.
+     *
+     * Returns a `Promise` that resolves with a `Uint16Array` or rejects on error.
+     */
+    read_input_registers(address: number, quantity: number): Promise<any>;
+    /**
+     * Read a single coil at `address`.
+     *
+     * Returns a `Promise` that resolves with a `boolean` or rejects on error.
+     */
+    read_single_coil(address: number): Promise<any>;
+    /**
+     * Read a single discrete input at `address`.
+     *
+     * Returns a `Promise` resolving with a `boolean` or rejects on error.
+     */
+    read_single_discrete_input(address: number): Promise<any>;
+    /**
+     * Read a single holding register at `address`.
+     *
+     * Returns a `Promise` that resolves with a `number` or rejects on error.
+     */
+    read_single_holding_register(address: number): Promise<any>;
+    /**
+     * Read a single input register at `address`.
+     *
+     * Returns a `Promise` that resolves with a `number` or rejects on error.
+     */
+    read_single_input_register(address: number): Promise<any>;
+    /**
+     * Perform an atomic read-then-write on holding registers.
+     *
+     * Reads `read_quantity` registers from `read_address`, then writes `values` to `write_address`.
+     * `write_quantity` is ignored — the quantity written is derived from `values.length`.
+     * Returns a `Promise` resolving with a `Uint16Array` (the values read) or rejects on error.
+     */
+    read_write_multiple_registers(read_address: number, read_quantity: number, write_address: number, _write_quantity: number, values: Uint16Array): Promise<any>;
+    /**
+     * Drop all pending in-flight requests and attempt to reconnect the WebSocket.
+     * Outstanding Promises for dropped requests will be rejected with `"ConnectionLost"`.
+     */
+    reconnect(): boolean;
+    /**
+     * Report Server ID (FC 17).
+     *
+     * Returns a `Promise` resolving with a `Uint8Array` (raw server ID data) or rejects on error.
+     */
+    report_server_id(): Promise<any>;
+    /**
+     * Write a file record (FC 21).
+     *
+     * `values` is a `Uint16Array` of register values to write.
+     * Returns a `Promise` resolving with `true` or rejects on error.
+     */
+    write_file_record(file_number: number, record_number: number, values: Uint16Array): Promise<any>;
+    /**
+     * Write multiple coils starting at `address`.
+     *
+     * `packed_bytes` is a bit-packed `Uint8Array` (LSB of byte 0 = coil at `address`).
+     * Returns a `Promise` that resolves with `{ address, quantity }` or rejects on error.
+     */
+    write_multiple_coils(address: number, quantity: number, packed_bytes: Uint8Array): Promise<any>;
+    /**
+     * Write `values` to multiple consecutive holding registers starting at `address`.
+     *
+     * Returns a `Promise` that resolves with `{ address, quantity }` or rejects on error.
+     */
+    write_multiple_registers(address: number, quantity: number, values: Uint16Array): Promise<any>;
+    /**
+     * Write a single coil at `address` to `value` (true = ON, false = OFF).
+     *
+     * Returns a `Promise` that resolves with `{ address, value }` or rejects on error.
+     */
+    write_single_coil(address: number, value: boolean): Promise<any>;
+    /**
+     * Write `value` to a single holding register at `address`.
+     *
+     * Returns a `Promise` that resolves with `{ address, value }` or rejects on error.
+     */
+    write_single_register(address: number, value: number): Promise<any>;
+}
+
+/**
+ * Browser-facing Modbus client that communicates over Web Serial RTU or ASCII.
+ */
+export class WasmSerialModbusClient {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Send a Diagnostics request (FC 8).
+     *
+     * `sub_function` is one of the `DiagnosticSubFunction` u16 codes.
+     * Returns a `Promise` resolving with `{ subFunction, data: Uint16Array }` or rejects on error.
+     */
+    diagnostics(sub_function: number, data: Uint16Array): Promise<any>;
+    /**
+     * Read the communication event counter (FC 11).
+     *
+     * Returns a `Promise` resolving with `{ status, eventCount }` or rejects on error.
+     */
+    get_comm_event_counter(): Promise<any>;
+    /**
+     * Read the communication event log (FC 12).
+     *
+     * Returns a `Promise` resolving with `{ status, eventCount, messageCount, events: Uint8Array }`
+     * or rejects on error.
+     */
+    get_comm_event_log(): Promise<any>;
+    /**
+     * Returns `true` if there are in-flight Modbus requests waiting for
+     * response/timeout resolution.
+     */
+    has_pending_requests(): boolean;
+    /**
+     * Returns `true` when the serial port is open and the transport considers itself connected.
+     */
+    is_connected(): boolean;
+    /**
+     * Apply an AND/OR mask to a holding register at `address` (FC 22).
+     *
+     * Result register = (current & and_mask) | (or_mask & !and_mask).
+     * Returns a `Promise` resolving with `true` or rejects on error.
+     */
+    mask_write_register(address: number, and_mask: number, or_mask: number): Promise<any>;
+    /**
+     * Creates a Modbus serial client over browser Web Serial.
+     *
+     * `mode` accepts "rtu" or "ascii" (case-insensitive).
+     * `parity` accepts "none", "even", or "odd".
+     */
+    constructor(port_handle: WasmSerialPortHandle, unit_id: number, mode: string, baud_rate: number, data_bits: number, stop_bits: number, parity: string, response_timeout_ms: number, retry_attempts: number, tick_interval_ms: number);
+    /**
+     * Read `quantity` coils starting at `address`.
+     *
+     * Returns a `Promise` resolving with a `Uint8Array` (bit-packed coil bytes) or rejects on error.
+     */
+    read_coils(address: number, quantity: number): Promise<any>;
+    /**
+     * Read Device Identification (FC 43 / MEI 0x0E).
+     *
+     * `read_device_id_code`: 1=Basic, 2=Regular, 3=Extended, 4=Specific.
+     * `object_id`: 0x00=VendorName, 0x01=ProductCode, 0x02=Revision, etc.
+     * Returns a `Promise` resolving with `{ readDeviceIdCode, conformityLevel, moreFollows, objects }`
+     * or rejects on error.
+     */
+    read_device_identification(read_device_id_code: number, object_id: number): Promise<any>;
+    /**
+     * Read `quantity` discrete inputs starting at `address`.
+     *
+     * Returns a `Promise` resolving with a `Uint8Array` (bit-packed) or rejects on error.
+     */
+    read_discrete_inputs(address: number, quantity: number): Promise<any>;
+    /**
+     * Read the exception status (FC 7).
+     *
+     * Returns a `Promise` resolving with a status `number` or rejects on error.
+     */
+    read_exception_status(): Promise<any>;
+    /**
+     * Read the FIFO queue pointed to by `address` (FC 24).
+     *
+     * Returns a `Promise` resolving with a `Uint16Array` or rejects on error.
+     */
+    read_fifo_queue(address: number): Promise<any>;
+    /**
+     * Read a file record (FC 20).
+     *
+     * Returns a `Promise` resolving with `Array<{ fileNumber, recordNumber, data: Uint16Array }>`
+     * or rejects on error.
+     */
+    read_file_record(file_number: number, record_number: number, record_length: number): Promise<any>;
+    /**
+     * Read `quantity` holding registers starting at `address`.
+     *
+     * Returns a `Promise` resolving with a `Uint16Array` (register values) or rejects on error.
+     */
+    read_holding_registers(address: number, quantity: number): Promise<any>;
+    /**
+     * Read `quantity` input registers starting at `address`.
+     *
+     * Returns a `Promise` resolving with a `Uint16Array` or rejects on error.
+     */
+    read_input_registers(address: number, quantity: number): Promise<any>;
+    /**
+     * Read a single coil at `address`.
+     *
+     * Returns a `Promise` resolving with a `boolean` or rejects on error.
+     */
+    read_single_coil(address: number): Promise<any>;
+    /**
+     * Read a single discrete input at `address`.
+     *
+     * Returns a `Promise` resolving with a `boolean` or rejects on error.
+     */
+    read_single_discrete_input(address: number): Promise<any>;
+    /**
+     * Read a single holding register at `address`.
+     *
+     * Returns a `Promise` resolving with a `number` or rejects on error.
+     */
+    read_single_holding_register(address: number): Promise<any>;
+    /**
+     * Read a single input register at `address`.
+     *
+     * Returns a `Promise` resolving with a `number` or rejects on error.
+     */
+    read_single_input_register(address: number): Promise<any>;
+    /**
+     * Perform an atomic read-then-write on holding registers.
+     *
+     * Reads `read_quantity` registers from `read_address`, then writes `values` to `write_address`.
+     * `write_quantity` is ignored — the quantity written is derived from `values.length`.
+     * Returns a `Promise` resolving with a `Uint16Array` (the values read) or rejects on error.
+     */
+    read_write_multiple_registers(read_address: number, read_quantity: number, write_address: number, _write_quantity: number, values: Uint16Array): Promise<any>;
+    /**
+     * Drop all pending in-flight requests and attempt to reopen the serial port.
+     * Outstanding Promises for dropped requests will be rejected with `"ConnectionLost"`.
+     */
+    reconnect(): boolean;
+    /**
+     * Report Server ID (FC 17).
+     *
+     * Returns a `Promise` resolving with a `Uint8Array` (raw server ID data) or rejects on error.
+     */
+    report_server_id(): Promise<any>;
+    /**
+     * Write a file record (FC 21).
+     *
+     * `values` is a `Uint16Array` of register values to write.
+     * Returns a `Promise` resolving with `true` or rejects on error.
+     */
+    write_file_record(file_number: number, record_number: number, values: Uint16Array): Promise<any>;
+    /**
+     * Write multiple coils starting at `address`.
+     *
+     * `packed_bytes` is a bit-packed `Uint8Array` (LSB of byte 0 = coil at `address`).
+     * Returns a `Promise` resolving with `{ address, quantity }` or rejects on error.
+     */
+    write_multiple_coils(address: number, quantity: number, packed_bytes: Uint8Array): Promise<any>;
+    /**
+     * Write `values` to multiple consecutive holding registers starting at `address`.
+     *
+     * Returns a `Promise` resolving with `{ address, quantity }` or rejects on error.
+     */
+    write_multiple_registers(address: number, quantity: number, values: Uint16Array): Promise<any>;
+    /**
+     * Write a single coil at `address` to `value` (true = ON, false = OFF).
+     *
+     * Returns a `Promise` resolving with `{ address, value }` or rejects on error.
+     */
+    write_single_coil(address: number, value: boolean): Promise<any>;
+    /**
+     * Write `value` to a single holding register at `address`.
+     *
+     * Returns a `Promise` resolving with `{ address, value }` or rejects on error.
+     */
+    write_single_register(address: number, value: number): Promise<any>;
+}
+
+/**
+ * Opaque handle around a browser `SerialPort` object granted by Web Serial.
+ */
+export class WasmSerialPortHandle {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Returns true if the wrapped JS value still looks like a valid SerialPort object.
+     */
+    is_valid(): boolean;
+}
+
+/**
+ * Browser-facing Modbus server endpoint for Web Serial traffic.
+ */
+export class WasmSerialServer {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Attach browser SerialPort object delegated to mbus-serial transport.
+     */
+    attach_serial_port(port: any): void;
+    /**
+     * Clears the stored last-error message.
+     */
+    clear_last_error(): void;
+    /**
+     * Dispatch a request object into JS app handler.
+     */
+    dispatch_request(request: any): Promise<any>;
+    /**
+     * Whether server lifecycle is currently active.
+     */
+    is_running(): boolean;
+    /**
+     * Returns the last captured binding-layer error message, if any.
+     */
+    last_error_message(): string | undefined;
+    /**
+     * Selected serial mode as numeric enum.
+     */
+    mode(): WasmServerTransportKind;
+    /**
+     * Create a serial server with a JS request handler callback.
+     *
+     * `on_request` receives one request object and may return a direct value or Promise.
+     */
+    constructor(config: WasmSerialServerConfig, on_request: Function);
+    /**
+     * Try receiving one frame from delegated serial transport.
+     */
+    recv_frame(): Uint8Array;
+    /**
+     * Send one encoded frame through delegated serial transport.
+     */
+    send_frame(frame: Uint8Array): void;
+    /**
+     * Start server lifecycle.
+     */
+    start(): void;
+    /**
+     * Returns a point-in-time status snapshot for diagnostics/observability.
+     */
+    status_snapshot(): WasmServerStatusSnapshot;
+    /**
+     * Stop server lifecycle.
+     */
+    stop(): void;
+    /**
+     * Whether delegated serial transport currently reports connected.
+     */
+    transport_connected(): boolean;
+}
+
+/**
+ * Configuration for Web Serial server bindings.
+ */
+export class WasmSerialServerConfig {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Create ASCII serial server config.
+     */
+    static ascii(): WasmSerialServerConfig;
+    /**
+     * Selected serial mode.
+     */
+    mode(): WasmServerTransportKind;
+    /**
+     * Create RTU serial server config.
+     */
+    static rtu(): WasmSerialServerConfig;
+}
+
+/**
+ * High-level design descriptor for phased server binding rollout.
+ */
+export class WasmServerBindingPlan {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Whether JS app callbacks are required for request dispatch.
+     */
+    app_callbacks_required(): boolean;
+    /**
+     * Whether lifecycle includes managed start/stop semantics.
+     */
+    lifecycle_managed(): boolean;
+    /**
+     * Plan for Web Serial ASCII based server bindings.
+     */
+    static serial_ascii(): WasmServerBindingPlan;
+    /**
+     * Plan for Web Serial RTU based server bindings.
+     */
+    static serial_rtu(): WasmServerBindingPlan;
+    /**
+     * Whether diagnostics counters are part of the plan.
+     */
+    supports_diagnostics_stats(): boolean;
+    /**
+     * Whether traffic hook callbacks are part of the plan.
+     */
+    supports_traffic_hooks(): boolean;
+    /**
+     * Plan for WebSocket-gateway based server bindings.
+     */
+    static tcp_gateway(): WasmServerBindingPlan;
+    /**
+     * Selected transport family.
+     */
+    transport(): WasmServerTransportKind;
+}
+
+/**
+ * Lightweight runtime status snapshot for browser-side server observability.
+ */
+export class WasmServerStatusSnapshot {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Number of successful `dispatch_request(...)` calls completed.
+     */
+    dispatched_requests(): number;
+    /**
+     * Whether a last error message is currently stored.
+     */
+    last_error_present(): boolean;
+    /**
+     * Number of successful `recv_frame(...)` calls.
+     */
+    received_frames(): number;
+    /**
+     * Whether server lifecycle is running.
+     */
+    running(): boolean;
+    /**
+     * Number of successful `send_frame(...)` calls.
+     */
+    sent_frames(): number;
+    /**
+     * Transport family of this server snapshot.
+     */
+    transport(): WasmServerTransportKind;
+    /**
+     * Whether delegated transport reports connected.
+     */
+    transport_connected(): boolean;
+}
+
+/**
+ * Transport families planned for browser-side server bindings.
+ */
+export enum WasmServerTransportKind {
+    /**
+     * Server loop receives requests via a WebSocket gateway.
+     */
+    TcpGateway = 0,
+    /**
+     * Server loop receives RTU frames via Web Serial.
+     */
+    SerialRtu = 1,
+    /**
+     * Server loop receives ASCII frames via Web Serial.
+     */
+    SerialAscii = 2,
+}
+
+/**
+ * Configuration for TCP gateway server bindings.
+ */
+export class WasmTcpGatewayConfig {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Create a new TCP-gateway config from a websocket URL.
+     */
+    constructor(ws_url: string);
+    /**
+     * WebSocket endpoint URL.
+     */
+    ws_url(): string;
+}
+
+/**
+ * Browser-facing Modbus server endpoint for WebSocket gateway traffic.
+ */
+export class WasmTcpServer {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Clears the stored last-error message.
+     */
+    clear_last_error(): void;
+    /**
+     * Dispatch a request object into JS app handler.
+     *
+     * This is the phase-1 execution path used before transport loops are added.
+     */
+    dispatch_request(request: any): Promise<any>;
+    /**
+     * Whether server lifecycle is currently active.
+     */
+    is_running(): boolean;
+    /**
+     * Returns the last captured binding-layer error message, if any.
+     */
+    last_error_message(): string | undefined;
+    /**
+     * Create a server from gateway config and a JS request handler.
+     *
+     * `on_request` receives one request object and may return a direct value or Promise.
+     */
+    constructor(config: WasmTcpGatewayConfig, on_request: Function);
+    /**
+     * Try receiving one frame from delegated network transport.
+     */
+    recv_frame(): Uint8Array;
+    /**
+     * Send one encoded response/request frame through delegated network transport.
+     */
+    send_frame(frame: Uint8Array): void;
+    /**
+     * Start server lifecycle.
+     */
+    start(): void;
+    /**
+     * Returns a point-in-time status snapshot for diagnostics/observability.
+     */
+    status_snapshot(): WasmServerStatusSnapshot;
+    /**
+     * Stop server lifecycle.
+     */
+    stop(): void;
+    /**
+     * Whether the delegated websocket transport is fully open and ready.
+     */
+    transport_connected(): boolean;
+    /**
+     * Whether the delegated websocket transport handshake is still in progress.
+     */
+    transport_connecting(): boolean;
+    /**
+     * Gateway URL this server is configured to use.
+     */
+    ws_url(): string;
+}
+
+/**
+ * Requests a browser serial port from `navigator.serial.requestPort()`.
+ *
+ * Must be invoked from a user-gesture context (e.g. click handler).
+ */
+export function request_serial_port(): Promise<WasmSerialPortHandle>;

package/dist/bundler/modbus-rs.js

@@ -0,0 +1,9 @@
+/* @ts-self-types="./modbus-rs.d.ts" */
+import * as wasm from "./modbus-rs_bg.wasm";
+import { __wbg_set_wasm } from "./modbus-rs_bg.js";
+
+__wbg_set_wasm(wasm);
+wasm.__wbindgen_start();
+export {
+    WasmModbusClient, WasmSerialModbusClient, WasmSerialPortHandle, WasmSerialServer, WasmSerialServerConfig, WasmServerBindingPlan, WasmServerStatusSnapshot, WasmServerTransportKind, WasmTcpGatewayConfig, WasmTcpServer, request_serial_port
+} from "./modbus-rs_bg.js";