ixfx
    Preparing search index...

    Class Device

    Serial device. Assumes data is sent with new line characters (\r\n) between messages.

    import { Serial } from '@ixfx/io.js'
    const s = new Serial.Device();
    s.addEventListener(`change`, evt => {
     console.log(`State change ${evt.priorState} -> ${evt.newState}`);
     if (evt.newState === `connected`) {
       // Do something when connected...
     }
    });

    // In a UI event handler...
    s.connect();

    Reading incoming data:

    // Parse incoming data as JSON
    s.addEventListener(`data`, evt => {
     try {
       const o = JSON.parse(evt.data);
       // If we get this far, JSON is legit
     } catch (ex) {
     }
    });

    Writing to the microcontroller

    s.write(JSON.stringify({msg:"hello"}));

    Hierarchy (View Summary)

    Index

    Accessors

    isClosed isConnected isDisposed

    Constructors

    constructor

    Methods

    addEventListener close connect dispose fireEvent log onClosed onConnectAttempt onPreConnect removeEventListener verbose warn write writeInternal

    Properties

    abort baudRate chunkSize codec connectAttempts name port rxBuffer states tx txBuffer verboseLogging

    Accessors

    Constructors

    Methods

    • Must change state

      Returns void

    • Should throw if did not succeed.

      Returns Promise<void>

    • Returns Promise<void>

    • Writes text collected in buffer

      Parameters

      • txt: string

      Returns Promise<void>

    Properties

    abort: AbortController
    baudRate: number
    chunkSize: number
    codec: Codec
    connectAttempts: number
    name: string
    port: undefined | SerialPort
    rxBuffer: StringReceiveBuffer
    states: StateMachineWithEvents<
        Readonly<
            Readonly<
                {
                    closed: "connecting";
                    connected: string[];
                    connecting: string[];
                    ready: "connecting";
                },
            >,
        >,
    >
    tx: undefined | WritableStreamDefaultWriter<string>
    txBuffer: StringWriteBuffer
    verboseLogging: boolean = false

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructors
    Methods
    Properties