public class BrickletLoadCellV2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletLoadCellV2.Configuration |
class |
BrickletLoadCellV2.SPITFPErrorCount |
class |
BrickletLoadCellV2.WeightCallbackConfiguration |
static interface |
BrickletLoadCellV2.WeightListener
This listener is triggered periodically according to the configuration set by
setWeightCallbackConfiguration(long, boolean, char, int, int) . |
Device.Identity
Constructor and Description |
---|
BrickletLoadCellV2(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and 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, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
BrickletLoadCellV2.Configuration |
getConfiguration()
Returns the configuration as set by
setConfiguration(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 by
setInfoLEDConfig(int) |
int |
getMovingAverage()
Returns the length moving average as set by
setMovingAverage(int) . |
BrickletLoadCellV2.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
int |
getWeight()
Returns the currently measured weight.
|
BrickletLoadCellV2.WeightCallbackConfiguration |
getWeightCallbackConfiguration()
Returns the listener configuration as set by
setWeightCallbackConfiguration(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 the
BrickletLoadCellV2.WeightListener listener is triggered
periodically. |
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(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 by
setWriteFirmwarePointer(long) before. |
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_WEIGHT
public static final byte FUNCTION_SET_WEIGHT_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_WEIGHT_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_MOVING_AVERAGE
public static final byte FUNCTION_GET_MOVING_AVERAGE
public static final byte FUNCTION_SET_INFO_LED_CONFIG
public static final byte FUNCTION_GET_INFO_LED_CONFIG
public static final byte FUNCTION_CALIBRATE
public static final byte FUNCTION_TARE
public static final byte FUNCTION_SET_CONFIGURATION
public static final byte FUNCTION_GET_CONFIGURATION
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final char THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_GREATER
public static final int INFO_LED_CONFIG_OFF
public static final int INFO_LED_CONFIG_ON
public static final int INFO_LED_CONFIG_SHOW_HEARTBEAT
public static final int RATE_10HZ
public static final int RATE_80HZ
public static final int GAIN_128X
public static final int GAIN_64X
public static final int GAIN_32X
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletLoadCellV2(String uid, IPConnection ipcon)
public int getWeight() throws TinkerforgeException
BrickletLoadCellV2.WeightListener
listener. You can set the listener configuration
with setWeightCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setWeightCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletLoadCellV2.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 the BrickletLoadCellV2.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.TinkerforgeException
public BrickletLoadCellV2.WeightCallbackConfiguration getWeightCallbackConfiguration() throws TinkerforgeException
setWeightCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setMovingAverage(int average) throws TinkerforgeException
TinkerforgeException
public int getMovingAverage() throws TinkerforgeException
setMovingAverage(int)
.TinkerforgeException
public void setInfoLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getInfoLEDConfig() throws TinkerforgeException
setInfoLEDConfig(int)
TinkerforgeException
public void calibrate(long weight) throws TinkerforgeException
TinkerforgeException
public void tare() throws TinkerforgeException
TinkerforgeException
public void setConfiguration(int rate, int gain) throws TinkerforgeException
setMovingAverage(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.TinkerforgeException
public BrickletLoadCellV2.Configuration getConfiguration() throws TinkerforgeException
setConfiguration(int, int)
.TinkerforgeException
public BrickletLoadCellV2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
writeFirmware(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.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
setWriteFirmwarePointer(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.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addWeightListener(BrickletLoadCellV2.WeightListener listener)
public void removeWeightListener(BrickletLoadCellV2.WeightListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.