class Tinkerforge::BrickletMotorizedLinearPoti
Motorized Linear Potentiometer
Constants
- CALLBACK_POSITION
This callback is triggered periodically according to the configuration set by
BrickletMotorizedLinearPoti#set_position_callback_configuration
.The parameter is the same as
BrickletMotorizedLinearPoti#get_position
.- CALLBACK_POSITION_REACHED
This callback is triggered if a new position as set by
BrickletMotorizedLinearPoti#set_motor_position
is reached.The parameter is the current position.
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 77 def initialize(uid, ipcon) super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME @api_version = [2, 0, 0] @response_expected[FUNCTION_GET_POSITION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_POSITION_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_MOTOR_POSITION] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_MOTOR_POSITION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_CALIBRATE] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_POSITION_REACHED_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @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_POSITION] = [10, 'S'] @callback_formats[CALLBACK_POSITION_REACHED] = [10, 'S'] @ipcon.add_device self end
Public Instance Methods
Starts a calibration procedure. The potentiometer will be driven to the extreme points to calibrate the potentiometer.
The calibration is saved in flash, it does not have to be called on every start up.
The Motorized Linear Poti Bricklet is already factory-calibrated during testing at Tinkerforge
.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 198 def calibrate check_validity send_request FUNCTION_CALIBRATE, [], '', 8, '' end
Returns the current bootloader mode, see BrickletMotorizedLinearPoti#set_bootloader_mode
.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 252 def get_bootloader_mode check_validity send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 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.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 310 def get_chip_temperature check_validity send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's' 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|
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 357 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
Returns the last motor position as set by BrickletMotorizedLinearPoti#set_motor_position
. This is not the current position (use BrickletMotorizedLinearPoti#get_position
to get the current position). This is the last used set point and configuration.
The position reached parameter is true if the position has been reached at one point. The position may have been changed again in the meantime by the user.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 185 def get_motor_position check_validity send_request FUNCTION_GET_MOTOR_POSITION, [], '', 13, 'S C ? ?' end
Returns the position of the linear potentiometer. The value is between 0 (slider down) and 100 (slider up).
If you want to get the value periodically, it is recommended to use the CALLBACK_POSITION
callback. You can set the callback configuration with BrickletMotorizedLinearPoti#set_position_callback_configuration
.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 116 def get_position check_validity send_request FUNCTION_GET_POSITION, [], '', 10, 'S' end
Returns the callback configuration as set by BrickletMotorizedLinearPoti#set_position_callback_configuration
.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 154 def get_position_callback_configuration check_validity send_request FUNCTION_GET_POSITION_CALLBACK_CONFIGURATION, [], '', 18, 'L ? k S S' end
Returns the CALLBACK_POSITION_REACHED
callback configuration as set by BrickletMotorizedLinearPoti#set_position_reached_callback_configuration
.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 213 def get_position_reached_callback_configuration check_validity send_request FUNCTION_GET_POSITION_REACHED_CALLBACK_CONFIGURATION, [], '', 9, '?' 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.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 230 def get_spitfp_error_count check_validity send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L' end
Returns the configuration as set by BrickletMotorizedLinearPoti#set_status_led_config
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 298 def get_status_led_config check_validity send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C' end
Returns the current UID as an integer. Encode as Base58
to get the usual string version.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 341 def read_uid check_validity send_request FUNCTION_READ_UID, [], '', 12, 'L' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 362 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback 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!
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 322 def reset check_validity send_request FUNCTION_RESET, [], '', 8, '' 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.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 245 def set_bootloader_mode(mode) check_validity send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C' end
Sets the position of the potentiometer. The motorized potentiometer will immediately start to approach the position. Depending on the chosen drive mode, the position will either be reached as fast as possible or in a slow but smooth motion.
The position has to be between 0 (slider down) and 100 (slider up).
If you set the hold position parameter to true, the position will automatically be retained. If a user changes the position of the potentiometer, it will automatically drive back to the original set point.
If the hold position parameter is set to false, the potentiometer can be changed again by the user as soon as the set point was reached once.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 173 def set_motor_position(position, drive_mode, hold_position) check_validity send_request FUNCTION_SET_MOTOR_POSITION, [position, drive_mode, hold_position], 'S C ?', 8, '' end
The period is the period with which the CALLBACK_POSITION
callback is triggered periodically. A value of 0 turns the callback off.
If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.
If it is set to false, the callback is continuously triggered with the period, independent of the value.
It is furthermore possible to constrain the callback with thresholds.
The `option`-parameter together with min/max sets a threshold for the CALLBACK_POSITION
callback.
The following options are possible:
"Option", "Description" "'x'", "Threshold is turned off" "'o'", "Threshold is triggered when the value is *outside* the min and max values" "'i'", "Threshold is triggered when the value is *inside* or equal to the min and max values" "'<'", "Threshold is triggered when the value is smaller than the min value (max is ignored)" "'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)"
If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 147 def set_position_callback_configuration(period, value_has_to_change, option, min, max) check_validity send_request FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k S S', 8, '' end
Enables/Disables CALLBACK_POSITION_REACHED
callback.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 205 def set_position_reached_callback_configuration(enabled) check_validity send_request FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION, [enabled], '?', 8, '' 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.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 291 def set_status_led_config(config) check_validity send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, '' end
Sets the firmware pointer for BrickletMotorizedLinearPoti#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.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 264 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 BrickletMotorizedLinearPoti#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.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 278 def write_firmware(data) check_validity send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C' 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.
# File lib/tinkerforge/bricklet_motorized_linear_poti.rb, line 333 def write_uid(uid) check_validity send_request FUNCTION_WRITE_UID, [uid], 'L', 8, '' end