1. Home
  2. j5e/sensor~Sensor

new <async> Sensor( io )

Description
The Sensor class allows for input from sensor devices that connect to an ADC
Parameters
Name Type Description
io number | string | object Pin identifier or IO Options (See Instantiating a Device)
Examples

Using a pin number

import Sensor from "j5e/sensor";
			
			const sensor = await new Sensor(12);
			sensor.on("change", data => {
			 trace(data);
			});

Using a pin identifier

import Sensor from "j5e/sensor";
			
			const sensor = await new Sensor("A1");
			sensor.on("change", data => {
			 trace(data);
			});
Details

module:j5e/withinable~Withinable

sensor/index.js, line 17

Members

limit :Array.<number>

Description
Limits the output range
Details
Array.<number>

sensor/index.js, line 128

threshold :number

Description
The minimum amount of change required to emit a "change" event
Details
number

sensor/index.js, line 140

interval :number

Description
The interval between readings (in ms)
Details
number

sensor/index.js, line 152

smoothing :number

Description
The number of samples to take before finding the median
Details
number

sensor/index.js, line 173

aref :number

Description
The reference voltage
Details
number

sensor/index.js, line 185

samples :number

Description
The number of samples to take before finding the median
Details
number

sensor/index.js, line 193

<readonly> range :Array.<number>

Description
The input range of the sensor
Details
Array.<number>

sensor/index.js, line 202

<readonly> raw :number

Description
Get the most recent raw ADC reading
Details
number

sensor/index.js, line 211

<readonly> median :number

Description
Get the most recent median ADC reading
Details
number

sensor/index.js, line 220

<readonly> resolution :number

Description
The maximum possible ADC reading
Details
number

sensor/index.js, line 229

<readonly> scaled :number

Description
Get the most recent scaled raw reading
Details
number

sensor/index.js, line 238

<readonly> value :number

Properties
Name Type Description
Get the most recent scaled median value
Details
number

sensor/index.js, line 253

Methods

configure( options ) → {Sensor}

Description
Configure a Sensor
Parameters
Name Type Description
options object Device configuration options
Name Type Attributes Default Description
aref number <optional>
 3.3 Analog reference voltage
enabled boolean <optional>
 true Wether the device is currently performing reads every ms
interval number <optional>
 100 Interval between readings in millseconds
limit Array.<number> <optional>
 Limit the output range
range Array.<number> <optional>
 [0, N] The input range of the sensor
scale Array.<number> <optional>
 [0, N] The output range for the sensor's value
threshold number <optional>
 1 The minimum amount of change required to emit a "change" event
Returns
The instance on which the method was called
Examples

Passing in Cofiguration Options

import Sensor from "j5e/sensor";
			
			const sensor = await new Sensor({
			 pin: 12
			});
			
			sensor.configure({
			 interval: 500
			});
			
			sensor.on("change", data => {
			 trace(data);
			});
Details

sensor/index.js, line 99

enable() → {Object}

Description
Enable a disabled sensor.
Returns
instance
Examples
import Sensor from "j5e/sensor";
			const sensor = await new Sensor(12);
			
			sensor.disable();
			
			// Wait 5 seconds and then take readings
			timer.setTimeout(function() {
			 sensor.enable();
			});
Details

sensor/index.js, line 271

disable() → {Object}

Description
Disable an enabled sensor.
Returns
instance
Examples
import Sensor from "j5e/sensor";
			const sensor = await new Sensor(12);
			
			// Take reading for 5 seconds and then stop
			timer.setTimeout(function() {
			 sensor.disable();
			});
Details

sensor/index.js, line 292

read() → {Number}

Description
Synchronous read of a sensor.
Returns
sensor value
Examples
import Sensor from "j5e/sensor";
			const sensor = await new Sensor(12);
			
			let myValue = sensor.read();
Details

sensor/index.js, line 311

scale( low, high [, low, high ] ) → {Object}

Description
scale/scaleTo Set a value scaling range
Parameters
Name Type Attributes Description
low Number Lowerbound
high Number Upperbound
low, high Array <optional>
 Lowerbound
Returns
instance
instance
Examples
import Sensor from "j5e/sensor";
			const sensor = await new Sensor(12);
			
			// Scale all future values to 8-bit range
			sensor.scale([0, 255]);
Details

sensor/index.js, line 402

scaleTo( low, low, high ) → {Number}

Description
scaleTo Scales value to integer representation
Parameters
Name Type Description
low Number An array containing a lower and upper bound
low Number A number to use as a lower bound
high Number A number to use as an upper bound
Returns
The scaled value
Examples
import Sensor from "j5e/sensor";
			const sensor = await new Sensor(12);
			
			// Scale the returned value to 8-bit range
			sensor.scaleTo([0, 255]);
Details

sensor/index.js, line 429

fscaleTo( low, low, high ) → {Number}

Description
fscaleTo Scales value to single precision float representation
Parameters
Name Type Description
low Number An array containing a lower and upper bound
low Number A number to use as a lower bound
high Number A number to use as an upper bound
Returns
The scaled value
Examples
import Sensor from "j5e/sensor";
			const sensor = await new Sensor(12);
			
			// Scale the returned value to float between 0 and 1
			sensor.fscaleTo([0, 1]);
Details

sensor/index.js, line 448

on( event, listener )

Description
Create an event listener
Parameters
Name Type Description
event string The name of the event to listen for
listener function A callback to run when the event is fired.
Details

module:j5e/event.Emitter#on

module:j5e/withinable~Withinable#on

event/index.js, line 25

within( range, unit, callback )

Description
Fire a callback when the value is within a certain range
Parameters
Name Type Description
range Array.<number> The upper and lower ends of the range to watch
unit string The property to test
callback function A callback to run when the event is fired.
Details

module:j5e/withinable~Withinable#within

module:j5e/withinable~Withinable#within

withinable/index.js, line 26

removeListener( event, listener )

Description
Remove an event listener
Parameters
Name Type Description
event string The name of the event that we are removing a listener from
listener function The callback that we are removing
Details

module:j5e/event.Emitter#removeListener

module:j5e/withinable~Withinable#removeListener

event/index.js, line 36

once( event, listener )

Description
Create an event listener that will only fire one time.
Parameters
Name Type Description
event string The name of the event to listen for
listener function A callback to run when the event is fired.
Details

module:j5e/event.Emitter#once

module:j5e/withinable~Withinable#once

event/index.js, line 64