tinkerforge 2.1.24 → 2.1.29

data/lib/tinkerforge/bricklet_industrial_dual_ac_relay.rb

@@ -0,0 +1,325 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2021-05-06.      #
+#                                                           #
+# Ruby Bindings Version 2.1.29                              #
+#                                                           #
+# 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
+  # Two relays to switch AC devices
+  class BrickletIndustrialDualACRelay < Device
+    DEVICE_IDENTIFIER = 2162 # :nodoc:
+    DEVICE_DISPLAY_NAME = 'Industrial Dual AC Relay Bricklet' # :nodoc:
+
+    # This callback is triggered whenever a monoflop timer reaches 0. The
+    # parameters contain the relay and the current state of the relay
+    # (the state after the monoflop).
+    CALLBACK_MONOFLOP_DONE = 7
+
+    FUNCTION_SET_VALUE = 1 # :nodoc:
+    FUNCTION_GET_VALUE = 2 # :nodoc:
+    FUNCTION_SET_CHANNEL_LED_CONFIG = 3 # :nodoc:
+    FUNCTION_GET_CHANNEL_LED_CONFIG = 4 # :nodoc:
+    FUNCTION_SET_MONOFLOP = 5 # :nodoc:
+    FUNCTION_GET_MONOFLOP = 6 # :nodoc:
+    FUNCTION_SET_SELECTED_VALUE = 8 # :nodoc:
+    FUNCTION_GET_SPITFP_ERROR_COUNT = 234 # :nodoc:
+    FUNCTION_SET_BOOTLOADER_MODE = 235 # :nodoc:
+    FUNCTION_GET_BOOTLOADER_MODE = 236 # :nodoc:
+    FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237 # :nodoc:
+    FUNCTION_WRITE_FIRMWARE = 238 # :nodoc:
+    FUNCTION_SET_STATUS_LED_CONFIG = 239 # :nodoc:
+    FUNCTION_GET_STATUS_LED_CONFIG = 240 # :nodoc:
+    FUNCTION_GET_CHIP_TEMPERATURE = 242 # :nodoc:
+    FUNCTION_RESET = 243 # :nodoc:
+    FUNCTION_WRITE_UID = 248 # :nodoc:
+    FUNCTION_READ_UID = 249 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :nodoc:
+
+    CHANNEL_LED_CONFIG_OFF = 0 # :nodoc:
+    CHANNEL_LED_CONFIG_ON = 1 # :nodoc:
+    CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2 # :nodoc:
+    CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3 # :nodoc:
+    BOOTLOADER_MODE_BOOTLOADER = 0 # :nodoc:
+    BOOTLOADER_MODE_FIRMWARE = 1 # :nodoc:
+    BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2 # :nodoc:
+    BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3 # :nodoc:
+    BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4 # :nodoc:
+    BOOTLOADER_STATUS_OK = 0 # :nodoc:
+    BOOTLOADER_STATUS_INVALID_MODE = 1 # :nodoc:
+    BOOTLOADER_STATUS_NO_CHANGE = 2 # :nodoc:
+    BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3 # :nodoc:
+    BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4 # :nodoc:
+    BOOTLOADER_STATUS_CRC_MISMATCH = 5 # :nodoc:
+    STATUS_LED_CONFIG_OFF = 0 # :nodoc:
+    STATUS_LED_CONFIG_ON = 1 # :nodoc:
+    STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2 # :nodoc:
+    STATUS_LED_CONFIG_SHOW_STATUS = 3 # :nodoc:
+
+    # 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, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME
+
+      @api_version = [2, 0, 0]
+
+      @response_expected[FUNCTION_SET_VALUE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_CHANNEL_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_CHANNEL_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_MONOFLOP] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_MONOFLOP] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_SELECTED_VALUE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_MONOFLOP_DONE] = [10, 'C ?']
+
+      @ipcon.add_device self
+    end
+
+    # Sets the state of the relays, *true* means on and *false* means off.
+    # For example: (true, false) turns relay 0 on and relay 1 off.
+    # 
+    # If you just want to set one of the relays and don't know the current state
+    # of the other relay, you can get the state with BrickletIndustrialDualACRelay#get_value or you
+    # can use BrickletIndustrialDualACRelay#set_selected_value.
+    # 
+    # All running monoflop timers will be aborted if this function is called.
+    def set_value(channel0, channel1)
+      check_validity
+
+      send_request FUNCTION_SET_VALUE, [channel0, channel1], '? ?', 8, ''
+    end
+
+    # Returns the state of the relays, *true* means on and *false* means off.
+    def get_value
+      check_validity
+
+      send_request FUNCTION_GET_VALUE, [], '', 10, '? ?'
+    end
+
+    # Each channel has a corresponding LED. You can turn the LED off, on or show a
+    # heartbeat. You can also set the LED to "Channel Status". In this mode the
+    # LED is on if the channel is high and off otherwise.
+    def set_channel_led_config(channel, config)
+      check_validity
+
+      send_request FUNCTION_SET_CHANNEL_LED_CONFIG, [channel, config], 'C C', 8, ''
+    end
+
+    # Returns the channel LED configuration as set by BrickletIndustrialDualACRelay#set_channel_led_config
+    def get_channel_led_config(channel)
+      check_validity
+
+      send_request FUNCTION_GET_CHANNEL_LED_CONFIG, [channel], 'C', 9, 'C'
+    end
+
+    # The first parameter can be 0 or 1 (relay 0 or relay 1). The second parameter
+    # is the desired state of the relay (*true* means on and *false* means off).
+    # The third parameter indicates the time that the relay should hold
+    # the state.
+    # 
+    # If this function is called with the parameters (1, true, 1500):
+    # Relay 1 will turn on and in 1.5s it will turn off again.
+    # 
+    # A monoflop can be used as a failsafe mechanism. For example: Lets assume you
+    # have a RS485 bus and a Industrial Dual AC Relay Bricklet connected to one of the
+    # slave stacks. You can now call this function every second, with a time parameter
+    # of two seconds. The relay will be on all the time. If now the RS485
+    # connection is lost, the relay will turn off in at most two seconds.
+    def set_monoflop(channel, value, time)
+      check_validity
+
+      send_request FUNCTION_SET_MONOFLOP, [channel, value, time], 'C ? L', 8, ''
+    end
+
+    # Returns (for the given relay) the current state and the time as set by
+    # BrickletIndustrialDualACRelay#set_monoflop as well as the remaining time until the state flips.
+    # 
+    # If the timer is not running currently, the remaining time will be returned
+    # as 0.
+    def get_monoflop(channel)
+      check_validity
+
+      send_request FUNCTION_GET_MONOFLOP, [channel], 'C', 17, '? L L'
+    end
+
+    # Sets the state of the selected relay, *true* means on and *false*
+    # means off.
+    # 
+    # A running monoflop timer for the selected relay will be aborted if this function
+    # is called.
+    # 
+    # The other relay remains untouched.
+    def set_selected_value(channel, value)
+      check_validity
+
+      send_request FUNCTION_SET_SELECTED_VALUE, [channel, value], 'C ?', 8, ''
+    end
+
+    # Returns the error count for the communication between Brick and Bricklet.
+    # 
+    # The errors are divided into
+    # 
+    # * ACK checksum errors,
+    # * message checksum errors,
+    # * framing errors and
+    # * overflow errors.
+    # 
+    # The errors counts are for errors that occur on the Bricklet side. All
+    # Bricks have a similar function that returns the errors on the Brick side.
+    def get_spitfp_error_count
+      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
+    # mode change was instigated.
+    # 
+    # You can change from bootloader mode to firmware mode and vice versa. A change
+    # from bootloader mode to firmware mode will only take place if the entry function,
+    # device identifier and CRC are present and correct.
+    # 
+    # This function is used by Brick Viewer during flashing. It should not be
+    # necessary to call it in a normal user program.
+    def set_bootloader_mode(mode)
+      check_validity
+
+      send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
+    end
+
+    # Returns the current bootloader mode, see BrickletIndustrialDualACRelay#set_bootloader_mode.
+    def get_bootloader_mode
+      check_validity
+
+      send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
+    end
+
+    # Sets the firmware pointer for BrickletIndustrialDualACRelay#write_firmware. The pointer has
+    # to be increased by chunks of size 64. The data is written to flash
+    # every 4 chunks (which equals to one page of size 256).
+    # 
+    # This function is used by Brick Viewer during flashing. It should not be
+    # necessary to call it in a normal user program.
+    def set_write_firmware_pointer(pointer)
+      check_validity
+
+      send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
+    end
+
+    # Writes 64 Bytes of firmware at the position as written by
+    # BrickletIndustrialDualACRelay#set_write_firmware_pointer before. The firmware is written
+    # to flash every 4 chunks.
+    # 
+    # You can only write firmware in bootloader mode.
+    # 
+    # This function is used by Brick Viewer during flashing. It should not be
+    # necessary to call it in a normal user program.
+    def write_firmware(data)
+      check_validity
+
+      send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
+    end
+
+    # Sets the status LED configuration. By default the LED shows
+    # communication traffic between Brick and Bricklet, it flickers once
+    # for every 10 received data packets.
+    # 
+    # You can also turn the LED permanently on/off or show a heartbeat.
+    # 
+    # If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
+    def set_status_led_config(config)
+      check_validity
+
+      send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
+    end
+
+    # Returns the configuration as set by BrickletIndustrialDualACRelay#set_status_led_config
+    def get_status_led_config
+      check_validity
+
+      send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
+    end
+
+    # 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
+      check_validity
+
+      send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
+    end
+
+    # Calling this function will reset the Bricklet. All configurations
+    # will be lost.
+    # 
+    # After a reset you have to create new device objects,
+    # calling functions on the existing ones will result in
+    # undefined behavior!
+    def reset
+      check_validity
+
+      send_request FUNCTION_RESET, [], '', 8, ''
+    end
+
+    # Writes a new UID into flash. If you want to set a new UID
+    # you have to decode the Base58 encoded UID string into an
+    # integer first.
+    # 
+    # We recommend that you use Brick Viewer to change the UID.
+    def write_uid(uid)
+      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
+      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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port).
+    # A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at
+    # position 'z'.
+    # 
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
+    def get_identity
+      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>.
+    def register_callback(id, &block)
+      callback = block
+      @registered_callbacks[id] = callback
+    end
+  end
+end

