This is the description of the C# API bindings for the Joystick Bricklet. General information and technical specifications for the Joystick 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 | using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "ABC"; // Change to your UID
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletJoystick joy = new BrickletJoystick(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current position
short posX;
short posY;
joy.GetPosition(out posX, out posY);
System.Console.WriteLine("Position: (" + posX + ", " + posY + ")");
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 | using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "ABC"; // Change to your UID
// Callback functions for pressed and released events
static void PressedCB(BrickletJoystick sender)
{
System.Console.WriteLine("Pressed");
}
static void ReleasedCB(BrickletJoystick sender)
{
System.Console.WriteLine("Released");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletJoystick joy = new BrickletJoystick(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Register callbacks for pressed and released events
joy.Pressed += PressedCB;
joy.Released += ReleasedCB;
System.Console.WriteLine("Press enter to exit");
System.Console.ReadLine();
ipcon.Disconnect();
}
}
|
Download (ExampleFindBorders.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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "ABC"; // Change to your UID
// Callback for x or y position outside of [-99..99]
static void ReachedCB(BrickletJoystick sender, short x, short y)
{
if(y == 100)
{
System.Console.WriteLine("Top");
}
else if(y == -100)
{
System.Console.WriteLine("Bottom");
}
if(x == 100)
{
System.Console.WriteLine("Right");
}
else if(x == -100)
{
System.Console.WriteLine("Left");
}
System.Console.WriteLine("");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletJoystick joy = new BrickletJoystick(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 0.2 seconds (200ms)
joy.SetDebouncePeriod(200);
// Register threshold reached callback to function ReachedCB
joy.PositionReached += ReachedCB;
// Configure threshold for "x or y value outside of [-99..99]"
joy.SetPositionCallbackThreshold('o', -99, 99, -99, 99);
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:
BrickletJoystick joystick = new BrickletJoystick("YOUR_DEVICE_UID", ipcon);
This object can then be used after the IP Connection is connected (see examples above).
Returns the position of the Joystick. The value ranges between -100 and 100 for both axis. The middle position of the joystick is x=0, y=0. The returned values are averaged and calibrated (see Calibrate()).
If you want to get the position periodically, it is recommended to use the callback Position and set the period with SetPositionCallbackPeriod().
Returns the values as read by a 12-bit analog-to-digital converter. The values are between 0 and 4095 for both axis.
Note
The values returned by GetPosition() are averaged over several samples to yield less noise, while GetAnalogValue() gives back raw unfiltered analog values. The only reason to use GetAnalogValue() is, if you need the full resolution of the analog-to-digital converter.
If you want the analog values periodically, it is recommended to use the callback AnalogValue and set the period with SetAnalogValueCallbackPeriod().
Calibrates the middle position of the Joystick. If your Joystick Bricklet does not return x=0 and y=0 in the middle position, call this function while the Joystick is standing still in the middle position.
The resulting calibration will be saved on the EEPROM of the Joystick Bricklet, thus you only have to calibrate it once.
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 Position callback is triggered periodically. A value of 0 turns the callback off.
Position is only triggered if the position has changed since the last triggering.
The default value is 0.
Returns the period as set by SetPositionCallbackPeriod().
Sets the period in ms with which the AnalogValue callback is triggered periodically. A value of 0 turns the callback off.
AnalogValue is only triggered if the analog values have changed since the last triggering.
The default value is 0.
Returns the period as set by SetAnalogValueCallbackPeriod().
Sets the thresholds for the PositionReached callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the position is outside the min and max values |
'i' | Callback is triggered when the position is inside the min and max values |
'<' | Callback is triggered when the position is smaller than the min values (max is ignored) |
'>' | Callback is triggered when the position is greater than the min values (max is ignored) |
The default value is ('x', 0, 0, 0, 0).
The following constants are available for this function:
Returns the threshold as set by SetPositionCallbackThreshold().
The following constants are available for this function:
Sets the thresholds for the AnalogValueReached callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the analog values are outside the min and max values |
'i' | Callback is triggered when the analog values are inside the min and max values |
'<' | Callback is triggered when the analog values are smaller than the min values (max is ignored) |
'>' | Callback is triggered when the analog values are greater than the min values (max is ignored) |
The default value is ('x', 0, 0, 0, 0).
The following constants are available for this function:
Returns the threshold as set by SetAnalogValueCallbackThreshold().
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(BrickletJoystick sender, int value)
{
System.Console.WriteLine("Value: " + value);
}
joystick.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 SetPositionCallbackPeriod(). The parameter is the position of the Joystick.
Position is only triggered if the position has changed since the last triggering.
This callback is triggered periodically with the period that is set by SetAnalogValueCallbackPeriod(). The parameters are the analog values of the Joystick.
AnalogValue is only triggered if the values have changed since the last triggering.
This callback is triggered when the threshold as set by SetPositionCallbackThreshold() is reached. The parameters are the position of the Joystick.
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 SetAnalogValueCallbackThreshold() is reached. The parameters are the analog values of the Joystick.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().
This callback is triggered when the button is pressed.
This callback is triggered when the button is released.
This constant is used to identify a Joystick 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.