Java - Gas Detector Bricklet

Note

This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.

This is the description of the Java API bindings for the Gas Detector Bricklet. General information and technical specifications for the Gas Detector Bricklet are summarized in its hardware description.

An installation guide for the Java API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

API

Generally, every method of the Java bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions

public class BrickletGasDetector(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

BrickletGasDetector gasDetector = new BrickletGasDetector("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected (see examples above).

public int getValue()

Returns a value between 0 and 4095.

See here for more information about the measurements.

If you want to get the value periodically, it is recommended to use the listener ValueListener and set the period with setValueCallbackPeriod().

Advanced Functions

public void setMovingAverage(short average)

Sets the length of a moving averaging for the measured value.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

The range for the averaging is 1-100.

The default value is 100.

public short getMovingAverage()

Returns the length moving average as set by setMovingAverage().

public void setDetectorType(short detectorType)

Sets the detector type.

The following types are currently supported.

  • Type 0: MQ2 and MQ5
  • Type 1: MQ3

The detector type is written to the EEPROM of the Bricklet, so it only has to be set once.

You can use the Brick Viewer to set the detector type, so you likely don't need to use this function in your source code.

The default detector type is 0.

The following constants are available for this function:

  • BrickletGasDetector.DETECTOR_TYPE_0 = 0
  • BrickletGasDetector.DETECTOR_TYPE_1 = 1
public short getDetectorType()

Returns the detector type as set by setDetectorType().

The following constants are available for this function:

  • BrickletGasDetector.DETECTOR_TYPE_0 = 0
  • BrickletGasDetector.DETECTOR_TYPE_1 = 1
public void heaterOn()

Turns the internal heater on.

public void heaterOff()

Turns the internal heater off.

public boolean isHeaterOn()

Returns true if the heater is on, false otherwise.

public short[] getAPIVersion()

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

public boolean getResponseExpected(short functionId)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For listener configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See setResponseExpected() for the list of function ID constants available for this function.

public void setResponseExpected(short functionId, boolean responseExpected)

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and listener configuration functions (default value: true). For getter functions it is always enabled and listeners it is always disabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletGasDetector.FUNCTION_SET_VALUE_CALLBACK_PERIOD = 2
  • BrickletGasDetector.FUNCTION_SET_VALUE_CALLBACK_THRESHOLD = 4
  • BrickletGasDetector.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletGasDetector.FUNCTION_SET_MOVING_AVERAGE = 8
  • BrickletGasDetector.FUNCTION_SET_DETECTOR_TYPE = 10
  • BrickletGasDetector.FUNCTION_HEATER_ON = 12
  • BrickletGasDetector.FUNCTION_HEATER_OFF = 13
public void setResponseExpectedAll(boolean responseExpected)

Changes the response expected flag for all setter and listener configuration functions of this device at once.

public BrickletGasDetector.Identity getIdentity()

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

The returned object has the public member variables String uid, String connectedUid, char position, short[] hardwareVersion, short[] firmwareVersion and int deviceIdentifier.

Listener Configuration Functions

public void setValueCallbackPeriod(long period)

Sets the period in ms with which the ValueListener listener is triggered periodically. A value of 0 turns the listener off.

ValueListener is only triggered if the value value has changed since the last triggering.

The default value is 0.

public long getValueCallbackPeriod()

Returns the period as set by setValueCallbackPeriod().

public void setValueCallbackThreshold(char option, int min, int max)

Sets the thresholds for the ValueReachedListener listener.

The following options are possible:

Option Description
'x' Listener is turned off
'o' Listener is triggered when the value value is outside the min and max values
'i' Listener is triggered when the value value is inside the min and max values
'<' Listener is triggered when the value value is smaller than the min value (max is ignored)
'>' Listener is triggered when the value value is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletGasDetector.THRESHOLD_OPTION_OFF = 'x'
  • BrickletGasDetector.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletGasDetector.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletGasDetector.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletGasDetector.THRESHOLD_OPTION_GREATER = '>'
public BrickletGasDetector.ValueCallbackThreshold getValueCallbackThreshold()

Returns the threshold as set by setValueCallbackThreshold().

The following constants are available for this function:

  • BrickletGasDetector.THRESHOLD_OPTION_OFF = 'x'
  • BrickletGasDetector.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletGasDetector.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletGasDetector.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletGasDetector.THRESHOLD_OPTION_GREATER = '>'

The returned object has the public member variables char option, int min and int max.

public void setDebouncePeriod(long debounce)

Sets the period in ms with which the threshold listener

is triggered, if the threshold

keeps being reached.

The default value is 100.

public long getDebouncePeriod()

Returns the debounce period as set by setDebouncePeriod().

Listeners

Listeners can be registered to receive time critical or recurring data from the device. The registration is done with "add*Listener" functions of the device object.

The parameter is a listener class object, for example:

device.addExampleListener(new BrickletGasDetector.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

The available listener classes with inherent methods to be overwritten are described below. It is possible to add several listeners and to remove them with the corresponding "remove*Listener" function.

Note

Using listeners for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

public class BrickletGasDetector.ValueListener()

This listener can be added with the addValueListener() function. An added listener can be removed with the removeValueListener() function.

public void value(int value)

This listener is triggered periodically with the period that is set by setValueCallbackPeriod(). The parameter is the value value of the sensor.

ValueListener is only triggered if the value has changed since the last triggering.

public class BrickletGasDetector.ValueReachedListener()

This listener can be added with the addValueReachedListener() function. An added listener can be removed with the removeValueReachedListener() function.

public void valueReached(int value)

This listener is triggered when the threshold as set by setValueCallbackThreshold() is reached. The parameter is the value of the detector.

If the threshold keeps being reached, the listener is triggered periodically with the period as set by setDebouncePeriod().

Constants

public static final int BrickletGasDetector.DEVICE_IDENTIFIER

This constant is used to identify a Gas Detector Bricklet.

The getIdentity() function and the EnumerateListener listener of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

Creative Commons Licence The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.