Class BrickHAT


  • public class BrickHAT
    extends Device
    HAT for Raspberry Pi with 8 Bricklets ports and real-time clock
    • Field Detail

      • DEVICE_DISPLAY_NAME

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

        public static final byte FUNCTION_SET_SLEEP_MODE
        See Also:
        Constant Field Values
      • FUNCTION_GET_SLEEP_MODE

        public static final byte FUNCTION_GET_SLEEP_MODE
        See Also:
        Constant Field Values
      • FUNCTION_SET_BRICKLET_POWER

        public static final byte FUNCTION_SET_BRICKLET_POWER
        See Also:
        Constant Field Values
      • FUNCTION_GET_BRICKLET_POWER

        public static final byte FUNCTION_GET_BRICKLET_POWER
        See Also:
        Constant Field Values
      • FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_VOLTAGES_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_GET_VOLTAGES_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_SET_RTC_DRIVER

        public static final byte FUNCTION_SET_RTC_DRIVER
        See Also:
        Constant Field Values
      • FUNCTION_GET_RTC_DRIVER

        public static final byte FUNCTION_GET_RTC_DRIVER
        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

      • BrickHAT

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

      • setSleepMode

        public void setSleepMode​(long powerOffDelay,
                                 long powerOffDuration,
                                 boolean raspberryPiOff,
                                 boolean brickletsOff,
                                 boolean enableSleepIndicator)
                          throws TinkerforgeException
        Sets the sleep mode. \note Calling this function will cut the Raspberry Pi's power after Power Off Delay seconds. You have to shut down the operating system yourself, e.g. by calling 'sudo shutdown -h now'. Parameters: * Power Off Delay: Time before the RPi/Bricklets are powered off. * Power Off Duration: Duration that the RPi/Bricklets stay powered off. * Raspberry Pi Off: RPi is powered off if set to true. * Bricklets Off: Bricklets are powered off if set to true. * Enable Sleep Indicator: If set to true, the status LED will blink in a 1s interval during the whole power off duration. This will draw additional 0.3mA. Example: To turn RPi and Bricklets off in 5 seconds for 10 minutes with sleep indicator enabled, call (5, 60*10, true, true, true). This function can also be used to implement a watchdog. To do this you can write a program that calls this function once per second in a loop with (10, 2, true, false, false). If the RPi crashes or gets stuck the HAT will reset the RPi after 10 seconds.
        Throws:
        TinkerforgeException
      • setBrickletPower

        public void setBrickletPower​(boolean brickletPower)
                              throws TinkerforgeException
        Set to true/false to turn the power supply of the connected Bricklets on/off.
        Throws:
        TinkerforgeException
      • getVoltages

        public BrickHAT.Voltages getVoltages()
                                      throws TinkerforgeException
        Returns the USB supply voltage and the DC input supply voltage. There are three possible combinations: * Only USB connected: The USB supply voltage will be fed back to the DC input connector. You will read the USB voltage and a slightly lower voltage on the DC input. * Only DC input connected: The DC voltage will not be fed back to the USB connector. You will read the DC input voltage and the USB voltage will be 0. * USB and DC input connected: You will read both voltages. In this case the USB supply will be without load, but it will work as backup if you disconnect the DC input (or if the DC input voltage falls below the USB voltage).
        Throws:
        TinkerforgeException
      • setVoltagesCallbackConfiguration

        public void setVoltagesCallbackConfiguration​(long period,
                                                     boolean valueHasToChange)
                                              throws TinkerforgeException
        The period is the period with which the BrickHAT.VoltagesListener 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.1$nbsp;(Firmware)
        Throws:
        TinkerforgeException
      • setRTCDriver

        public void setRTCDriver​(int rtcDriver)
                          throws TinkerforgeException
        Configures the RTC driver that is given to the Raspberry Pi to be used. Currently there are two different RTCs used: * Hardware version <= 1.5: PCF8523 * Hardware version 1.6: DS1338 The correct driver will be set during factory flashing by Tinkerforge. .. versionadded:: 2.0.3$nbsp;(Firmware)
        Throws:
        TinkerforgeException
      • getSPITFPErrorCount

        public BrickHAT.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 HAT is connected to (typically '0' as the HAT is the root device in the topology), the position, the hardware and firmware version as well as the device identifier. The HAT (Zero) Brick is always at position 'i'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|
        Specified by:
        getIdentity in class Device
        Throws:
        TinkerforgeException
      • removeVoltagesListener

        public void removeVoltagesListener​(BrickHAT.VoltagesListener listener)
        Removes a Voltages listener.