data/lib/tinkerforge/bricklet_industrial_dual_analog_in.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-11-25.      #
+# This file was automatically generated on 2021-05-06.      #
 #                                                           #
-# Ruby Bindings Version 2.1.24                              #
+# Ruby Bindings Version 2.1.29                              #
 #                                                           #
 # 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 two DC voltages between -35V and +35V with 24bit resolution each
   class BrickletIndustrialDualAnalogIn < 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]
 
@@ -80,9 +82,10 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_ADC_VALUES] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_VOLTAGE] = 'C l'
-      @callback_formats[CALLBACK_VOLTAGE_REACHED] = 'C l'
+      @callback_formats[CALLBACK_VOLTAGE] = [13, 'C l']
+      @callback_formats[CALLBACK_VOLTAGE_REACHED] = [13, 'C l']
 
+      @ipcon.add_device self
     end
 
     # Returns the voltage for the given channel.
@@ -91,7 +94,9 @@ module Tinkerforge
     # CALLBACK_VOLTAGE callback and set the period with
     # BrickletIndustrialDualAnalogIn#set_voltage_callback_period.
     def get_voltage(channel)
-      send_request FUNCTION_GET_VOLTAGE, [channel], 'C', 4, 'l'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE, [channel], 'C', 12, 'l'
     end
 
     # Sets the period with which the CALLBACK_VOLTAGE callback is triggered
