public class BrickletPiezoSpeakerV2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletPiezoSpeakerV2.Alarm |
static interface |
BrickletPiezoSpeakerV2.AlarmFinishedListener
This listener is triggered if a alarm set by
setAlarm(int, int, int, int, int, long) is finished |
class |
BrickletPiezoSpeakerV2.Beep |
static interface |
BrickletPiezoSpeakerV2.BeepFinishedListener
This listener is triggered if a beep set by
setBeep(int, int, long) is finished |
class |
BrickletPiezoSpeakerV2.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletPiezoSpeakerV2(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and 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 by
setAlarm(int, int, int, int, int, long) . |
BrickletPiezoSpeakerV2.Beep |
getBeep()
Returns the last beep settings as set by
setBeep(int, int, long) . |
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(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 by
setStatusLEDConfig(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 for
writeFirmware(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 by
setWriteFirmwarePointer(long) before. |
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_SET_BEEP
public static final byte FUNCTION_GET_BEEP
public static final byte FUNCTION_SET_ALARM
public static final byte FUNCTION_GET_ALARM
public static final byte FUNCTION_UPDATE_VOLUME
public static final byte FUNCTION_UPDATE_FREQUENCY
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final long BEEP_DURATION_OFF
public static final long BEEP_DURATION_INFINITE
public static final long ALARM_DURATION_OFF
public static final long ALARM_DURATION_INFINITE
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletPiezoSpeakerV2(String uid, IPConnection ipcon)
public void setBeep(int frequency, int volume, long duration) throws TinkerforgeException
TinkerforgeException
public BrickletPiezoSpeakerV2.Beep getBeep() throws TinkerforgeException
setBeep(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 (with updateFrequency(int)
or updateVolume(int)
) this function returns the updated value.TinkerforgeException
public void setAlarm(int startFrequency, int endFrequency, int stepSize, int stepDelay, int volume, long duration) throws TinkerforgeException
TinkerforgeException
public BrickletPiezoSpeakerV2.Alarm getAlarm() throws TinkerforgeException
setAlarm(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 (with updateVolume(int)
)
this function returns the updated value.TinkerforgeException
public void updateVolume(int volume) throws TinkerforgeException
TinkerforgeException
public void updateFrequency(int frequency) throws TinkerforgeException
TinkerforgeException
public BrickletPiezoSpeakerV2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
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.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
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.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addBeepFinishedListener(BrickletPiezoSpeakerV2.BeepFinishedListener listener)
public void removeBeepFinishedListener(BrickletPiezoSpeakerV2.BeepFinishedListener listener)
public void addAlarmFinishedListener(BrickletPiezoSpeakerV2.AlarmFinishedListener listener)
public void removeAlarmFinishedListener(BrickletPiezoSpeakerV2.AlarmFinishedListener listener)
Copyright © 2022 Tinkerforge GmbH. All rights reserved.