Package com.tinkerforge
Class BrickletPiezoSpeakerV2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletPiezoSpeakerV2
-
public class BrickletPiezoSpeakerV2 extends Device
Creates beep and alarm with configurable volume and frequency
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletPiezoSpeakerV2.Alarm
static interface
BrickletPiezoSpeakerV2.AlarmFinishedListener
This listener is triggered if a alarm set bysetAlarm(int, int, int, int, int, long)
is finishedclass
BrickletPiezoSpeakerV2.Beep
static interface
BrickletPiezoSpeakerV2.BeepFinishedListener
This listener is triggered if a beep set bysetBeep(int, int, long)
is finishedclass
BrickletPiezoSpeakerV2.SPITFPErrorCount
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletPiezoSpeakerV2(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
addAlarmFinishedListener(BrickletPiezoSpeakerV2.AlarmFinishedListener listener)
Adds a AlarmFinished listener.void
addBeepFinishedListener(BrickletPiezoSpeakerV2.BeepFinishedListener listener)
Adds a BeepFinished listener.BrickletPiezoSpeakerV2.Alarm
getAlarm()
Returns the last alarm settings as set bysetAlarm(int, int, int, int, int, long)
.BrickletPiezoSpeakerV2.Beep
getBeep()
Returns the last beep settings as set bysetBeep(int, int, long)
.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.BrickletPiezoSpeakerV2.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
long
readUID()
Returns the current UID as an integer.void
removeAlarmFinishedListener(BrickletPiezoSpeakerV2.AlarmFinishedListener listener)
Removes a AlarmFinished listener.void
removeBeepFinishedListener(BrickletPiezoSpeakerV2.BeepFinishedListener listener)
Removes a BeepFinished listener.void
reset()
Calling this function will reset the Bricklet.void
setAlarm(int startFrequency, int endFrequency, int stepSize, int stepDelay, int volume, long duration)
Creates an alarm (a tone that goes back and force between two specified frequencies).void
setBeep(int frequency, int volume, long duration)
Beeps with the given frequency and volume for the duration.int
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested mode change was instigated.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.void
updateFrequency(int frequency)
Updates the frequency of an ongoing beep.void
updateVolume(int volume)
Updates the volume of an ongoing beep or alarm.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_SET_BEEP
public static final byte FUNCTION_SET_BEEP
- See Also:
- Constant Field Values
-
FUNCTION_GET_BEEP
public static final byte FUNCTION_GET_BEEP
- See Also:
- Constant Field Values
-
FUNCTION_SET_ALARM
public static final byte FUNCTION_SET_ALARM
- See Also:
- Constant Field Values
-
FUNCTION_GET_ALARM
public static final byte FUNCTION_GET_ALARM
- See Also:
- Constant Field Values
-
FUNCTION_UPDATE_VOLUME
public static final byte FUNCTION_UPDATE_VOLUME
- See Also:
- Constant Field Values
-
FUNCTION_UPDATE_FREQUENCY
public static final byte FUNCTION_UPDATE_FREQUENCY
- 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
-
BEEP_DURATION_OFF
public static final long BEEP_DURATION_OFF
- See Also:
- Constant Field Values
-
BEEP_DURATION_INFINITE
public static final long BEEP_DURATION_INFINITE
- See Also:
- Constant Field Values
-
ALARM_DURATION_OFF
public static final long ALARM_DURATION_OFF
- See Also:
- Constant Field Values
-
ALARM_DURATION_INFINITE
public static final long ALARM_DURATION_INFINITE
- 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
-
BrickletPiezoSpeakerV2
public BrickletPiezoSpeakerV2(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
-
setBeep
public void setBeep(int frequency, int volume, long duration) throws TinkerforgeException
Beeps with the given frequency and volume for the duration. A duration of 0 stops the current beep if any is ongoing. A duration of 4294967295 results in an infinite beep.- Throws:
TinkerforgeException
-
getBeep
public BrickletPiezoSpeakerV2.Beep getBeep() throws TinkerforgeException
Returns the last beep settings as set bysetBeep(int, int, long)
. If a beep is currently running it also returns the remaining duration of the beep. If the frequency or volume is updated during a beep (withupdateFrequency(int)
orupdateVolume(int)
) this function returns the updated value.- Throws:
TinkerforgeException
-
setAlarm
public void setAlarm(int startFrequency, int endFrequency, int stepSize, int stepDelay, int volume, long duration) throws TinkerforgeException
Creates an alarm (a tone that goes back and force between two specified frequencies). The following parameters can be set: * Start Frequency: Start frequency of the alarm. * End Frequency: End frequency of the alarm. * Step Size: Size of one step of the sweep between the start/end frequencies. * Step Delay: Delay between two steps (duration of time that one tone is used in a sweep). * Duration: Duration of the alarm. A duration of 0 stops the current alarm if any is ongoing. A duration of 4294967295 results in an infinite alarm. Below you can find two sets of example settings that you can try out. You can use these as a starting point to find an alarm signal that suits your application. Example 1: 10 seconds of loud annoying fast alarm * Start Frequency = 800 * End Frequency = 2000 * Step Size = 10 * Step Delay = 1 * Volume = 10 * Duration = 10000 Example 2: 10 seconds of soft siren sound with slow build-up * Start Frequency = 250 * End Frequency = 750 * Step Size = 1 * Step Delay = 5 * Volume = 0 * Duration = 10000 The following conditions must be met: * Start Frequency: has to be smaller than end frequency * End Frequency: has to be bigger than start frequency * Step Size: has to be small enough to fit into the frequency range * Step Delay: has to be small enough to fit into the duration- Throws:
TinkerforgeException
-
getAlarm
public BrickletPiezoSpeakerV2.Alarm getAlarm() throws TinkerforgeException
Returns the last alarm settings as set bysetAlarm(int, int, int, int, int, long)
. If an alarm is currently running it also returns the remaining duration of the alarm as well as the current frequency of the alarm. If the volume is updated during an alarm (withupdateVolume(int)
) this function returns the updated value.- Throws:
TinkerforgeException
-
updateVolume
public void updateVolume(int volume) throws TinkerforgeException
Updates the volume of an ongoing beep or alarm.- Throws:
TinkerforgeException
-
updateFrequency
public void updateFrequency(int frequency) throws TinkerforgeException
Updates the frequency of an ongoing beep.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletPiezoSpeakerV2.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
-
addBeepFinishedListener
public void addBeepFinishedListener(BrickletPiezoSpeakerV2.BeepFinishedListener listener)
Adds a BeepFinished listener.
-
removeBeepFinishedListener
public void removeBeepFinishedListener(BrickletPiezoSpeakerV2.BeepFinishedListener listener)
Removes a BeepFinished listener.
-
addAlarmFinishedListener
public void addAlarmFinishedListener(BrickletPiezoSpeakerV2.AlarmFinishedListener listener)
Adds a AlarmFinished listener.
-
removeAlarmFinishedListener
public void removeAlarmFinishedListener(BrickletPiezoSpeakerV2.AlarmFinishedListener listener)
Removes a AlarmFinished listener.
-
-