Mathematica - 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 Mathematica 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 Mathematica 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 Mathematica bindings that returns a value can throw a Tinkerforge.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 plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since .NET/Link does not support multiple return values directly, we use the out keyword to return multiple values from a method. For further information about the out keyword in .NET/Link see the corresponding Mathematica .NET/Link documentation.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletGasDetector[uid, ipcon] → gasDetector
Parameters:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Returns:
  • gasDetector -- NETObject[BrickletGasDetector]

Creates an object with the unique device ID uid:

gasDetector=NETNew["Tinkerforge.BrickletGasDetector","YOUR_DEVICE_UID",ipcon]

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

The .NET runtime has built-in garbage collection that frees objects that are no longer in use by a program. But because Mathematica can not automatically tell when a Mathematica "program" doesn't use a .NET object anymore, this has to be done by the program. For this the ReleaseNETObject[] function is used in the examples.

For further information about object management in .NET/Link see the corresponding Mathematica .NET/Link documentation.

BrickletGasDetector@GetValue[] → value
Returns:
  • value -- Integer

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 callback Value and set the period with SetValueCallbackPeriod[].

Advanced Functions

BrickletGasDetector@SetMovingAverage[average] → Null
Parameters:
  • average -- Integer

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.

BrickletGasDetector@GetMovingAverage[] → average
Returns:
  • average -- Integer

Returns the length moving average as set by SetMovingAverage[].

BrickletGasDetector@SetDetectorType[detectorType] → Null
Parameters:
  • detectorType -- Integer

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`DETECTORUTYPEU0 = 0
  • BrickletGasDetector`DETECTORUTYPEU1 = 1
BrickletGasDetector@GetDetectorType[] → detectorType
Returns:
  • detectorType -- Integer

Returns the detector type as set by SetDetectorType[].

The following constants are available for this function:

  • BrickletGasDetector`DETECTORUTYPEU0 = 0
  • BrickletGasDetector`DETECTORUTYPEU1 = 1
BrickletGasDetector@HeaterOn[] → Null

Turns the internal heater on.

BrickletGasDetector@HeaterOff[] → Null

Turns the internal heater off.

BrickletGasDetector@IsHeaterOn[] → heater
Returns:
  • heater -- True/False

Returns true if the heater is on, false otherwise.

BrickletGasDetector@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Returns:
  • apiVersioni -- Integer

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.

BrickletGasDetector@GetResponseExpected[functionId] → responseExpected
Parameters:
  • functionId -- Integer
Returns:
  • responseExpected -- True/False

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 callback 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.

BrickletGasDetector@SetResponseExpected[functionId, responseExpected] → Null
Parameters:
  • functionId -- Integer
  • responseExpected -- True/False

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 callback configuration functions (default value: true). For getter functions it is always enabled and callbacks 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`FUNCTIONUSETUVALUEUCALLBACKUPERIOD = 2
  • BrickletGasDetector`FUNCTIONUSETUVALUEUCALLBACKUTHRESHOLD = 4
  • BrickletGasDetector`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
  • BrickletGasDetector`FUNCTIONUSETUMOVINGUAVERAGE = 8
  • BrickletGasDetector`FUNCTIONUSETUDETECTORUTYPE = 10
  • BrickletGasDetector`FUNCTIONUHEATERUON = 12
  • BrickletGasDetector`FUNCTIONUHEATERUOFF = 13
BrickletGasDetector@SetResponseExpectedAll[responseExpected] → Null
Parameters:
  • responseExpected -- True/False

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

BrickletGasDetector@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameters:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- Integer

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.

Callback Configuration Functions

BrickletGasDetector@SetValueCallbackPeriod[period] → Null
Parameters:
  • period -- Integer

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

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

The default value is 0.

BrickletGasDetector@GetValueCallbackPeriod[] → period
Returns:
  • period -- Integer

Returns the period as set by SetValueCallbackPeriod[].

BrickletGasDetector@SetValueCallbackThreshold[option, min, max] → Null
Parameters:
  • option -- Integer
  • min -- Integer
  • max -- Integer

Sets the thresholds for the ValueReached callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the value value is outside the min and max values
'i' Callback is triggered when the value value is inside the min and max values
'<' Callback is triggered when the value value is smaller than the min value (max is ignored)
'>' Callback 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`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletGasDetector`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletGasDetector`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletGasDetector`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletGasDetector`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletGasDetector@GetValueCallbackThreshold[out option, out min, out max] → Null
Parameters:
  • option -- Integer
  • min -- Integer
  • max -- Integer

Returns the threshold as set by SetValueCallbackThreshold[].

The following constants are available for this function:

  • BrickletGasDetector`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletGasDetector`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletGasDetector`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletGasDetector`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletGasDetector`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletGasDetector@SetDebouncePeriod[debounce] → Null
Parameters:
  • debounce -- Integer

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

BrickletGasDetector@GetDebouncePeriod[] → debounce
Returns:
  • debounce -- Integer

Returns the debounce period as set by SetDebouncePeriod[].

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object:

Callback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[gasDetector@Example,Callback]

For further information about event handling using .NET/Link see the corresponding Mathematica .NET/Link documentation.

The available callback property and their type of parameters are described below.

Note

Using callbacks 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.

event BrickletGasDetector@Value[sender, value]
Parameters:
  • sender -- NETObject[BrickletGasDetector]
  • value -- Integer

This callback is triggered periodically with the period that is set by SetValueCallbackPeriod[]. The parameter is the value value of the sensor.

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

event BrickletGasDetector@ValueReached[sender, value]
Parameters:
  • sender -- NETObject[BrickletGasDetector]
  • value -- Integer

This callback 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 callback is triggered periodically with the period as set by SetDebouncePeriod[].

Constants

BrickletGasDetector`DEVICEUIDENTIFIER

This constant is used to identify a Gas Detector Bricklet.

The GetIdentity[] function and the EnumerateCallback callback 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.