com.javelindevices.javelinsdk.model

Class ISensorManager

java.lang.Object

com.javelindevices.javelinsdk.model.ISensorManager

Direct Known Subclasses:

JavelinSensorManager

public abstract class ISensorManager
extends java.lang.Object

Contains the Javelin's API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ISensorManager.JavelinEventListener

Field Summary

Fields

Modifier and Type	Field and Description
protected ISensorManager.JavelinEventListener	listener

Constructor Summary

Constructors

Constructor and Description
ISensorManager()

Method Summary

Modifier and Type	Method and Description
abstract boolean	createBond() Bonds the application to the javelin device.
abstract void	disable() Disconnects the javelin device.
abstract void	enable() Connects to the javelin device.
abstract void	ledEnable(boolean enable) LED on/off switch.
abstract void	readRssi() Reads the signal strength from the javelin device to the central device.
abstract void	registerListener(ISensorManager.JavelinEventListener listener, int sensorType) Enable notifications from a sensor.
abstract boolean	removeBond() Removes the bond from the application to the javelin device.
abstract void	setAccelerometerFullScaleRange(int range)
abstract void	setAcceleromGyroRate(int rate) Sets the sampling rate of the accelerometer and gyroscope to the value closest to the given parameter.
abstract void	setAcceleromGyroSampleRateDivisor(int divisor) Set the divisor used to divide the default sample rate up.
abstract void	setAudioQuality(int quality)
abstract void	setGyroscopeFullScaleRange(int range)
abstract void	setLedBlinkNumber(int times) Sets how many times the LED goes on and off for the specified number of times at the current rate, pulsation type, and intensity.
abstract void	setLedBlinkRate(int rate) Sets the LED's blinking rate for the PULSE, TRIANGLE, and SAWTOOTH LED types.
abstract void	setLedBlinkType(int blinkType) Sets the kind of blinking type to enable when ledEnable(true) is called
abstract void	setLedIntensity(int intensity) Sets the LED intensity on a scale of 1 - 100, 100 being the strongest intensity.
void	setListener(ISensorManager.JavelinEventListener listener) Allows the android activity to receive sensor events.
abstract void	setVibrationIntensity(int intensity)
abstract void	setVibrationRate(int rate) Sets the vibration rate for the PULSE, TRIANGLE, and SAWTOOTH vibration types.
abstract void	setVibrationRepeatNumber(int times) Sets the number of times to vibrate if the SOLID, PULSE, TRIANGLE or SAWTOOTH vibration type is set.
abstract void	setVibrationType(int type) Sets the vibration type to use
abstract void	unregisterAll() Removes all listeners, stopping sensor updates.
abstract void	unregisterListener(ISensorManager.JavelinEventListener listener, int sensorType) Disables notifications and data from a sensor for the given listener, if it is already subscribed.
abstract void	vibrationEnable(boolean enable) Vibrator on / off switch.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

listener

protected ISensorManager.JavelinEventListener listener

Constructor Detail

ISensorManager

public ISensorManager()

Method Detail

setListener

public void setListener(ISensorManager.JavelinEventListener listener)

Allows the android activity to receive sensor events. To properly receive these events, the caller must extend the ISensorManager.SensorEventListener class

Parameters:

listener - the ISensorManager.JavelinEventListener

enable

public abstract void enable()
                     throws com.javelindevices.javelinsdk.SensorManagerException

Connects to the javelin device. If this is called without setting a listener then no events will be received.

Throws:

com.javelindevices.javelinsdk.SensorManagerException

disable

public abstract void disable()

Disconnects the javelin device. This should always be called when not planning to use anymore javelin data.

readRssi

public abstract void readRssi()

Reads the signal strength from the javelin device to the central device. The result will be shown on the onReadRemoteRssi() callback in ISensorManager.JavelinEventListener.

registerListener

public abstract void registerListener(ISensorManager.JavelinEventListener listener,
                                      int sensorType)

Enable notifications from a sensor. A JavelinSensorManager will remember all registered listeners

Parameters:

sensorType - The sensor to enable.

unregisterListener

public abstract void unregisterListener(ISensorManager.JavelinEventListener listener,
                                        int sensorType)