@@ -100,12 +105,16 @@ module Tinkerforge
     # The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since the
     # last triggering.
     def set_voltage_callback_period(channel, period)
-      send_request FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD, [channel, period], 'C L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD, [channel, period], 'C L', 8, ''
     end
 
     # Returns the period as set by BrickletIndustrialDualAnalogIn#set_voltage_callback_period.
     def get_voltage_callback_period(channel)
-      send_request FUNCTION_GET_VOLTAGE_CALLBACK_PERIOD, [channel], 'C', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE_CALLBACK_PERIOD, [channel], 'C', 12, 'L'
     end
 
     # Sets the thresholds for the CALLBACK_VOLTAGE_REACHED callback for the given
@@ -121,12 +130,16 @@ module Tinkerforge
     #  "'<'",    "Callback is triggered when the voltage is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the voltage is greater than the min value (max is ignored)"
     def set_voltage_callback_threshold(channel, option, min, max)
-      send_request FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD, [channel, option, min, max], 'C k l l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD, [channel, option, min, max], 'C k l l', 8, ''
     end
 
     # Returns the threshold as set by BrickletIndustrialDualAnalogIn#set_voltage_callback_threshold.
     def get_voltage_callback_threshold(channel)
-      send_request FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD, [channel], 'C', 9, 'k l l'
+      check_validity
+
+      send_request FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD, [channel], 'C', 17, 'k l l'
     end
 
     # Sets the period with which the threshold callback
