tinkerforge 2.1.23 → 2.1.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/tinkerforge/brick_dc.rb +156 -75
- data/lib/tinkerforge/brick_hat.rb +109 -30
- data/lib/tinkerforge/brick_hat_zero.rb +119 -21
- data/lib/tinkerforge/brick_imu.rb +191 -86
- data/lib/tinkerforge/brick_imu_v2.rb +219 -118
- data/lib/tinkerforge/brick_master.rb +495 -195
- data/lib/tinkerforge/brick_red.rb +197 -74
- data/lib/tinkerforge/brick_servo.rb +186 -102
- data/lib/tinkerforge/brick_silent_stepper.rb +248 -168
- data/lib/tinkerforge/brick_stepper.rb +212 -100
- data/lib/tinkerforge/bricklet_accelerometer.rb +61 -36
- data/lib/tinkerforge/bricklet_accelerometer_v2.rb +107 -63
- data/lib/tinkerforge/bricklet_air_quality.rb +123 -76
- data/lib/tinkerforge/bricklet_ambient_light.rb +62 -46
- data/lib/tinkerforge/bricklet_ambient_light_v2.rb +41 -28
- data/lib/tinkerforge/bricklet_ambient_light_v3.rb +61 -28
- data/lib/tinkerforge/bricklet_analog_in.rb +66 -45
- data/lib/tinkerforge/bricklet_analog_in_v2.rb +60 -43
- data/lib/tinkerforge/bricklet_analog_in_v3.rb +68 -32
- data/lib/tinkerforge/bricklet_analog_out.rb +25 -16
- data/lib/tinkerforge/bricklet_analog_out_v2.rb +21 -10
- data/lib/tinkerforge/bricklet_analog_out_v3.rb +55 -22
- data/lib/tinkerforge/bricklet_barometer.rb +108 -58
- data/lib/tinkerforge/bricklet_barometer_v2.rb +109 -67
- data/lib/tinkerforge/bricklet_can.rb +84 -24
- data/lib/tinkerforge/bricklet_can_v2.rb +173 -72
- data/lib/tinkerforge/bricklet_co2.rb +36 -25
- data/lib/tinkerforge/bricklet_co2_v2.rb +119 -60
- data/lib/tinkerforge/bricklet_color.rb +75 -47
- data/lib/tinkerforge/bricklet_color_v2.rb +91 -47
- data/lib/tinkerforge/bricklet_compass.rb +81 -40
- data/lib/tinkerforge/bricklet_current12.rb +61 -40
- data/lib/tinkerforge/bricklet_current25.rb +61 -40
- data/lib/tinkerforge/bricklet_distance_ir.rb +60 -38
- data/lib/tinkerforge/bricklet_distance_ir_v2.rb +85 -45
- data/lib/tinkerforge/bricklet_distance_us.rb +43 -30
- data/lib/tinkerforge/bricklet_distance_us_v2.rb +68 -33
- data/lib/tinkerforge/bricklet_dmx.rb +92 -48
- data/lib/tinkerforge/bricklet_dual_button.rb +23 -12
- data/lib/tinkerforge/bricklet_dual_button_v2.rb +64 -29
- data/lib/tinkerforge/bricklet_dual_relay.rb +27 -14
- data/lib/tinkerforge/bricklet_dust_detector.rb +43 -30
- data/lib/tinkerforge/bricklet_e_paper_296x128.rb +115 -63
- data/lib/tinkerforge/bricklet_energy_monitor.rb +81 -40
- data/lib/tinkerforge/bricklet_gps.rb +72 -48
- data/lib/tinkerforge/bricklet_gps_v2.rb +124 -73
- data/lib/tinkerforge/bricklet_hall_effect.rb +43 -28
- data/lib/tinkerforge/bricklet_hall_effect_v2.rb +76 -44
- data/lib/tinkerforge/bricklet_humidity.rb +54 -38
- data/lib/tinkerforge/bricklet_humidity_v2.rb +86 -49
- data/lib/tinkerforge/bricklet_imu_v3.rb +784 -0
- data/lib/tinkerforge/bricklet_industrial_analog_out.rb +41 -18
- data/lib/tinkerforge/bricklet_industrial_analog_out_v2.rb +84 -40
- data/lib/tinkerforge/bricklet_industrial_counter.rb +102 -59
- data/lib/tinkerforge/bricklet_industrial_digital_in_4.rb +51 -24
- data/lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb +79 -40
- data/lib/tinkerforge/bricklet_industrial_digital_out_4.rb +36 -15
- data/lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb +75 -33
- data/lib/tinkerforge/bricklet_industrial_dual_0_20ma.rb +43 -29
- data/lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb +81 -44
- data/lib/tinkerforge/bricklet_industrial_dual_ac_relay.rb +325 -0
- data/lib/tinkerforge/bricklet_industrial_dual_analog_in.rb +51 -30
- data/lib/tinkerforge/bricklet_industrial_dual_analog_in_v2.rb +139 -40
- data/lib/tinkerforge/bricklet_industrial_dual_relay.rb +63 -28
- data/lib/tinkerforge/bricklet_industrial_quad_relay.rb +36 -15
- data/lib/tinkerforge/bricklet_industrial_quad_relay_v2.rb +67 -28
- data/lib/tinkerforge/bricklet_io16.rb +57 -32
- data/lib/tinkerforge/bricklet_io16_v2.rb +93 -48
- data/lib/tinkerforge/bricklet_io4.rb +56 -31
- data/lib/tinkerforge/bricklet_io4_v2.rb +109 -57
- data/lib/tinkerforge/bricklet_isolator.rb +111 -35
- data/lib/tinkerforge/bricklet_joystick.rb +63 -42
- data/lib/tinkerforge/bricklet_joystick_v2.rb +71 -35
- data/lib/tinkerforge/bricklet_laser_range_finder.rb +87 -59
- data/lib/tinkerforge/bricklet_laser_range_finder_v2.rb +99 -51
- data/lib/tinkerforge/bricklet_lcd_128x64.rb +219 -131
- data/lib/tinkerforge/bricklet_lcd_16x2.rb +49 -25
- data/lib/tinkerforge/bricklet_lcd_20x4.rb +59 -29
- data/lib/tinkerforge/bricklet_led_strip.rb +69 -47
- data/lib/tinkerforge/bricklet_led_strip_v2.rb +105 -48
- data/lib/tinkerforge/bricklet_line.rb +35 -22
- data/lib/tinkerforge/bricklet_linear_poti.rb +53 -35
- data/lib/tinkerforge/bricklet_linear_poti_v2.rb +55 -24
- data/lib/tinkerforge/bricklet_load_cell.rb +64 -40
- data/lib/tinkerforge/bricklet_load_cell_v2.rb +81 -41
- data/lib/tinkerforge/bricklet_moisture.rb +43 -30
- data/lib/tinkerforge/bricklet_motion_detector.rb +21 -10
- data/lib/tinkerforge/bricklet_motion_detector_v2.rb +62 -29
- data/lib/tinkerforge/bricklet_motorized_linear_poti.rb +71 -32
- data/lib/tinkerforge/bricklet_multi_touch.rb +30 -17
- data/lib/tinkerforge/bricklet_multi_touch_v2.rb +76 -39
- data/lib/tinkerforge/bricklet_nfc.rb +130 -80
- data/lib/tinkerforge/bricklet_nfc_rfid.rb +32 -13
- data/lib/tinkerforge/bricklet_oled_128x64.rb +30 -17
- data/lib/tinkerforge/bricklet_oled_128x64_v2.rb +75 -40
- data/lib/tinkerforge/bricklet_oled_64x48.rb +30 -17
- data/lib/tinkerforge/bricklet_one_wire.rb +65 -24
- data/lib/tinkerforge/bricklet_outdoor_weather.rb +84 -41
- data/lib/tinkerforge/bricklet_particulate_matter.rb +85 -37
- data/lib/tinkerforge/bricklet_performance_dc.rb +676 -0
- data/lib/tinkerforge/bricklet_piezo_buzzer.rb +19 -13
- data/lib/tinkerforge/bricklet_piezo_speaker.rb +22 -19
- data/lib/tinkerforge/bricklet_piezo_speaker_v2.rb +84 -57
- data/lib/tinkerforge/bricklet_ptc.rb +76 -51
- data/lib/tinkerforge/bricklet_ptc_v2.rb +96 -54
- data/lib/tinkerforge/bricklet_real_time_clock.rb +45 -36
- data/lib/tinkerforge/bricklet_real_time_clock_v2.rb +78 -47
- data/lib/tinkerforge/bricklet_remote_switch.rb +38 -29
- data/lib/tinkerforge/bricklet_remote_switch_v2.rb +86 -49
- data/lib/tinkerforge/bricklet_rgb_led.rb +17 -8
- data/lib/tinkerforge/bricklet_rgb_led_button.rb +61 -30
- data/lib/tinkerforge/bricklet_rgb_led_matrix.rb +78 -33
- data/lib/tinkerforge/bricklet_rgb_led_v2.rb +51 -20
- data/lib/tinkerforge/bricklet_rotary_encoder.rb +40 -25
- data/lib/tinkerforge/bricklet_rotary_encoder_v2.rb +60 -27
- data/lib/tinkerforge/bricklet_rotary_poti.rb +55 -37
- data/lib/tinkerforge/bricklet_rotary_poti_v2.rb +57 -26
- data/lib/tinkerforge/bricklet_rs232.rb +89 -28
- data/lib/tinkerforge/bricklet_rs232_v2.rb +121 -47
- data/lib/tinkerforge/bricklet_rs485.rb +250 -164
- data/lib/tinkerforge/bricklet_segment_display_4x7.rb +24 -14
- data/lib/tinkerforge/bricklet_segment_display_4x7_v2.rb +75 -36
- data/lib/tinkerforge/bricklet_servo_v2.rb +565 -0
- data/lib/tinkerforge/bricklet_solid_state_relay.rb +24 -13
- data/lib/tinkerforge/bricklet_solid_state_relay_v2.rb +58 -25
- data/lib/tinkerforge/bricklet_sound_intensity.rb +36 -24
- data/lib/tinkerforge/bricklet_sound_pressure_level.rb +77 -41
- data/lib/tinkerforge/bricklet_temperature.rb +43 -28
- data/lib/tinkerforge/bricklet_temperature_ir.rb +61 -47
- data/lib/tinkerforge/bricklet_temperature_ir_v2.rb +74 -44
- data/lib/tinkerforge/bricklet_temperature_v2.rb +62 -31
- data/lib/tinkerforge/bricklet_thermal_imaging.rb +118 -68
- data/lib/tinkerforge/bricklet_thermocouple.rb +46 -30
- data/lib/tinkerforge/bricklet_thermocouple_v2.rb +65 -30
- data/lib/tinkerforge/bricklet_tilt.rb +23 -10
- data/lib/tinkerforge/bricklet_uv_light.rb +37 -24
- data/lib/tinkerforge/bricklet_uv_light_v2.rb +87 -46
- data/lib/tinkerforge/bricklet_voltage.rb +54 -37
- data/lib/tinkerforge/bricklet_voltage_current.rb +94 -85
- data/lib/tinkerforge/bricklet_voltage_current_v2.rb +92 -77
- data/lib/tinkerforge/bricklet_xmc1400_breakout.rb +81 -36
- data/lib/tinkerforge/device_display_names.rb +167 -0
- data/lib/tinkerforge/ip_connection.rb +156 -33
- data/lib/tinkerforge/version.rb +1 -1
- metadata +8 -3
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
# -*- ruby encoding: utf-8 -*-
|
|
2
2
|
#############################################################
|
|
3
|
-
# This file was automatically generated on
|
|
3
|
+
# This file was automatically generated on 2021-01-15. #
|
|
4
4
|
# #
|
|
5
|
-
# Ruby Bindings Version 2.1.
|
|
5
|
+
# Ruby Bindings Version 2.1.28 #
|
|
6
6
|
# #
|
|
7
7
|
# If you have a bugfix for this file and want to commit it, #
|
|
8
8
|
# please fix the bug in the generator. You can find a link #
|
|
9
9
|
# to the generators git repository on tinkerforge.com #
|
|
10
10
|
#############################################################
|
|
11
11
|
|
|
12
|
+
require_relative './ip_connection'
|
|
13
|
+
|
|
12
14
|
module Tinkerforge
|
|
13
15
|
# Reads temperatures from Pt100 und Pt1000 sensors
|
|
14
16
|
class BrickletPTC < Device
|
|
@@ -90,7 +92,7 @@ module Tinkerforge
|
|
|
90
92
|
# Creates an object with the unique device ID <tt>uid</tt> and adds it to
|
|
91
93
|
# the IP Connection <tt>ipcon</tt>.
|
|
92
94
|
def initialize(uid, ipcon)
|
|
93
|
-
super uid, ipcon
|
|
95
|
+
super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME
|
|
94
96
|
|
|
95
97
|
@api_version = [2, 0, 1]
|
|
96
98
|
|
|
@@ -115,23 +117,24 @@ module Tinkerforge
|
|
|
115
117
|
@response_expected[FUNCTION_GET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
|
|
116
118
|
@response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
|
|
117
119
|
|
|
118
|
-
@callback_formats[CALLBACK_TEMPERATURE] = 'l'
|
|
119
|
-
@callback_formats[CALLBACK_TEMPERATURE_REACHED] = 'l'
|
|
120
|
-
@callback_formats[CALLBACK_RESISTANCE] = 'l'
|
|
121
|
-
@callback_formats[CALLBACK_RESISTANCE_REACHED] = 'l'
|
|
122
|
-
@callback_formats[CALLBACK_SENSOR_CONNECTED] = '?'
|
|
120
|
+
@callback_formats[CALLBACK_TEMPERATURE] = [12, 'l']
|
|
121
|
+
@callback_formats[CALLBACK_TEMPERATURE_REACHED] = [12, 'l']
|
|
122
|
+
@callback_formats[CALLBACK_RESISTANCE] = [12, 'l']
|
|
123
|
+
@callback_formats[CALLBACK_RESISTANCE_REACHED] = [12, 'l']
|
|
124
|
+
@callback_formats[CALLBACK_SENSOR_CONNECTED] = [9, '?']
|
|
123
125
|
|
|
126
|
+
@ipcon.add_device self
|
|
124
127
|
end
|
|
125
128
|
|
|
126
|
-
# Returns the temperature of connected sensor.
|
|
127
|
-
# has a range of -246 to 849 °C and is given in °C/100,
|
|
128
|
-
# e.g. a value of 4223 means that a temperature of 42.23 °C is measured.
|
|
129
|
+
# Returns the temperature of connected sensor.
|
|
129
130
|
#
|
|
130
131
|
# If you want to get the temperature periodically, it is recommended
|
|
131
132
|
# to use the CALLBACK_TEMPERATURE callback and set the period with
|
|
132
133
|
# BrickletPTC#set_temperature_callback_period.
|
|
133
134
|
def get_temperature
|
|
134
|
-
|
|
135
|
+
check_validity
|
|
136
|
+
|
|
137
|
+
send_request FUNCTION_GET_TEMPERATURE, [], '', 12, 'l'
|
|
135
138
|
end
|
|
136
139
|
|
|
137
140
|
# Returns the value as measured by the MAX31865 precision delta-sigma ADC.
|
|
@@ -145,39 +148,45 @@ module Tinkerforge
|
|
|
145
148
|
# to use the CALLBACK_RESISTANCE callback and set the period with
|
|
146
149
|
# BrickletPTC#set_resistance_callback_period.
|
|
147
150
|
def get_resistance
|
|
148
|
-
|
|
151
|
+
check_validity
|
|
152
|
+
|
|
153
|
+
send_request FUNCTION_GET_RESISTANCE, [], '', 12, 'l'
|
|
149
154
|
end
|
|
150
155
|
|
|
151
|
-
# Sets the period
|
|
156
|
+
# Sets the period with which the CALLBACK_TEMPERATURE callback is triggered
|
|
152
157
|
# periodically. A value of 0 turns the callback off.
|
|
153
158
|
#
|
|
154
159
|
# The CALLBACK_TEMPERATURE callback is only triggered if the temperature has
|
|
155
160
|
# changed since the last triggering.
|
|
156
|
-
#
|
|
157
|
-
# The default value is 0.
|
|
158
161
|
def set_temperature_callback_period(period)
|
|
159
|
-
|
|
162
|
+
check_validity
|
|
163
|
+
|
|
164
|
+
send_request FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD, [period], 'L', 8, ''
|
|
160
165
|
end
|
|
161
166
|
|
|
162
167
|
# Returns the period as set by BrickletPTC#set_temperature_callback_period.
|
|
163
168
|
def get_temperature_callback_period
|
|
164
|
-
|
|
169
|
+
check_validity
|
|
170
|
+
|
|
171
|
+
send_request FUNCTION_GET_TEMPERATURE_CALLBACK_PERIOD, [], '', 12, 'L'
|
|
165
172
|
end
|
|
166
173
|
|
|
167
|
-
# Sets the period
|
|
174
|
+
# Sets the period with which the CALLBACK_RESISTANCE callback is triggered
|
|
168
175
|
# periodically. A value of 0 turns the callback off.
|
|
169
176
|
#
|
|
170
177
|
# The CALLBACK_RESISTANCE callback is only triggered if the resistance has changed
|
|
171
178
|
# since the last triggering.
|
|
172
|
-
#
|
|
173
|
-
# The default value is 0.
|
|
174
179
|
def set_resistance_callback_period(period)
|
|
175
|
-
|
|
180
|
+
check_validity
|
|
181
|
+
|
|
182
|
+
send_request FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD, [period], 'L', 8, ''
|
|
176
183
|
end
|
|
177
184
|
|
|
178
185
|
# Returns the period as set by BrickletPTC#set_resistance_callback_period.
|
|
179
186
|
def get_resistance_callback_period
|
|
180
|
-
|
|
187
|
+
check_validity
|
|
188
|
+
|
|
189
|
+
send_request FUNCTION_GET_RESISTANCE_CALLBACK_PERIOD, [], '', 12, 'L'
|
|
181
190
|
end
|
|
182
191
|
|
|
183
192
|
# Sets the thresholds for the CALLBACK_TEMPERATURE_REACHED callback.
|
|
@@ -191,15 +200,17 @@ module Tinkerforge
|
|
|
191
200
|
# "'i'", "Callback is triggered when the temperature is *inside* the min and max values"
|
|
192
201
|
# "'<'", "Callback is triggered when the temperature is smaller than the min value (max is ignored)"
|
|
193
202
|
# "'>'", "Callback is triggered when the temperature is greater than the min value (max is ignored)"
|
|
194
|
-
#
|
|
195
|
-
# The default value is ('x', 0, 0).
|
|
196
203
|
def set_temperature_callback_threshold(option, min, max)
|
|
197
|
-
|
|
204
|
+
check_validity
|
|
205
|
+
|
|
206
|
+
send_request FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD, [option, min, max], 'k l l', 8, ''
|
|
198
207
|
end
|
|
199
208
|
|
|
200
209
|
# Returns the threshold as set by BrickletPTC#set_temperature_callback_threshold.
|
|
201
210
|
def get_temperature_callback_threshold
|
|
202
|
-
|
|
211
|
+
check_validity
|
|
212
|
+
|
|
213
|
+
send_request FUNCTION_GET_TEMPERATURE_CALLBACK_THRESHOLD, [], '', 17, 'k l l'
|
|
203
214
|
end
|
|
204
215
|
|
|
205
216
|
# Sets the thresholds for the CALLBACK_RESISTANCE_REACHED callback.
|
|
@@ -213,18 +224,20 @@ module Tinkerforge
|
|
|
213
224
|
# "'i'", "Callback is triggered when the temperature is *inside* the min and max values"
|
|
214
225
|
# "'<'", "Callback is triggered when the temperature is smaller than the min value (max is ignored)"
|
|
215
226
|
# "'>'", "Callback is triggered when the temperature is greater than the min value (max is ignored)"
|
|
216
|
-
#
|
|
217
|
-
# The default value is ('x', 0, 0).
|
|
218
227
|
def set_resistance_callback_threshold(option, min, max)
|
|
219
|
-
|
|
228
|
+
check_validity
|
|
229
|
+
|
|
230
|
+
send_request FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD, [option, min, max], 'k l l', 8, ''
|
|
220
231
|
end
|
|
221
232
|
|
|
222
233
|
# Returns the threshold as set by BrickletPTC#set_resistance_callback_threshold.
|
|
223
234
|
def get_resistance_callback_threshold
|
|
224
|
-
|
|
235
|
+
check_validity
|
|
236
|
+
|
|
237
|
+
send_request FUNCTION_GET_RESISTANCE_CALLBACK_THRESHOLD, [], '', 17, 'k l l'
|
|
225
238
|
end
|
|
226
239
|
|
|
227
|
-
# Sets the period
|
|
240
|
+
# Sets the period with which the threshold callback
|
|
228
241
|
#
|
|
229
242
|
# * CALLBACK_TEMPERATURE_REACHED,
|
|
230
243
|
# * CALLBACK_RESISTANCE_REACHED
|
|
@@ -235,31 +248,35 @@ module Tinkerforge
|
|
|
235
248
|
# * BrickletPTC#set_resistance_callback_threshold
|
|
236
249
|
#
|
|
237
250
|
# keeps being reached.
|
|
238
|
-
#
|
|
239
|
-
# The default value is 100.
|
|
240
251
|
def set_debounce_period(debounce)
|
|
241
|
-
|
|
252
|
+
check_validity
|
|
253
|
+
|
|
254
|
+
send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, ''
|
|
242
255
|
end
|
|
243
256
|
|
|
244
257
|
# Returns the debounce period as set by BrickletPTC#set_debounce_period.
|
|
245
258
|
def get_debounce_period
|
|
246
|
-
|
|
259
|
+
check_validity
|
|
260
|
+
|
|
261
|
+
send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 12, 'L'
|
|
247
262
|
end
|
|
248
263
|
|
|
249
264
|
# Sets the noise rejection filter to either 50Hz (0) or 60Hz (1).
|
|
250
265
|
# Noise from 50Hz or 60Hz power sources (including
|
|
251
266
|
# harmonics of the AC power's fundamental frequency) is
|
|
252
267
|
# attenuated by 82dB.
|
|
253
|
-
#
|
|
254
|
-
# Default value is 0 = 50Hz.
|
|
255
268
|
def set_noise_rejection_filter(filter)
|
|
256
|
-
|
|
269
|
+
check_validity
|
|
270
|
+
|
|
271
|
+
send_request FUNCTION_SET_NOISE_REJECTION_FILTER, [filter], 'C', 8, ''
|
|
257
272
|
end
|
|
258
273
|
|
|
259
274
|
# Returns the noise rejection filter option as set by
|
|
260
275
|
# BrickletPTC#set_noise_rejection_filter
|
|
261
276
|
def get_noise_rejection_filter
|
|
262
|
-
|
|
277
|
+
check_validity
|
|
278
|
+
|
|
279
|
+
send_request FUNCTION_GET_NOISE_REJECTION_FILTER, [], '', 9, 'C'
|
|
263
280
|
end
|
|
264
281
|
|
|
265
282
|
# Returns *true* if the sensor is connected correctly.
|
|
@@ -268,50 +285,58 @@ module Tinkerforge
|
|
|
268
285
|
# returns *false*, there is either no Pt100 or Pt1000 sensor connected,
|
|
269
286
|
# the sensor is connected incorrectly or the sensor itself is faulty.
|
|
270
287
|
def is_sensor_connected
|
|
271
|
-
|
|
288
|
+
check_validity
|
|
289
|
+
|
|
290
|
+
send_request FUNCTION_IS_SENSOR_CONNECTED, [], '', 9, '?'
|
|
272
291
|
end
|
|
273
292
|
|
|
274
293
|
# Sets the wire mode of the sensor. Possible values are 2, 3 and 4 which
|
|
275
294
|
# correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper
|
|
276
295
|
# configuration on the Bricklet.
|
|
277
|
-
#
|
|
278
|
-
# The default value is 2 = 2-wire.
|
|
279
296
|
def set_wire_mode(mode)
|
|
280
|
-
|
|
297
|
+
check_validity
|
|
298
|
+
|
|
299
|
+
send_request FUNCTION_SET_WIRE_MODE, [mode], 'C', 8, ''
|
|
281
300
|
end
|
|
282
301
|
|
|
283
302
|
# Returns the wire mode as set by BrickletPTC#set_wire_mode
|
|
284
303
|
def get_wire_mode
|
|
285
|
-
|
|
304
|
+
check_validity
|
|
305
|
+
|
|
306
|
+
send_request FUNCTION_GET_WIRE_MODE, [], '', 9, 'C'
|
|
286
307
|
end
|
|
287
308
|
|
|
288
309
|
# If you enable this callback, the CALLBACK_SENSOR_CONNECTED callback is triggered
|
|
289
310
|
# every time a Pt sensor is connected/disconnected.
|
|
290
311
|
#
|
|
291
|
-
# By default this callback is disabled.
|
|
292
|
-
#
|
|
293
312
|
# .. versionadded:: 2.0.2$nbsp;(Plugin)
|
|
294
313
|
def set_sensor_connected_callback_configuration(enabled)
|
|
295
|
-
|
|
314
|
+
check_validity
|
|
315
|
+
|
|
316
|
+
send_request FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION, [enabled], '?', 8, ''
|
|
296
317
|
end
|
|
297
318
|
|
|
298
319
|
# Returns the configuration as set by BrickletPTC#set_sensor_connected_callback_configuration.
|
|
299
320
|
#
|
|
300
321
|
# .. versionadded:: 2.0.2$nbsp;(Plugin)
|
|
301
322
|
def get_sensor_connected_callback_configuration
|
|
302
|
-
|
|
323
|
+
check_validity
|
|
324
|
+
|
|
325
|
+
send_request FUNCTION_GET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION, [], '', 9, '?'
|
|
303
326
|
end
|
|
304
327
|
|
|
305
328
|
# Returns the UID, the UID where the Bricklet is connected to,
|
|
306
329
|
# the position, the hardware and firmware version as well as the
|
|
307
330
|
# device identifier.
|
|
308
331
|
#
|
|
309
|
-
# The position can be 'a', 'b', 'c' or '
|
|
332
|
+
# The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port).
|
|
333
|
+
# A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at
|
|
334
|
+
# position 'z'.
|
|
310
335
|
#
|
|
311
336
|
# The device identifier numbers can be found :ref:`here <device_identifier>`.
|
|
312
337
|
# |device_identifier_constant|
|
|
313
338
|
def get_identity
|
|
314
|
-
send_request FUNCTION_GET_IDENTITY, [], '',
|
|
339
|
+
send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
|
|
315
340
|
end
|
|
316
341
|
|
|
317
342
|
# Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.
|
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
# -*- ruby encoding: utf-8 -*-
|
|
2
2
|
#############################################################
|
|
3
|
-
# This file was automatically generated on
|
|
3
|
+
# This file was automatically generated on 2021-01-15. #
|
|
4
4
|
# #
|
|
5
|
-
# Ruby Bindings Version 2.1.
|
|
5
|
+
# Ruby Bindings Version 2.1.28 #
|
|
6
6
|
# #
|
|
7
7
|
# If you have a bugfix for this file and want to commit it, #
|
|
8
8
|
# please fix the bug in the generator. You can find a link #
|
|
9
9
|
# to the generators git repository on tinkerforge.com #
|
|
10
10
|
#############################################################
|
|
11
11
|
|
|
12
|
+
require_relative './ip_connection'
|
|
13
|
+
|
|
12
14
|
module Tinkerforge
|
|
13
15
|
# Reads temperatures from Pt100 und Pt1000 sensors
|
|
14
16
|
class BrickletPTCV2 < Device
|
|
@@ -90,7 +92,7 @@ module Tinkerforge
|
|
|
90
92
|
# Creates an object with the unique device ID <tt>uid</tt> and adds it to
|
|
91
93
|
# the IP Connection <tt>ipcon</tt>.
|
|
92
94
|
def initialize(uid, ipcon)
|
|
93
|
-
super uid, ipcon
|
|
95
|
+
super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME
|
|
94
96
|
|
|
95
97
|
@api_version = [2, 0, 0]
|
|
96
98
|
|
|
@@ -122,25 +124,26 @@ module Tinkerforge
|
|
|
122
124
|
@response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
|
|
123
125
|
@response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
|
|
124
126
|
|
|
125
|
-
@callback_formats[CALLBACK_TEMPERATURE] = 'l'
|
|
126
|
-
@callback_formats[CALLBACK_RESISTANCE] = 'l'
|
|
127
|
-
@callback_formats[CALLBACK_SENSOR_CONNECTED] = '?'
|
|
127
|
+
@callback_formats[CALLBACK_TEMPERATURE] = [12, 'l']
|
|
128
|
+
@callback_formats[CALLBACK_RESISTANCE] = [12, 'l']
|
|
129
|
+
@callback_formats[CALLBACK_SENSOR_CONNECTED] = [9, '?']
|
|
128
130
|
|
|
131
|
+
@ipcon.add_device self
|
|
129
132
|
end
|
|
130
133
|
|
|
131
|
-
# Returns the temperature of the connected sensor.
|
|
132
|
-
# has a range of -246 to 849 °C and is given in °C/100,
|
|
133
|
-
# e.g. a value of 4223 means that a temperature of 42.23 °C is measured.
|
|
134
|
+
# Returns the temperature of the connected sensor.
|
|
134
135
|
#
|
|
135
136
|
#
|
|
136
137
|
# If you want to get the value periodically, it is recommended to use the
|
|
137
138
|
# CALLBACK_TEMPERATURE callback. You can set the callback configuration
|
|
138
139
|
# with BrickletPTCV2#set_temperature_callback_configuration.
|
|
139
140
|
def get_temperature
|
|
140
|
-
|
|
141
|
+
check_validity
|
|
142
|
+
|
|
143
|
+
send_request FUNCTION_GET_TEMPERATURE, [], '', 12, 'l'
|
|
141
144
|
end
|
|
142
145
|
|
|
143
|
-
# The period
|
|
146
|
+
# The period is the period with which the CALLBACK_TEMPERATURE callback is triggered
|
|
144
147
|
# periodically. A value of 0 turns the callback off.
|
|
145
148
|
#
|
|
146
149
|
# If the `value has to change`-parameter is set to true, the callback is only
|
|
@@ -165,15 +168,17 @@ module Tinkerforge
|
|
|
165
168
|
# "'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)"
|
|
166
169
|
#
|
|
167
170
|
# If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
|
|
168
|
-
#
|
|
169
|
-
# The default value is (0, false, 'x', 0, 0).
|
|
170
171
|
def set_temperature_callback_configuration(period, value_has_to_change, option, min, max)
|
|
171
|
-
|
|
172
|
+
check_validity
|
|
173
|
+
|
|
174
|
+
send_request FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
|
|
172
175
|
end
|
|
173
176
|
|
|
174
177
|
# Returns the callback configuration as set by BrickletPTCV2#set_temperature_callback_configuration.
|
|
175
178
|
def get_temperature_callback_configuration
|
|
176
|
-
|
|
179
|
+
check_validity
|
|
180
|
+
|
|
181
|
+
send_request FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
|
|
177
182
|
end
|
|
178
183
|
|
|
179
184
|
# Returns the value as measured by the MAX31865 precision delta-sigma ADC.
|
|
@@ -188,10 +193,12 @@ module Tinkerforge
|
|
|
188
193
|
# CALLBACK_RESISTANCE callback. You can set the callback configuration
|
|
189
194
|
# with BrickletPTCV2#set_resistance_callback_configuration.
|
|
190
195
|
def get_resistance
|
|
191
|
-
|
|
196
|
+
check_validity
|
|
197
|
+
|
|
198
|
+
send_request FUNCTION_GET_RESISTANCE, [], '', 12, 'l'
|
|
192
199
|
end
|
|
193
200
|
|
|
194
|
-
# The period
|
|
201
|
+
# The period is the period with which the CALLBACK_RESISTANCE callback is triggered
|
|
195
202
|
# periodically. A value of 0 turns the callback off.
|
|
196
203
|
#
|
|
197
204
|
# If the `value has to change`-parameter is set to true, the callback is only
|
|
@@ -216,31 +223,35 @@ module Tinkerforge
|
|
|
216
223
|
# "'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)"
|
|
217
224
|
#
|
|
218
225
|
# If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
|
|
219
|
-
#
|
|
220
|
-
# The default value is (0, false, 'x', 0, 0).
|
|
221
226
|
def set_resistance_callback_configuration(period, value_has_to_change, option, min, max)
|
|
222
|
-
|
|
227
|
+
check_validity
|
|
228
|
+
|
|
229
|
+
send_request FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
|
|
223
230
|
end
|
|
224
231
|
|
|
225
232
|
# Returns the callback configuration as set by BrickletPTCV2#set_resistance_callback_configuration.
|
|
226
233
|
def get_resistance_callback_configuration
|
|
227
|
-
|
|
234
|
+
check_validity
|
|
235
|
+
|
|
236
|
+
send_request FUNCTION_GET_RESISTANCE_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
|
|
228
237
|
end
|
|
229
238
|
|
|
230
239
|
# Sets the noise rejection filter to either 50Hz (0) or 60Hz (1).
|
|
231
240
|
# Noise from 50Hz or 60Hz power sources (including
|
|
232
241
|
# harmonics of the AC power's fundamental frequency) is
|
|
233
242
|
# attenuated by 82dB.
|
|
234
|
-
#
|
|
235
|
-
# Default value is 0 = 50Hz.
|
|
236
243
|
def set_noise_rejection_filter(filter)
|
|
237
|
-
|
|
244
|
+
check_validity
|
|
245
|
+
|
|
246
|
+
send_request FUNCTION_SET_NOISE_REJECTION_FILTER, [filter], 'C', 8, ''
|
|
238
247
|
end
|
|
239
248
|
|
|
240
249
|
# Returns the noise rejection filter option as set by
|
|
241
250
|
# BrickletPTCV2#set_noise_rejection_filter
|
|
242
251
|
def get_noise_rejection_filter
|
|
243
|
-
|
|
252
|
+
check_validity
|
|
253
|
+
|
|
254
|
+
send_request FUNCTION_GET_NOISE_REJECTION_FILTER, [], '', 9, 'C'
|
|
244
255
|
end
|
|
245
256
|
|
|
246
257
|
# Returns *true* if the sensor is connected correctly.
|
|
@@ -253,21 +264,25 @@ module Tinkerforge
|
|
|
253
264
|
# CALLBACK_SENSOR_CONNECTED callback. You can set the callback configuration
|
|
254
265
|
# with BrickletPTCV2#set_sensor_connected_callback_configuration.
|
|
255
266
|
def is_sensor_connected
|
|
256
|
-
|
|
267
|
+
check_validity
|
|
268
|
+
|
|
269
|
+
send_request FUNCTION_IS_SENSOR_CONNECTED, [], '', 9, '?'
|
|
257
270
|
end
|
|
258
271
|
|
|
259
272
|
# Sets the wire mode of the sensor. Possible values are 2, 3 and 4 which
|
|
260
273
|
# correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper
|
|
261
274
|
# configuration on the Bricklet.
|
|
262
|
-
#
|
|
263
|
-
# The default value is 2 = 2-wire.
|
|
264
275
|
def set_wire_mode(mode)
|
|
265
|
-
|
|
276
|
+
check_validity
|
|
277
|
+
|
|
278
|
+
send_request FUNCTION_SET_WIRE_MODE, [mode], 'C', 8, ''
|
|
266
279
|
end
|
|
267
280
|
|
|
268
281
|
# Returns the wire mode as set by BrickletPTCV2#set_wire_mode
|
|
269
282
|
def get_wire_mode
|
|
270
|
-
|
|
283
|
+
check_validity
|
|
284
|
+
|
|
285
|
+
send_request FUNCTION_GET_WIRE_MODE, [], '', 9, 'C'
|
|
271
286
|
end
|
|
272
287
|
|
|
273
288
|
# Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__
|
|
@@ -276,34 +291,37 @@ module Tinkerforge
|
|
|
276
291
|
# Setting the length to 1 will turn the averaging off. With less
|
|
277
292
|
# averaging, there is more noise on the data.
|
|
278
293
|
#
|
|
279
|
-
# The range for the averaging is 1-1000.
|
|
280
|
-
#
|
|
281
294
|
# New data is gathered every 20ms. With a moving average of length 1000 the resulting
|
|
282
295
|
# averaging window has a length of 20s. If you want to do long term measurements the longest
|
|
283
296
|
# moving average will give the cleanest results.
|
|
284
297
|
#
|
|
285
|
-
# The default
|
|
286
|
-
# the non-changeable averaging settings of the old PTC Bricklet 1.0
|
|
298
|
+
# The default values match the non-changeable averaging settings of the old PTC Bricklet 1.0
|
|
287
299
|
def set_moving_average_configuration(moving_average_length_resistance, moving_average_length_temperature)
|
|
288
|
-
|
|
300
|
+
check_validity
|
|
301
|
+
|
|
302
|
+
send_request FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION, [moving_average_length_resistance, moving_average_length_temperature], 'S S', 8, ''
|
|
289
303
|
end
|
|
290
304
|
|
|
291
305
|
# Returns the moving average configuration as set by BrickletPTCV2#set_moving_average_configuration.
|
|
292
306
|
def get_moving_average_configuration
|
|
293
|
-
|
|
307
|
+
check_validity
|
|
308
|
+
|
|
309
|
+
send_request FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION, [], '', 12, 'S S'
|
|
294
310
|
end
|
|
295
311
|
|
|
296
312
|
# If you enable this callback, the CALLBACK_SENSOR_CONNECTED callback is triggered
|
|
297
313
|
# every time a Pt sensor is connected/disconnected.
|
|
298
|
-
#
|
|
299
|
-
# By default this callback is disabled.
|
|
300
314
|
def set_sensor_connected_callback_configuration(enabled)
|
|
301
|
-
|
|
315
|
+
check_validity
|
|
316
|
+
|
|
317
|
+
send_request FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION, [enabled], '?', 8, ''
|
|
302
318
|
end
|
|
303
319
|
|
|
304
320
|
# Returns the configuration as set by BrickletPTCV2#set_sensor_connected_callback_configuration.
|
|
305
321
|
def get_sensor_connected_callback_configuration
|
|
306
|
-
|
|
322
|
+
check_validity
|
|
323
|
+
|
|
324
|
+
send_request FUNCTION_GET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION, [], '', 9, '?'
|
|
307
325
|
end
|
|
308
326
|
|
|
309
327
|
# Returns the error count for the communication between Brick and Bricklet.
|
|
@@ -318,7 +336,9 @@ module Tinkerforge
|
|
|
318
336
|
# The errors counts are for errors that occur on the Bricklet side. All
|
|
319
337
|
# Bricks have a similar function that returns the errors on the Brick side.
|
|
320
338
|
def get_spitfp_error_count
|
|
321
|
-
|
|
339
|
+
check_validity
|
|
340
|
+
|
|
341
|
+
send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
|
|
322
342
|
end
|
|
323
343
|
|
|
324
344
|
# Sets the bootloader mode and returns the status after the requested
|
|
@@ -331,12 +351,16 @@ module Tinkerforge
|
|
|
331
351
|
# This function is used by Brick Viewer during flashing. It should not be
|
|
332
352
|
# necessary to call it in a normal user program.
|
|
333
353
|
def set_bootloader_mode(mode)
|
|
334
|
-
|
|
354
|
+
check_validity
|
|
355
|
+
|
|
356
|
+
send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
|
|
335
357
|
end
|
|
336
358
|
|
|
337
359
|
# Returns the current bootloader mode, see BrickletPTCV2#set_bootloader_mode.
|
|
338
360
|
def get_bootloader_mode
|
|
339
|
-
|
|
361
|
+
check_validity
|
|
362
|
+
|
|
363
|
+
send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
|
|
340
364
|
end
|
|
341
365
|
|
|
342
366
|
# Sets the firmware pointer for BrickletPTCV2#write_firmware. The pointer has
|
|
@@ -346,7 +370,9 @@ module Tinkerforge
|
|
|
346
370
|
# This function is used by Brick Viewer during flashing. It should not be
|
|
347
371
|
# necessary to call it in a normal user program.
|
|
348
372
|
def set_write_firmware_pointer(pointer)
|
|
349
|
-
|
|
373
|
+
check_validity
|
|
374
|
+
|
|
375
|
+
send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
|
|
350
376
|
end
|
|
351
377
|
|
|
352
378
|
# Writes 64 Bytes of firmware at the position as written by
|
|
@@ -358,7 +384,9 @@ module Tinkerforge
|
|
|
358
384
|
# This function is used by Brick Viewer during flashing. It should not be
|
|
359
385
|
# necessary to call it in a normal user program.
|
|
360
386
|
def write_firmware(data)
|
|
361
|
-
|
|
387
|
+
check_validity
|
|
388
|
+
|
|
389
|
+
send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
|
|
362
390
|
end
|
|
363
391
|
|
|
364
392
|
# Sets the status LED configuration. By default the LED shows
|
|
@@ -369,22 +397,28 @@ module Tinkerforge
|
|
|
369
397
|
#
|
|
370
398
|
# If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
|
|
371
399
|
def set_status_led_config(config)
|
|
372
|
-
|
|
400
|
+
check_validity
|
|
401
|
+
|
|
402
|
+
send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
|
|
373
403
|
end
|
|
374
404
|
|
|
375
405
|
# Returns the configuration as set by BrickletPTCV2#set_status_led_config
|
|
376
406
|
def get_status_led_config
|
|
377
|
-
|
|
407
|
+
check_validity
|
|
408
|
+
|
|
409
|
+
send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
|
|
378
410
|
end
|
|
379
411
|
|
|
380
|
-
# Returns the temperature
|
|
412
|
+
# Returns the temperature as measured inside the microcontroller. The
|
|
381
413
|
# value returned is not the ambient temperature!
|
|
382
414
|
#
|
|
383
415
|
# The temperature is only proportional to the real temperature and it has bad
|
|
384
416
|
# accuracy. Practically it is only useful as an indicator for
|
|
385
417
|
# temperature changes.
|
|
386
418
|
def get_chip_temperature
|
|
387
|
-
|
|
419
|
+
check_validity
|
|
420
|
+
|
|
421
|
+
send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
|
|
388
422
|
end
|
|
389
423
|
|
|
390
424
|
# Calling this function will reset the Bricklet. All configurations
|
|
@@ -394,7 +428,9 @@ module Tinkerforge
|
|
|
394
428
|
# calling functions on the existing ones will result in
|
|
395
429
|
# undefined behavior!
|
|
396
430
|
def reset
|
|
397
|
-
|
|
431
|
+
check_validity
|
|
432
|
+
|
|
433
|
+
send_request FUNCTION_RESET, [], '', 8, ''
|
|
398
434
|
end
|
|
399
435
|
|
|
400
436
|
# Writes a new UID into flash. If you want to set a new UID
|
|
@@ -403,25 +439,31 @@ module Tinkerforge
|
|
|
403
439
|
#
|
|
404
440
|
# We recommend that you use Brick Viewer to change the UID.
|
|
405
441
|
def write_uid(uid)
|
|
406
|
-
|
|
442
|
+
check_validity
|
|
443
|
+
|
|
444
|
+
send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
|
|
407
445
|
end
|
|
408
446
|
|
|
409
447
|
# Returns the current UID as an integer. Encode as
|
|
410
448
|
# Base58 to get the usual string version.
|
|
411
449
|
def read_uid
|
|
412
|
-
|
|
450
|
+
check_validity
|
|
451
|
+
|
|
452
|
+
send_request FUNCTION_READ_UID, [], '', 12, 'L'
|
|
413
453
|
end
|
|
414
454
|
|
|
415
455
|
# Returns the UID, the UID where the Bricklet is connected to,
|
|
416
456
|
# the position, the hardware and firmware version as well as the
|
|
417
457
|
# device identifier.
|
|
418
458
|
#
|
|
419
|
-
# The position can be 'a', 'b', 'c' or '
|
|
459
|
+
# The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port).
|
|
460
|
+
# A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at
|
|
461
|
+
# position 'z'.
|
|
420
462
|
#
|
|
421
463
|
# The device identifier numbers can be found :ref:`here <device_identifier>`.
|
|
422
464
|
# |device_identifier_constant|
|
|
423
465
|
def get_identity
|
|
424
|
-
send_request FUNCTION_GET_IDENTITY, [], '',
|
|
466
|
+
send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
|
|
425
467
|
end
|
|
426
468
|
|
|
427
469
|
# Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.
|