tinkerforge 2.1.23 → 2.1.24

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.
Files changed (141) hide show
  1. checksums.yaml +4 -4
  2. data/lib/tinkerforge/brick_dc.rb +2 -2
  3. data/lib/tinkerforge/brick_hat.rb +45 -4
  4. data/lib/tinkerforge/brick_hat_zero.rb +69 -3
  5. data/lib/tinkerforge/brick_imu.rb +8 -10
  6. data/lib/tinkerforge/brick_imu_v2.rb +12 -14
  7. data/lib/tinkerforge/brick_master.rb +6 -14
  8. data/lib/tinkerforge/brick_red.rb +2 -2
  9. data/lib/tinkerforge/brick_servo.rb +2 -2
  10. data/lib/tinkerforge/brick_silent_stepper.rb +3 -3
  11. data/lib/tinkerforge/brick_stepper.rb +3 -3
  12. data/lib/tinkerforge/bricklet_accelerometer.rb +7 -16
  13. data/lib/tinkerforge/bricklet_accelerometer_v2.rb +18 -24
  14. data/lib/tinkerforge/bricklet_air_quality.rb +13 -23
  15. data/lib/tinkerforge/bricklet_ambient_light.rb +14 -27
  16. data/lib/tinkerforge/bricklet_ambient_light_v2.rb +4 -8
  17. data/lib/tinkerforge/bricklet_ambient_light_v3.rb +3 -5
  18. data/lib/tinkerforge/bricklet_analog_in.rb +6 -22
  19. data/lib/tinkerforge/bricklet_analog_in_v2.rb +6 -22
  20. data/lib/tinkerforge/bricklet_analog_in_v3.rb +4 -9
  21. data/lib/tinkerforge/bricklet_analog_out.rb +5 -9
  22. data/lib/tinkerforge/bricklet_analog_out_v2.rb +4 -4
  23. data/lib/tinkerforge/bricklet_analog_out_v3.rb +4 -4
  24. data/lib/tinkerforge/bricklet_barometer.rb +10 -33
  25. data/lib/tinkerforge/bricklet_barometer_v2.rb +13 -32
  26. data/lib/tinkerforge/bricklet_can.rb +3 -7
  27. data/lib/tinkerforge/bricklet_can_v2.rb +8 -40
  28. data/lib/tinkerforge/bricklet_co2.rb +5 -13
  29. data/lib/tinkerforge/bricklet_co2_v2.rb +24 -24
  30. data/lib/tinkerforge/bricklet_color.rb +9 -22
  31. data/lib/tinkerforge/bricklet_color_v2.rb +7 -16
  32. data/lib/tinkerforge/bricklet_compass.rb +6 -12
  33. data/lib/tinkerforge/bricklet_current12.rb +6 -18
  34. data/lib/tinkerforge/bricklet_current25.rb +6 -18
  35. data/lib/tinkerforge/bricklet_distance_ir.rb +6 -17
  36. data/lib/tinkerforge/bricklet_distance_ir_v2.rb +5 -16
  37. data/lib/tinkerforge/bricklet_distance_us.rb +6 -16
  38. data/lib/tinkerforge/bricklet_distance_us_v2.rb +4 -10
  39. data/lib/tinkerforge/bricklet_dmx.rb +7 -16
  40. data/lib/tinkerforge/bricklet_dual_button.rb +2 -4
  41. data/lib/tinkerforge/bricklet_dual_button_v2.rb +3 -7
  42. data/lib/tinkerforge/bricklet_dual_relay.rb +3 -5
  43. data/lib/tinkerforge/bricklet_dust_detector.rb +6 -16
  44. data/lib/tinkerforge/bricklet_e_paper_296x128.rb +30 -33
  45. data/lib/tinkerforge/bricklet_energy_monitor.rb +11 -15
  46. data/lib/tinkerforge/bricklet_gps.rb +11 -24
  47. data/lib/tinkerforge/bricklet_gps_v2.rb +10 -28
  48. data/lib/tinkerforge/bricklet_hall_effect.rb +3 -7
  49. data/lib/tinkerforge/bricklet_hall_effect_v2.rb +8 -19
  50. data/lib/tinkerforge/bricklet_humidity.rb +6 -19
  51. data/lib/tinkerforge/bricklet_humidity_v2.rb +6 -20
  52. data/lib/tinkerforge/bricklet_industrial_analog_out.rb +6 -6
  53. data/lib/tinkerforge/bricklet_industrial_analog_out_v2.rb +6 -13
  54. data/lib/tinkerforge/bricklet_industrial_counter.rb +4 -22
  55. data/lib/tinkerforge/bricklet_industrial_digital_in_4.rb +9 -9
  56. data/lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb +5 -13
  57. data/lib/tinkerforge/bricklet_industrial_digital_out_4.rb +3 -3
  58. data/lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb +5 -8
  59. data/lib/tinkerforge/bricklet_industrial_dual_0_20ma.rb +6 -15
  60. data/lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb +4 -16
  61. data/lib/tinkerforge/bricklet_industrial_dual_analog_in.rb +5 -13
  62. data/lib/tinkerforge/bricklet_industrial_dual_analog_in_v2.rb +4 -11
  63. data/lib/tinkerforge/bricklet_industrial_dual_relay.rb +5 -7
  64. data/lib/tinkerforge/bricklet_industrial_quad_relay.rb +3 -3
  65. data/lib/tinkerforge/bricklet_industrial_quad_relay_v2.rb +3 -5
  66. data/lib/tinkerforge/bricklet_io16.rb +5 -13
  67. data/lib/tinkerforge/bricklet_io16_v2.rb +6 -16
  68. data/lib/tinkerforge/bricklet_io4.rb +4 -10
  69. data/lib/tinkerforge/bricklet_io4_v2.rb +16 -23
  70. data/lib/tinkerforge/bricklet_isolator.rb +44 -11
  71. data/lib/tinkerforge/bricklet_joystick.rb +7 -19
  72. data/lib/tinkerforge/bricklet_joystick_v2.rb +6 -11
  73. data/lib/tinkerforge/bricklet_laser_range_finder.rb +8 -29
  74. data/lib/tinkerforge/bricklet_laser_range_finder_v2.rb +6 -17
  75. data/lib/tinkerforge/bricklet_lcd_128x64.rb +30 -63
  76. data/lib/tinkerforge/bricklet_lcd_16x2.rb +7 -9
  77. data/lib/tinkerforge/bricklet_lcd_20x4.rb +4 -8
  78. data/lib/tinkerforge/bricklet_led_strip.rb +12 -27
  79. data/lib/tinkerforge/bricklet_led_strip_v2.rb +17 -4
  80. data/lib/tinkerforge/bricklet_line.rb +4 -10
  81. data/lib/tinkerforge/bricklet_linear_poti.rb +5 -16
  82. data/lib/tinkerforge/bricklet_linear_poti_v2.rb +3 -5
  83. data/lib/tinkerforge/bricklet_load_cell.rb +6 -19
  84. data/lib/tinkerforge/bricklet_load_cell_v2.rb +4 -13
  85. data/lib/tinkerforge/bricklet_moisture.rb +6 -16
  86. data/lib/tinkerforge/bricklet_motion_detector.rb +2 -2
  87. data/lib/tinkerforge/bricklet_motion_detector_v2.rb +3 -7
  88. data/lib/tinkerforge/bricklet_motorized_linear_poti.rb +3 -7
  89. data/lib/tinkerforge/bricklet_multi_touch.rb +2 -6
  90. data/lib/tinkerforge/bricklet_multi_touch_v2.rb +3 -13
  91. data/lib/tinkerforge/bricklet_nfc.rb +6 -20
  92. data/lib/tinkerforge/bricklet_nfc_rfid.rb +2 -2
  93. data/lib/tinkerforge/bricklet_oled_128x64.rb +4 -8
  94. data/lib/tinkerforge/bricklet_oled_128x64_v2.rb +12 -18
  95. data/lib/tinkerforge/bricklet_oled_64x48.rb +4 -8
  96. data/lib/tinkerforge/bricklet_one_wire.rb +2 -2
  97. data/lib/tinkerforge/bricklet_outdoor_weather.rb +16 -16
  98. data/lib/tinkerforge/bricklet_particulate_matter.rb +13 -9
  99. data/lib/tinkerforge/bricklet_piezo_buzzer.rb +3 -6
  100. data/lib/tinkerforge/bricklet_piezo_speaker.rb +3 -11
  101. data/lib/tinkerforge/bricklet_piezo_speaker_v2.rb +8 -18
  102. data/lib/tinkerforge/bricklet_ptc.rb +5 -11
  103. data/lib/tinkerforge/bricklet_ptc_v2.rb +4 -8
  104. data/lib/tinkerforge/bricklet_real_time_clock.rb +3 -5
  105. data/lib/tinkerforge/bricklet_real_time_clock_v2.rb +3 -5
  106. data/lib/tinkerforge/bricklet_remote_switch.rb +2 -2
  107. data/lib/tinkerforge/bricklet_remote_switch_v2.rb +2 -2
  108. data/lib/tinkerforge/bricklet_rgb_led.rb +2 -2
  109. data/lib/tinkerforge/bricklet_rgb_led_button.rb +2 -2
  110. data/lib/tinkerforge/bricklet_rgb_led_matrix.rb +2 -2
  111. data/lib/tinkerforge/bricklet_rgb_led_v2.rb +2 -2
  112. data/lib/tinkerforge/bricklet_rotary_encoder.rb +4 -8
  113. data/lib/tinkerforge/bricklet_rotary_encoder_v2.rb +3 -5
  114. data/lib/tinkerforge/bricklet_rotary_poti.rb +5 -11
  115. data/lib/tinkerforge/bricklet_rotary_poti_v2.rb +3 -5
  116. data/lib/tinkerforge/bricklet_rs232.rb +2 -2
  117. data/lib/tinkerforge/bricklet_rs232_v2.rb +6 -5
  118. data/lib/tinkerforge/bricklet_rs485.rb +30 -71
  119. data/lib/tinkerforge/bricklet_segment_display_4x7.rb +2 -2
  120. data/lib/tinkerforge/bricklet_segment_display_4x7_v2.rb +3 -3
  121. data/lib/tinkerforge/bricklet_solid_state_relay.rb +2 -2
  122. data/lib/tinkerforge/bricklet_solid_state_relay_v2.rb +2 -2
  123. data/lib/tinkerforge/bricklet_sound_intensity.rb +4 -8
  124. data/lib/tinkerforge/bricklet_sound_pressure_level.rb +8 -12
  125. data/lib/tinkerforge/bricklet_temperature.rb +6 -14
  126. data/lib/tinkerforge/bricklet_temperature_ir.rb +7 -26
  127. data/lib/tinkerforge/bricklet_temperature_ir_v2.rb +6 -19
  128. data/lib/tinkerforge/bricklet_temperature_v2.rb +4 -8
  129. data/lib/tinkerforge/bricklet_thermal_imaging.rb +16 -26
  130. data/lib/tinkerforge/bricklet_thermocouple.rb +4 -8
  131. data/lib/tinkerforge/bricklet_thermocouple_v2.rb +3 -5
  132. data/lib/tinkerforge/bricklet_tilt.rb +2 -2
  133. data/lib/tinkerforge/bricklet_uv_light.rb +4 -8
  134. data/lib/tinkerforge/bricklet_uv_light_v2.rb +5 -11
  135. data/lib/tinkerforge/bricklet_voltage.rb +5 -11
  136. data/lib/tinkerforge/bricklet_voltage_current.rb +6 -14
  137. data/lib/tinkerforge/bricklet_voltage_current_v2.rb +5 -11
  138. data/lib/tinkerforge/bricklet_xmc1400_breakout.rb +4 -8
  139. data/lib/tinkerforge/ip_connection.rb +3 -0
  140. data/lib/tinkerforge/version.rb +1 -1
  141. metadata +2 -2
