Class: Tinkerforge::BrickletIndustrialAnalogOutV2

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

Overview

Generates configurable DC voltage and current, 0V to 10V and 4mA to 20mA

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2116
DEVICE_DISPLAY_NAME =

:nodoc:

'Industrial Analog Out Bricklet 2.0'
FUNCTION_SET_ENABLED =

:nodoc:

1
FUNCTION_GET_ENABLED =

:nodoc:

2
FUNCTION_SET_VOLTAGE =

:nodoc:

3
FUNCTION_GET_VOLTAGE =

:nodoc:

4
FUNCTION_SET_CURRENT =

:nodoc:

5
FUNCTION_GET_CURRENT =

:nodoc:

6
FUNCTION_SET_CONFIGURATION =

:nodoc:

7
FUNCTION_GET_CONFIGURATION =

:nodoc:

8
FUNCTION_SET_OUT_LED_CONFIG =

:nodoc:

9
FUNCTION_GET_OUT_LED_CONFIG =

:nodoc:

10
FUNCTION_SET_OUT_LED_STATUS_CONFIG =

:nodoc:

11
FUNCTION_GET_OUT_LED_STATUS_CONFIG =

:nodoc:

12
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
VOLTAGE_RANGE_0_TO_5V =

:nodoc:

0
VOLTAGE_RANGE_0_TO_10V =

:nodoc:

1
CURRENT_RANGE_4_TO_20MA =

:nodoc:

0
CURRENT_RANGE_0_TO_20MA =

:nodoc:

1
CURRENT_RANGE_0_TO_24MA =

:nodoc:

2
OUT_LED_CONFIG_OFF =

:nodoc:

0
OUT_LED_CONFIG_ON =

:nodoc:

1
OUT_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
OUT_LED_CONFIG_SHOW_OUT_STATUS =

:nodoc:

3
OUT_LED_STATUS_CONFIG_THRESHOLD =

:nodoc:

0
OUT_LED_STATUS_CONFIG_INTENSITY =

:nodoc:

1
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) ⇒ BrickletIndustrialAnalogOutV2

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 74

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

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_SET_ENABLED] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_ENABLED] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_VOLTAGE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_VOLTAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CURRENT] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_CURRENT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_OUT_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_OUT_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_OUT_LED_STATUS_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_OUT_LED_STATUS_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @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


  @ipcon.add_device self
end

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletIndustrialAnalogOutV2#set_bootloader_mode.



270
271
272
273
274
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 270

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.



328
329
330
331
332
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 328

def get_chip_temperature
  check_validity

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

#get_configuration ⇒ Object

Returns the configuration as set by BrickletIndustrialAnalogOutV2#set_configuration.



178
179
180
181
182
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 178

def get_configuration
  check_validity

  send_request FUNCTION_GET_CONFIGURATION, [], '', 10, 'C C'
end

#get_current ⇒ Object

Returns the current as set by BrickletIndustrialAnalogOutV2#set_current.



150
151
152
153
154
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 150

def get_current
  check_validity

  send_request FUNCTION_GET_CURRENT, [], '', 10, 'S'
end

#get_enabled ⇒ Object

Returns true if output of voltage and current is enabled, false otherwise.



116
117
118
119
120
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 116

def get_enabled
  check_validity

  send_request FUNCTION_GET_ENABLED, [], '', 9, '?'
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|



375
376
377
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 375

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

#get_out_led_config ⇒ Object

Returns the Out LED configuration as set by BrickletIndustrialAnalogOutV2#set_out_led_config



197
198
199
200
201
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 197

def get_out_led_config
  check_validity

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

#get_out_led_status_config ⇒ Object

Returns the Out LED status configuration as set by BrickletIndustrialAnalogOutV2#set_out_led_status_config.



231
232
233
234
235
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 231

def get_out_led_status_config
  check_validity

  send_request FUNCTION_GET_OUT_LED_STATUS_CONFIG, [], '', 13, 'S S C'
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.



248
249
250
251
252
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 248

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 BrickletIndustrialAnalogOutV2#set_status_led_config



316
317
318
319
320
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 316

