Class: Tinkerforge::BrickletPiezoSpeakerV2

Inherits:
Device
  • Object
show all
Defined in:
lib/tinkerforge/bricklet_piezo_speaker_v2.rb

Overview

Creates beep and alarm with configurable volume and frequency

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2145
DEVICE_DISPLAY_NAME =

:nodoc:

'Piezo Speaker Bricklet 2.0'
CALLBACK_BEEP_FINISHED =

This callback is triggered if a beep set by BrickletPiezoSpeakerV2#set_beep is finished

7
CALLBACK_ALARM_FINISHED =

This callback is triggered if a alarm set by BrickletPiezoSpeakerV2#set_alarm is finished

8
FUNCTION_SET_BEEP =

:nodoc:

1
FUNCTION_GET_BEEP =

:nodoc:

2
FUNCTION_SET_ALARM =

:nodoc:

3
FUNCTION_GET_ALARM =

:nodoc:

4
FUNCTION_UPDATE_VOLUME =

:nodoc:

5
FUNCTION_UPDATE_FREQUENCY =

:nodoc:

6
FUNCTION_GET_SPITFP_ERROR_COUNT =

:nodoc:

234
FUNCTION_SET_BOOTLOADER_MODE =

:nodoc:

235
FUNCTION_GET_BOOTLOADER_MODE =

:nodoc:

236
FUNCTION_SET_WRITE_FIRMWARE_POINTER =

:nodoc:

237
FUNCTION_WRITE_FIRMWARE =

:nodoc:

238
FUNCTION_SET_STATUS_LED_CONFIG =

:nodoc:

239
FUNCTION_GET_STATUS_LED_CONFIG =

:nodoc:

240
FUNCTION_GET_CHIP_TEMPERATURE =

:nodoc:

242
FUNCTION_RESET =

:nodoc:

243
FUNCTION_WRITE_UID =

:nodoc:

248
FUNCTION_READ_UID =

:nodoc:

249
FUNCTION_GET_IDENTITY =

:nodoc:

255
BEEP_DURATION_OFF =

:nodoc:

0
BEEP_DURATION_INFINITE =

:nodoc:

4294967295
ALARM_DURATION_OFF =

:nodoc:

0
ALARM_DURATION_INFINITE =

:nodoc:

4294967295
BOOTLOADER_MODE_BOOTLOADER =

:nodoc:

0
BOOTLOADER_MODE_FIRMWARE =

:nodoc:

1
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT =

:nodoc:

2
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT =

:nodoc:

3
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT =

:nodoc:

4
BOOTLOADER_STATUS_OK =

:nodoc:

0
BOOTLOADER_STATUS_INVALID_MODE =

:nodoc:

1
BOOTLOADER_STATUS_NO_CHANGE =

:nodoc:

2
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT =

:nodoc:

3
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT =

:nodoc:

4
BOOTLOADER_STATUS_CRC_MISMATCH =

:nodoc:

5
STATUS_LED_CONFIG_OFF =

:nodoc:

0
STATUS_LED_CONFIG_ON =

:nodoc:

1
STATUS_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
STATUS_LED_CONFIG_SHOW_STATUS =

:nodoc:

3

Constants inherited from Device

Device::DEVICE_IDENTIFIER_CHECK_MATCH, Device::DEVICE_IDENTIFIER_CHECK_MISMATCH, Device::DEVICE_IDENTIFIER_CHECK_PENDING, Device::RESPONSE_EXPECTED_ALWAYS_TRUE, Device::RESPONSE_EXPECTED_FALSE, Device::RESPONSE_EXPECTED_INVALID_FUNCTION_ID, Device::RESPONSE_EXPECTED_TRUE

Instance Attribute Summary

Attributes inherited from Device

#callback_formats, #expected_response_function_id, #expected_response_sequence_number, #high_level_callbacks, #registered_callbacks, #replaced, #uid

Instance Method Summary collapse

Methods inherited from Device

#check_validity, #dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all

Constructor Details

#initialize(uid, ipcon) ⇒ BrickletPiezoSpeakerV2

