ixfx
    Preparing search index...

    Class Device

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

    import { Serial } from 'https://unpkg.com/ixfx/dist/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)

    Constructors

    constructor

    Properties

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

    Accessors

    isClosed isConnected isDisposed

    Methods

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

    Constructors

    constructor

    Properties

    abort

    abort: AbortController

    baudRate

    baudRate: number

    chunkSize

    chunkSize: number

    codec

    codec: Codec

    connectAttempts

    connectAttempts: number

    name

    name: string

    port

    port: undefined | SerialPort

    rxBuffer

    rxBuffer: StringReceiveBuffer

    states

    states: Flow.StateMachine.WithEvents<
        Readonly<
            Readonly<
                {
                    closed: "connecting";
                    connected: string[];
                    connecting: string[];
                    ready: "connecting";
                },
            >,
        >,
    >

    tx

    tx: undefined | WritableStreamDefaultWriter<string>

    txBuffer

    txBuffer: StringWriteBuffer

    verboseLogging

    verboseLogging: boolean = false

    Accessors

    isClosed

    • get isClosed(): boolean

      Returns boolean

    isConnected

    • get isConnected(): boolean

      Returns boolean

    isDisposed

    • get isDisposed(): boolean

      Returns boolean

    Methods

    addEventListener

    close

    • close(): Promise<void>

      Returns Promise<void>

    connect

    • connect(): Promise<void>

      Returns Promise<void>

    dispose

    • dispose(): void

      Returns void

    ProtectedfireEvent

    Protectedlog

    • log(m: string): void

      Parameters

      • m: string

      Returns void

    onClosed

    • onClosed(): void

      Must change state

      Returns void

    onConnectAttempt

    • onConnectAttempt(): Promise<void>

      Should throw if did not succeed.

      Returns Promise<void>

    onPreConnect

    • onPreConnect(): Promise<void>

      Returns Promise<void>

    removeEventListener

    Protectedverbose

    • verbose(m: string): void

      Parameters

      • m: string

      Returns void

    Protectedwarn

    • warn(m: unknown): void

      Parameters

      • m: unknown

      Returns void

    write

    • write(txt: string): void

      Parameters

      • txt: string

      Returns void

    ProtectedwriteInternal

    • writeInternal(txt: string): Promise<void>

      Writes text collected in buffer

      Parameters

      • txt: string

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods