Members
(private, static) buffer :Array
Sensor data buffer
Type:
- Array
(private, static) bufferSize :Number
The size of buffer data
Type:
- Number
(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 |
(private, static) intervalRead :Number
An id return by setInterval() function
Type:
- Number
Methods
disableThreshold()
Disable the functionality of using threshold
getBufferSize() → {Number}
Retrieve buffer size
Returns:
Buffer size
- Type
- Number
getFreq() → {Number}
Retrieve sensor frequency
Returns:
Frequency of the sensor
- Type
- Number
getState() → {Number}
Retrieve sensor state
Returns:
- Sensor state
- Type
- Number
getThreshold() → {Number}
Retrieve sensor threshold
Returns:
- Threshold value
- Type
- Number
getType() → {String}
Retrieve sensor type
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 |
Fires:
Returns:
Sensor ID
- Type
- String
(abstract) readData()
Read data from the sensor
readDataBuffer(numOfData) → {Array}
Read data from the data buffer
Parameters:
| Name | Type | Description |
|---|---|---|
numOfData |
Number | Number of data |
Returns:
- Array of returned data
- Type
- Array
resetBuffer()
Reset data buffer
setBufferSize(size)
Set buffer size
Parameters:
| Name | Type | Description |
|---|---|---|
size |
Number | Buffer size |
setFreq(freq)
Set sensor frequency
Parameters:
| Name | Type | Description |
|---|---|---|
freq |
Number | Frequency value |
setState(state)
Set sensor state
Parameters:
| Name | Type | Description |
|---|---|---|
state |
String | State value |
setThreshold(freq)
Set sensor threshold
Parameters:
| Name | Type | Description |
|---|---|---|
freq |
int | Threshold value |
start(self)
Start the sensor's operation
Parameters:
| Name | Type | Description |
|---|---|---|
self |
Object | Sensor object |
stop()
Stop the sensor's operation
toString()
Print sensor's basic information (type + vendor + version)