Creates an object with the unique device ID uid and adds it to the IP Connection ipcon.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 67

def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_SET_BEEP] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_BEEP] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ALARM] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_ALARM] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_UPDATE_VOLUME] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_UPDATE_FREQUENCY] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_BEEP_FINISHED] = [8, '']
  @callback_formats[CALLBACK_ALARM_FINISHED] = [8, '']

  @ipcon.add_device self
end

Instance Method Details

#get_alarm ⇒ Object

Returns the last alarm settings as set by BrickletPiezoSpeakerV2#set_alarm. 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 BrickletPiezoSpeakerV2#update_volume) this function returns the updated value.



170
171
172
173
174
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 170

def get_alarm
  check_validity

  send_request FUNCTION_GET_ALARM, [], '', 27, 'S S S S C L L S'
end

#get_beep ⇒ Object

Returns the last beep settings as set by BrickletPiezoSpeakerV2#set_beep. 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 BrickletPiezoSpeakerV2#update_frequency or BrickletPiezoSpeakerV2#update_volume) this function returns the updated value.



112
113
114
115
116
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 112

def get_beep
  check_validity

  send_request FUNCTION_GET_BEEP, [], '', 19, 'S C L L'
end

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletPiezoSpeakerV2#set_bootloader_mode.



223
224
225
226
227
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 223

def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end

#get_chip_temperature ⇒ Object

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.



281
282
283
284
285
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 281

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end

#get_identity ⇒ Object

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|



328
329
330
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 328

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end

#get_spitfp_error_count ⇒ Object

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.



201
202
203
204
205
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 201

def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end

#get_status_led_config ⇒ Object

Returns the configuration as set by BrickletPiezoSpeakerV2#set_status_led_config



269
270
271
272
273
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 269

def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end

#read_uid ⇒ Object

Returns the current UID as an integer. Encode as Base58 to get the usual string version.



312
313
314
315
316
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 312

def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



333
334
335
336
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 333

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end

#reset ⇒ Object

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!



293
294
295
296
297
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 293

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end

#set_alarm(start_frequency, end_frequency, step_size, step_delay, volume, duration) ⇒ Object

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



158
159
160
161
162
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 158

def set_alarm(start_frequency, end_frequency, step_size, step_delay, volume, duration)
  check_validity

  send_request FUNCTION_SET_ALARM, [start_frequency, end_frequency, step_size, step_delay, volume, duration], 'S S S S C L', 8, ''
end

#set_beep(frequency, volume, duration) ⇒ Object

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.



101
102
103
104
105
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 101

def set_beep(frequency, volume, duration)
  check_validity

  send_request FUNCTION_SET_BEEP, [frequency, volume, duration], 'S C L', 8, ''
end

#set_bootloader_mode(mode) ⇒ Object

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.



216
217
218
219
220
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 216

def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end

#set_status_led_config(config) ⇒ Object

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.



262
263
264
265
266
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 262

def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

Sets the firmware pointer for BrickletPiezoSpeakerV2#write_firmware. 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.



235
236
237
238
239
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 235

def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end

#update_frequency(frequency) ⇒ Object

Updates the frequency of an ongoing beep.



184
185
186
187
188
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 184

def update_frequency(frequency)
  check_validity

  send_request FUNCTION_UPDATE_FREQUENCY, [frequency], 'S', 8, ''
end

#update_volume(volume) ⇒ Object

Updates the volume of an ongoing beep or alarm.



177
178
179
180
181
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 177

def update_volume(volume)
  check_validity

  send_request FUNCTION_UPDATE_VOLUME, [volume], 'C', 8, ''
end

#write_firmware(data) ⇒ Object

Writes 64 Bytes of firmware at the position as written by BrickletPiezoSpeakerV2#set_write_firmware_pointer 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.



249
250
251
252
253
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 249

def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end

#write_uid(uid) ⇒ Object

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.



304
305
306
307
308
 
# File 'lib/tinkerforge/bricklet_piezo_speaker_v2.rb', line 304

def write_uid(uid)
  check_validity

  send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
end