Interface ObnizMeasureOptions
Hierarchy
- ObnizMeasureOptions
Index
Properties - Pulse generation
Properties - Response measurement
Properties - Pulse generation
io_
io_
pulse
pulse: "negative" | "positive"
"positive" or "negative"
pulse_
pulse_
pulse duration in values between ms. 0.001 to 1000.
Properties - Response measurement
Optional callback
callback?: ((edges) => void)
Type declaration
-
- (edges): void
-
callback function after measurement or timeout.
A callback function will be called when the edge count = measure_edges or timeout. It has an array of edge information. For example, if you get a response like below
then, you will get below
callback: function(edges) {
edges.length // == 2
edges[0].edge // == true
edges[0].timing // == t1
edges[1].edge // == false
edges[1].timing // == t2
}Parameters
-
edges: ObnizMeasureResultArray
Returns void
-
io_
io_
io for measuring response. Please use with 'measure_edges' params.
measure_
measure_
maximum number of edges to detect. 1 to 4.
Optional timeout
timeout?: number
timeout in ms, and default is 1000. 0.001 to 1000.
io number to generate pulse. Please use with 'pulse' and 'pulse_width' params.