@@ -1,8 +1,8 @@
1
1
  # -*- ruby encoding: utf-8 -*-
2
2
  #############################################################
3
- # This file was automatically generated on 2019-08-23. #
3
+ # This file was automatically generated on 2019-11-25. #
4
4
  # #
5
- # Ruby Bindings Version 2.1.23 #
5
+ # Ruby Bindings Version 2.1.24 #
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 #
@@ -107,9 +107,8 @@ module Tinkerforge
107
107
 
108
108
  end
109
109
 
110
- # Returns the position of the joystick. The value ranges between -100 and
111
- # 100 for both axis. The middle position of the joystick is x=0, y=0. The
112
- # returned values are averaged and calibrated (see BrickletJoystick#calibrate).
110
+ # Returns the position of the joystick. The middle position of the joystick is x=0, y=0.
111
+ # The returned values are averaged and calibrated (see BrickletJoystick#calibrate).
113
112
  #
114
113
  # If you want to get the position periodically, it is recommended to use the
115
114
  # CALLBACK_POSITION callback and set the period with
@@ -127,7 +126,6 @@ module Tinkerforge
127
126
  end
128
127
 
129
128
  # Returns the values as read by a 12-bit analog-to-digital converter.
130
- # The values are between 0 and 4095 for both axis.
131
129
  #
