tinkerforge 2.1.23 → 2.1.28

data/lib/tinkerforge/bricklet_nfc_rfid.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2021-01-15.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.28                              #
 #                                                           #
 # 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
   # Reads and writes NFC and RFID tags
   class BrickletNFCRFID < Device
@@ -52,7 +54,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]
 
@@ -65,8 +67,9 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_PAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_STATE_CHANGED] = 'C ?'
+      @callback_formats[CALLBACK_STATE_CHANGED] = [10, 'C ?']
 
+      @ipcon.add_device self
     end
 
     # To read or write a tag that is in proximity of the NFC/RFID Bricklet you
@@ -98,7 +101,9 @@ module Tinkerforge
     # In case of any *Error* state the selection is lost and you have to
     # start again by calling BrickletNFCRFID#request_tag_id.
     def request_tag_id(tag_type)
-      send_request FUNCTION_REQUEST_TAG_ID, [tag_type], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_REQUEST_TAG_ID, [tag_type], 'C', 8, ''
     end
 
     # Returns the tag type, tag ID and the length of the tag ID
@@ -113,7 +118,9 @@ module Tinkerforge
     #    CALLBACK_STATE_CHANGED callback)
     # 3. Call BrickletNFCRFID#get_tag_id
     def get_tag_id
-      send_request FUNCTION_GET_TAG_ID, [], '', 9, 'C C C7'
+      check_validity
+
+      send_request FUNCTION_GET_TAG_ID, [], '', 17, 'C C C7'
     end
 
     # Returns the current state of the NFC/RFID Bricklet.
@@ -131,7 +138,9 @@ module Tinkerforge
     # 
     # The same approach is used analogously for the other API functions.
     def get_state
-      send_request FUNCTION_GET_STATE, [], '', 2, 'C ?'
+      check_validity
+
+      send_request FUNCTION_GET_STATE, [], '', 10, 'C ?'
     end
 
     # Mifare Classic tags use authentication. If you want to read from or write to
@@ -153,7 +162,9 @@ module Tinkerforge
     #    BrickletNFCRFID#get_state or CALLBACK_STATE_CHANGED callback)
     # 6. Call BrickletNFCRFID#request_page or BrickletNFCRFID#write_page to read/write page
     def authenticate_mifare_classic_page(page, key_number, key)
-      send_request FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE, [page, key_number, key], 'S C C6', 0, ''
+      check_validity
+
+      send_request FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE, [page, key_number, key], 'S C C6', 8, ''
     end
 
     # Writes 16 bytes starting from the given page. How many pages are written
@@ -177,7 +188,9 @@ module Tinkerforge
     # If you use a Mifare Classic tag you have to authenticate a page before you
     # can write to it. See BrickletNFCRFID#authenticate_mifare_classic_page.
     def write_page(page, data)
-      send_request FUNCTION_WRITE_PAGE, [page, data], 'S C16', 0, ''
+      check_validity
+
+      send_request FUNCTION_WRITE_PAGE, [page, data], 'S C16', 8, ''
     end
 
     # Reads 16 bytes starting from the given page and stores them into a buffer.
@@ -204,25 +217,31 @@ module Tinkerforge
     # If you use a Mifare Classic tag you have to authenticate a page before you
     # can read it. See BrickletNFCRFID#authenticate_mifare_classic_page.
     def request_page(page)
-      send_request FUNCTION_REQUEST_PAGE, [page], 'S', 0, ''
+      check_validity
+
+      send_request FUNCTION_REQUEST_PAGE, [page], 'S', 8, ''
     end
 
     # Returns 16 bytes of data from an internal buffer. To fill the buffer
     # with specific pages you have to call BrickletNFCRFID#request_page beforehand.
     def get_page
-      send_request FUNCTION_GET_PAGE, [], '', 16, 'C16'
+      check_validity
+
+      send_request FUNCTION_GET_PAGE, [], '', 24, 'C16'
     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>.

data/lib/tinkerforge/bricklet_oled_128x64.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2021-01-15.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.28                              #
 #                                                           #
 # 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
   # 3.3cm (1.3") OLED display with 128x64 pixels
   class BrickletOLED128x64 < Device
@@ -27,7 +29,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]
 
@@ -40,6 +42,7 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
 
+      @ipcon.add_device self
     end
 
     # Appends 64 byte of data to the window as set by BrickletOLED128x64#new_window.
@@ -63,39 +66,45 @@ module Tinkerforge
     # and the next two the second row and so on. To fill the whole display
     # you need to call BrickletOLED128x64#write 16 times.
     def write(data)
