Class BrickletIO4V2


  • public class BrickletIO4V2
    extends Device
    4-channel digital input/output
    • Field Detail

      • DEVICE_DISPLAY_NAME

        public static final java.lang.String DEVICE_DISPLAY_NAME
        See Also:
        Constant Field Values
      • FUNCTION_SET_SELECTED_VALUE

        public static final byte FUNCTION_SET_SELECTED_VALUE
        See Also:
        Constant Field Values
      • FUNCTION_SET_CONFIGURATION

        public static final byte FUNCTION_SET_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_CONFIGURATION

        public static final byte FUNCTION_GET_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_INPUT_VALUE_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_GET_INPUT_VALUE_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_GET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_EDGE_COUNT

        public static final byte FUNCTION_GET_EDGE_COUNT
        See Also:
        Constant Field Values
      • FUNCTION_SET_EDGE_COUNT_CONFIGURATION

        public static final byte FUNCTION_SET_EDGE_COUNT_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_EDGE_COUNT_CONFIGURATION

        public static final byte FUNCTION_GET_EDGE_COUNT_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_SET_PWM_CONFIGURATION

        public static final byte FUNCTION_SET_PWM_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_PWM_CONFIGURATION

        public static final byte FUNCTION_GET_PWM_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
      • 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_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_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

      • BrickletIO4V2

        public BrickletIO4V2​(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

      • setValue

        public void setValue​(boolean[] value)
                      throws TinkerforgeException
        Sets the output value of all four channels. A value of *true* or *false* outputs logic 1 or logic 0 respectively on the corresponding channel. Use setSelectedValue(int, boolean) to change only one output channel state. For example: (True, True, False, False) will turn the channels 0-1 high and the channels 2-3 low. All running monoflop timers and PWMs will be aborted if this function is called. \note This function does nothing for channels that are configured as input. Pull-up resistors can be switched on with setConfiguration(int, char, boolean).
        Throws:
        TinkerforgeException
      • getValue

        public boolean[] getValue()
                           throws TinkerforgeException
        Returns the logic levels that are currently measured on the channels. This function works if the channel is configured as input as well as if it is configured as output.
        Throws:
        TinkerforgeException
      • setSelectedValue

        public void setSelectedValue​(int channel,
                                     boolean value)
                              throws TinkerforgeException
        Sets the output value of a specific channel without affecting the other channels. A running monoflop timer or PWM for the specific channel will be aborted if this function is called. \note This function does nothing for channels that are configured as input. Pull-up resistors can be switched on with setConfiguration(int, char, boolean).
        Throws:
        TinkerforgeException
      • setConfiguration

        public void setConfiguration​(int channel,
                                     char direction,
                                     boolean value)
                              throws TinkerforgeException
        Configures the value and direction of a specific channel. Possible directions are 'i' and 'o' for input and output. If the direction is configured as output, the value is either high or low (set as *true* or *false*). If the direction is configured as input, the value is either pull-up or default (set as *true* or *false*). For example: * (0, 'i', true) will set channel 0 as input pull-up. * (1, 'i', false) will set channel 1 as input default (floating if nothing is connected). * (2, 'o', true) will set channel 2 as output high. * (3, 'o', false) will set channel 3 as output low. A running monoflop timer or PWM for the specific channel will be aborted if this function is called.
        Throws:
        TinkerforgeException
      • setInputValueCallbackConfiguration

        public void setInputValueCallbackConfiguration​(int channel,
                                                       long period,
                                                       boolean valueHasToChange)
                                                throws TinkerforgeException
        This listener can be configured per channel. The period is the period with which the BrickletIO4V2.InputValueListener 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.
        Throws:
        TinkerforgeException
      • setAllInputValueCallbackConfiguration

        public void setAllInputValueCallbackConfiguration​(long period,
                                                          boolean valueHasToChange)
                                                   throws TinkerforgeException
        The period is the period with which the BrickletIO4V2.AllInputValueListener 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.
        Throws:
        TinkerforgeException
      • setMonoflop

        public void setMonoflop​(int channel,
                                boolean value,
                                long time)
                         throws TinkerforgeException
        The first parameter is the desired state of the channel (*true* means output *high* and *false* means output *low*). The second parameter indicates the time that the channel should hold the state. If this function is called with the parameters (true, 1500): The channel will turn on and in 1.5s it will turn off again. A PWM for the selected channel will be aborted if this function is called. A monoflop can be used as a failsafe mechanism. For example: Lets assume you have a RS485 bus and a IO-4 Bricklet 2.0 is connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The channel will be *high* all the time. If now the RS485 connection is lost, the channel will turn *low* in at most two seconds.
        Throws:
        TinkerforgeException
      • getEdgeCount

        public long getEdgeCount​(int channel,
                                 boolean resetCounter)
                          throws TinkerforgeException
        Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with setEdgeCountConfiguration(int, int, int). If you set the reset counter to *true*, the count is set back to 0 directly after it is read. \note Calling this function is only allowed for channels configured as input.
        Throws:
        TinkerforgeException
      • setEdgeCountConfiguration

        public void setEdgeCountConfiguration​(int channel,
                                              int edgeType,
                                              int debounce)
                                       throws TinkerforgeException
        Configures the edge counter for a specific channel. The edge type parameter configures if rising edges, falling edges or both are counted if the channel is configured for input. Possible edge types are: * 0 = rising * 1 = falling * 2 = both Configuring an edge counter resets its value to 0. If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you. \note Calling this function is only allowed for channels configured as input.
        Throws:
        TinkerforgeException
      • setPWMConfiguration

        public void setPWMConfiguration​(int channel,
                                        long frequency,
                                        int dutyCycle)
                                 throws TinkerforgeException
        Activates a PWM for the given channel. You need to set the channel to output before you call this function, otherwise it will report an invalid parameter error. To turn the PWM off again, you can set the frequency to 0 or any other function that changes a value of the channel (e.g. setSelectedValue(int, boolean)). A running monoflop timer for the given channel will be aborted if this function is called.
        Throws:
        TinkerforgeException
      • getSPITFPErrorCount

        public BrickletIO4V2.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
      • setWriteFirmwarePointer

        public void setWriteFirmwarePointer​(long pointer)
                                     throws TinkerforgeException
        Sets the firmware pointer for 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.
        Throws:
        TinkerforgeException
      • writeFirmware

        public int writeFirmware​(int[] data)
                          throws TinkerforgeException
        Writes 64 Bytes of firmware at the position as written by 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.
        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
      • 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
      • 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 class Device
        Throws:
        TinkerforgeException