132
130
  # .. note::
133
131
  # The values returned by BrickletJoystick#get_position are averaged over several samples
@@ -152,13 +150,11 @@ module Tinkerforge
152
150
  send_request FUNCTION_CALIBRATE, [], '', 0, ''
153
151
  end
154
152
 
155
- # Sets the period in ms with which the CALLBACK_POSITION callback is triggered
153
+ # Sets the period with which the CALLBACK_POSITION callback is triggered
156
154
  # periodically. A value of 0 turns the callback off.
157
155
  #
158
156
  # The CALLBACK_POSITION callback is only triggered if the position has changed since the
159
157
  # last triggering.
160
- #
161
- # The default value is 0.
162
158
  def set_position_callback_period(period)
163
159
  send_request FUNCTION_SET_POSITION_CALLBACK_PERIOD, [period], 'L', 0, ''
164
160
  end
@@ -168,13 +164,11 @@ module Tinkerforge
168
164
  send_request FUNCTION_GET_POSITION_CALLBACK_PERIOD, [], '', 4, 'L'
169
165
  end
170
166
 
171
- # Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered
167
+ # Sets the period with which the CALLBACK_ANALOG_VALUE callback is triggered
172
168
  # periodically. A value of 0 turns the callback off.
173
169
  #
174
170
  # The CALLBACK_ANALOG_VALUE callback is only triggered if the analog values have
175
171
  # changed since the last triggering.
176
- #
177
- # The default value is 0.
178
172
  def set_analog_value_callback_period(period)
179
173
  send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD, [period], 'L', 0, ''
180
174
  end
@@ -195,8 +189,6 @@ module Tinkerforge
195
189
  # "'i'", "Callback is triggered when the position is *inside* the min and max values"
196
190
  # "'<'", "Callback is triggered when the position is smaller than the min values (max is ignored)"
197
191
  # "'>'", "Callback is triggered when the position is greater than the min values (max is ignored)"
198
- #
199
- # The default value is ('x', 0, 0, 0, 0).
200
192
  def set_position_callback_threshold(option, min_x, max_x, min_y, max_y)
201
193
  send_request FUNCTION_SET_POSITION_CALLBACK_THRESHOLD, [option, min_x, max_x, min_y, max_y], 'k s s s s', 0, ''
202
194
  end
@@ -217,8 +209,6 @@ module Tinkerforge
217
209
  # "'i'", "Callback is triggered when the analog values are *inside* the min and max values"
218
210
  # "'<'", "Callback is triggered when the analog values are smaller than the min values (max is ignored)"
219
211
  # "'>'", "Callback is triggered when the analog values are greater than the min values (max is ignored)"
220
- #
221
- # The default value is ('x', 0, 0, 0, 0).
222
212
  def set_analog_value_callback_threshold(option, min_x, max_x, min_y, max_y)
223
213
  send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD, [option, min_x, max_x, min_y, max_y], 'k S S S S', 0, ''
224
214
  end
@@ -228,7 +218,7 @@ module Tinkerforge
228
218
  send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD, [], '', 9, 'k S S S S'
229
219
  end
230
220
 
231
- # Sets the period in ms with which the threshold callbacks
221
+ # Sets the period with which the threshold callbacks
232
222
  #
233
223
  # * CALLBACK_POSITION_REACHED,
234
224
  # * CALLBACK_ANALOG_VALUE_REACHED
@@ -239,8 +229,6 @@ module Tinkerforge
239
229
  # * BrickletJoystick#set_analog_value_callback_threshold
240
230
  #
241
231
  # keep being reached.
242
- #
243
- # The default value is 100.
244
232
  def set_debounce_period(debounce)
245
233
  send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, ''
246
234
  end
@@ -1,8 +1,8 @@
1
1
  # -*- ruby encoding: utf-8 -*-
2
2
  #############################################################
3
- # This file was automatically generated on 2019-08-23. #
3
+ # This file was automatically generated on 2019-11-25. #
4
4
  # #