-      send_request FUNCTION_WRITE, [data], 'C64', 0, ''
+      check_validity
+
+      send_request FUNCTION_WRITE, [data], 'C64', 8, ''
     end
 
     # Sets the window in which you can write with BrickletOLED128x64#write. One row
     # has a height of 8 pixels.
-    # 
-    # The columns have a range of 0 to 127 and the rows have a range of 0 to 7.
     def new_window(column_from, column_to, row_from, row_to)
-      send_request FUNCTION_NEW_WINDOW, [column_from, column_to, row_from, row_to], 'C C C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_NEW_WINDOW, [column_from, column_to, row_from, row_to], 'C C C C', 8, ''
     end
 
     # Clears the current content of the window as set by BrickletOLED128x64#new_window.
     def clear_display
-      send_request FUNCTION_CLEAR_DISPLAY, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_CLEAR_DISPLAY, [], '', 8, ''
     end
 
     # Sets the configuration of the display.
     # 
     # You can set a contrast value from 0 to 255 and you can invert the color
     # (black/white) of the display.
-    # 
-    # The default values are contrast 143 and inverting off.
     def set_display_configuration(contrast, invert)
-      send_request FUNCTION_SET_DISPLAY_CONFIGURATION, [contrast, invert], 'C ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DISPLAY_CONFIGURATION, [contrast, invert], 'C ?', 8, ''
     end
 
     # Returns the configuration as set by BrickletOLED128x64#set_display_configuration.
     def get_display_configuration
-      send_request FUNCTION_GET_DISPLAY_CONFIGURATION, [], '', 2, 'C ?'
+      check_validity
+
+      send_request FUNCTION_GET_DISPLAY_CONFIGURATION, [], '', 10, 'C ?'
     end
 
-    # Writes text to a specific line (0 to 7) with a specific position
-    # (0 to 25). The text can have a maximum of 26 characters.
+    # Writes text to a specific line with a specific position.
+    # The text can have a maximum of 26 characters.
     # 
     # For example: (1, 10, "Hello") will write *Hello* in the middle of the
     # second line of the display.
@@ -106,19 +115,23 @@ module Tinkerforge
     # The display uses a special 5x7 pixel charset. You can view the characters
     # of the charset in Brick Viewer.
     def write_line(line, position, text)
-      send_request FUNCTION_WRITE_LINE, [line, position, text], 'C C Z26', 0, ''
+      check_validity
+
+      send_request FUNCTION_WRITE_LINE, [line, position, text], 'C C Z26', 8, ''
     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
 
   end

data/lib/tinkerforge/bricklet_oled_128x64_v2.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2021-01-15.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.28                              #
 #                                                           #
 # 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
   # 3.3cm (1.3") OLED display with 128x64 pixels
   class BrickletOLED128x64V2 < Device
@@ -54,7 +56,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]
 
@@ -79,13 +81,13 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
 
+      @ipcon.add_device self
     end
 
     # Writes pixels to the specified window.
     # 
-    # The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are written
-    # into the window line by line top to bottom and each line is written from left to
-    # right.
+    # The pixels are written into the window line by line top to bottom
+    # and each line is written from left to right.
     # 
     # If automatic draw is enabled (default) the pixels are directly written to
     # the screen. Only pixels that have actually changed are updated on the screen,
@@ -99,14 +101,15 @@ module Tinkerforge
     # Automatic draw can be configured with the BrickletOLED128x64V2#set_display_configuration
     # function.
     def write_pixels_low_level(x_start, y_start, x_end, y_end, pixels_length, pixels_chunk_offset, pixels_chunk_data)
-      send_request FUNCTION_WRITE_PIXELS_LOW_LEVEL, [x_start, y_start, x_end, y_end, pixels_length, pixels_chunk_offset, pixels_chunk_data], 'C C C C S S ?448', 0, ''
+      check_validity
+
+      send_request FUNCTION_WRITE_PIXELS_LOW_LEVEL, [x_start, y_start, x_end, y_end, pixels_length, pixels_chunk_offset, pixels_chunk_data], 'C C C C S S ?448', 8, ''
     end
 
     # Reads pixels from the specified window.
     # 
-    # The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are read
-    # from the window line by line top to bottom and each line is read from left to
-    # right.
+    # The pixels are read from the window line by line top to bottom
+    # and each line is read from left to right.
     # 
     # If automatic draw is enabled (default) the pixels that are read are always the
     # same that are shown on the display.
