This is the description of the C# API bindings for the Barometer Bricklet. General information and technical specifications for the Barometer Bricklet are summarized in its hardware description.
An installation guide for the C# API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 | using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "bAc"; // Change to your UID
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletBarometer b = new BrickletBarometer(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current air pressure (unit is mbar/1000)
int airPressure = b.GetAirPressure();
// Get current altitude (unit is cm)
int altitude = b.GetAltitude();
System.Console.WriteLine("Air Pressure: " + airPressure/1000.0 + " mbar");
System.Console.WriteLine("Altitude: " + altitude/100.0 + " m");
System.Console.WriteLine("Press enter to exit");
System.Console.ReadLine();
ipcon.Disconnect();
}
}
|
Download (ExampleThreshold.cs)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 | using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "bAc"; // Change to your UID
// Callback for air pressure greater than 1025 mbar
static void ReachedCB(BrickletBarometer sender, int airPressure)
{
System.Console.WriteLine("We have " + airPressure/1000.0 + " mbar.");
System.Console.WriteLine("Enjoy the potentially good weather!");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletBarometer b = new BrickletBarometer(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get threshold callbacks with a debounce time of 10 seconds (10000ms)
b.SetDebouncePeriod(10000);
// Register threshold reached callback to function ReachedCB
b.AirPressureReached += ReachedCB;
// Configure threshold for "greater than 1025 mbar" (unit is mbar/1000)
b.SetAirPressureCallbackThreshold('>', 1025*1000, 0);
System.Console.WriteLine("Press enter to exit");
System.Console.ReadLine();
ipcon.Disconnect();
}
}
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "bAc"; // Change to your UID
// Callback function for air pressure callback (parameter has unit mbar/1000)
static void AirPressureCB(BrickletBarometer sender, int airPressure)
{
System.Console.WriteLine("Air Pressure: " + airPressure/1000.0 + " mbar");
}
// Callback function for altitude callback (parameter has unit cm)
static void AltitudeCB(BrickletBarometer sender, int altitude)
{
System.Console.WriteLine("Altitude: " + altitude/100.0 + " m");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletBarometer b = new BrickletBarometer(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Set Period for air pressure and altitude callbacks to 1s (1000ms)
// Note: The air pressure and altitude callbacks are only called every second
// if the air pressure or altitude has changed since the last call!
b.SetAirPressureCallbackPeriod(1000);
b.SetAltitudeCallbackPeriod(1000);
// Register air pressure callback to function AirPressureCB
b.AirPressure += AirPressureCB;
// Register altitude callback to function AltitudeCB
b.Altitude += AltitudeCB;
System.Console.WriteLine("Press enter to exit");
System.Console.ReadLine();
ipcon.Disconnect();
}
}
|
Generally, every method of the C# 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 C# does not support multiple return values directly, we use the out keyword to return multiple values from a method.
The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.
All methods listed below are thread-safe.
Creates an object with the unique device ID uid:
BrickletBarometer barometer = new BrickletBarometer("YOUR_DEVICE_UID", ipcon);
This object can then be used after the IP Connection is connected (see examples above).
Returns the air pressure of the air pressure sensor. The value has a range of 10000 to 1200000 and is given in mbar/1000, i.e. a value of 1001092 means that an air pressure of 1001.092 mbar is measured.
If you want to get the air pressure periodically, it is recommended to use the callback AirPressure and set the period with SetAirPressureCallbackPeriod().
Returns the relative altitude of the air pressure sensor. The value is given in cm and is calculated based on the difference between the current air pressure and the reference air pressure that can be set with SetReferenceAirPressure().
If you want to get the altitude periodically, it is recommended to use the callback Altitude and set the period with SetAltitudeCallbackPeriod().
Sets the reference air pressure in mbar/1000 for the altitude calculation. Setting the reference to the current air pressure results in a calculated altitude of 0cm. Passing 0 is a shortcut for passing the current air pressure as reference.
Well known reference values are the Q codes QNH and QFE used in aviation.
The default value is 1013.25mbar.
Returns the reference air pressure as set by SetReferenceAirPressure().
Returns the temperature of the air pressure sensor. The value has a range of -4000 to 8500 and is given in °C/100, i.e. a value of 2007 means that a temperature of 20.07 °C is measured.
This temperature is used internally for temperature compensation of the air pressure measurement. It is not as accurate as the temperature measured by the Temperature Bricklet or the Temperature IR Bricklet.
Sets the different averaging parameters. It is possible to set the length of a normal averaging for the temperature and pressure, as well as an additional length of a moving average for the pressure. The moving average is calculated from the normal averages. There is no moving average for the temperature.
The maximum length for the pressure average is 10, for the temperature average is 255 and for the moving average is 25.
Setting the all three parameters to 0 will turn the averaging completely off. If the averaging is off, there is lots of noise on the data, but the data is without delay. Thus we recommend to turn the averaging off if the Barometer Bricklet data is to be used for sensor fusion with other sensors.
The default values are 10 for the normal averages and 25 for the moving average.
New in version 2.0.1 (Plugin).
Returns the averaging configuration as set by SetAveraging().
New in version 2.0.1 (Plugin).
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.
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.
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:
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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.
Sets the period in ms with which the AirPressure callback is triggered periodically. A value of 0 turns the callback off.
AirPressure is only triggered if the air pressure has changed since the last triggering.
The default value is 0.
Returns the period as set by SetAirPressureCallbackPeriod().
Sets the period in ms with which the Altitude callback is triggered periodically. A value of 0 turns the callback off.
Altitude is only triggered if the altitude has changed since the last triggering.
The default value is 0.
Returns the period as set by SetAltitudeCallbackPeriod().
Sets the thresholds for the AirPressureReached callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the air pressure is outside the min and max values |
'i' | Callback is triggered when the air pressure is inside the min and max values |
'<' | Callback is triggered when the air pressure is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the air pressure is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Returns the threshold as set by SetAirPressureCallbackThreshold().
The following constants are available for this function:
Sets the thresholds for the AltitudeReached callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the altitude is outside the min and max values |
'i' | Callback is triggered when the altitude is inside the min and max values |
'<' | Callback is triggered when the altitude is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the altitude is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Returns the threshold as set by SetAltitudeCallbackThreshold().
The following constants are available for this function:
Sets the period in ms with which the threshold callbacks
are triggered, if the thresholds
keep being reached.
The default value is 100.
Returns the debounce period as set by SetDebouncePeriod().
Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by appending your callback handler to the corresponding event:
void Callback(BrickletBarometer sender, int value)
{
System.Console.WriteLine("Value: " + value);
}
barometer.ExampleCallback += Callback;
The available events 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.
This callback is triggered periodically with the period that is set by SetAirPressureCallbackPeriod(). The parameter is the air pressure of the air pressure sensor.
AirPressure is only triggered if the air pressure has changed since the last triggering.
This callback is triggered periodically with the period that is set by SetAltitudeCallbackPeriod(). The parameter is the altitude of the air pressure sensor.
Altitude is only triggered if the altitude has changed since the last triggering.
This callback is triggered when the threshold as set by SetAirPressureCallbackThreshold() is reached. The parameter is the air pressure of the air pressure sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().
This callback is triggered when the threshold as set by SetAltitudeCallbackThreshold() is reached. The parameter is the altitude of the air pressure sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().
This constant is used to identify a Barometer 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.