5
- # Ruby Bindings Version 2.1.23 #
5
+ # Ruby Bindings Version 2.1.24 #
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 #
@@ -95,9 +95,8 @@ module Tinkerforge
95
95
 
96
96
  end
97
97
 
98
- # Returns the position of the joystick. The value ranges between -100 and
99
- # 100 for both axis. The middle position of the joystick is x=0, y=0. The
100
- # returned values are averaged and calibrated (see BrickletJoystickV2#calibrate).
98
+ # Returns the position of the joystick. The middle position of the joystick is x=0, y=0.
99
+ # The returned values are averaged and calibrated (see BrickletJoystickV2#calibrate).
101
100
  #
102
101
  # If you want to get the position periodically, it is recommended to use the
103
102
  # CALLBACK_POSITION callback and set the period with
@@ -125,7 +124,7 @@ module Tinkerforge
125
124
  send_request FUNCTION_CALIBRATE, [], '', 0, ''
126
125
  end
127
126
 
128
- # The period in ms is the period with which the CALLBACK_POSITION
127
+ # The period is the period with which the CALLBACK_POSITION
129
128
  # callback is triggered periodically. A value of 0 turns the callback off.
130
129
  #
131
130
  # If the `value has to change`-parameter is set to true, the callback is only
@@ -134,8 +133,6 @@ module Tinkerforge
134
133
  #
135
134
  # If it is set to false, the callback is continuously triggered with the period,
136
135
  # independent of the value.
137
- #
138
- # The default value is (0, false).
139
136
  def set_position_callback_configuration(period, value_has_to_change)
140
137
  send_request FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
141
138
  end
@@ -146,7 +143,7 @@ module Tinkerforge
146
143
  send_request FUNCTION_GET_POSITION_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
147
144
  end
148
145
 
149
- # The period in ms is the period with which the CALLBACK_PRESSED
146
+ # The period is the period with which the CALLBACK_PRESSED
150
147
  # callback is triggered periodically. A value of 0 turns the callback off.
151
148
  #
152
149
  # If the `value has to change`-parameter is set to true, the callback is only
@@ -155,8 +152,6 @@ module Tinkerforge
155
152
  #
156
153
  # If it is set to false, the callback is continuously triggered with the period,
157
154
  # independent of the value.
158
- #
159
- # The default value is (0, false).
160
155
  def set_pressed_callback_configuration(period, value_has_to_change)
161
156
  send_request FUNCTION_SET_PRESSED_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
162
157
  end
@@ -1,8 +1,8 @@
1
1
  # -*- ruby encoding: utf-8 -*-
2
2
  #############################################################
3
- # This file was automatically generated on 2019-08-23. #
3
+ # This file was automatically generated on 2019-11-25. #
4
4
  # #
5
- # Ruby Bindings Version 2.1.23 #
5
+ # Ruby Bindings Version 2.1.24 #
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 #
@@ -122,8 +122,7 @@ module Tinkerforge
122
122
 
123
123
  end
124
124
 
125
- # Returns the measured distance. The value has a range of 0 to 4000
126
- # and is given in cm.
125
+ # Returns the measured distance.
127
126
  #
128
127
  # Sensor hardware version 1 (see BrickletLaserRangeFinder#get_sensor_hardware_version) cannot
129
128
  # measure distance and velocity at the same time. Therefore, the distance mode
@@ -138,8 +137,7 @@ module Tinkerforge
138
137
  send_request FUNCTION_GET_DISTANCE, [], '', 2, 'S'
139
138
  end
140
139
 
141
- # Returns the measured velocity. The value has a range of -12800 to 12700
142
- # and is given in 1/100 m/s.
140
+ # Returns the measured velocity.
143
141
  #
144
142
  # Sensor hardware version 1 (see BrickletLaserRangeFinder#get_sensor_hardware_version) cannot
145
143
  # measure distance and velocity at the same time. Therefore, the velocity mode
@@ -156,13 +154,11 @@ module Tinkerforge
156
154
  send_request FUNCTION_GET_VELOCITY, [], '', 2, 's'
157
155
  end
158
156
 
159
- # Sets the period in ms with which the CALLBACK_DISTANCE callback is triggered
157
+ # Sets the period with which the CALLBACK_DISTANCE callback is triggered
160
158
  # periodically. A value of 0 turns the callback off.
161
159
  #
162
160
  # The CALLBACK_DISTANCE callback is only triggered if the distance value has
163
161
  # changed since the last triggering.
164
- #
165
- # The default value is 0.
166
162
  def set_distance_callback_period(period)
167
163
  send_request FUNCTION_SET_DISTANCE_CALLBACK_PERIOD, [period], 'L', 0, ''
168
164
  end
@@ -172,13 +168,11 @@ module Tinkerforge
172
168
  send_request FUNCTION_GET_DISTANCE_CALLBACK_PERIOD, [], '', 4, 'L'
173
169
  end
174
170
 
175
- # Sets the period in ms with which the CALLBACK_VELOCITY callback is triggered
171
+ # Sets the period with which the CALLBACK_VELOCITY callback is triggered
176
172
  # periodically. A value of 0 turns the callback off.
177
173
  #
178
174
  # The CALLBACK_VELOCITY callback is only triggered if the velocity value has
179
175
  # changed since the last triggering.
180
- #
181
- # The default value is 0.
182
176
  def set_velocity_callback_period(period)
183
177
  send_request FUNCTION_SET_VELOCITY_CALLBACK_PERIOD, [period], 'L', 0, ''
184
178
  end
@@ -199,8 +193,6 @@ module Tinkerforge
199
193
  # "'i'", "Callback is triggered when the distance value is *inside* the min and max values"
200
194
  # "'<'", "Callback is triggered when the distance value is smaller than the min value (max is ignored)"
