public class BrickletAccelerometerV2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletAccelerometerV2.Acceleration |
class |
BrickletAccelerometerV2.AccelerationCallbackConfiguration |
static interface |
BrickletAccelerometerV2.AccelerationListener
This listener is triggered periodically according to the configuration set by
setAccelerationCallbackConfiguration(long, boolean) . |
class |
BrickletAccelerometerV2.Configuration |
static interface |
BrickletAccelerometerV2.ContinuousAcceleration16BitListener
Returns 30 acceleration values with 16 bit resolution.
|
static interface |
BrickletAccelerometerV2.ContinuousAcceleration8BitListener
Returns 60 acceleration values with 8 bit resolution.
|
class |
BrickletAccelerometerV2.ContinuousAccelerationConfiguration |
class |
BrickletAccelerometerV2.FilterConfiguration |
class |
BrickletAccelerometerV2.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletAccelerometerV2(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addAccelerationListener(BrickletAccelerometerV2.AccelerationListener listener)
Adds a Acceleration listener.
|
void |
addContinuousAcceleration16BitListener(BrickletAccelerometerV2.ContinuousAcceleration16BitListener listener)
Adds a ContinuousAcceleration16Bit listener.
|
void |
addContinuousAcceleration8BitListener(BrickletAccelerometerV2.ContinuousAcceleration8BitListener listener)
Adds a ContinuousAcceleration8Bit listener.
|
BrickletAccelerometerV2.Acceleration |
getAcceleration()
Returns the acceleration in x, y and z direction.
|
BrickletAccelerometerV2.AccelerationCallbackConfiguration |
getAccelerationCallbackConfiguration()
Returns the listener configuration as set by
setAccelerationCallbackConfiguration(long, boolean) . |
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
BrickletAccelerometerV2.Configuration |
getConfiguration()
Returns the configuration as set by
setConfiguration(int, int) . |
BrickletAccelerometerV2.ContinuousAccelerationConfiguration |
getContinuousAccelerationConfiguration()
Returns the continuous acceleration configuration as set by
setContinuousAccelerationConfiguration(boolean, boolean, boolean, int) . |
BrickletAccelerometerV2.FilterConfiguration |
getFilterConfiguration()
Returns the configuration as set by
setFilterConfiguration(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) |
BrickletAccelerometerV2.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
long |
readUID()
Returns the current UID as an integer.
|
void |
removeAccelerationListener(BrickletAccelerometerV2.AccelerationListener listener)
Removes a Acceleration listener.
|
void |
removeContinuousAcceleration16BitListener(BrickletAccelerometerV2.ContinuousAcceleration16BitListener listener)
Removes a ContinuousAcceleration16Bit listener.
|
void |
removeContinuousAcceleration8BitListener(BrickletAccelerometerV2.ContinuousAcceleration8BitListener listener)
Removes a ContinuousAcceleration8Bit listener.
|
void |
reset()
Calling this function will reset the Bricklet.
|
void |
setAccelerationCallbackConfiguration(long period,
boolean valueHasToChange)
The period is the period with which the
BrickletAccelerometerV2.AccelerationListener
listener is triggered periodically. |
int |
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested
mode change was instigated.
|
void |
setConfiguration(int dataRate,
int fullScale)
Configures the data rate and full scale range.
|
void |
setContinuousAccelerationConfiguration(boolean enableX,
boolean enableY,
boolean enableZ,
int resolution)
For high throughput of acceleration data (> 1000Hz) you have to use the
BrickletAccelerometerV2.ContinuousAcceleration16BitListener or BrickletAccelerometerV2.ContinuousAcceleration8BitListener
callbacks. |
void |
setFilterConfiguration(int iirBypass,
int lowPassFilter)
Configures IIR Bypass filter mode and low pass filter roll off corner frequency.
|
void |
setInfoLEDConfig(int config)
Configures the info LED (marked as "Force" on the Bricklet) to be either turned off,
turned on, or blink in heartbeat mode.
|
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(int[]) . |
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 java.lang.String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_ACCELERATION
public static final byte FUNCTION_SET_CONFIGURATION
public static final byte FUNCTION_GET_CONFIGURATION
public static final byte FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_ACCELERATION_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_INFO_LED_CONFIG
public static final byte FUNCTION_GET_INFO_LED_CONFIG
public static final byte FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION
public static final byte FUNCTION_GET_CONTINUOUS_ACCELERATION_CONFIGURATION
public static final byte FUNCTION_SET_FILTER_CONFIGURATION
public static final byte FUNCTION_GET_FILTER_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 int DATA_RATE_0_781HZ
public static final int DATA_RATE_1_563HZ
public static final int DATA_RATE_3_125HZ
public static final int DATA_RATE_6_2512HZ
public static final int DATA_RATE_12_5HZ
public static final int DATA_RATE_25HZ
public static final int DATA_RATE_50HZ
public static final int DATA_RATE_100HZ
public static final int DATA_RATE_200HZ
public static final int DATA_RATE_400HZ
public static final int DATA_RATE_800HZ
public static final int DATA_RATE_1600HZ
public static final int DATA_RATE_3200HZ
public static final int DATA_RATE_6400HZ
public static final int DATA_RATE_12800HZ
public static final int DATA_RATE_25600HZ
public static final int FULL_SCALE_2G
public static final int FULL_SCALE_4G
public static final int FULL_SCALE_8G
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 RESOLUTION_8BIT
public static final int RESOLUTION_16BIT
public static final int IIR_BYPASS_APPLIED
public static final int IIR_BYPASS_BYPASSED
public static final int LOW_PASS_FILTER_NINTH
public static final int LOW_PASS_FILTER_HALF
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 BrickletAccelerometerV2(java.lang.String uid, IPConnection ipcon)
public BrickletAccelerometerV2.Acceleration getAcceleration() throws TinkerforgeException
setConfiguration(int, int)
.
If you want to get the acceleration periodically, it is recommended
to use the BrickletAccelerometerV2.AccelerationListener
listener and set the period with
setAccelerationCallbackConfiguration(long, boolean)
.TinkerforgeException
public void setConfiguration(int dataRate, int fullScale) throws TinkerforgeException
TinkerforgeException
public BrickletAccelerometerV2.Configuration getConfiguration() throws TinkerforgeException
setConfiguration(int, int)
.TinkerforgeException
public void setAccelerationCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletAccelerometerV2.AccelerationListener
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.
If this listener is enabled, the BrickletAccelerometerV2.ContinuousAcceleration16BitListener
listener
and BrickletAccelerometerV2.ContinuousAcceleration8BitListener
listener will automatically be disabled.TinkerforgeException
public BrickletAccelerometerV2.AccelerationCallbackConfiguration getAccelerationCallbackConfiguration() throws TinkerforgeException
setAccelerationCallbackConfiguration(long, boolean)
.TinkerforgeException
public void setInfoLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getInfoLEDConfig() throws TinkerforgeException
setInfoLEDConfig(int)
TinkerforgeException
public void setContinuousAccelerationConfiguration(boolean enableX, boolean enableY, boolean enableZ, int resolution) throws TinkerforgeException
BrickletAccelerometerV2.ContinuousAcceleration16BitListener
or BrickletAccelerometerV2.ContinuousAcceleration8BitListener
callbacks.
You can enable the listener for each axis (x, y, z) individually and choose a
resolution of 8 bit or 16 bit.
If at least one of the axis is enabled and the resolution is set to 8 bit,
the BrickletAccelerometerV2.ContinuousAcceleration8BitListener
listener is activated. If at least
one of the axis is enabled and the resolution is set to 16 bit,
the BrickletAccelerometerV2.ContinuousAcceleration16BitListener
listener is activated.
The returned values are raw ADC data. If you want to put this data into
a FFT to determine the occurrences of specific frequencies we recommend
that you use the data as is. It has all of the ADC noise in it. This noise
looks like pure noise at first glance, but it might still have some frequnecy
information in it that can be utilized by the FFT.
Otherwise you have to use the following formulas that depend on the configured
resolution (8/16 bit) and the full scale range (see setConfiguration(int, int)
) to calculate
the data in gₙ/10000 (same unit that is returned by getAcceleration()
):
* 16 bit, full scale 2g: acceleration = value * 625 / 1024
* 16 bit, full scale 4g: acceleration = value * 1250 / 1024
* 16 bit, full scale 8g: acceleration = value * 2500 / 1024
If a resolution of 8 bit is used, only the 8 most significant bits will be
transferred, so you can use the following formulas:
* 8 bit, full scale 2g: acceleration = value * 256 * 625 / 1024
* 8 bit, full scale 4g: acceleration = value * 256 * 1250 / 1024
* 8 bit, full scale 8g: acceleration = value * 256 * 2500 / 1024
If no axis is enabled, both listeners are disabled. If one of the continuous
callbacks is enabled, the BrickletAccelerometerV2.AccelerationListener
listener is disabled.
The maximum throughput depends on the exact configuration:
\verbatim
"Number of axis enabled", "Throughput 8 bit", "Throughout 16 bit"
"1", "25600Hz", "25600Hz"
"2", "25600Hz", "15000Hz"
"3", "20000Hz", "10000Hz"
\endverbatimTinkerforgeException
public BrickletAccelerometerV2.ContinuousAccelerationConfiguration getContinuousAccelerationConfiguration() throws TinkerforgeException
setContinuousAccelerationConfiguration(boolean, boolean, boolean, int)
.TinkerforgeException
public void setFilterConfiguration(int iirBypass, int lowPassFilter) throws TinkerforgeException
TinkerforgeException
public BrickletAccelerometerV2.FilterConfiguration getFilterConfiguration() throws TinkerforgeException
setFilterConfiguration(int, int)
.
.. versionadded:: 2.0.2$nbsp;(Plugin)TinkerforgeException
public BrickletAccelerometerV2.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 addAccelerationListener(BrickletAccelerometerV2.AccelerationListener listener)
public void removeAccelerationListener(BrickletAccelerometerV2.AccelerationListener listener)
public void addContinuousAcceleration16BitListener(BrickletAccelerometerV2.ContinuousAcceleration16BitListener listener)
public void removeContinuousAcceleration16BitListener(BrickletAccelerometerV2.ContinuousAcceleration16BitListener listener)
public void addContinuousAcceleration8BitListener(BrickletAccelerometerV2.ContinuousAcceleration8BitListener listener)
public void removeContinuousAcceleration8BitListener(BrickletAccelerometerV2.ContinuousAcceleration8BitListener listener)
Copyright © 2020 Tinkerforge GmbH. All rights reserved.