This is the description of the Mathematica API bindings for the Voltage/Current Bricklet. General information and technical specifications for the Voltage/Current Bricklet are summarized in its hardware description.
An installation guide for the Mathematica 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 | Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]
host="localhost"
port=4223
uid="amb"(* Change to your UID *)
(* Create IPConnection and device object *)
ipcon=NETNew["Tinkerforge.IPConnection"]
vc=NETNew["Tinkerforge.BrickletVoltageCurrent",uid,ipcon]
ipcon@Connect[host,port]
(* Get current current and voltage (unit is mA and mV) *)
Print["Current: "<>ToString[N[Quantity[vc@GetCurrent[],"mA"]]]]
Print["Voltage: "<>ToString[N[Quantity[vc@GetVoltage[],"mV"]]]]
(* Clean up *)
ipcon@Disconnect[]
ReleaseNETObject[vc]
ReleaseNETObject[ipcon]
|
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 | Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]
host="localhost"
port=4223
uid="amb"(* Change to your UID *)
(* Create IPConnection and device object *)
ipcon=NETNew["Tinkerforge.IPConnection"]
vc=NETNew["Tinkerforge.BrickletVoltageCurrent",uid,ipcon]
ipcon@Connect[host,port]
(* Set Period for current callback to 1s (1000ms) *)
(* Note: The current callback is only called every second if the *)
(* current has changed since the last call! *)
vc@SetCurrentCallbackPeriod[1000]
(* Callback function for current callback (parameter has unit mA) *)
CurrentCB[sender_,current_]:=
Print["Current: "<>ToString[N[Quantity[current,"mA"]]]]
AddEventHandler[vc@Current,CurrentCB]
Input["Click OK to exit"]
(* Clean up *)
ipcon@Disconnect[]
ReleaseNETObject[vc]
ReleaseNETObject[ipcon]
|
Download (ExampleThreshold.nb)
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 | Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]
host="localhost"
port=4223
uid="amb"(* Change to your UID *)
(* Create IPConnection and device object *)
ipcon=NETNew["Tinkerforge.IPConnection"]
vc=NETNew["Tinkerforge.BrickletVoltageCurrent",uid,ipcon]
ipcon@Connect[host,port]
(* Get threshold callbacks with a debounce time of 1 second (1000ms) *)
vc@SetDebouncePeriod[1000]
(* Callback for current greater than 1A *)
CurrentReachedCB[sender_,current_]:=
Print["Current is greater than 1A: "<>ToString[N[Quantity[current,"mA"]]]]
AddEventHandler[vc@CurrentReached,CurrentReachedCB]
(* Configure threshold for "greater than 1A" (unit is mA) *)
option=Tinkerforge`BrickletVoltageCurrent`THRESHOLDUOPTIONUGREATER
vc@SetCurrentCallbackThreshold[option,1*1000,0]
Input["Click OK to exit"]
(* Clean up *)
ipcon@Disconnect[]
ReleaseNETObject[vc]
ReleaseNETObject[ipcon]
|
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.*.
Parameters: |
|
---|---|
Returns: |
|
Creates an object with the unique device ID uid:
voltageCurrent=NETNew["Tinkerforge.BrickletVoltageCurrent","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.
Returns: |
|
---|
Returns the current. The value is in mA and between -20000mA and 20000mA.
If you want to get the current periodically, it is recommended to use the callback Current and set the period with SetCurrentCallbackPeriod[].
Returns: |
|
---|
Returns the voltage. The value is in mV and between 0mV and 36000mV.
If you want to get the voltage periodically, it is recommended to use the callback Voltage and set the period with SetVoltageCallbackPeriod[].
Returns: |
|
---|
Returns the power. The value is in mW and between 0mV and 720000mW.
If you want to get the power periodically, it is recommended to use the callback Power and set the period with SetPowerCallbackPeriod[].
Parameters: |
|
---|
Sets the configuration of the Voltage/Current Bricklet. It is possible to configure number of averages as well as voltage and current conversion time.
Averaging:
Value | Number of Averages |
---|---|
0 | 1 |
1 | 4 |
2 | 16 |
3 | 64 |
4 | 128 |
5 | 256 |
6 | 512 |
>=7 | 1024 |
Voltage/Current conversion:
Value | Conversion time |
---|---|
0 | 140µs |
1 | 204µs |
2 | 332µs |
3 | 588µs |
4 | 1.1ms |
5 | 2.116ms |
6 | 4.156ms |
>=7 | 8.244ms |
The default values are 3, 4 and 4 (64, 1.1ms, 1.1ms) for averaging, voltage conversion and current conversion.
The following constants are available for this function:
Parameters: |
|
---|
Returns the configuration as set by SetConfiguration[].
The following constants are available for this function:
Parameters: |
|
---|
Since the shunt resistor that is used to measure the current is not perfectly precise, it needs to be calibrated by a multiplier and divisor if a very precise reading is needed.
For example, if you are expecting a measurement of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the multiplier to 1000 and the divisor to 1023.
Parameters: |
|
---|
Returns the calibration as set by SetCalibration[].
Returns: |
|
---|
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.
Parameters: |
|
---|---|
Returns: |
|
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.
Parameters: |
|
---|
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:
Parameters: |
|
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
Parameters: |
|
---|
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.
Parameters: |
|
---|
Sets the period in ms with which the Current callback is triggered periodically. A value of 0 turns the callback off.
Current is only triggered if the current has changed since the last triggering.
The default value is 0.
Returns: |
|
---|
Returns the period as set by SetCurrentCallbackPeriod[].
Parameters: |
|
---|
Sets the period in ms with which the Voltage callback is triggered periodically. A value of 0 turns the callback off.
Voltage is only triggered if the voltage has changed since the last triggering.
The default value is 0.
Returns: |
|
---|
Returns the period as set by SetVoltageCallbackPeriod[].
Parameters: |
|
---|
Sets the period in ms with which the Power callback is triggered periodically. A value of 0 turns the callback off.
Power is only triggered if the power has changed since the last triggering.
The default value is 0.
Returns: |
|
---|
Returns the period as set by GetPowerCallbackPeriod[].
Parameters: |
|
---|
Sets the thresholds for the CurrentReached callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the current is outside the min and max values |
'i' | Callback is triggered when the current is inside the min and max values |
'<' | Callback is triggered when the current is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the current is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Parameters: |
|
---|
Returns the threshold as set by SetCurrentCallbackThreshold[].
The following constants are available for this function:
Parameters: |
|
---|
Sets the thresholds for the VoltageReached callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the voltage is outside the min and max values |
'i' | Callback is triggered when the voltage is inside the min and max values |
'<' | Callback is triggered when the voltage is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the voltage is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Parameters: |
|
---|
Returns the threshold as set by SetVoltageCallbackThreshold[].
The following constants are available for this function:
Parameters: |
|
---|
Sets the thresholds for the PowerReached callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the power is outside the min and max values |
'i' | Callback is triggered when the power is inside the min and max values |
'<' | Callback is triggered when the power is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the power is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Parameters: |
|
---|
Returns the threshold as set by SetPowerCallbackThreshold[].
The following constants are available for this function:
Parameters: |
|
---|
Sets the period in ms with which the threshold callbacks
are triggered, if the thresholds
keep being reached.
The default value is 100.
Returns: |
|
---|
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 assigning a function to a callback property of the device object:
Callback[sender_,value_]:=Print["Value: "<>ToString[value]] AddEventHandler[voltageCurrent@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.
Parameters: |
|
---|
This callback is triggered periodically with the period that is set by SetCurrentCallbackPeriod[]. The parameter is the current of the sensor.
Current is only triggered if the current has changed since the last triggering.
Parameters: |
|
---|
This callback is triggered periodically with the period that is set by SetVoltageCallbackPeriod[]. The parameter is the voltage of the sensor.
Voltage is only triggered if the voltage has changed since the last triggering.
Parameters: |
|
---|
This callback is triggered periodically with the period that is set by SetPowerCallbackPeriod[]. The parameter is the power of the sensor.
Power is only triggered if the power has changed since the last triggering.
Parameters: |
|
---|
This callback is triggered when the threshold as set by SetCurrentCallbackThreshold[] is reached. The parameter is the current of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod[].
Parameters: |
|
---|
This callback is triggered when the threshold as set by SetVoltageCallbackThreshold[] is reached. The parameter is the voltage of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod[].
Parameters: |
|
---|
This callback is triggered when the threshold as set by SetPowerCallbackThreshold[] is reached. The parameter is the power of the 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 Voltage/Current 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.