201
195
  # "'>'", "Callback is triggered when the distance value is greater than the min value (max is ignored)"
202
- #
203
- # The default value is ('x', 0, 0).
204
196
  def set_distance_callback_threshold(option, min, max)
205
197
  send_request FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
206
198
  end
@@ -221,8 +213,6 @@ module Tinkerforge
221
213
  # "'i'", "Callback is triggered when the velocity is *inside* the min and max values"
222
214
  # "'<'", "Callback is triggered when the velocity is smaller than the min value (max is ignored)"
223
215
  # "'>'", "Callback is triggered when the velocity is greater than the min value (max is ignored)"
224
- #
225
- # The default value is ('x', 0, 0).
226
216
  def set_velocity_callback_threshold(option, min, max)
227
217
  send_request FUNCTION_SET_VELOCITY_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 0, ''
228
218
  end
@@ -232,7 +222,7 @@ module Tinkerforge
232
222
  send_request FUNCTION_GET_VELOCITY_CALLBACK_THRESHOLD, [], '', 5, 'k s s'
233
223
  end
234
224
 
235
- # Sets the period in ms with which the threshold callbacks
225
+ # Sets the period with which the threshold callbacks
236
226
  #
237
227
  # * CALLBACK_DISTANCE_REACHED,
238
228
  # * CALLBACK_VELOCITY_REACHED,
@@ -243,8 +233,6 @@ module Tinkerforge
243
233
  # * BrickletLaserRangeFinder#set_velocity_callback_threshold,
244
234
  #
245
235
  # keep being reached.
246
- #
247
- # The default value is 100.
248
236
  def set_debounce_period(debounce)
249
237
  send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, ''
250
238
  end
@@ -259,10 +247,6 @@ module Tinkerforge
259
247
  #
260
248
  # Setting the length to 0 will turn the averaging completely off. With less
261
249
  # averaging, there is more noise on the data.
262
- #
263
- # The range for the averaging is 0-30.
264
- #
265
- # The default value is 10.
266
250
  def set_moving_average(distance_average_length, velocity_average_length)
267
251
  send_request FUNCTION_SET_MOVING_AVERAGE, [distance_average_length, velocity_average_length], 'C C', 0, ''
268
252
  end
@@ -283,13 +267,11 @@ module Tinkerforge
283
267
  #
284
268
  # The following modes are available:
285
269
  #
286
- # * 0: Distance is measured with resolution 1.0 cm and range 0-400 cm
270
+ # * 0: Distance is measured with resolution 1.0 cm and range 0-4000 cm
287
271
  # * 1: Velocity is measured with resolution 0.1 m/s and range is 0-12.7 m/s
288
272
  # * 2: Velocity is measured with resolution 0.25 m/s and range is 0-31.75 m/s
289
273
  # * 3: Velocity is measured with resolution 0.5 m/s and range is 0-63.5 m/s
290
274
  # * 4: Velocity is measured with resolution 1.0 m/s and range is 0-127 m/s
291
- #
292
- # The default mode is 0 (distance is measured).
293
275
  def set_mode(mode)
294
276
  send_request FUNCTION_SET_MODE, [mode], 'C', 0, ''
295
277
  end
@@ -354,9 +336,6 @@ module Tinkerforge
354
336
  # of the calculated velocity. The allowed values are 10Hz-500Hz (and 0 to turn the fixed
355
337
  # frequency off).
356
338
  #
357
- # The default values for Acquisition Count, Enable Quick Termination, Threshold Value and
358
- # Measurement Frequency are 128, false, 0 and 0.
359
- #
360
339
  # .. versionadded:: 2.0.3$nbsp;(Plugin)
361
340
  def set_configuration(acquisition_count, enable_quick_termination, threshold_value, measurement_frequency)
362
341
  send_request FUNCTION_SET_CONFIGURATION, [acquisition_count, enable_quick_termination, threshold_value, measurement_frequency], 'C ? C S', 0, ''
@@ -1,8 +1,8 @@
1
1
  # -*- ruby encoding: utf-8 -*-
2
2
  #############################################################
3
- # This file was automatically generated on 2019-08-23. #
3
+ # This file was automatically generated on 2019-11-25. #
4
4
  # #
5
- # Ruby Bindings Version 2.1.23 #
5
+ # Ruby Bindings Version 2.1.24 #
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 #
@@ -122,8 +122,7 @@ module Tinkerforge
122
122
 
123
123
  end
124
124
 
125
- # Returns the measured distance. The value has a range of 0 to 4000
126
- # and is given in cm.
125
+ # Returns the measured distance.
127
126
  #
128
127
  # The laser has to be enabled, see BrickletLaserRangeFinderV2#set_enable.
129
128
  #
@@ -135,7 +134,7 @@ module Tinkerforge
135
134
  send_request FUNCTION_GET_DISTANCE, [], '', 2, 's'
136
135
  end
137
136
 
138
- # The period in ms is the period with which the CALLBACK_DISTANCE callback is triggered
137
+ # The period is the period with which the CALLBACK_DISTANCE callback is triggered
139
138
  # periodically. A value of 0 turns the callback off.
140
139
  #
141
140
  # If the `value has to change`-parameter is set to true, the callback is only
@@ -160,8 +159,6 @@ module Tinkerforge
160
159
  # "'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)"
161
160
  #
162
161
  # If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
163
- #
164
- # The default value is (0, false, 'x', 0, 0).
165
162
  def set_distance_callback_configuration(period, value_has_to_change, option, min, max)
166
163
  send_request FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k s s', 0, ''
167
164
  end
@@ -186,7 +183,7 @@ module Tinkerforge
186
183
  send_request FUNCTION_GET_VELOCITY, [], '', 2, 's'
187
184
  end
188
185
 
