Package com.tinkerforge
Class BrickletLoadCellV2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletLoadCellV2
-
public class BrickletLoadCellV2 extends Device
Measures weight with a load cell
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletLoadCellV2.Configuration
class
BrickletLoadCellV2.SPITFPErrorCount
class
BrickletLoadCellV2.WeightCallbackConfiguration
static interface
BrickletLoadCellV2.WeightListener
This listener is triggered periodically according to the configuration set bysetWeightCallbackConfiguration(long, boolean, char, int, int)
.-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletLoadCellV2(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addWeightListener(BrickletLoadCellV2.WeightListener listener)
Adds a Weight listener.void
calibrate(long weight)
To calibrate your Load Cell Bricklet 2.0 you have to * empty the scale and call this function with 0 and * add a known weight to the scale and call this function with the weight.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.BrickletLoadCellV2.Configuration
getConfiguration()
Returns the configuration as set bysetConfiguration(int, int)
.Device.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.int
getInfoLEDConfig()
Returns the LED configuration as set bysetInfoLEDConfig(int)
int
getMovingAverage()
Returns the length moving average as set bysetMovingAverage(int)
.BrickletLoadCellV2.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
int
getWeight()
Returns the currently measured weight.BrickletLoadCellV2.WeightCallbackConfiguration
getWeightCallbackConfiguration()
Returns the listener configuration as set bysetWeightCallbackConfiguration(long, boolean, char, int, int)
.long
readUID()
Returns the current UID as an integer.void
removeWeightListener(BrickletLoadCellV2.WeightListener listener)
Removes a Weight listener.void
reset()
Calling this function will reset the Bricklet.int
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested mode change was instigated.void
setConfiguration(int rate, int gain)
The measurement rate and gain are configurable.void
setInfoLEDConfig(int config)
Configures the info LED to be either turned off, turned on, or blink in heartbeat mode.void
setMovingAverage(int average)
Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__ for the weight value.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setWeightCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)
The period is the period with which theBrickletLoadCellV2.WeightListener
listener is triggered periodically.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.void
tare()
Sets the currently measured weight as tare weight.int
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before.void
writeUID(long uid)
Writes a new UID into flash.-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_WEIGHT
public static final byte FUNCTION_GET_WEIGHT
- See Also:
- Constant Field Values
-
FUNCTION_SET_WEIGHT_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_WEIGHT_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_WEIGHT_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_WEIGHT_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_MOVING_AVERAGE
public static final byte FUNCTION_SET_MOVING_AVERAGE
- See Also:
- Constant Field Values
-
FUNCTION_GET_MOVING_AVERAGE
public static final byte FUNCTION_GET_MOVING_AVERAGE
- See Also:
- Constant Field Values
-
FUNCTION_SET_INFO_LED_CONFIG
public static final byte FUNCTION_SET_INFO_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_INFO_LED_CONFIG
public static final byte FUNCTION_GET_INFO_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_CALIBRATE
public static final byte FUNCTION_CALIBRATE
- See Also:
- Constant Field Values
-
FUNCTION_TARE
public static final byte FUNCTION_TARE
- See Also:
- Constant Field Values
-
FUNCTION_SET_CONFIGURATION
public static final byte FUNCTION_SET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_CONFIGURATION
public static final byte FUNCTION_GET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_WRITE_FIRMWARE
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_UID
public static final byte FUNCTION_WRITE_UID
- See Also:
- Constant Field Values
-
FUNCTION_READ_UID
public static final byte FUNCTION_READ_UID
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OFF
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_OUTSIDE
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_INSIDE
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_SMALLER
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_GREATER
public static final char THRESHOLD_OPTION_GREATER
- See Also:
- Constant Field Values
-
INFO_LED_CONFIG_OFF
public static final int INFO_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
INFO_LED_CONFIG_ON
public static final int INFO_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
INFO_LED_CONFIG_SHOW_HEARTBEAT
public static final int INFO_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
RATE_10HZ
public static final int RATE_10HZ
- See Also:
- Constant Field Values
-
RATE_80HZ
public static final int RATE_80HZ
- See Also:
- Constant Field Values
-
GAIN_128X
public static final int GAIN_128X
- See Also:
- Constant Field Values
-
GAIN_64X
public static final int GAIN_64X
- See Also:
- Constant Field Values
-
GAIN_32X
public static final int GAIN_32X
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_BOOTLOADER
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_FIRMWARE
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_OK
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_INVALID_MODE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_NO_CHANGE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_CRC_MISMATCH
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_STATUS
public static final int STATUS_LED_CONFIG_SHOW_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletLoadCellV2
public BrickletLoadCellV2(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
getWeight
public int getWeight() throws TinkerforgeException
Returns the currently measured weight. If you want to get the value periodically, it is recommended to use theBrickletLoadCellV2.WeightListener
listener. You can set the listener configuration withsetWeightCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setWeightCallbackConfiguration
public void setWeightCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
The period is the period with which theBrickletLoadCellV2.WeightListener
listener is triggered periodically. A value of 0 turns the listener off. If the `value has to change`-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change. If it is set to false, the listener is continuously triggered with the period, independent of the value. It is furthermore possible to constrain the listener with thresholds. The `option`-parameter together with min/max sets a threshold for theBrickletLoadCellV2.WeightListener
listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Threshold is turned off" "'o'", "Threshold is triggered when the value is *outside* the min and max values" "'i'", "Threshold is triggered when the value is *inside* or equal to the min and max values" "'<'", "Threshold is triggered when the value is smaller than the min value (max is ignored)" "'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)" \endverbatim If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.- Throws:
TinkerforgeException
-
getWeightCallbackConfiguration
public BrickletLoadCellV2.WeightCallbackConfiguration getWeightCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetWeightCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setMovingAverage
public void setMovingAverage(int average) throws TinkerforgeException
Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__ for the weight value. Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.- Throws:
TinkerforgeException
-
getMovingAverage
public int getMovingAverage() throws TinkerforgeException
Returns the length moving average as set bysetMovingAverage(int)
.- Throws:
TinkerforgeException
-
setInfoLEDConfig
public void setInfoLEDConfig(int config) throws TinkerforgeException
Configures the info LED to be either turned off, turned on, or blink in heartbeat mode.- Throws:
TinkerforgeException
-
getInfoLEDConfig
public int getInfoLEDConfig() throws TinkerforgeException
Returns the LED configuration as set bysetInfoLEDConfig(int)
- Throws:
TinkerforgeException
-
calibrate
public void calibrate(long weight) throws TinkerforgeException
To calibrate your Load Cell Bricklet 2.0 you have to * empty the scale and call this function with 0 and * add a known weight to the scale and call this function with the weight. The calibration is saved in the flash of the Bricklet and only needs to be done once. We recommend to use the Brick Viewer for calibration, you don't need to call this function in your source code.- Throws:
TinkerforgeException
-
tare
public void tare() throws TinkerforgeException
Sets the currently measured weight as tare weight.- Throws:
TinkerforgeException
-
setConfiguration
public void setConfiguration(int rate, int gain) throws TinkerforgeException
The measurement rate and gain are configurable. The rate can be either 10Hz or 80Hz. A faster rate will produce more noise. It is additionally possible to add a moving average (seesetMovingAverage(int)
) to the measurements. The gain can be 128x, 64x or 32x. It represents a measurement range of ±20mV, ±40mV and ±80mV respectively. The Load Cell Bricklet uses an excitation voltage of 5V and most load cells use an output of 2mV/V. That means the voltage range is ±15mV for most load cells (i.e. gain of 128x is best). If you don't know what all of this means you should keep it at 128x, it will most likely be correct.- Throws:
TinkerforgeException
-
getConfiguration
public BrickletLoadCellV2.Configuration getConfiguration() throws TinkerforgeException
Returns the configuration as set bysetConfiguration(int, int)
.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletLoadCellV2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
Returns the error count for the communication between Brick and Bricklet. The errors are divided into * ACK checksum errors, * message checksum errors, * framing errors and * overflow errors. The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.- Throws:
TinkerforgeException
-
setBootloaderMode
public int setBootloaderMode(int mode) throws TinkerforgeException
Sets the bootloader mode and returns the status after the requested mode change was instigated. You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
getBootloaderMode
public int getBootloaderMode() throws TinkerforgeException
Returns the current bootloader mode, seesetBootloaderMode(int)
.- Throws:
TinkerforgeException
-
setWriteFirmwarePointer
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
Sets the firmware pointer forwriteFirmware(int[])
. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256). This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
writeFirmware
public int writeFirmware(int[] data) throws TinkerforgeException
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before. The firmware is written to flash every 4 chunks. You can only write firmware in bootloader mode. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
setStatusLEDConfig
public void setStatusLEDConfig(int config) throws TinkerforgeException
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets. You can also turn the LED permanently on/off or show a heartbeat. If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.- Throws:
TinkerforgeException
-
getStatusLEDConfig
public int getStatusLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetStatusLEDConfig(int)
- Throws:
TinkerforgeException
-
getChipTemperature
public int getChipTemperature() throws TinkerforgeException
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature! The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.- Throws:
TinkerforgeException
-
reset
public void reset() throws TinkerforgeException
Calling this function will reset the Bricklet. All configurations will be lost. After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!- Throws:
TinkerforgeException
-
writeUID
public void writeUID(long uid) throws TinkerforgeException
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first. We recommend that you use Brick Viewer to change the UID.- Throws:
TinkerforgeException
-
readUID
public long readUID() throws TinkerforgeException
Returns the current UID as an integer. Encode as Base58 to get the usual string version.- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
addWeightListener
public void addWeightListener(BrickletLoadCellV2.WeightListener listener)
Adds a Weight listener.
-
removeWeightListener
public void removeWeightListener(BrickletLoadCellV2.WeightListener listener)
Removes a Weight listener.
-
-