public class BrickletIsolator extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletIsolator.IsolatorSPITFPErrorCount |
class |
BrickletIsolator.SPITFPBaudrateConfig |
class |
BrickletIsolator.SPITFPErrorCount |
class |
BrickletIsolator.Statistics |
class |
BrickletIsolator.StatisticsCallbackConfiguration |
static interface |
BrickletIsolator.StatisticsListener
This listener is triggered periodically according to the configuration set by
setStatisticsCallbackConfiguration(long, boolean) . |
Device.Identity
Constructor and Description |
---|
BrickletIsolator(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addStatisticsListener(BrickletIsolator.StatisticsListener listener)
Adds a Statistics listener.
|
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.
|
BrickletIsolator.IsolatorSPITFPErrorCount |
getIsolatorSPITFPErrorCount()
Returns the error count for the communication between Isolator Bricklet and
the connected Bricklet.
|
long |
getSPITFPBaudrate()
Returns the baudrate, see
setSPITFPBaudrate(long) . |
BrickletIsolator.SPITFPBaudrateConfig |
getSPITFPBaudrateConfig()
Returns the baudrate config, see
setSPITFPBaudrateConfig(boolean, long) . |
BrickletIsolator.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
BrickletIsolator.Statistics |
getStatistics()
Returns statistics for the Isolator Bricklet.
|
BrickletIsolator.StatisticsCallbackConfiguration |
getStatisticsCallbackConfiguration()
Returns the listener configuration as set by
setStatisticsCallbackConfiguration(long, boolean) . |
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
long |
readUID()
Returns the current UID as an integer.
|
void |
removeStatisticsListener(BrickletIsolator.StatisticsListener listener)
Removes a Statistics 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 |
setSPITFPBaudrate(long baudrate)
Sets the baudrate for a the communication between Isolator Bricklet
and the connected Bricklet.
|
void |
setSPITFPBaudrateConfig(boolean enableDynamicBaudrate,
long minimumDynamicBaudrate)
The SPITF protocol can be used with a dynamic baudrate.
|
void |
setStatisticsCallbackConfiguration(long period,
boolean valueHasToChange)
The period is the period with which the
BrickletIsolator.StatisticsListener
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_STATISTICS
public static final byte FUNCTION_SET_SPITFP_BAUDRATE_CONFIG
public static final byte FUNCTION_GET_SPITFP_BAUDRATE_CONFIG
public static final byte FUNCTION_SET_SPITFP_BAUDRATE
public static final byte FUNCTION_GET_SPITFP_BAUDRATE
public static final byte FUNCTION_GET_ISOLATOR_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_STATISTICS_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 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 BrickletIsolator(java.lang.String uid, IPConnection ipcon)
public BrickletIsolator.Statistics getStatistics() throws TinkerforgeException
TinkerforgeException
public void setSPITFPBaudrateConfig(boolean enableDynamicBaudrate, long minimumDynamicBaudrate) throws TinkerforgeException
setSPITFPBaudrate(long)
. If the dynamic baudrate is disabled, the baudrate
as set by setSPITFPBaudrate(long)
will be used statically.TinkerforgeException
public BrickletIsolator.SPITFPBaudrateConfig getSPITFPBaudrateConfig() throws TinkerforgeException
setSPITFPBaudrateConfig(boolean, long)
.TinkerforgeException
public void setSPITFPBaudrate(long baudrate) throws TinkerforgeException
getSPITFPErrorCount()
) you can decrease the
baudrate.
If the dynamic baudrate feature is enabled, the baudrate set by this
function corresponds to the maximum baudrate (see setSPITFPBaudrateConfig(boolean, long)
).
Regulatory testing is done with the default baudrate. If CE compatibility
or similar is necessary in you applications we recommend to not change
the baudrate.TinkerforgeException
public long getSPITFPBaudrate() throws TinkerforgeException
setSPITFPBaudrate(long)
.TinkerforgeException
public BrickletIsolator.IsolatorSPITFPErrorCount getIsolatorSPITFPErrorCount() throws TinkerforgeException
getSPITFPErrorCount()
to get the
error count between Isolator Bricklet and Brick.
The errors are divided into
* ACK checksum errors,
* message checksum errors,
* framing errors and
* overflow errors.TinkerforgeException
public void setStatisticsCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletIsolator.StatisticsListener
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.
.. versionadded:: 2.0.2$nbsp;(Plugin)TinkerforgeException
public BrickletIsolator.StatisticsCallbackConfiguration getStatisticsCallbackConfiguration() throws TinkerforgeException
setStatisticsCallbackConfiguration(long, boolean)
.
.. versionadded:: 2.0.2$nbsp;(Plugin)TinkerforgeException
public BrickletIsolator.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 addStatisticsListener(BrickletIsolator.StatisticsListener listener)
public void removeStatisticsListener(BrickletIsolator.StatisticsListener listener)
Copyright © 2020 Tinkerforge GmbH. All rights reserved.