@@ -117,7 +120,9 @@ module Tinkerforge
     # Automatic draw can be configured with the BrickletOLED128x64V2#set_display_configuration
     # function.
     def read_pixels_low_level(x_start, y_start, x_end, y_end)
-      send_request FUNCTION_READ_PIXELS_LOW_LEVEL, [x_start, y_start, x_end, y_end], 'C C C C', 484, 'S S ?480'
+      check_validity
+
+      send_request FUNCTION_READ_PIXELS_LOW_LEVEL, [x_start, y_start, x_end, y_end], 'C C C C', 72, 'S S ?480'
     end
 
     # Clears the complete content of the display.
@@ -132,7 +137,9 @@ module Tinkerforge
     # Automatic draw can be configured with the BrickletOLED128x64V2#set_display_configuration
     # function.
     def clear_display
-      send_request FUNCTION_CLEAR_DISPLAY, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_CLEAR_DISPLAY, [], '', 8, ''
     end
 
     # Sets the configuration of the display.
@@ -144,19 +151,21 @@ module Tinkerforge
     # call of BrickletOLED128x64V2#write_pixels or BrickletOLED128x64V2#write_line. If it is set to false, the
     # changes are written into an internal buffer and only shown on the display after
     # a call of BrickletOLED128x64V2#draw_buffered_frame.
-    # 
-    # The default values are contrast 143, inverting off and automatic draw on.
     def set_display_configuration(contrast, invert, automatic_draw)
-      send_request FUNCTION_SET_DISPLAY_CONFIGURATION, [contrast, invert, automatic_draw], 'C ? ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DISPLAY_CONFIGURATION, [contrast, invert, automatic_draw], 'C ? ?', 8, ''
     end
 
     # Returns the configuration as set by BrickletOLED128x64V2#set_display_configuration.
     def get_display_configuration
-      send_request FUNCTION_GET_DISPLAY_CONFIGURATION, [], '', 3, 'C ? ?'
+      check_validity
+
+      send_request FUNCTION_GET_DISPLAY_CONFIGURATION, [], '', 11, 'C ? ?'
     end
 
-    # Writes text to a specific line (0 to 7) with a specific position
-    # (0 to 21). The text can have a maximum of 22 characters.
+    # Writes text to a specific line with a specific position.
+    # The text can have a maximum of 22 characters.
     # 
     # For example: (1, 10, "Hello") will write *Hello* in the middle of the
     # second line of the display.
@@ -176,7 +185,9 @@ module Tinkerforge
     # Automatic draw can be configured with the BrickletOLED128x64V2#set_display_configuration
     # function.
     def write_line(line, position, text)
-      send_request FUNCTION_WRITE_LINE, [line, position, text], 'C C Z22', 0, ''
+      check_validity
+
+      send_request FUNCTION_WRITE_LINE, [line, position, text], 'C C Z22', 8, ''
     end
 
     # Draws the currently buffered frame. Normally each call of BrickletOLED128x64V2#write_pixels and
@@ -189,7 +200,9 @@ module Tinkerforge
     # instead of only the changed parts. Normally it should not be necessary to set this to
     # *true*. It may only become necessary in case of stuck pixels because of errors.
     def draw_buffered_frame(force_complete_redraw)
-      send_request FUNCTION_DRAW_BUFFERED_FRAME, [force_complete_redraw], '?', 0, ''
+      check_validity
+
+      send_request FUNCTION_DRAW_BUFFERED_FRAME, [force_complete_redraw], '?', 8, ''
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -204,7 +217,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
@@ -217,12 +232,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 BrickletOLED128x64V2#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 BrickletOLED128x64V2#write_firmware. The pointer has
@@ -232,7 +251,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
@@ -244,7 +265,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
@@ -255,22 +278,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 BrickletOLED128x64V2#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
@@ -280,7 +309,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
@@ -289,32 +320,37 @@ 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).
+    # 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
 
     # Writes pixels to the specified window.
     # 
-    # The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are written
-    # into the window line by line top to bottom and each line is written from left to
-    # right.
+    # The pixels are written into the window line by line top to bottom
+    # and each line is written from left to right.
     # 
     # If automatic draw is enabled (default) the pixels are directly written to
     # the screen. Only pixels that have actually changed are updated on the screen,
@@ -360,9 +396,8 @@ module Tinkerforge
 
     # Reads pixels from the specified window.
     # 
-    # The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are read
-    # from the window line by line top to bottom and each line is read from left to
-    # right.
+    # The pixels are read from the window line by line top to bottom
+    # and each line is read from left to right.
     # 
     # If automatic draw is enabled (default) the pixels that are read are always the
     # same that are shown on the display.