Disables notifications and data from a sensor for the given listener, if it is already subscribed. If other listeners are still registered to the sensor, they'll still receive data. When there are no listeners subscribed to a sensor, the javelin device will turn that sensor off to save battery. A sensor listener should be unregistered when no more data is needed from it for less battery consumption.

Parameters:

sensorType - a type defined in ISensor

unregisterAll

public abstract void unregisterAll()

Removes all listeners, stopping sensor updates. This does not disconnect the application from the javelin service.

createBond

public abstract boolean createBond()

Bonds the application to the javelin device.

Returns:

boolean indicating whether bonding was successful.

removeBond

public abstract boolean removeBond()

Removes the bond from the application to the javelin device.

Returns:

boolean indicating whether the removal was successful.

ledEnable

public abstract void ledEnable(boolean enable)

LED on/off switch. Will cancel any blinking taking place, if any.

Must set setLedBlinkType(int blinkType) before calling ledEnable(boolean)

Parameters:

enable - boolean

setLedIntensity

public abstract void setLedIntensity(int intensity)

Sets the LED intensity on a scale of 1 - 100, 100 being the strongest intensity.

Parameters:

intensity - the intensity of the LED from 1 to 100 inclusive.

setLedBlinkType

public abstract void setLedBlinkType(int blinkType)

Sets the kind of blinking type to enable when ledEnable(true) is called

Parameters:

blinkType - Integer constant describing the kind of blinking type to enable. This can be any of the LED_TYPE contants from JavelinSettings

setLedBlinkRate

public abstract void setLedBlinkRate(int rate)

Sets the LED's blinking rate for the PULSE, TRIANGLE, and SAWTOOTH LED types.

Parameters:

rate - the blinking rate, in .1Hz values. A value of 10 will make the LED blink once per second.

setLedBlinkNumber

public abstract void setLedBlinkNumber(int times)

Sets how many times the LED goes on and off for the specified number of times at the current rate, pulsation type, and intensity. Sending in the maximum value (255) will make it blink indefinitely until the LED is disabled or a disconnection event happens.

Parameters:

times - how many times to blink the LED when calling the ledEnable method. Allowed values are [1,255].

vibrationEnable

public abstract void vibrationEnable(boolean enable)

Vibrator on / off switch. This will override any vibrations taking place.

Must set setVibrationType(int type) before calling vibrationEnable(boolean)

Parameters:

enable - boolean

setVibrationIntensity

public abstract void setVibrationIntensity(int intensity)

Parameters:

intensity - the intensity of vibration from 1 to 100 inclusive.

setVibrationType

public abstract void setVibrationType(int type)

Sets the vibration type to use

Parameters:

type - one of the VIB_TYPE constants in ISensor

setVibrationRate

public abstract void setVibrationRate(int rate)

Sets the vibration rate for the PULSE, TRIANGLE, and SAWTOOTH vibration types.

Parameters:

rate - an integer indicating the number of vibrations per 1/10th of a second (.1Hz). A value of 10 will make it vibrate once per second.

setVibrationRepeatNumber

public abstract void setVibrationRepeatNumber(int times)

Sets the number of times to vibrate if the SOLID, PULSE, TRIANGLE or SAWTOOTH vibration type is set. If the SOLID vibration type is set, it will vibrate for that many seconds, otherwise, it will use the default rate of vibration or one that has been set. Sending in the maximum value (255) will make it blink indefinitely until the vibrator is disabled or a disconnection event happens.

Parameters:

times - the number of times to vibrate

setAudioQuality

public abstract void setAudioQuality(int quality)

setAcceleromGyroRate

public abstract void setAcceleromGyroRate(int rate)

Sets the sampling rate of the accelerometer and gyroscope to the value closest to the given parameter. The default rate, 100Hz, must be divisible by the desired sample rate -- otherwise it attempts to approximate it.

Parameters:

rate - the sampling rate to set the gyroscope and accelerometer to.

setAccelerometerFullScaleRange

public abstract void setAccelerometerFullScaleRange(int range)

setGyroscopeFullScaleRange

public abstract void setGyroscopeFullScaleRange(int range)

setAcceleromGyroSampleRateDivisor

public abstract void setAcceleromGyroSampleRateDivisor(int divisor)

Set the divisor used to divide the default sample rate up. The default sample rate is 100Hz

Parameters:

divisor -