189
- # The period in ms is the period with which the CALLBACK_VELOCITY callback is triggered
186
+ # The period is the period with which the CALLBACK_VELOCITY callback is triggered
190
187
  # periodically. A value of 0 turns the callback off.
191
188
  #
192
189
  # If the `value has to change`-parameter is set to true, the callback is only
@@ -211,8 +208,6 @@ module Tinkerforge
211
208
  # "'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)"
212
209
  #
213
210
  # If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
214
- #
215
- # The default value is (0, false, 'x', 0, 0).
216
211
  def set_velocity_callback_configuration(period, value_has_to_change, option, min, max)
217
212
  send_request FUNCTION_SET_VELOCITY_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k s s', 0, ''
218
213
  end
@@ -276,10 +271,6 @@ module Tinkerforge
276
271
  #
277
272
  # Setting the length to 0 will turn the averaging completely off. With less
278
273
  # averaging, there is more noise on the data.
279
- #
280
- # The range for the averaging is 0-255.
281
- #
282
- # The default value is 10.
283
274
  def set_moving_average(distance_average_length, velocity_average_length)
284
275
  send_request FUNCTION_SET_MOVING_AVERAGE, [distance_average_length, velocity_average_length], 'C C', 0, ''
285
276
  end
@@ -289,7 +280,7 @@ module Tinkerforge
289
280
  send_request FUNCTION_GET_MOVING_AVERAGE, [], '', 2, 'C C'
290
281
  end
291
282
 
292
- # The offset is given in cm and added to the measured distance.
283
+ # The offset is added to the measured distance.
293
284
  # It is saved in non-volatile memory, you only have to set it once.
294
285
  #
295
286
  # The Bricklet comes with a per-sensor factory-calibrated offset value,
@@ -309,8 +300,6 @@ module Tinkerforge
309
300
 
310
301
  # Configures the distance LED to be either turned off, turned on, blink in
311
302
  # heartbeat mode or show the distance (brighter = object is nearer).
312
- #
313
- # The default value is 3 (show distance).
314
303
  def set_distance_led_config(config)
315
304
  send_request FUNCTION_SET_DISTANCE_LED_CONFIG, [config], 'C', 0, ''
316
305
  end
@@ -1,8 +1,8 @@
1
1
  # -*- ruby encoding: utf-8 -*-
2
2
  #############################################################
3
- # This file was automatically generated on 2019-08-23. #
3
+ # This file was automatically generated on 2019-11-25. #
4
4
  # #
5
- # Ruby Bindings Version 2.1.23 #
5
+ # Ruby Bindings Version 2.1.24 #
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 #
@@ -227,9 +227,8 @@ module Tinkerforge
227
227
 
228
228
  # Writes pixels to the specified window.
229
229
  #
230
- # The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are written
231
- # into the window line by line top to bottom and each line is written from left to
232
- # right.
230
+ # The pixels are written into the window line by line top to bottom
231
+ # and each line is written from left to right.
233
232
  #
234
233
  # If automatic draw is enabled (default) the pixels are directly written to
235
234
  # the screen. Only pixels that have actually changed are updated on the screen,
@@ -248,9 +247,8 @@ module Tinkerforge
248
247
 
249
248
  # Reads pixels from the specified window.
250
249
  #
251
- # The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are read
252
- # from the window line by line top to bottom and each line is read from left to
253
- # right.
250
+ # The pixels are read from the window line by line top to bottom
251
+ # and each line is read from left to right.
254
252
  #
255
253
  # If automatic draw is enabled (default) the pixels that are read are always the
256
254
  # same that are shown on the display.
@@ -281,16 +279,10 @@ module Tinkerforge
281
279
 
282
280
  # Sets the configuration of the display.
283
281
  #
284
- # You can set a contrast value from 0 to 63, a backlight intensity value
285
- # from 0 to 100 and you can invert the color (white/black) of the display.
286
- #
287
282
  # If automatic draw is set to *true*, the display is automatically updated with every
288
283
  # call of BrickletLCD128x64#write_pixels and BrickletLCD128x64#write_line. If it is set to false, the
289
284
  # changes are written into an internal buffer and only shown on the display after
290
285
  # a call of BrickletLCD128x64#draw_buffered_frame.
291
- #
292
- # The default values are contrast 14, backlight intensity 100, inverting off
293
- # and automatic draw on.
294
286
  def set_display_configuration(contrast, backlight, invert, automatic_draw)
295
287
  send_request FUNCTION_SET_DISPLAY_CONFIGURATION, [contrast, backlight, invert, automatic_draw], 'C C ? ?', 0, ''
296
288
  end
@@ -300,8 +292,7 @@ module Tinkerforge
300
292
  send_request FUNCTION_GET_DISPLAY_CONFIGURATION, [], '', 4, 'C C ? ?'
301
293
  end
302
294
 
303
- # Writes text to a specific line (0 to 7) with a specific position
304
- # (0 to 21). The text can have a maximum of 22 characters.
295
+ # Writes text to a specific line with a specific position.
305
296
  #
306
297
  # For example: (1, 10, "Hello") will write *Hello* in the middle of the
307
298
  # second line of the display.
@@ -343,15 +334,15 @@ module Tinkerforge
343
334
 
344
335
  # Returns the last valid touch position:
345
336
  #
346
- # * Pressure: Amount of pressure applied by the user (0-300)
347
- # * X: Touch position on x-axis (0-127)
348
- # * Y: Touch position on y-axis (0-63)
337
+ # * Pressure: Amount of pressure applied by the user
338
+ # * X: Touch position on x-axis
339
+ # * Y: Touch position on y-axis
349
340
  # * Age: Age of touch press in ms (how long ago it was)
350
341
  def get_touch_position
351
342
  send_request FUNCTION_GET_TOUCH_POSITION, [], '', 10, 'S S S L'
