public class BrickletHallEffectV2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletHallEffectV2.CounterCallbackConfiguration |
class |
BrickletHallEffectV2.CounterConfig |
static interface |
BrickletHallEffectV2.CounterListener
This listener is triggered periodically according to the configuration set by
setCounterCallbackConfiguration(long, boolean) . |
class |
BrickletHallEffectV2.MagneticFluxDensityCallbackConfiguration |
static interface |
BrickletHallEffectV2.MagneticFluxDensityListener
This listener is triggered periodically according to the configuration set by
setMagneticFluxDensityCallbackConfiguration(long, boolean, char, int, int) . |
class |
BrickletHallEffectV2.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletHallEffectV2(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addCounterListener(BrickletHallEffectV2.CounterListener listener)
Adds a Counter listener.
|
void |
addMagneticFluxDensityListener(BrickletHallEffectV2.MagneticFluxDensityListener listener)
Adds a MagneticFluxDensity listener.
|
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
long |
getCounter(boolean resetCounter)
Returns the current value of the counter.
|
BrickletHallEffectV2.CounterCallbackConfiguration |
getCounterCallbackConfiguration()
Returns the listener configuration as set by
setCounterCallbackConfiguration(long, boolean) . |
BrickletHallEffectV2.CounterConfig |
getCounterConfig()
Returns the counter config as set by
setCounterConfig(int, int, long) . |
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 |
getMagneticFluxDensity()
Returns the `magnetic flux density (magnetic induction) <https://en.wikipedia.org/wiki/Magnetic_flux>`__.
|
BrickletHallEffectV2.MagneticFluxDensityCallbackConfiguration |
getMagneticFluxDensityCallbackConfiguration()
Returns the listener configuration as set by
setMagneticFluxDensityCallbackConfiguration(long, boolean, char, int, int) . |
BrickletHallEffectV2.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 |
removeCounterListener(BrickletHallEffectV2.CounterListener listener)
Removes a Counter listener.
|
void |
removeMagneticFluxDensityListener(BrickletHallEffectV2.MagneticFluxDensityListener listener)
Removes a MagneticFluxDensity 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 |
setCounterCallbackConfiguration(long period,
boolean valueHasToChange)
The period is the period with which the
BrickletHallEffectV2.CounterListener
listener is triggered periodically. |
void |
setCounterConfig(int highThreshold,
int lowThreshold,
long debounce)
Sets a high and a low threshold as well as a debounce time.
|
void |
setMagneticFluxDensityCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletHallEffectV2.MagneticFluxDensityListener listener is triggered
periodically. |
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_MAGNETIC_FLUX_DENSITY
public static final byte FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_COUNTER
public static final byte FUNCTION_SET_COUNTER_CONFIG
public static final byte FUNCTION_GET_COUNTER_CONFIG
public static final byte FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_COUNTER_CALLBACK_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 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 BrickletHallEffectV2(java.lang.String uid, IPConnection ipcon)
public int getMagneticFluxDensity() throws TinkerforgeException
BrickletHallEffectV2.MagneticFluxDensityListener
listener. You can set the listener configuration
with setMagneticFluxDensityCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setMagneticFluxDensityCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletHallEffectV2.MagneticFluxDensityListener
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 BrickletHallEffectV2.MagneticFluxDensityListener
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 BrickletHallEffectV2.MagneticFluxDensityCallbackConfiguration getMagneticFluxDensityCallbackConfiguration() throws TinkerforgeException
setMagneticFluxDensityCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public long getCounter(boolean resetCounter) throws TinkerforgeException
setCounterConfig(int, int, long)
.
If you set reset counter to *true*, the count is set back to 0
directly after it is read.
If you want to get the count periodically, it is recommended to use the
BrickletHallEffectV2.CounterListener
listener. You can set the listener configuration
with setCounterCallbackConfiguration(long, boolean)
.TinkerforgeException
public void setCounterConfig(int highThreshold, int lowThreshold, long debounce) throws TinkerforgeException
TinkerforgeException
public BrickletHallEffectV2.CounterConfig getCounterConfig() throws TinkerforgeException
setCounterConfig(int, int, long)
.TinkerforgeException
public void setCounterCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletHallEffectV2.CounterListener
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 at least one of the values has changed. If the values 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.TinkerforgeException
public BrickletHallEffectV2.CounterCallbackConfiguration getCounterCallbackConfiguration() throws TinkerforgeException
setCounterCallbackConfiguration(long, boolean)
.TinkerforgeException
public BrickletHallEffectV2.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 addMagneticFluxDensityListener(BrickletHallEffectV2.MagneticFluxDensityListener listener)
public void removeMagneticFluxDensityListener(BrickletHallEffectV2.MagneticFluxDensityListener listener)
public void addCounterListener(BrickletHallEffectV2.CounterListener listener)
public void removeCounterListener(BrickletHallEffectV2.CounterListener listener)
Copyright © 2020 Tinkerforge GmbH. All rights reserved.