Package com.tinkerforge
Class BrickletIsolator
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletIsolator
-
public class BrickletIsolator extends Device
Galvanically isolates any Bricklet from any Brick
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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 bysetStatisticsCallbackConfiguration(long, boolean)
.-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletIsolator(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addStatisticsListener(BrickletIsolator.StatisticsListener listener)
Adds a Statistics listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(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, seesetSPITFPBaudrate(long)
.BrickletIsolator.SPITFPBaudrateConfig
getSPITFPBaudrateConfig()
Returns the baudrate config, seesetSPITFPBaudrateConfig(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 bysetStatisticsCallbackConfiguration(long, boolean)
.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(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 theBrickletIsolator.StatisticsListener
listener is triggered periodically.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.int
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before.void
writeUID(long uid)
Writes a new UID into flash.-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATISTICS
public static final byte FUNCTION_GET_STATISTICS
- See Also:
- Constant Field Values
-
FUNCTION_SET_SPITFP_BAUDRATE_CONFIG
public static final byte FUNCTION_SET_SPITFP_BAUDRATE_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_BAUDRATE_CONFIG
public static final byte FUNCTION_GET_SPITFP_BAUDRATE_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_SET_SPITFP_BAUDRATE
public static final byte FUNCTION_SET_SPITFP_BAUDRATE
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_BAUDRATE
public static final byte FUNCTION_GET_SPITFP_BAUDRATE
- See Also:
- Constant Field Values
-
FUNCTION_GET_ISOLATOR_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_ISOLATOR_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATISTICS_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_STATISTICS_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_WRITE_FIRMWARE
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_UID
public static final byte FUNCTION_WRITE_UID
- See Also:
- Constant Field Values
-
FUNCTION_READ_UID
public static final byte FUNCTION_READ_UID
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_BOOTLOADER
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_FIRMWARE
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_OK
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_INVALID_MODE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_NO_CHANGE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_CRC_MISMATCH
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_STATUS
public static final int STATUS_LED_CONFIG_SHOW_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletIsolator
public BrickletIsolator(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
getStatistics
public BrickletIsolator.Statistics getStatistics() throws TinkerforgeException
Returns statistics for the Isolator Bricklet.- Throws:
TinkerforgeException
-
setSPITFPBaudrateConfig
public void setSPITFPBaudrateConfig(boolean enableDynamicBaudrate, long minimumDynamicBaudrate) throws TinkerforgeException
The SPITF protocol can be used with a dynamic baudrate. If the dynamic baudrate is enabled, the Isolator Bricklet will try to adapt the baudrate for the communication between Bricks and Bricklets according to the amount of data that is transferred. The baudrate for communication config between Brick and Isolator Bricklet can be set through the API of the Brick. The baudrate will be increased exponentially if lots of data is sent/received and decreased linearly if little data is sent/received. This lowers the baudrate in applications where little data is transferred (e.g. a weather station) and increases the robustness. If there is lots of data to transfer (e.g. Thermal Imaging Bricklet) it automatically increases the baudrate as needed. In cases where some data has to transferred as fast as possible every few seconds (e.g. RS485 Bricklet with a high baudrate but small payload) you may want to turn the dynamic baudrate off to get the highest possible performance. The maximum value of the baudrate can be set per port with the functionsetSPITFPBaudrate(long)
. If the dynamic baudrate is disabled, the baudrate as set bysetSPITFPBaudrate(long)
will be used statically.- Throws:
TinkerforgeException
-
getSPITFPBaudrateConfig
public BrickletIsolator.SPITFPBaudrateConfig getSPITFPBaudrateConfig() throws TinkerforgeException
Returns the baudrate config, seesetSPITFPBaudrateConfig(boolean, long)
.- Throws:
TinkerforgeException
-
setSPITFPBaudrate
public void setSPITFPBaudrate(long baudrate) throws TinkerforgeException
Sets the baudrate for a the communication between Isolator Bricklet and the connected Bricklet. The baudrate for communication between Brick and Isolator Bricklet can be set through the API of the Brick. If you want to increase the throughput of Bricklets you can increase the baudrate. If you get a high error count because of high interference (seegetSPITFPErrorCount()
) you can decrease the baudrate. If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (seesetSPITFPBaudrateConfig(boolean, long)
). Regulatory testing is done with the default baudrate. If CE compatibility or similar is necessary in your applications we recommend to not change the baudrate.- Throws:
TinkerforgeException
-
getSPITFPBaudrate
public long getSPITFPBaudrate() throws TinkerforgeException
Returns the baudrate, seesetSPITFPBaudrate(long)
.- Throws:
TinkerforgeException
-
getIsolatorSPITFPErrorCount
public BrickletIsolator.IsolatorSPITFPErrorCount getIsolatorSPITFPErrorCount() throws TinkerforgeException
Returns the error count for the communication between Isolator Bricklet and the connected Bricklet. CallgetSPITFPErrorCount()
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.- Throws:
TinkerforgeException
-
setStatisticsCallbackConfiguration
public void setStatisticsCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
The period is the period with which theBrickletIsolator.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)- Throws:
TinkerforgeException
-
getStatisticsCallbackConfiguration
public BrickletIsolator.StatisticsCallbackConfiguration getStatisticsCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetStatisticsCallbackConfiguration(long, boolean)
. .. versionadded:: 2.0.2$nbsp;(Plugin)- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletIsolator.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
Returns the error count for the communication between Brick and Bricklet. The errors are divided into * ACK checksum errors, * message checksum errors, * framing errors and * overflow errors. The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.- Throws:
TinkerforgeException
-
setBootloaderMode
public int setBootloaderMode(int mode) throws TinkerforgeException
Sets the bootloader mode and returns the status after the requested mode change was instigated. You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
getBootloaderMode
public int getBootloaderMode() throws TinkerforgeException
Returns the current bootloader mode, seesetBootloaderMode(int)
.- Throws:
TinkerforgeException
-
setWriteFirmwarePointer
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
Sets the firmware pointer forwriteFirmware(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.- Throws:
TinkerforgeException
-
writeFirmware
public int writeFirmware(int[] data) throws TinkerforgeException
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(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.- Throws:
TinkerforgeException
-
setStatusLEDConfig
public void setStatusLEDConfig(int config) throws TinkerforgeException
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets. You can also turn the LED permanently on/off or show a heartbeat. If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.- Throws:
TinkerforgeException
-
getStatusLEDConfig
public int getStatusLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetStatusLEDConfig(int)
- Throws:
TinkerforgeException
-
getChipTemperature
public int getChipTemperature() throws TinkerforgeException
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature! The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.- Throws:
TinkerforgeException
-
reset
public void reset() throws TinkerforgeException
Calling this function will reset the Bricklet. All configurations will be lost. After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!- Throws:
TinkerforgeException
-
writeUID
public void writeUID(long uid) throws TinkerforgeException
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first. We recommend that you use Brick Viewer to change the UID.- Throws:
TinkerforgeException
-
readUID
public long readUID() throws TinkerforgeException
Returns the current UID as an integer. Encode as Base58 to get the usual string version.- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier. The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
addStatisticsListener
public void addStatisticsListener(BrickletIsolator.StatisticsListener listener)
Adds a Statistics listener.
-
removeStatisticsListener
public void removeStatisticsListener(BrickletIsolator.StatisticsListener listener)
Removes a Statistics listener.
-
-