352
343
  end
353
344
 
354
- # The period in ms is the period with which the CALLBACK_TOUCH_POSITION callback
345
+ # The period is the period with which the CALLBACK_TOUCH_POSITION callback
355
346
  # is triggered periodically. A value of 0 turns the callback off.
356
347
  #
357
348
  # If the `value has to change`-parameter is set to true, the callback is only
@@ -360,8 +351,6 @@ module Tinkerforge
360
351
  #
361
352
  # If it is set to false, the callback is continuously triggered with the period,
362
353
  # independent of the value.
363
- #
364
- # The default value is (0, false).
365
354
  def set_touch_position_callback_configuration(period, value_has_to_change)
366
355
  send_request FUNCTION_SET_TOUCH_POSITION_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
367
356
  end
@@ -380,12 +369,12 @@ module Tinkerforge
380
369
  # provided. You can use this vector do determine a more exact location of the gesture (e.g.
381
370
  # the swipe from top to bottom was on the left or right part of the screen).
382
371
  #
383
- # The age parameter corresponds to the age of gesture in ms (how long ago it was).
372
+ # The age parameter corresponds to the age of gesture (how long ago it was).
384
373
  def get_touch_gesture
385
374
  send_request FUNCTION_GET_TOUCH_GESTURE, [], '', 19, 'C L S S S S S L'
386
375
  end
387
376
 
388
- # The period in ms is the period with which the CALLBACK_TOUCH_GESTURE callback
377
+ # The period is the period with which the CALLBACK_TOUCH_GESTURE callback
389
378
  # is triggered periodically. A value of 0 turns the callback off.
390
379
  #
391
380
  # If the `value has to change`-parameter is set to true, the callback is only
@@ -394,8 +383,6 @@ module Tinkerforge
394
383
  #
395
384
  # If it is set to false, the callback is continuously triggered with the period,
396
385
  # independent of the value.
397
- #
398
- # The default value is (0, false).
399
386
  def set_touch_gesture_callback_configuration(period, value_has_to_change)
400
387
  send_request FUNCTION_SET_TOUCH_GESTURE_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
401
388
  end
@@ -407,8 +394,6 @@ module Tinkerforge
407
394
  end
408
395
 
409
396
  # Draws a white or black line from (x, y)-start to (x, y)-end.
410
- # The x values have to be within the range of 0 to 127 and the y
411
- # values have t be within the range of 0 to 63.
412
397
  #
413
398
  # .. versionadded:: 2.0.2$nbsp;(Plugin)
414
399
  def draw_line(position_x_start, position_y_start, position_x_end, position_y_end, color)
@@ -416,8 +401,6 @@ module Tinkerforge
416
401
  end
417
402
 
418
403
  # Draws a white or black box from (x, y)-start to (x, y)-end.
419
- # The x values have to be within the range of 0 to 127 and the y
420
- # values have to be within the range of 0 to 63.
421
404
  #
422
405
  # If you set fill to true, the box will be filled with the
423
406
  # color. Otherwise only the outline will be drawn.
@@ -427,10 +410,7 @@ module Tinkerforge
427
410
  send_request FUNCTION_DRAW_BOX, [position_x_start, position_y_start, position_x_end, position_y_end, fill, color], 'C C C C ? ?', 0, ''
428
411
  end
429
412
 
430
- # Draws a text with up to 22 characters at the pixel position (x, y).
431
- #
432
- # The x values have to be within the range of 0 to 127 and the y
433
- # values have to be within the range of 0 to 63.
413
+ # Draws a text at the pixel position (x, y).
434
414
  #
435
415
  # You can use one of 9 different font sizes and draw the text in white or black.
436
416
  #
@@ -439,10 +419,9 @@ module Tinkerforge
439
419
  send_request FUNCTION_DRAW_TEXT, [position_x, position_y, font, color, text], 'C C C ? Z22', 0, ''
440
420
  end
441
421
 
442
- # Draws a clickable button at position (x, y) with the given text
443
- # of up to 16 characters.
422
+ # Draws a clickable button at position (x, y) with the given text.
444
423
  #
445
- # You can use up to 12 buttons (index 0-11).
424
+ # You can use up to 12 buttons.
446
425
  #
447
426
  # The x position + width has to be within the range of 1 to 128 and the y
448
427
  # position + height has to be within the range of 1 to 64.
@@ -484,7 +463,7 @@ module Tinkerforge
484
463
  send_request FUNCTION_REMOVE_GUI_BUTTON, [index], 'C', 0, ''
485
464
  end
486
465
 
487
- # The period in ms is the period with which the CALLBACK_GUI_BUTTON_PRESSED callback
466
+ # The period is the period with which the CALLBACK_GUI_BUTTON_PRESSED callback
488
467
  # is triggered periodically. A value of 0 turns the callback off.
489
468
  #
490
469
  # If the `value has to change`-parameter is set to true, the callback is only
@@ -494,8 +473,6 @@ module Tinkerforge
494
473
  # If it is set to false, the callback is continuously triggered with the period,
495
474
  # independent of the value.
496
475
  #
497
- # The default value is (0, false).
498
- #
499
476
  # .. versionadded:: 2.0.2$nbsp;(Plugin)
500
477
  def set_gui_button_pressed_callback_configuration(period, value_has_to_change)
501
478
  send_request FUNCTION_SET_GUI_BUTTON_PRESSED_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
@@ -520,7 +497,7 @@ module Tinkerforge
520
497
 
521
498
  # Draws a slider at position (x, y) with the given length.
522
499
  #
523
- # You can use up to 6 sliders (index 0-5).
500
+ # You can use up to 6 sliders.
524
501
  #
525
502
  # If you use the horizontal direction, the x position + length has to be
526
503
  # within the range of 1 to 128 and the y position has to be within
