The measure module provides hardware level measurement.

Hierarchy

Constructors

Properties

Obniz: Obniz

obniz to be used

timeout: number = ...

Rsponse waiting timeout in milliseconds

prefixed: string | boolean

Methods

  • Some electrical parts or circuits accept "pulse" and echo the "pulse" after delay. This module is best suited for measuring that delay.

    This module generates one pulse shot on an io, then measures the response time.

    // Javascript Example
    obniz.measure.echo({
    io_pulse: 0, // io for generate pulse
    io_echo: 1, // io to be measured
    pulse: "positive", // generate pulse pattern
    pulse_width: 0.1, // generate pulse width
    measure_edges: 3, // 1 to 4. maximum edges to measure
    timeout: 1000, // this is optional. 1000(1sec) is default
    callback: function(edges) {
    // callback function
    console.log(edges);
    }
    });

    Parameters

    Returns void

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

    Parameters

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

    Returns boolean

  • 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 ObnizMeasure

  • Add a listener for a given event.

    Parameters

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

    Returns ObnizMeasure

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

    Parameters

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

    Returns ObnizMeasure

  • Remove the listeners of a given event.

    Parameters

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

    Returns ObnizMeasure

Generated using TypeDoc