It is General Purpose SPI

Hierarchy

Constructors

Properties

Obniz: Obniz

obniz to be used

timeout: number = ...

Rsponse waiting timeout in milliseconds

prefixed: string | boolean

Methods

  • Calls each of the listeners registered for a given event.

    Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

  • It ends spi

    // Javascript Example
    obniz.spi0.start({mode:"master", clk :0, mosi:1, miso:2, clock:1000000});
    obniz.spi0.write([0x12, 0x98]);
    obniz.spi0.end();

    Parameters

    • Optional reuse: boolean

      True : getFreeSpi will not return this object

      • False : getFreeSpi will return this object

    Returns void

  • Return an array listing the events for which the emitter has registered listeners.

    Returns string[]

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string

    Returns number

  • Return the listeners registered for a given event.

    Parameters

    • event: string

    Returns ListenerFn[]

  • Parameters

    • event: string
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns PeripheralSPI

  • Add a listener for a given event.

    Parameters

    • event: string
    • fn: ListenerFn
    • Optional context: any

    Returns PeripheralSPI

  • Add a one-time listener for a given event.

    Parameters

    • event: string
    • fn: ListenerFn
    • Optional context: any

    Returns PeripheralSPI

  • Remove the listeners of a given event.

    Parameters

    • event: string
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns PeripheralSPI

  • It starts spi. Now the mode is only "master".

    drive and pull are optional settings for io output. Default settings are drive:5v, pull:null. See more using obniz.io.drive() or pull().

    // Javascript Example
    obniz.spi0.start({mode:"master", clk :0, mosi:1, miso:2, frequency:1000000});
    var ret = await obniz.spi0.writeWait([0x12, 0x98]);
    console.log("received: "+ret);

    // drive and pull is optional
    obniz.spi0.start({mode:"master", clk :0, mosi:1, miso:2, frequency:1000000, drive: "5v", pull:null});

    Parameters

    • params: PeripheralSPIOptions

      spi parameters

    Returns void

  • It only sends data to spi and does not receive it.

    // Javascript Example
    obniz.spi0.start({mode:"master", clk :0, mosi:1, miso:2, frequency:1000000});
    obniz.spi0.write([0x12, 0x98]);

    Parameters

    • data: number[]

      Max length is 1024 bytes.

    Returns void

  • It sends data to spi and wait until data are received. The received data length is the same as the sent data.

    // Javascript Example
    obniz.spi0.start({mode:"master", clk :0, mosi:1, miso:2, frequency:1000000});
    var ret = await obniz.spi0.writeWait([0x12, 0x98]);
    console.log("received: "+ret);

    Parameters

    • data: number[]

      Max length is 1024 bytes.

    Returns Promise<number[]>

    received data

Generated using TypeDoc