@@ -566,7 +543,7 @@ module Tinkerforge
566
543
  send_request FUNCTION_REMOVE_GUI_SLIDER, [index], 'C', 0, ''
567
544
  end
568
545
 
569
- # The period in ms is the period with which the CALLBACK_GUI_SLIDER_VALUE callback
546
+ # The period is the period with which the CALLBACK_GUI_SLIDER_VALUE callback
570
547
  # is triggered periodically. A value of 0 turns the callback off.
571
548
  #
572
549
  # If the `value has to change`-parameter is set to true, the callback is only
@@ -576,8 +553,6 @@ module Tinkerforge
576
553
  # If it is set to false, the callback is continuously triggered with the period,
577
554
  # independent of the value.
578
555
  #
579
- # The default value is (0, false).
580
- #
581
556
  # .. versionadded:: 2.0.2$nbsp;(Plugin)
582
557
  def set_gui_slider_value_callback_configuration(period, value_has_to_change)
583
558
  send_request FUNCTION_SET_GUI_SLIDER_VALUE_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
@@ -604,8 +579,6 @@ module Tinkerforge
604
579
  # Additionally, if you set `Clear GUI` to true, all of the GUI elements (buttons,
605
580
  # slider, graphs) will automatically be removed on every tab change.
606
581
  #
607
- # By default click and swipe as well as automatic GUI clear is enabled.
608
- #
609
582
  # .. versionadded:: 2.0.2$nbsp;(Plugin)
610
583
  def set_gui_tab_configuration(change_tab_config, clear_gui)
611
584
  send_request FUNCTION_SET_GUI_TAB_CONFIGURATION, [change_tab_config, clear_gui], 'C ?', 0, ''
@@ -618,9 +591,9 @@ module Tinkerforge
618
591
  send_request FUNCTION_GET_GUI_TAB_CONFIGURATION, [], '', 2, 'C ?'
619
592
  end
620
593
 
621
- # Adds a text-tab with the given index. The text can have a length of up to 5 characters.
594
+ # Adds a text-tab with the given index.
622
595
  #
623
- # You can use up to 10 tabs (index 0-9).
596
+ # You can use up to 10 tabs.
624
597
  #
625
598
  # A text-tab with the same index as a icon-tab will overwrite the icon-tab.
626
599
  #
@@ -642,7 +615,7 @@ module Tinkerforge
642
615
  # Adds a icon-tab with the given index. The icon can have a width of 28 pixels
643
616
  # with a height of 6 pixels. It is drawn line-by-line from left to right.
644
617
  #
645
- # You can use up to 10 tabs (index 0-9).
618
+ # You can use up to 10 tabs.
646
619
  #
647
620
  # A icon-tab with the same index as a text-tab will overwrite the text-tab.
648
621
  #
@@ -677,7 +650,7 @@ module Tinkerforge
677
650
  send_request FUNCTION_SET_GUI_TAB_SELECTED, [index], 'C', 0, ''
678
651
  end
679
652
 
680
- # The period in ms is the period with which the CALLBACK_GUI_TAB_SELECTED callback
653
+ # The period is the period with which the CALLBACK_GUI_TAB_SELECTED callback
681
654
  # is triggered periodically. A value of 0 turns the callback off.
682
655
  #
683
656
  # If the `value has to change`-parameter is set to true, the callback is only
@@ -687,8 +660,6 @@ module Tinkerforge
687
660
  # If it is set to false, the callback is continuously triggered with the period,
688
661
  # independent of the value.
689
662
  #
690
- # The default value is (0, false).
691
- #
692
663
  # .. versionadded:: 2.0.2$nbsp;(Plugin)
693
664
  def set_gui_tab_selected_callback_configuration(period, value_has_to_change)
694
665
  send_request FUNCTION_SET_GUI_TAB_SELECTED_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
@@ -710,15 +681,13 @@ module Tinkerforge
710
681
  send_request FUNCTION_GET_GUI_TAB_SELECTED, [], '', 1, 'c'
711
682
  end
712
683
 
713
- # Sets the configuration for up to four graphs (index 0-3).
684
+ # Sets the configuration for up to four graphs.
714
685
  #
715
686
  # The graph type can be dot-, line- or bar-graph.
716
687
  #
717
- # The x and y position are pixel positions. They have to be within
718
- # the range of (0, 0) to (127, 63). The maximum width is 118 and the
719
- # maximum height is 63.
688
+ # The x and y position are pixel positions.
720
689
  #
721
- # You can add a text for the x and y axis with at most 4 characters each.
690
+ # You can add a text for the x and y axis.
722
691
  # The text is drawn at the inside of the graph and it can overwrite some
723
692
  # of the graph data. If you need the text outside of the graph you can
724
693
  # leave this text here empty and use BrickletLCD128x64#draw_text to draw the caption
@@ -925,9 +894,8 @@ module Tinkerforge
925
894
 
926
895
  # Writes pixels to the specified window.
927
896
  #
928
- # The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are written
929
- # into the window line by line top to bottom and each line is written from left to
930
- # right.
897
+ # The pixels are written into the window line by line top to bottom
898
+ # and each line is written from left to right.
931
899
  #
932
900
  # If automatic draw is enabled (default) the pixels are directly written to
933
901
  # the screen. Only pixels that have actually changed are updated on the screen,
@@ -973,9 +941,8 @@ module Tinkerforge
973
941
 
974
942
  # Reads pixels from the specified window.
975
943
  #
976
- # The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are read
977
- # from the window line by line top to bottom and each line is read from left to
978
- # right.
944
+ # The pixels are read from the window line by line top to bottom
945
+ # and each line is read from left to right.
979
946
  #
980
947
  # If automatic draw is enabled (default) the pixels that are read are always the
981
948
  # same that are shown on the display.