public class BrickletPerformanceDC extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletPerformanceDC.CurrentVelocityCallbackConfiguration |
static interface |
BrickletPerformanceDC.CurrentVelocityListener
This listener is triggered with the period that is set by
setCurrentVelocityCallbackConfiguration(long, boolean) . |
static interface |
BrickletPerformanceDC.EmergencyShutdownListener
This listener is triggered if either the current consumption
is too high or the temperature of the driver chip is too high
(above 150°C) or the user defined thermal shutdown is triggered (see
setThermalShutdown(int) ). |
class |
BrickletPerformanceDC.GPIOConfiguration |
static interface |
BrickletPerformanceDC.GPIOStateListener
This listener is triggered by GPIO changes if it is activated through
setGPIOAction(int, long) . |
class |
BrickletPerformanceDC.Motion |
class |
BrickletPerformanceDC.PowerStatistics |
class |
BrickletPerformanceDC.SPITFPErrorCount |
static interface |
BrickletPerformanceDC.VelocityReachedListener
This listener is triggered whenever a set velocity is reached.
|
Device.Identity
Constructor and Description |
---|
BrickletPerformanceDC(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addCurrentVelocityListener(BrickletPerformanceDC.CurrentVelocityListener listener)
Adds a CurrentVelocity listener.
|
void |
addEmergencyShutdownListener(BrickletPerformanceDC.EmergencyShutdownListener listener)
Adds a EmergencyShutdown listener.
|
void |
addGPIOStateListener(BrickletPerformanceDC.GPIOStateListener listener)
Adds a GPIOState listener.
|
void |
addVelocityReachedListener(BrickletPerformanceDC.VelocityReachedListener listener)
Adds a VelocityReached listener.
|
void |
fullBrake()
Executes an active full brake.
|
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getCCWLEDConfig()
Returns the LED configuration as set by
setCCWLEDConfig(int) |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
int |
getCurrentVelocity()
Returns the *current* velocity of the motor.
|
BrickletPerformanceDC.CurrentVelocityCallbackConfiguration |
getCurrentVelocityCallbackConfiguration()
Returns the listener configuration as set by
setCurrentVelocityCallbackConfiguration(long, boolean) . |
int |
getCWLEDConfig()
Returns the LED configuration as set by
setCWLEDConfig(int) |
int |
getDriveMode()
Returns the drive mode, as set by
setDriveMode(int) . |
boolean |
getEmergencyShutdownCallbackConfiguration()
Returns the listener configuration as set by
setEmergencyShutdownCallbackConfiguration(boolean) . |
boolean |
getEnabled()
Returns *true* if the driver chip is enabled, *false* otherwise.
|
int |
getErrorLEDConfig()
Returns the LED configuration as set by
setErrorLEDConfig(int) |
long |
getGPIOAction(int channel)
Returns the GPIO action for a channel as set by
setGPIOAction(int, long) . |
BrickletPerformanceDC.GPIOConfiguration |
getGPIOConfiguration(int channel)
Returns the GPIO configuration for a channel as set by
setGPIOConfiguration(int, int, int) . |
int |
getGPIOLEDConfig(int channel)
Returns the LED configuration as set by
setGPIOLEDConfig(int, int) |
boolean[] |
getGPIOState()
Returns the GPIO state for both channels.
|
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.
|
BrickletPerformanceDC.Motion |
getMotion()
Returns the acceleration/deceleration as set by
setMotion(int, int) . |
BrickletPerformanceDC.PowerStatistics |
getPowerStatistics()
Returns input voltage, current usage and temperature of the driver.
|
int |
getPWMFrequency()
Returns the PWM frequency as set by
setPWMFrequency(int) . |
BrickletPerformanceDC.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
int |
getThermalShutdown()
Returns the thermal shutdown temperature as set by
setThermalShutdown(int) . |
int |
getVelocity()
Returns the velocity as set by
setVelocity(int) . |
boolean |
getVelocityReachedCallbackConfiguration()
Returns the listener configuration as set by
setVelocityReachedCallbackConfiguration(boolean) . |
long |
readUID()
Returns the current UID as an integer.
|
void |
removeCurrentVelocityListener(BrickletPerformanceDC.CurrentVelocityListener listener)
Removes a CurrentVelocity listener.
|
void |
removeEmergencyShutdownListener(BrickletPerformanceDC.EmergencyShutdownListener listener)
Removes a EmergencyShutdown listener.
|
void |
removeGPIOStateListener(BrickletPerformanceDC.GPIOStateListener listener)
Removes a GPIOState listener.
|
void |
removeVelocityReachedListener(BrickletPerformanceDC.VelocityReachedListener listener)
Removes a VelocityReached 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 |
setCCWLEDConfig(int config)
Configures the CCW LED to be either turned off, turned on, blink in
heartbeat mode or if the motor turn counter-clockwise.
|
void |
setCurrentVelocityCallbackConfiguration(long period,
boolean valueHasToChange)
The period is the period with which the
BrickletPerformanceDC.CurrentVelocityListener
listener is triggered periodically. |
void |
setCWLEDConfig(int config)
Configures the CW LED to be either turned off, turned on, blink in
heartbeat mode or if the motor turn clockwise.
|
void |
setDriveMode(int mode)
Sets the drive mode.
|
void |
setEmergencyShutdownCallbackConfiguration(boolean enabled)
Enable/Disable
BrickletPerformanceDC.EmergencyShutdownListener listener. |
void |
setEnabled(boolean enabled)
Enables/Disables the driver chip.
|
void |
setErrorLEDConfig(int config)
Configures the error LED to be either turned off, turned on, blink in
heartbeat mode or show an error.
|
void |
setGPIOAction(int channel,
long action)
Sets the GPIO action for the given channel.
|
void |
setGPIOConfiguration(int channel,
int debounce,
int stopDeceleration)
Sets the GPIO configuration for the given channel.
|
void |
setGPIOLEDConfig(int channel,
int config)
Configures the GPIO LED to be either turned off, turned on, blink in
heartbeat mode or the GPIO state.
|
void |
setMotion(int acceleration,
int deceleration)
Sets the acceleration and deceleration of the motor.
|
void |
setPWMFrequency(int frequency)
Sets the frequency of the PWM with which the motor is driven.
|
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setThermalShutdown(int temperature)
Sets a temperature threshold that is used for thermal shutdown.
|
void |
setVelocity(int velocity)
Sets the velocity of the motor.
|
void |
setVelocityReachedCallbackConfiguration(boolean enabled)
Enable/Disable
BrickletPerformanceDC.VelocityReachedListener listener. |
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_SET_ENABLED
public static final byte FUNCTION_GET_ENABLED
public static final byte FUNCTION_SET_VELOCITY
public static final byte FUNCTION_GET_VELOCITY
public static final byte FUNCTION_GET_CURRENT_VELOCITY
public static final byte FUNCTION_SET_MOTION
public static final byte FUNCTION_GET_MOTION
public static final byte FUNCTION_FULL_BRAKE
public static final byte FUNCTION_SET_DRIVE_MODE
public static final byte FUNCTION_GET_DRIVE_MODE
public static final byte FUNCTION_SET_PWM_FREQUENCY
public static final byte FUNCTION_GET_PWM_FREQUENCY
public static final byte FUNCTION_GET_POWER_STATISTICS
public static final byte FUNCTION_SET_THERMAL_SHUTDOWN
public static final byte FUNCTION_GET_THERMAL_SHUTDOWN
public static final byte FUNCTION_SET_GPIO_CONFIGURATION
public static final byte FUNCTION_GET_GPIO_CONFIGURATION
public static final byte FUNCTION_SET_GPIO_ACTION
public static final byte FUNCTION_GET_GPIO_ACTION
public static final byte FUNCTION_GET_GPIO_STATE
public static final byte FUNCTION_SET_ERROR_LED_CONFIG
public static final byte FUNCTION_GET_ERROR_LED_CONFIG
public static final byte FUNCTION_SET_CW_LED_CONFIG
public static final byte FUNCTION_GET_CW_LED_CONFIG
public static final byte FUNCTION_SET_CCW_LED_CONFIG
public static final byte FUNCTION_GET_CCW_LED_CONFIG
public static final byte FUNCTION_SET_GPIO_LED_CONFIG
public static final byte FUNCTION_GET_GPIO_LED_CONFIG
public static final byte FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_VELOCITY_REACHED_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_CURRENT_VELOCITY_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 int DRIVE_MODE_DRIVE_BRAKE
public static final int DRIVE_MODE_DRIVE_COAST
public static final long GPIO_ACTION_NONE
public static final long GPIO_ACTION_NORMAL_STOP_RISING_EDGE
public static final long GPIO_ACTION_NORMAL_STOP_FALLING_EDGE
public static final long GPIO_ACTION_FULL_BRAKE_RISING_EDGE
public static final long GPIO_ACTION_FULL_BRAKE_FALLING_EDGE
public static final long GPIO_ACTION_CALLBACK_RISING_EDGE
public static final long GPIO_ACTION_CALLBACK_FALLING_EDGE
public static final int ERROR_LED_CONFIG_OFF
public static final int ERROR_LED_CONFIG_ON
public static final int ERROR_LED_CONFIG_SHOW_HEARTBEAT
public static final int ERROR_LED_CONFIG_SHOW_ERROR
public static final int CW_LED_CONFIG_OFF
public static final int CW_LED_CONFIG_ON
public static final int CW_LED_CONFIG_SHOW_HEARTBEAT
public static final int CW_LED_CONFIG_SHOW_CW_AS_FORWARD
public static final int CW_LED_CONFIG_SHOW_CW_AS_BACKWARD
public static final int CCW_LED_CONFIG_OFF
public static final int CCW_LED_CONFIG_ON
public static final int CCW_LED_CONFIG_SHOW_HEARTBEAT
public static final int CCW_LED_CONFIG_SHOW_CCW_AS_FORWARD
public static final int CCW_LED_CONFIG_SHOW_CCW_AS_BACKWARD
public static final int GPIO_LED_CONFIG_OFF
public static final int GPIO_LED_CONFIG_ON
public static final int GPIO_LED_CONFIG_SHOW_HEARTBEAT
public static final int GPIO_LED_CONFIG_SHOW_GPIO_ACTIVE_HIGH
public static final int GPIO_LED_CONFIG_SHOW_GPIO_ACTIVE_LOW
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 BrickletPerformanceDC(String uid, IPConnection ipcon)
public void setEnabled(boolean enabled) throws TinkerforgeException
TinkerforgeException
public boolean getEnabled() throws TinkerforgeException
TinkerforgeException
public void setVelocity(int velocity) throws TinkerforgeException
setMotion(int, int)
), the motor is not immediately
brought to the velocity but smoothly accelerated.
The velocity describes the duty cycle of the PWM with which the motor is
controlled, e.g. a velocity of 3277 sets a PWM with a 10% duty cycle.
You can not only control the duty cycle of the PWM but also the frequency,
see setPWMFrequency(int)
.TinkerforgeException
public int getVelocity() throws TinkerforgeException
setVelocity(int)
.TinkerforgeException
public int getCurrentVelocity() throws TinkerforgeException
getVelocity()
whenever the motor is currently accelerating
to a goal set by setVelocity(int)
.TinkerforgeException
public void setMotion(int acceleration, int deceleration) throws TinkerforgeException
TinkerforgeException
public BrickletPerformanceDC.Motion getMotion() throws TinkerforgeException
setMotion(int, int)
.TinkerforgeException
public void fullBrake() throws TinkerforgeException
setVelocity(int)
with 0 if you just want to stop the motor.TinkerforgeException
public void setDriveMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getDriveMode() throws TinkerforgeException
setDriveMode(int)
.TinkerforgeException
public void setPWMFrequency(int frequency) throws TinkerforgeException
TinkerforgeException
public int getPWMFrequency() throws TinkerforgeException
setPWMFrequency(int)
.TinkerforgeException
public BrickletPerformanceDC.PowerStatistics getPowerStatistics() throws TinkerforgeException
TinkerforgeException
public void setThermalShutdown(int temperature) throws TinkerforgeException
setEnabled(boolean)
.TinkerforgeException
public int getThermalShutdown() throws TinkerforgeException
setThermalShutdown(int)
.TinkerforgeException
public void setGPIOConfiguration(int channel, int debounce, int stopDeceleration) throws TinkerforgeException
setGPIOAction(int, long)
.TinkerforgeException
public BrickletPerformanceDC.GPIOConfiguration getGPIOConfiguration(int channel) throws TinkerforgeException
setGPIOConfiguration(int, int, int)
.TinkerforgeException
public void setGPIOAction(int channel, long action) throws TinkerforgeException
setGPIOConfiguration(int, int, int)
.TinkerforgeException
public long getGPIOAction(int channel) throws TinkerforgeException
setGPIOAction(int, long)
.TinkerforgeException
public boolean[] getGPIOState() throws TinkerforgeException
TinkerforgeException
public void setErrorLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getErrorLEDConfig() throws TinkerforgeException
setErrorLEDConfig(int)
TinkerforgeException
public void setCWLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getCWLEDConfig() throws TinkerforgeException
setCWLEDConfig(int)
TinkerforgeException
public void setCCWLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getCCWLEDConfig() throws TinkerforgeException
setCCWLEDConfig(int)
TinkerforgeException
public void setGPIOLEDConfig(int channel, int config) throws TinkerforgeException
TinkerforgeException
public int getGPIOLEDConfig(int channel) throws TinkerforgeException
setGPIOLEDConfig(int, int)
TinkerforgeException
public void setEmergencyShutdownCallbackConfiguration(boolean enabled) throws TinkerforgeException
BrickletPerformanceDC.EmergencyShutdownListener
listener.TinkerforgeException
public boolean getEmergencyShutdownCallbackConfiguration() throws TinkerforgeException
setEmergencyShutdownCallbackConfiguration(boolean)
.TinkerforgeException
public void setVelocityReachedCallbackConfiguration(boolean enabled) throws TinkerforgeException
BrickletPerformanceDC.VelocityReachedListener
listener.TinkerforgeException
public boolean getVelocityReachedCallbackConfiguration() throws TinkerforgeException
setVelocityReachedCallbackConfiguration(boolean)
.TinkerforgeException
public void setCurrentVelocityCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletPerformanceDC.CurrentVelocityListener
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.TinkerforgeException
public BrickletPerformanceDC.CurrentVelocityCallbackConfiguration getCurrentVelocityCallbackConfiguration() throws TinkerforgeException
setCurrentVelocityCallbackConfiguration(long, boolean)
.TinkerforgeException
public BrickletPerformanceDC.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 addEmergencyShutdownListener(BrickletPerformanceDC.EmergencyShutdownListener listener)
public void removeEmergencyShutdownListener(BrickletPerformanceDC.EmergencyShutdownListener listener)
public void addVelocityReachedListener(BrickletPerformanceDC.VelocityReachedListener listener)
public void removeVelocityReachedListener(BrickletPerformanceDC.VelocityReachedListener listener)
public void addCurrentVelocityListener(BrickletPerformanceDC.CurrentVelocityListener listener)
public void removeCurrentVelocityListener(BrickletPerformanceDC.CurrentVelocityListener listener)
public void addGPIOStateListener(BrickletPerformanceDC.GPIOStateListener listener)
public void removeGPIOStateListener(BrickletPerformanceDC.GPIOStateListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.