@@ -139,24 +152,32 @@ module Tinkerforge
     # 
     # keeps being reached.
     def set_debounce_period(debounce)
-      send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, ''
     end
 
     # Returns the debounce period as set by BrickletIndustrialDualAnalogIn#set_debounce_period.
     def get_debounce_period
-      send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the sample rate. The sample rate can be between 1 sample per second
     # and 976 samples per second. Decreasing the sample rate will also decrease the
     # noise on the data.
     def set_sample_rate(rate)
-      send_request FUNCTION_SET_SAMPLE_RATE, [rate], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_SAMPLE_RATE, [rate], 'C', 8, ''
     end
 
     # Returns the sample rate as set by BrickletIndustrialDualAnalogIn#set_sample_rate.
     def get_sample_rate
-      send_request FUNCTION_GET_SAMPLE_RATE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_SAMPLE_RATE, [], '', 9, 'C'
     end
 
     # Sets offset and gain of MCP3911 internal calibration registers.
@@ -165,30 +186,38 @@ module Tinkerforge
     # is already factory calibrated by Tinkerforge. It should not be necessary
     # for you to use this function
     def set_calibration(offset, gain)
-      send_request FUNCTION_SET_CALIBRATION, [offset, gain], 'l2 l2', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CALIBRATION, [offset, gain], 'l2 l2', 8, ''
     end
 
     # Returns the calibration as set by BrickletIndustrialDualAnalogIn#set_calibration.
     def get_calibration
-      send_request FUNCTION_GET_CALIBRATION, [], '', 16, 'l2 l2'
+      check_validity
+
+      send_request FUNCTION_GET_CALIBRATION, [], '', 24, 'l2 l2'
     end
 
     # Returns the ADC values as given by the MCP3911 IC. This function
     # is needed for proper calibration, see BrickletIndustrialDualAnalogIn#set_calibration.
     def get_adc_values
-      send_request FUNCTION_GET_ADC_VALUES, [], '', 8, 'l2'
+      check_validity
+
+      send_request FUNCTION_GET_ADC_VALUES, [], '', 16, 'l2'
     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).
+    # A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at
+    # position 'z'.
     # 
     # The device identifier numbers can be found :ref:`here <device_identifier>`.
     # |device_identifier_constant|
     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>.