com.tinkerforge.BrickHAT Maven / Gradle / Ivy
/* ***********************************************************
* This file was automatically generated on 2019-11-25. *
* *
* Java Bindings Version 2.1.25 *
* *
* If you have a bugfix for this file and want to commit it, *
* please fix the bug in the generator. You can find a link *
* to the generators git repository on tinkerforge.com *
*************************************************************/
package com.tinkerforge;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.Arrays;
import java.util.List;
/**
* HAT for Raspberry Pi with 8 Bricklets ports and real-time clock
*/
public class BrickHAT extends Device {
public final static int DEVICE_IDENTIFIER = 111;
public final static String DEVICE_DISPLAY_NAME = "HAT Brick";
public final static byte FUNCTION_SET_SLEEP_MODE = (byte)1;
public final static byte FUNCTION_GET_SLEEP_MODE = (byte)2;
public final static byte FUNCTION_SET_BRICKLET_POWER = (byte)3;
public final static byte FUNCTION_GET_BRICKLET_POWER = (byte)4;
public final static byte FUNCTION_GET_VOLTAGES = (byte)5;
public final static byte FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION = (byte)6;
public final static byte FUNCTION_GET_VOLTAGES_CALLBACK_CONFIGURATION = (byte)7;
public final static byte FUNCTION_GET_SPITFP_ERROR_COUNT = (byte)234;
public final static byte FUNCTION_SET_BOOTLOADER_MODE = (byte)235;
public final static byte FUNCTION_GET_BOOTLOADER_MODE = (byte)236;
public final static byte FUNCTION_SET_WRITE_FIRMWARE_POINTER = (byte)237;
public final static byte FUNCTION_WRITE_FIRMWARE = (byte)238;
public final static byte FUNCTION_SET_STATUS_LED_CONFIG = (byte)239;
public final static byte FUNCTION_GET_STATUS_LED_CONFIG = (byte)240;
public final static byte FUNCTION_GET_CHIP_TEMPERATURE = (byte)242;
public final static byte FUNCTION_RESET = (byte)243;
public final static byte FUNCTION_WRITE_UID = (byte)248;
public final static byte FUNCTION_READ_UID = (byte)249;
public final static byte FUNCTION_GET_IDENTITY = (byte)255;
private final static int CALLBACK_VOLTAGES = 8;
public final static int BOOTLOADER_MODE_BOOTLOADER = 0;
public final static int BOOTLOADER_MODE_FIRMWARE = 1;
public final static int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2;
public final static int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3;
public final static int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4;
public final static int BOOTLOADER_STATUS_OK = 0;
public final static int BOOTLOADER_STATUS_INVALID_MODE = 1;
public final static int BOOTLOADER_STATUS_NO_CHANGE = 2;
public final static int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3;
public final static int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4;
public final static int BOOTLOADER_STATUS_CRC_MISMATCH = 5;
public final static int STATUS_LED_CONFIG_OFF = 0;
public final static int STATUS_LED_CONFIG_ON = 1;
public final static int STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2;
public final static int STATUS_LED_CONFIG_SHOW_STATUS = 3;
private List listenerVoltages = new CopyOnWriteArrayList();
public class SleepMode {
public long powerOffDelay;
public long powerOffDuration;
public boolean raspberryPiOff;
public boolean brickletsOff;
public boolean enableSleepIndicator;
public String toString() {
return "[" + "powerOffDelay = " + powerOffDelay + ", " + "powerOffDuration = " + powerOffDuration + ", " + "raspberryPiOff = " + raspberryPiOff + ", " + "brickletsOff = " + brickletsOff + ", " + "enableSleepIndicator = " + enableSleepIndicator + "]";
}
}
public class Voltages {
public int voltageUSB;
public int voltageDC;
public String toString() {
return "[" + "voltageUSB = " + voltageUSB + ", " + "voltageDC = " + voltageDC + "]";
}
}
public class VoltagesCallbackConfiguration {
public long period;
public boolean valueHasToChange;
public String toString() {
return "[" + "period = " + period + ", " + "valueHasToChange = " + valueHasToChange + "]";
}
}
public class SPITFPErrorCount {
public long errorCountAckChecksum;
public long errorCountMessageChecksum;
public long errorCountFrame;
public long errorCountOverflow;
public String toString() {
return "[" + "errorCountAckChecksum = " + errorCountAckChecksum + ", " + "errorCountMessageChecksum = " + errorCountMessageChecksum + ", " + "errorCountFrame = " + errorCountFrame + ", " + "errorCountOverflow = " + errorCountOverflow + "]";
}
}
/**
* This listener is triggered periodically according to the configuration set by
* {@link BrickHAT#setVoltagesCallbackConfiguration(long, boolean)}.
*
* The parameters are the same as {@link BrickHAT#getVoltages()}.
*
* .. versionadded:: 2.0.1$nbsp;(Firmware)
*/
public interface VoltagesListener extends DeviceListener {
public void voltages(int voltageUSB, int voltageDC);
}
/**
* Creates an object with the unique device ID \c uid. and adds it to
* the IP Connection \c ipcon.
*/
public BrickHAT(String uid, IPConnection ipcon) {
super(uid, ipcon);
apiVersion[0] = 2;
apiVersion[1] = 0;
apiVersion[2] = 1;
responseExpected[IPConnection.unsignedByte(FUNCTION_SET_SLEEP_MODE)] = RESPONSE_EXPECTED_FLAG_FALSE;
responseExpected[IPConnection.unsignedByte(FUNCTION_GET_SLEEP_MODE)] = RESPONSE_EXPECTED_FLAG_ALWAYS_TRUE;
responseExpected[IPConnection.unsignedByte(FUNCTION_SET_BRICKLET_POWER)] = RESPONSE_EXPECTED_FLAG_FALSE;
responseExpected[IPConnection.unsignedByte(FUNCTION_GET_BRICKLET_POWER)] = RESPONSE_EXPECTED_FLAG_ALWAYS_TRUE;
responseExpected[IPConnection.unsignedByte(FUNCTION_GET_VOLTAGES)] = RESPONSE_EXPECTED_FLAG_ALWAYS_TRUE;
responseExpected[IPConnection.unsignedByte(FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION)] = RESPONSE_EXPECTED_FLAG_TRUE;
responseExpected[IPConnection.unsignedByte(FUNCTION_GET_VOLTAGES_CALLBACK_CONFIGURATION)] = RESPONSE_EXPECTED_FLAG_ALWAYS_TRUE;
responseExpected[IPConnection.unsignedByte(FUNCTION_GET_SPITFP_ERROR_COUNT)] = RESPONSE_EXPECTED_FLAG_ALWAYS_TRUE;
responseExpected[IPConnection.unsignedByte(FUNCTION_SET_BOOTLOADER_MODE)] = RESPONSE_EXPECTED_FLAG_ALWAYS_TRUE;
responseExpected[IPConnection.unsignedByte(FUNCTION_GET_BOOTLOADER_MODE)] = RESPONSE_EXPECTED_FLAG_ALWAYS_TRUE;
responseExpected[IPConnection.unsignedByte(FUNCTION_SET_WRITE_FIRMWARE_POINTER)] = RESPONSE_EXPECTED_FLAG_FALSE;
responseExpected[IPConnection.unsignedByte(FUNCTION_WRITE_FIRMWARE)] = RESPONSE_EXPECTED_FLAG_ALWAYS_TRUE;
responseExpected[IPConnection.unsignedByte(FUNCTION_SET_STATUS_LED_CONFIG)] = RESPONSE_EXPECTED_FLAG_FALSE;
responseExpected[IPConnection.unsignedByte(FUNCTION_GET_STATUS_LED_CONFIG)] = RESPONSE_EXPECTED_FLAG_ALWAYS_TRUE;
responseExpected[IPConnection.unsignedByte(FUNCTION_GET_CHIP_TEMPERATURE)] = RESPONSE_EXPECTED_FLAG_ALWAYS_TRUE;
responseExpected[IPConnection.unsignedByte(FUNCTION_RESET)] = RESPONSE_EXPECTED_FLAG_FALSE;
responseExpected[IPConnection.unsignedByte(FUNCTION_WRITE_UID)] = RESPONSE_EXPECTED_FLAG_FALSE;
responseExpected[IPConnection.unsignedByte(FUNCTION_READ_UID)] = RESPONSE_EXPECTED_FLAG_ALWAYS_TRUE;
responseExpected[IPConnection.unsignedByte(FUNCTION_GET_IDENTITY)] = RESPONSE_EXPECTED_FLAG_ALWAYS_TRUE;
callbacks[CALLBACK_VOLTAGES] = new IPConnection.DeviceCallbackListener() {
public void callback(byte[] packet) {
ByteBuffer bb = ByteBuffer.wrap(packet, 8, packet.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
int voltageUSB = IPConnection.unsignedShort(bb.getShort());
int voltageDC = IPConnection.unsignedShort(bb.getShort());
for (VoltagesListener listener: listenerVoltages) {
listener.voltages(voltageUSB, voltageDC);
}
}
};
}
/**
* 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 in seconds before the RPi/Bricklets are powered off.
* * Power Off Duration: Duration in seconds 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.
*/
public void setSleepMode(long powerOffDelay, long powerOffDuration, boolean raspberryPiOff, boolean brickletsOff, boolean enableSleepIndicator) throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)19, FUNCTION_SET_SLEEP_MODE, this);
bb.putInt((int)powerOffDelay);
bb.putInt((int)powerOffDuration);
bb.put((byte)(raspberryPiOff ? 1 : 0));
bb.put((byte)(brickletsOff ? 1 : 0));
bb.put((byte)(enableSleepIndicator ? 1 : 0));
sendRequest(bb.array());
}
/**
* Returns the sleep mode settings as set by {@link BrickHAT#setSleepMode(long, long, boolean, boolean, boolean)}.
*/
public SleepMode getSleepMode() throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)8, FUNCTION_GET_SLEEP_MODE, this);
byte[] response = sendRequest(bb.array());
bb = ByteBuffer.wrap(response, 8, response.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
SleepMode obj = new SleepMode();
obj.powerOffDelay = IPConnection.unsignedInt(bb.getInt());
obj.powerOffDuration = IPConnection.unsignedInt(bb.getInt());
obj.raspberryPiOff = (bb.get()) != 0;
obj.brickletsOff = (bb.get()) != 0;
obj.enableSleepIndicator = (bb.get()) != 0;
return obj;
}
/**
* Set to true/false to turn the power supply of the connected Bricklets on/off.
*
* By default the Bricklets are on.
*/
public void setBrickletPower(boolean brickletPower) throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)9, FUNCTION_SET_BRICKLET_POWER, this);
bb.put((byte)(brickletPower ? 1 : 0));
sendRequest(bb.array());
}
/**
* Returns the power status of the connected Bricklets as set by {@link BrickHAT#setBrickletPower(boolean)}.
*/
public boolean getBrickletPower() throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)8, FUNCTION_GET_BRICKLET_POWER, this);
byte[] response = sendRequest(bb.array());
bb = ByteBuffer.wrap(response, 8, response.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
boolean brickletPower = (bb.get()) != 0;
return brickletPower;
}
/**
* Returns the USB supply voltage and the DC input supply voltage in mV.
*
* 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).
*/
public Voltages getVoltages() throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)8, FUNCTION_GET_VOLTAGES, this);
byte[] response = sendRequest(bb.array());
bb = ByteBuffer.wrap(response, 8, response.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
Voltages obj = new Voltages();
obj.voltageUSB = IPConnection.unsignedShort(bb.getShort());
obj.voltageDC = IPConnection.unsignedShort(bb.getShort());
return obj;
}
/**
* The period is the period with which the {@link 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)
*/
public void setVoltagesCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)13, FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION, this);
bb.putInt((int)period);
bb.put((byte)(valueHasToChange ? 1 : 0));
sendRequest(bb.array());
}
/**
* Returns the listener configuration as set by
* {@link BrickHAT#setVoltagesCallbackConfiguration(long, boolean)}.
*
* .. versionadded:: 2.0.1$nbsp;(Firmware)
*/
public VoltagesCallbackConfiguration getVoltagesCallbackConfiguration() throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)8, FUNCTION_GET_VOLTAGES_CALLBACK_CONFIGURATION, this);
byte[] response = sendRequest(bb.array());
bb = ByteBuffer.wrap(response, 8, response.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
VoltagesCallbackConfiguration obj = new VoltagesCallbackConfiguration();
obj.period = IPConnection.unsignedInt(bb.getInt());
obj.valueHasToChange = (bb.get()) != 0;
return obj;
}
/**
* 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.
*/
public SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)8, FUNCTION_GET_SPITFP_ERROR_COUNT, this);
byte[] response = sendRequest(bb.array());
bb = ByteBuffer.wrap(response, 8, response.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
SPITFPErrorCount obj = new SPITFPErrorCount();
obj.errorCountAckChecksum = IPConnection.unsignedInt(bb.getInt());
obj.errorCountMessageChecksum = IPConnection.unsignedInt(bb.getInt());
obj.errorCountFrame = IPConnection.unsignedInt(bb.getInt());
obj.errorCountOverflow = IPConnection.unsignedInt(bb.getInt());
return obj;
}
/**
* 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.
*/
public int setBootloaderMode(int mode) throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)9, FUNCTION_SET_BOOTLOADER_MODE, this);
bb.put((byte)mode);
byte[] response = sendRequest(bb.array());
bb = ByteBuffer.wrap(response, 8, response.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
int status = IPConnection.unsignedByte(bb.get());
return status;
}
/**
* Returns the current bootloader mode, see {@link BrickHAT#setBootloaderMode(int)}.
*/
public int getBootloaderMode() throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)8, FUNCTION_GET_BOOTLOADER_MODE, this);
byte[] response = sendRequest(bb.array());
bb = ByteBuffer.wrap(response, 8, response.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
int mode = IPConnection.unsignedByte(bb.get());
return mode;
}
/**
* Sets the firmware pointer for {@link BrickHAT#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.
*/
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)12, FUNCTION_SET_WRITE_FIRMWARE_POINTER, this);
bb.putInt((int)pointer);
sendRequest(bb.array());
}
/**
* Writes 64 Bytes of firmware at the position as written by
* {@link BrickHAT#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.
*/
public int writeFirmware(int[] data) throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)72, FUNCTION_WRITE_FIRMWARE, this);
for (int i = 0; i < 64; i++) {
bb.put((byte)data[i]);
}
byte[] response = sendRequest(bb.array());
bb = ByteBuffer.wrap(response, 8, response.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
int status = IPConnection.unsignedByte(bb.get());
return status;
}
/**
* 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.
*/
public void setStatusLEDConfig(int config) throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)9, FUNCTION_SET_STATUS_LED_CONFIG, this);
bb.put((byte)config);
sendRequest(bb.array());
}
/**
* Returns the configuration as set by {@link BrickHAT#setStatusLEDConfig(int)}
*/
public int getStatusLEDConfig() throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)8, FUNCTION_GET_STATUS_LED_CONFIG, this);
byte[] response = sendRequest(bb.array());
bb = ByteBuffer.wrap(response, 8, response.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
int config = IPConnection.unsignedByte(bb.get());
return config;
}
/**
* Returns the temperature in °C 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.
*/
public int getChipTemperature() throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)8, FUNCTION_GET_CHIP_TEMPERATURE, this);
byte[] response = sendRequest(bb.array());
bb = ByteBuffer.wrap(response, 8, response.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
int temperature = (bb.getShort());
return temperature;
}
/**
* 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!
*/
public void reset() throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)8, FUNCTION_RESET, this);
sendRequest(bb.array());
}
/**
* 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.
*/
public void writeUID(long uid) throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)12, FUNCTION_WRITE_UID, this);
bb.putInt((int)uid);
sendRequest(bb.array());
}
/**
* Returns the current UID as an integer. Encode as
* Base58 to get the usual string version.
*/
public long readUID() throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)8, FUNCTION_READ_UID, this);
byte[] response = sendRequest(bb.array());
bb = ByteBuffer.wrap(response, 8, response.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
long uid = IPConnection.unsignedInt(bb.getInt());
return uid;
}
/**
* 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' or 'd'.
*
* The device identifier numbers can be found :ref:`here <device_identifier>`.
* |device_identifier_constant|
*/
public Identity getIdentity() throws TinkerforgeException {
ByteBuffer bb = ipcon.createRequestPacket((byte)8, FUNCTION_GET_IDENTITY, this);
byte[] response = sendRequest(bb.array());
bb = ByteBuffer.wrap(response, 8, response.length - 8);
bb.order(ByteOrder.LITTLE_ENDIAN);
Identity obj = new Identity();
obj.uid = IPConnection.string(bb, 8);
obj.connectedUid = IPConnection.string(bb, 8);
obj.position = (char)(bb.get());
for (int i = 0; i < 3; i++) {
obj.hardwareVersion[i] = IPConnection.unsignedByte(bb.get());
}
for (int i = 0; i < 3; i++) {
obj.firmwareVersion[i] = IPConnection.unsignedByte(bb.get());
}
obj.deviceIdentifier = IPConnection.unsignedShort(bb.getShort());
return obj;
}
/**
* Adds a Voltages listener.
*/
public void addVoltagesListener(VoltagesListener listener) {
listenerVoltages.add(listener);
}
/**
* Removes a Voltages listener.
*/
public void removeVoltagesListener(VoltagesListener listener) {
listenerVoltages.remove(listener);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy