Class: Sensor

Sensor

new Sensor()

Generic sensor class
Source:

Members

(private, static) buffer :Array

Sensor data buffer
Type:
  • Array
Source:

(private, static) bufferSize :Number

The size of buffer data
Type:
  • Number
Source:

(private, static) info :Object

Holds basic sensor information
Type:
  • Object
Properties:
Name Type Description
type String Sensor type
vendor String Vendor name
version String Sensor version
freq Number Sensor frequency (Hz)
threshold Number Threshold value
state String Sensor state
Source:

(private, static) intervalRead :Number

An id return by setInterval() function
Type:
  • Number
Source:

Methods

disableThreshold()

Disable the functionality of using threshold
Source:

getBufferSize() → {Number}

Retrieve buffer size
Source:
Returns:
Buffer size
Type
Number

getFreq() → {Number}

Retrieve sensor frequency
Source:
Returns:
Frequency of the sensor
Type
Number

getState() → {Number}

Retrieve sensor state
Source:
Returns:
- Sensor state
Type
Number

getThreshold() → {Number}

Retrieve sensor threshold
Source:
Returns:
- Threshold value
Type
Number

getType() → {String}

Retrieve sensor type
Source:
Returns:
The sensor type
Type
String

isValid(initOption) → {String}

Check sensor's validity. If this sensor is valid, register to use it
Parameters:
Name Type Description
initOption Object sensor's initialized information
Source:
Fires:
Returns:
Sensor ID
Type
String

(abstract) readData()

Read data from the sensor
Source:

readDataBuffer(numOfData) → {Array}

Read data from the data buffer
Parameters:
Name Type Description
numOfData Number Number of data
Source:
Returns:
- Array of returned data
Type
Array

resetBuffer()

Reset data buffer
Source:

setBufferSize(size)

Set buffer size
Parameters:
Name Type Description
size Number Buffer size
Source:

setFreq(freq)

Set sensor frequency
Parameters:
Name Type Description
freq Number Frequency value
Source:

setState(state)

Set sensor state
Parameters:
Name Type Description
state String State value
Source:

setThreshold(freq)

Set sensor threshold
Parameters:
Name Type Description
freq int Threshold value
Source:

start(self)

Start the sensor's operation
Parameters:
Name Type Description
self Object Sensor object
Source:

stop()

Stop the sensor's operation
Source:

toString()

Print sensor's basic information (type + vendor + version)
Source: