tinkerforge 2.1.24 → 2.1.25

data/lib/tinkerforge/bricklet_energy_monitor.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-11-25.      #
+# This file was automatically generated on 2020-04-07.      #
 #                                                           #
-# Ruby Bindings Version 2.1.24                              #
+# Ruby Bindings Version 2.1.25                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################
 
+require_relative './ip_connection'
+
 module Tinkerforge
   # Measures Voltage, Current, Energy, Real/Apparent/Reactive Power, Power Factor and Frequency
   class BrickletEnergyMonitor < Device
@@ -62,7 +64,7 @@ module Tinkerforge
     # Creates an object with the unique device ID <tt>uid</tt> and adds it to
     # the IP Connection <tt>ipcon</tt>.
     def initialize(uid, ipcon)
-      super uid, ipcon
+      super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME
 
       @api_version = [2, 0, 0]
 
@@ -88,8 +90,9 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_ENERGY_DATA] = 'l l l l l l S S'
+      @callback_formats[CALLBACK_ENERGY_DATA] = [36, 'l l l l l l S S']
 
+      @ipcon.add_device self
     end
 
     # Returns all of the measurements that are done by the Energy Monitor Bricklet.
@@ -113,12 +116,16 @@ module Tinkerforge
     # to calculate the frequency and it will use an integration time of
     # 10 zero-crossings of the current waveform.
     def get_energy_data
-      send_request FUNCTION_GET_ENERGY_DATA, [], '', 28, 'l l l l l l S S'
+      check_validity
+
+      send_request FUNCTION_GET_ENERGY_DATA, [], '', 36, 'l l l l l l S S'
     end
 
     # Sets the energy value (see BrickletEnergyMonitor#get_energy_data) back to 0Wh.
     def reset_energy
-      send_request FUNCTION_RESET_ENERGY, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_RESET_ENERGY, [], '', 8, ''
     end
 
     # Returns a snapshot of the voltage and current waveform. The values
@@ -132,12 +139,16 @@ module Tinkerforge
     # This data is meant to be used for a non-realtime graphical representation of
     # the voltage and current waveforms.
     def get_waveform_low_level
-      send_request FUNCTION_GET_WAVEFORM_LOW_LEVEL, [], '', 62, 'S s30'
+      check_validity
+
+      send_request FUNCTION_GET_WAVEFORM_LOW_LEVEL, [], '', 70, 'S s30'
     end
 
     # Returns *true* if a voltage/current transformer is connected to the Bricklet.
     def get_transformer_status
-      send_request FUNCTION_GET_TRANSFORMER_STATUS, [], '', 2, '? ?'
+      check_validity
+
+      send_request FUNCTION_GET_TRANSFORMER_STATUS, [], '', 10, '? ?'
     end
 
     # Sets the transformer ratio for the voltage and current transformer in 1/100 form.
@@ -153,12 +164,16 @@ module Tinkerforge
     # 
     # Set the phase shift to 0. It is for future use and currently not supported by the Bricklet.
     def set_transformer_calibration(voltage_ratio, current_ratio, phase_shift)
-      send_request FUNCTION_SET_TRANSFORMER_CALIBRATION, [voltage_ratio, current_ratio, phase_shift], 'S S s', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_TRANSFORMER_CALIBRATION, [voltage_ratio, current_ratio, phase_shift], 'S S s', 8, ''
     end
 
     # Returns the transformer calibration as set by BrickletEnergyMonitor#set_transformer_calibration.
     def get_transformer_calibration
-      send_request FUNCTION_GET_TRANSFORMER_CALIBRATION, [], '', 6, 'S S s'
+      check_validity
+
+      send_request FUNCTION_GET_TRANSFORMER_CALIBRATION, [], '', 14, 'S S s'
     end
 
     # Calling this function will start an offset calibration. The offset calibration will
@@ -174,7 +189,9 @@ module Tinkerforge
     # 
     # The calibration is saved in non-volatile memory, you only have to set it once.
     def calibrate_offset
-      send_request FUNCTION_CALIBRATE_OFFSET, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_CALIBRATE_OFFSET, [], '', 8, ''
     end
 
     # The period is the period with which the CALLBACK_ENERGY_DATA
@@ -187,13 +204,17 @@ module Tinkerforge
     # If it is set to false, the callback is continuously triggered with the period,
     # independent of the value.
     def set_energy_data_callback_configuration(period, value_has_to_change)
-      send_request FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, ''
     end
 
     # Returns the callback configuration as set by
     # BrickletEnergyMonitor#set_energy_data_callback_configuration.
     def get_energy_data_callback_configuration
-      send_request FUNCTION_GET_ENERGY_DATA_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
+      check_validity
+
+      send_request FUNCTION_GET_ENERGY_DATA_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -208,7 +229,9 @@ module Tinkerforge
     # 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.
     def get_spitfp_error_count
-      send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 16, 'L L L L'
+      check_validity
+
+      send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
     end
 
     # Sets the bootloader mode and returns the status after the requested
@@ -221,12 +244,16 @@ module Tinkerforge
     # This function is used by Brick Viewer during flashing. It should not be
     # necessary to call it in a normal user program.
     def set_bootloader_mode(mode)
-      send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
     end
 
     # Returns the current bootloader mode, see BrickletEnergyMonitor#set_bootloader_mode.
     def get_bootloader_mode
-      send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
     end
 
     # Sets the firmware pointer for BrickletEnergyMonitor#write_firmware. The pointer has
@@ -236,7 +263,9 @@ module Tinkerforge
     # This function is used by Brick Viewer during flashing. It should not be
     # necessary to call it in a normal user program.
     def set_write_firmware_pointer(pointer)
-      send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
     end
 
     # Writes 64 Bytes of firmware at the position as written by
@@ -248,7 +277,9 @@ module Tinkerforge
     # This function is used by Brick Viewer during flashing. It should not be
     # necessary to call it in a normal user program.
     def write_firmware(data)
-      send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
     end
 
     # Sets the status LED configuration. By default the LED shows
@@ -259,22 +290,28 @@ module Tinkerforge
     # 
     # If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
     def set_status_led_config(config)
-      send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
     end
 
     # Returns the configuration as set by BrickletEnergyMonitor#set_status_led_config
     def get_status_led_config
-      send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
     end
 
-    # Returns the temperature in °C as measured inside the microcontroller. The
+    # 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.
     def get_chip_temperature
-      send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 2, 's'
+      check_validity
+
+      send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
     end
 
     # Calling this function will reset the Bricklet. All configurations
@@ -284,7 +321,9 @@ module Tinkerforge
     # calling functions on the existing ones will result in
     # undefined behavior!
     def reset
-      send_request FUNCTION_RESET, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_RESET, [], '', 8, ''
     end
 
     # Writes a new UID into flash. If you want to set a new UID
@@ -293,25 +332,32 @@ module Tinkerforge
     # 
     # We recommend that you use Brick Viewer to change the UID.
     def write_uid(uid)
-      send_request FUNCTION_WRITE_UID, [uid], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
     end
 
     # Returns the current UID as an integer. Encode as
     # Base58 to get the usual string version.
     def read_uid
-      send_request FUNCTION_READ_UID, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_READ_UID, [], '', 12, 'L'
     end
 
     # 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' or 'd'.
+    # The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port).
+    # The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet
+    # connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always as
+    # position 'z'.
     # 
     # The device identifier numbers can be found :ref:`here <device_identifier>`.
     # |device_identifier_constant|
     def get_identity
-      send_request FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S'
+      send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
     end
 
     # Returns a snapshot of the voltage and current waveform. The values

data/lib/tinkerforge/bricklet_gps.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-11-25.      #
+# This file was automatically generated on 2020-04-07.      #
 #                                                           #
-# Ruby Bindings Version 2.1.24                              #
+# Ruby Bindings Version 2.1.25                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################
 
+require_relative './ip_connection'
+
 module Tinkerforge
   # Determine position, velocity and altitude using GPS
   class BrickletGPS < Device
@@ -87,7 +89,7 @@ module Tinkerforge
     # Creates an object with the unique device ID <tt>uid</tt> and adds it to
     # the IP Connection <tt>ipcon</tt>.
     def initialize(uid, ipcon)
-      super uid, ipcon
+      super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME
 
       @api_version = [2, 0, 1]
 
@@ -109,12 +111,13 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_COORDINATES] = 'L k L k S S S S'
-      @callback_formats[CALLBACK_STATUS] = 'C C C'
-      @callback_formats[CALLBACK_ALTITUDE] = 'l l'
-      @callback_formats[CALLBACK_MOTION] = 'L L'
-      @callback_formats[CALLBACK_DATE_TIME] = 'L L'
+      @callback_formats[CALLBACK_COORDINATES] = [26, 'L k L k S S S S']
+      @callback_formats[CALLBACK_STATUS] = [11, 'C C C']
+      @callback_formats[CALLBACK_ALTITUDE] = [16, 'l l']
+      @callback_formats[CALLBACK_MOTION] = [16, 'L L']
+      @callback_formats[CALLBACK_DATE_TIME] = [16, 'L L']
 
+      @ipcon.add_device self
     end
 
     # Returns the GPS coordinates. Latitude and longitude are given in the
@@ -136,7 +139,9 @@ module Tinkerforge
     # This data is only valid if there is currently a fix as indicated by
     # BrickletGPS#get_status.
     def get_coordinates
-      send_request FUNCTION_GET_COORDINATES, [], '', 18, 'L k L k S S S S'
+      check_validity
+
+      send_request FUNCTION_GET_COORDINATES, [], '', 26, 'L k L k S S S S'
     end
 
     # Returns the current fix status, the number of satellites that are in view and
@@ -153,7 +158,9 @@ module Tinkerforge
     # There is also a :ref:`blue LED <gps_bricklet_fix_led>` on the Bricklet that
     # indicates the fix status.
     def get_status
-      send_request FUNCTION_GET_STATUS, [], '', 3, 'C C C'
+      check_validity
+
+      send_request FUNCTION_GET_STATUS, [], '', 11, 'C C C'
     end
 
     # Returns the current altitude and corresponding geoidal separation.
@@ -161,7 +168,9 @@ module Tinkerforge
     # This data is only valid if there is currently a fix as indicated by
     # BrickletGPS#get_status.
     def get_altitude
-      send_request FUNCTION_GET_ALTITUDE, [], '', 8, 'l l'
+      check_validity
+
+      send_request FUNCTION_GET_ALTITUDE, [], '', 16, 'l l'
     end
 
     # Returns the current course and speed. A course of 0° means the Bricklet is
@@ -173,7 +182,9 @@ module Tinkerforge
     # This data is only valid if there is currently a fix as indicated by
     # BrickletGPS#get_status.
     def get_motion
-      send_request FUNCTION_GET_MOTION, [], '', 8, 'L L'
+      check_validity
+
+      send_request FUNCTION_GET_MOTION, [], '', 16, 'L L'
     end
 
     # Returns the current date and time. The date is
@@ -181,7 +192,9 @@ module Tinkerforge
     # in the format ``hhmmss.sss``. For example, 140713 means
     # 14.07.13 as date and 195923568 means 19:59:23.568 as time.
     def get_date_time
-      send_request FUNCTION_GET_DATE_TIME, [], '', 8, 'L L'
+      check_validity
+
+      send_request FUNCTION_GET_DATE_TIME, [], '', 16, 'L L'
     end
 
     # Restarts the GPS Bricklet, the following restart types are available:
@@ -193,7 +206,9 @@ module Tinkerforge
     #  "2", "Cold start (don't use time, position, almanacs and ephemeris at restart)"
     #  "3", "Factory reset (clear all system/user configurations at restart)"
     def restart(restart_type)
-      send_request FUNCTION_RESTART, [restart_type], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_RESTART, [restart_type], 'C', 8, ''
     end
 
     # Sets the period with which the CALLBACK_COORDINATES callback is triggered
@@ -202,12 +217,16 @@ module Tinkerforge
     # The CALLBACK_COORDINATES callback is only triggered if the coordinates changed
     # since the last triggering.
     def set_coordinates_callback_period(period)
-      send_request FUNCTION_SET_COORDINATES_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_COORDINATES_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletGPS#set_coordinates_callback_period.
     def get_coordinates_callback_period
-      send_request FUNCTION_GET_COORDINATES_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_COORDINATES_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the period with which the CALLBACK_STATUS callback is triggered
@@ -216,12 +235,16 @@ module Tinkerforge
     # The CALLBACK_STATUS callback is only triggered if the status changed since the
     # last triggering.
     def set_status_callback_period(period)
-      send_request FUNCTION_SET_STATUS_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_STATUS_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletGPS#set_status_callback_period.
     def get_status_callback_period
-      send_request FUNCTION_GET_STATUS_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_STATUS_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the period with which the CALLBACK_ALTITUDE callback is triggered
@@ -230,12 +253,16 @@ module Tinkerforge
     # The CALLBACK_ALTITUDE callback is only triggered if the altitude changed since
     # the last triggering.
     def set_altitude_callback_period(period)
-      send_request FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletGPS#set_altitude_callback_period.
     def get_altitude_callback_period
-      send_request FUNCTION_GET_ALTITUDE_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_ALTITUDE_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the period with which the CALLBACK_MOTION callback is triggered
@@ -244,12 +271,16 @@ module Tinkerforge
     # The CALLBACK_MOTION callback is only triggered if the motion changed since the
     # last triggering.
     def set_motion_callback_period(period)
-      send_request FUNCTION_SET_MOTION_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MOTION_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletGPS#set_motion_callback_period.
     def get_motion_callback_period
-      send_request FUNCTION_GET_MOTION_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_MOTION_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the period with which the CALLBACK_DATE_TIME callback is triggered
@@ -258,24 +289,31 @@ module Tinkerforge
     # The CALLBACK_DATE_TIME callback is only triggered if the date or time changed
     # since the last triggering.
     def set_date_time_callback_period(period)
-      send_request FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletGPS#set_date_time_callback_period.
     def get_date_time_callback_period
-      send_request FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_DATE_TIME_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # 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' or 'd'.
+    # The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port).
+    # The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet
+    # connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always as
+    # position 'z'.
     # 
     # The device identifier numbers can be found :ref:`here <device_identifier>`.
     # |device_identifier_constant|
     def get_identity
-      send_request FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S'
+      send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
     end
 
     # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.