public class BrickletMotorizedLinearPoti extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletMotorizedLinearPoti.MotorPosition |
class |
BrickletMotorizedLinearPoti.PositionCallbackConfiguration |
static interface |
BrickletMotorizedLinearPoti.PositionListener
This listener is triggered periodically according to the configuration set by
setPositionCallbackConfiguration(long, boolean, char, int, int) . |
static interface |
BrickletMotorizedLinearPoti.PositionReachedListener
This listener is triggered if a new position as set by
setMotorPosition(int, int, boolean) is reached. |
class |
BrickletMotorizedLinearPoti.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletMotorizedLinearPoti(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addPositionListener(BrickletMotorizedLinearPoti.PositionListener listener)
Adds a Position listener.
|
void |
addPositionReachedListener(BrickletMotorizedLinearPoti.PositionReachedListener listener)
Adds a PositionReached listener.
|
void |
calibrate()
Starts a calibration procedure.
|
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
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.
|
BrickletMotorizedLinearPoti.MotorPosition |
getMotorPosition()
Returns the last motor position as set by
setMotorPosition(int, int, boolean) . |
int |
getPosition()
Returns the position of the linear potentiometer.
|
BrickletMotorizedLinearPoti.PositionCallbackConfiguration |
getPositionCallbackConfiguration()
Returns the listener configuration as set by
setPositionCallbackConfiguration(long, boolean, char, int, int) . |
boolean |
getPositionReachedCallbackConfiguration()
Returns the
BrickletMotorizedLinearPoti.PositionReachedListener listener configuration
as set by setPositionReachedCallbackConfiguration(boolean) . |
BrickletMotorizedLinearPoti.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 |
removePositionListener(BrickletMotorizedLinearPoti.PositionListener listener)
Removes a Position listener.
|
void |
removePositionReachedListener(BrickletMotorizedLinearPoti.PositionReachedListener listener)
Removes a PositionReached 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 |
setMotorPosition(int position,
int driveMode,
boolean holdPosition)
Sets the position of the potentiometer.
|
void |
setPositionCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletMotorizedLinearPoti.PositionListener listener is triggered
periodically. |
void |
setPositionReachedCallbackConfiguration(boolean enabled)
Enables/Disables
BrickletMotorizedLinearPoti.PositionReachedListener listener. |
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 String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_POSITION
public static final byte FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_POSITION_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_MOTOR_POSITION
public static final byte FUNCTION_GET_MOTOR_POSITION
public static final byte FUNCTION_CALIBRATE
public static final byte FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_POSITION_REACHED_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 DRIVE_MODE_FAST
public static final int DRIVE_MODE_SMOOTH
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 BrickletMotorizedLinearPoti(String uid, IPConnection ipcon)
public int getPosition() throws TinkerforgeException
BrickletMotorizedLinearPoti.PositionListener
listener. You can set the listener configuration
with setPositionCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setPositionCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletMotorizedLinearPoti.PositionListener
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 BrickletMotorizedLinearPoti.PositionListener
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 BrickletMotorizedLinearPoti.PositionCallbackConfiguration getPositionCallbackConfiguration() throws TinkerforgeException
setPositionCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setMotorPosition(int position, int driveMode, boolean holdPosition) throws TinkerforgeException
TinkerforgeException
public BrickletMotorizedLinearPoti.MotorPosition getMotorPosition() throws TinkerforgeException
setMotorPosition(int, int, boolean)
. This is not
the current position (use getPosition()
to get the current position). This
is the last used set point and configuration.
The position reached parameter is true if the position has been reached at one point.
The position may have been changed again in the meantime by the user.TinkerforgeException
public void calibrate() throws TinkerforgeException
TinkerforgeException
public void setPositionReachedCallbackConfiguration(boolean enabled) throws TinkerforgeException
BrickletMotorizedLinearPoti.PositionReachedListener
listener.TinkerforgeException
public boolean getPositionReachedCallbackConfiguration() throws TinkerforgeException
BrickletMotorizedLinearPoti.PositionReachedListener
listener configuration
as set by setPositionReachedCallbackConfiguration(boolean)
.TinkerforgeException
public BrickletMotorizedLinearPoti.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 addPositionListener(BrickletMotorizedLinearPoti.PositionListener listener)
public void removePositionListener(BrickletMotorizedLinearPoti.PositionListener listener)
public void addPositionReachedListener(BrickletMotorizedLinearPoti.PositionReachedListener listener)
public void removePositionReachedListener(BrickletMotorizedLinearPoti.PositionReachedListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.