def get_status_led_config
  check_validity

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

#get_voltage ⇒ Object

Returns the voltage as set by BrickletIndustrialAnalogOutV2#set_voltage.



133
134
135
136
137
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 133

def get_voltage
  check_validity

  send_request FUNCTION_GET_VOLTAGE, [], '', 10, 'S'
end

#read_uid ⇒ Object

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



359
360
361
362
363
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 359

def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
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!



340
341
342
343
344
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 340

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 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.



263
264
265
266
267
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 263

def set_bootloader_mode(mode)
  check_validity

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

#set_configuration(voltage_range, current_range) ⇒ Object

Configures the voltage and current range.

Possible voltage ranges are:

  • 0V to 5V

  • 0V to 10V

Possible current ranges are:

  • 4mA to 20mA

  • 0mA to 20mA

  • 0mA to 24mA

The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.



171
172
173
174
175
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 171

def set_configuration(voltage_range, current_range)
  check_validity

  send_request FUNCTION_SET_CONFIGURATION, [voltage_range, current_range], 'C C', 8, ''
end

#set_current(current) ⇒ Object

Sets the output current.

The output current and output voltage are linked. Changing the output current also changes the output voltage.



143
144
145
146
147
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 143

def set_current(current)
  check_validity

  send_request FUNCTION_SET_CURRENT, [current], 'S', 8, ''
end

#set_enabled(enabled) ⇒ Object

Enables/disables the output of voltage and current.



109
110
111
112
113
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 109

def set_enabled(enabled)
  check_validity

  send_request FUNCTION_SET_ENABLED, [enabled], '?', 8, ''
end

#set_out_led_config(config) ⇒ Object

You can turn the Out LED off, on or show a heartbeat. You can also set the LED to “Out Status”. In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the output value (voltage or current).

You can configure the channel status behavior with BrickletIndustrialAnalogOutV2#set_out_led_status_config.



190
191
192
193
194
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 190

def set_out_led_config(config)
  check_validity

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

#set_out_led_status_config(min, max, config) ⇒ Object

Sets the Out LED status config. This config is used if the Out LED is configured as “Out Status”, see BrickletIndustrialAnalogOutV2#set_out_led_config.

For each channel you can choose between threshold and intensity mode.

In threshold mode you can define a positive or a negative threshold. For a positive threshold set the “min” parameter to the threshold value in mV or µA above which the LED should turn on and set the “max” parameter to 0. Example: If you set a positive threshold of 5V, the LED will turn on as soon as the output value exceeds 5V and turn off again if it goes below 5V. For a negative threshold set the “max” parameter to the threshold value in mV or µA below which the LED should turn on and set the “min” parameter to 0. Example: If you set a negative threshold of 5V, the LED will turn on as soon as the output value goes below 5V and the LED will turn off when the output value exceeds 5V.

In intensity mode you can define a range mV or µA that is used to scale the brightness of the LED. Example with min=2V, max=8V: The LED is off at 2V and below, on at 8V and above and the brightness is linearly scaled between the values 2V and 8V. If the min value is greater than the max value, the LED brightness is scaled the other way around.



224
225
226
227
228
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 224

def set_out_led_status_config(min, max, config)
  check_validity

  send_request FUNCTION_SET_OUT_LED_STATUS_CONFIG, [min, max, config], 'S S C', 8, ''
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.



309
310
311
312
313
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 309

def set_status_led_config(config)
  check_validity

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

#set_voltage(voltage) ⇒ Object

Sets the output voltage.

The output voltage and output current are linked. Changing the output voltage also changes the output current.



126
127
128
129
130
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 126

def set_voltage(voltage)
  check_validity

  send_request FUNCTION_SET_VOLTAGE, [voltage], 'S', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

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



282
283
284
285
286
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 282

def set_write_firmware_pointer(pointer)
  check_validity

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

#write_firmware(data) ⇒ Object

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



296
297
298
299
300
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 296

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.



351
352
353
354
355
 
# File 'lib/tinkerforge/bricklet_industrial_analog_out_v2.rb', line 351

def write_uid(uid)
  check_validity

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