Class: Tinkerforge::BrickletSilentStepperV2

Inherits:
Device
  • Object
show all
Defined in:
lib/tinkerforge/bricklet_silent_stepper_v2.rb

Overview

Silently drives one bipolar stepper motor with up to 46V and 1.6A per phase

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2166
DEVICE_DISPLAY_NAME =

:nodoc:

'Silent Stepper Bricklet 2.0'
CALLBACK_UNDER_VOLTAGE =

This callback is triggered when the input voltage drops below the value set by BrickletSilentStepperV2#set_minimum_voltage. The parameter is the current voltage.

41
CALLBACK_POSITION_REACHED =

This callback is triggered when a position set by BrickletSilentStepperV2#set_steps or BrickletSilentStepperV2#set_target_position is reached.

.. note

Since we can’t get any feedback from the stepper motor, this only works if the acceleration (see BrickletSilentStepperV2#set_speed_ramping) is set smaller or equal to the maximum acceleration of the motor. Otherwise the motor will lag behind the control value and the callback will be triggered too early.

42
CALLBACK_ALL_DATA =

This callback is triggered periodically with the period that is set by BrickletSilentStepperV2#set_all_callback_configuration. The parameters are: the current velocity, the current position, the remaining steps, the stack voltage, the external voltage and the current consumption of the stepper motor.

53
CALLBACK_NEW_STATE =

This callback is triggered whenever the Silent Stepper Bricklet 2.0 enters a new state. It returns the new state as well as the previous state.

54
CALLBACK_GPIO_STATE =

This callback is triggered by GPIO changes if it is activated through BrickletSilentStepperV2#set_gpio_action.

55
FUNCTION_SET_MAX_VELOCITY =

:nodoc:

1
FUNCTION_GET_MAX_VELOCITY =

:nodoc:

2
FUNCTION_GET_CURRENT_VELOCITY =

:nodoc:

3
FUNCTION_SET_SPEED_RAMPING =

:nodoc:

4
FUNCTION_GET_SPEED_RAMPING =

:nodoc:

5
FUNCTION_FULL_BRAKE =

:nodoc:

6
FUNCTION_SET_CURRENT_POSITION =

:nodoc:

7
FUNCTION_GET_CURRENT_POSITION =

:nodoc:

8
FUNCTION_SET_TARGET_POSITION =

:nodoc:

9
FUNCTION_GET_TARGET_POSITION =

:nodoc:

10
FUNCTION_SET_STEPS =

:nodoc:

11
FUNCTION_GET_STEPS =

:nodoc:

12
FUNCTION_GET_REMAINING_STEPS =

:nodoc:

13
FUNCTION_SET_STEP_CONFIGURATION =

:nodoc:

14
FUNCTION_GET_STEP_CONFIGURATION =

:nodoc:

15
FUNCTION_DRIVE_FORWARD =

:nodoc:

16
FUNCTION_DRIVE_BACKWARD =

:nodoc:

17
FUNCTION_STOP =

:nodoc:

18
FUNCTION_GET_INPUT_VOLTAGE =

:nodoc:

19
FUNCTION_SET_MOTOR_CURRENT =

:nodoc:

22
FUNCTION_GET_MOTOR_CURRENT =

:nodoc:

23
FUNCTION_SET_ENABLED =

:nodoc:

24
FUNCTION_GET_ENABLED =

:nodoc:

25
FUNCTION_SET_BASIC_CONFIGURATION =

:nodoc:

26
FUNCTION_GET_BASIC_CONFIGURATION =

:nodoc:

27
FUNCTION_SET_SPREADCYCLE_CONFIGURATION =

:nodoc:

28
FUNCTION_GET_SPREADCYCLE_CONFIGURATION =

:nodoc:

29
FUNCTION_SET_STEALTH_CONFIGURATION =

:nodoc:

30
FUNCTION_GET_STEALTH_CONFIGURATION =

:nodoc:

31
FUNCTION_SET_COOLSTEP_CONFIGURATION =

:nodoc:

32
FUNCTION_GET_COOLSTEP_CONFIGURATION =

:nodoc:

33
FUNCTION_SET_MISC_CONFIGURATION =

:nodoc:

34
FUNCTION_GET_MISC_CONFIGURATION =

:nodoc:

35
FUNCTION_SET_ERROR_LED_CONFIG =

:nodoc:

36
FUNCTION_GET_ERROR_LED_CONFIG =

:nodoc:

37
FUNCTION_GET_DRIVER_STATUS =

:nodoc:

38
FUNCTION_SET_MINIMUM_VOLTAGE =

:nodoc:

39
FUNCTION_GET_MINIMUM_VOLTAGE =

:nodoc:

40
FUNCTION_SET_TIME_BASE =

:nodoc:

43
FUNCTION_GET_TIME_BASE =

:nodoc:

44
FUNCTION_GET_ALL_DATA =

:nodoc:

45
FUNCTION_SET_ALL_CALLBACK_CONFIGURATION =

:nodoc:

46
FUNCTION_GET_ALL_DATA_CALLBACK_CONFIGURATON =

:nodoc:

47
FUNCTION_SET_GPIO_CONFIGURATION =

:nodoc:

48
FUNCTION_GET_GPIO_CONFIGURATION =

:nodoc:

49
FUNCTION_SET_GPIO_ACTION =

:nodoc:

50
FUNCTION_GET_GPIO_ACTION =

:nodoc:

51
FUNCTION_GET_GPIO_STATE =

:nodoc:

52
FUNCTION_GET_SPITFP_ERROR_COUNT =

:nodoc:

234
FUNCTION_SET_BOOTLOADER_MODE =

:nodoc:

235
FUNCTION_GET_BOOTLOADER_MODE =

:nodoc:

236
FUNCTION_SET_WRITE_FIRMWARE_POINTER =

:nodoc:

237
FUNCTION_WRITE_FIRMWARE =

:nodoc:

238
FUNCTION_SET_STATUS_LED_CONFIG =

:nodoc:

239
FUNCTION_GET_STATUS_LED_CONFIG =

:nodoc:

240
FUNCTION_GET_CHIP_TEMPERATURE =

:nodoc:

242
FUNCTION_RESET =

:nodoc:

243
FUNCTION_WRITE_UID =

:nodoc:

248
FUNCTION_READ_UID =

:nodoc:

249
FUNCTION_GET_IDENTITY =

:nodoc:

255
STEP_RESOLUTION_1 =

:nodoc:

8
STEP_RESOLUTION_2 =

:nodoc:

7
STEP_RESOLUTION_4 =

:nodoc:

6
STEP_RESOLUTION_8 =

:nodoc:

5
STEP_RESOLUTION_16 =

:nodoc:

4
STEP_RESOLUTION_32 =

:nodoc:

3
STEP_RESOLUTION_64 =

:nodoc:

2
STEP_RESOLUTION_128 =

:nodoc:

1
STEP_RESOLUTION_256 =

:nodoc:

0
CHOPPER_MODE_SPREAD_CYCLE =

:nodoc:

0
CHOPPER_MODE_FAST_DECAY =

:nodoc:

1
FREEWHEEL_MODE_NORMAL =

:nodoc:

0
FREEWHEEL_MODE_FREEWHEELING =

:nodoc:

1
FREEWHEEL_MODE_COIL_SHORT_LS =

:nodoc:

2
FREEWHEEL_MODE_COIL_SHORT_HS =

:nodoc:

3
CURRENT_UP_STEP_INCREMENT_1 =

:nodoc:

0
CURRENT_UP_STEP_INCREMENT_2 =

:nodoc:

1
CURRENT_UP_STEP_INCREMENT_4 =

:nodoc:

2
CURRENT_UP_STEP_INCREMENT_8 =

:nodoc:

3
CURRENT_DOWN_STEP_DECREMENT_1 =

:nodoc:

0
CURRENT_DOWN_STEP_DECREMENT_2 =

:nodoc:

1
CURRENT_DOWN_STEP_DECREMENT_8 =

:nodoc:

2
CURRENT_DOWN_STEP_DECREMENT_32 =

:nodoc:

3
MINIMUM_CURRENT_HALF =

:nodoc:

0
MINIMUM_CURRENT_QUARTER =

:nodoc:

1
STALLGUARD_MODE_STANDARD =

:nodoc:

0
STALLGUARD_MODE_FILTERED =

:nodoc:

1
OPEN_LOAD_NONE =

:nodoc:

0
OPEN_LOAD_PHASE_A =

:nodoc:

1
OPEN_LOAD_PHASE_B =

:nodoc:

2
OPEN_LOAD_PHASE_AB =

:nodoc:

3
SHORT_TO_GROUND_NONE =

:nodoc:

0
SHORT_TO_GROUND_PHASE_A =

:nodoc:

1
SHORT_TO_GROUND_PHASE_B =

:nodoc:

2
SHORT_TO_GROUND_PHASE_AB =

:nodoc:

3
OVER_TEMPERATURE_NONE =

:nodoc:

0
OVER_TEMPERATURE_WARNING =

:nodoc:

1
OVER_TEMPERATURE_LIMIT =

:nodoc:

2
STATE_STOP =

:nodoc:

1
STATE_ACCELERATION =

:nodoc:

2
STATE_RUN =

:nodoc:

3
STATE_DEACCELERATION =

:nodoc:

4
STATE_DIRECTION_CHANGE_TO_FORWARD =

:nodoc:

5
STATE_DIRECTION_CHANGE_TO_BACKWARD =

:nodoc:

6
GPIO_ACTION_NONE =

:nodoc:

0
GPIO_ACTION_NORMAL_STOP_RISING_EDGE =

:nodoc:

1
GPIO_ACTION_NORMAL_STOP_FALLING_EDGE =

:nodoc:

2
GPIO_ACTION_FULL_BRAKE_RISING_EDGE =

:nodoc:

4
GPIO_ACTION_FULL_BRAKE_FALLING_EDGE =

:nodoc:

8
GPIO_ACTION_CALLBACK_RISING_EDGE =

:nodoc:

16
GPIO_ACTION_CALLBACK_FALLING_EDGE =

:nodoc:

32
ERROR_LED_CONFIG_OFF =

:nodoc:

0
ERROR_LED_CONFIG_ON =

:nodoc:

1
ERROR_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
ERROR_LED_CONFIG_SHOW_ERROR =

:nodoc:

3
BOOTLOADER_MODE_BOOTLOADER =

:nodoc:

0
BOOTLOADER_MODE_FIRMWARE =

:nodoc:

1
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT =

:nodoc:

2
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT =

:nodoc:

3
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT =

:nodoc:

4
BOOTLOADER_STATUS_OK =

:nodoc:

0
BOOTLOADER_STATUS_INVALID_MODE =

:nodoc:

1
BOOTLOADER_STATUS_NO_CHANGE =

:nodoc:

2
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT =

:nodoc:

3
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT =

:nodoc:

4
BOOTLOADER_STATUS_CRC_MISMATCH =

:nodoc:

5
STATUS_LED_CONFIG_OFF =

:nodoc:

0
STATUS_LED_CONFIG_ON =

:nodoc:

1
STATUS_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
STATUS_LED_CONFIG_SHOW_STATUS =

:nodoc:

3

Constants inherited from Device

Device::DEVICE_IDENTIFIER_CHECK_MATCH, Device::DEVICE_IDENTIFIER_CHECK_MISMATCH, Device::DEVICE_IDENTIFIER_CHECK_PENDING, Device::RESPONSE_EXPECTED_ALWAYS_TRUE, Device::RESPONSE_EXPECTED_FALSE, Device::RESPONSE_EXPECTED_INVALID_FUNCTION_ID, Device::RESPONSE_EXPECTED_TRUE

Instance Attribute Summary

Attributes inherited from Device

#callback_formats, #expected_response_function_id, #expected_response_sequence_number, #high_level_callbacks, #registered_callbacks, #replaced, #uid

Instance Method Summary collapse

Methods inherited from Device

#check_validity, #dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all

Constructor Details

#initialize(uid, ipcon) ⇒ BrickletSilentStepperV2

Creates an object with the unique device ID uid and adds it to the IP Connection ipcon.



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 181

def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_SET_MAX_VELOCITY] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_MAX_VELOCITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_CURRENT_VELOCITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SPEED_RAMPING] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SPEED_RAMPING] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_FULL_BRAKE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_SET_CURRENT_POSITION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_CURRENT_POSITION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_TARGET_POSITION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_TARGET_POSITION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STEPS] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_STEPS] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_REMAINING_STEPS] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STEP_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_STEP_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_DRIVE_FORWARD] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_DRIVE_BACKWARD] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_STOP] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_INPUT_VOLTAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_MOTOR_CURRENT] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_MOTOR_CURRENT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ENABLED] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_ENABLED] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_BASIC_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_BASIC_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SPREADCYCLE_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SPREADCYCLE_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STEALTH_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_STEALTH_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_COOLSTEP_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_COOLSTEP_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_MISC_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_MISC_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ERROR_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_ERROR_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_DRIVER_STATUS] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_MINIMUM_VOLTAGE] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_MINIMUM_VOLTAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_TIME_BASE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_TIME_BASE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_ALL_DATA] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ALL_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ALL_DATA_CALLBACK_CONFIGURATON] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_GPIO_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_GPIO_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_GPIO_ACTION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_GPIO_ACTION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_GPIO_STATE] = 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_UNDER_VOLTAGE] = [10, 'S']
  @callback_formats[CALLBACK_POSITION_REACHED] = [12, 'l']
  @callback_formats[CALLBACK_ALL_DATA] = [22, 'S l l S S']
  @callback_formats[CALLBACK_NEW_STATE] = [10, 'C C']
  @callback_formats[CALLBACK_GPIO_STATE] = [9, '?2']

  @ipcon.add_device self
end

Instance Method Details

#drive_backward ⇒ Object

Drives the stepper motor backward until BrickletSilentStepperV2#drive_forward or BrickletSilentStepperV2#stop is triggered. The velocity, acceleration and deacceleration as set by BrickletSilentStepperV2#set_max_velocity and BrickletSilentStepperV2#set_speed_ramping will be used.



424
425
426
427
428
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 424

def drive_backward
  check_validity

  send_request FUNCTION_DRIVE_BACKWARD, [], '', 8, ''
end

#drive_forward ⇒ Object

Drives the stepper motor forward until BrickletSilentStepperV2#drive_backward or BrickletSilentStepperV2#stop is called. The velocity, acceleration and deacceleration as set by BrickletSilentStepperV2#set_max_velocity and BrickletSilentStepperV2#set_speed_ramping will be used.



415
416
417
418
419
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 415

def drive_forward
  check_validity

  send_request FUNCTION_DRIVE_FORWARD, [], '', 8, ''
end

#full_brake ⇒ Object

Executes an active full brake.

.. warning

This function is for emergency purposes, where an immediate brake is necessary. Depending on the current velocity and the strength of the motor, a full brake can be quite violent.

Call BrickletSilentStepperV2#stop if you just want to stop the motor.



313
314
315
316
317
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 313

def full_brake
  check_validity

  send_request FUNCTION_FULL_BRAKE, [], '', 8, ''
end

#get_all_data ⇒ Object

Returns the following parameters: The current velocity, the current position, the remaining steps, the stack voltage, the external voltage and the current consumption of the stepper motor.

The current consumption is calculated by multiplying the “Actual Motor Current“ value (see BrickletSilentStepperV2#set_basic_configuration) with the “Motor Run Current“ (see BrickletSilentStepperV2#get_driver_status). This is an internal calculation of the driver, not an independent external measurement.

The current consumption calculation was broken up to firmware 2.0.1, it is fixed since firmware 2.0.2.

There is also a callback for this function, see CALLBACK_ALL_DATA callback.



809
810
811
812
813
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 809

def get_all_data
  check_validity

  send_request FUNCTION_GET_ALL_DATA, [], '', 22, 'S l l S S'
end

#get_all_data_callback_configuraton ⇒ Object

Returns the period as set by BrickletSilentStepperV2#set_all_callback_configuration.



824
825
826
827
828
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 824

def get_all_data_callback_configuraton
  check_validity

  send_request FUNCTION_GET_ALL_DATA_CALLBACK_CONFIGURATON, [], '', 12, 'L'
end

#get_basic_configuration ⇒ Object

Returns the configuration as set by BrickletSilentStepperV2#set_basic_configuration.



543
544
545
546
547
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 543

def get_basic_configuration
  check_validity

  send_request FUNCTION_GET_BASIC_CONFIGURATION, [], '', 23, 'S S S S S S S ?'
end

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletSilentStepperV2#set_bootloader_mode.



909
910
911
912
913
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 909

def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end

#get_chip_temperature ⇒ Object

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.



967
968
969
970
971
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 967

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end

#get_coolstep_configuration ⇒ Object

Returns the configuration as set by BrickletSilentStepperV2#set_coolstep_configuration.



671
672
673
674
675
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 671

def get_coolstep_configuration
  check_validity

  send_request FUNCTION_GET_COOLSTEP_CONFIGURATION, [], '', 15, 'C C C C C c C'
end

#get_current_position ⇒ Object

Returns the current position of the stepper motor in steps. On startup the position is 0. The steps are counted with all possible driving functions (BrickletSilentStepperV2#set_target_position, BrickletSilentStepperV2#set_steps, BrickletSilentStepperV2#drive_forward or BrickletSilentStepperV2#drive_backward). It also is possible to reset the steps to 0 or set them to any other desired value with BrickletSilentStepperV2#set_current_position.



333
334
335
336
337
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 333

def get_current_position
  check_validity

  send_request FUNCTION_GET_CURRENT_POSITION, [], '', 12, 'l'
end

#get_current_velocity ⇒ Object

Returns the current velocity of the stepper motor.



275
276
277
278
279
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 275

def get_current_velocity
  check_validity

  send_request FUNCTION_GET_CURRENT_VELOCITY, [], '', 10, 'S'
end

#get_driver_status ⇒ Object

Returns the current driver status.

  • Open Load: Indicates if an open load is present on phase A, B or both. This could mean that there is a problem with the wiring of the motor. False detection can occur in fast motion as well as during stand still.

  • Short To Ground: Indicates if a short to ground is present on phase A, B or both. If this is detected the driver automatically becomes disabled and stays disabled until it is enabled again manually.

  • Over Temperature: The over temperature indicator switches to “Warning” if the driver IC warms up. The warning flag is expected during long duration stepper uses. If the temperature limit is reached the indicator switches to “Limit”. In this case the driver becomes disabled until it cools down again.

  • Motor Stalled: Is true if a motor stall was detected.

  • Actual Motor Current: Indicates the actual current control scaling as used in Coolstep mode. It represents a multiplier of 1/32 to 32/32 of the “Motor Run Current“ as set by BrickletSilentStepperV2#set_basic_configuration. Example: If a “Motor Run Current“ of 1000mA was set and the returned value is 15, the “Actual Motor Current“ is 16/32*1000mA = 500mA.

  • Stallguard Result: Indicates the load of the motor. A lower value signals a higher load. Per trial and error you can find out which value corresponds to a suitable torque for the velocity used in your application. After that you can use this threshold value to find out if a motor stall becomes probable and react on it (e.g. decrease velocity). During stand still this value can not be used for stall detection, it shows the chopper on-time for motor coil A.

  • Stealth Voltage Amplitude: Shows the actual PWM scaling. In Stealth mode it can be used to detect motor load and stall if autoscale is enabled (see BrickletSilentStepperV2#set_stealth_configuration).



752
753
754
755
756
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 752

def get_driver_status
  check_validity

  send_request FUNCTION_GET_DRIVER_STATUS, [], '', 16, 'C C C ? C ? C C'
end

#get_enabled ⇒ Object

Returns true if the stepper driver is enabled, false otherwise.



491
492
493
494
495
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 491

def get_enabled
  check_validity

  send_request FUNCTION_GET_ENABLED, [], '', 9, '?'
end

#get_error_led_config ⇒ Object

Returns the LED configuration as set by BrickletSilentStepperV2#set_error_led_config



719
720
721
722
723
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 719

def get_error_led_config
  check_validity

  send_request FUNCTION_GET_ERROR_LED_CONFIG, [], '', 9, 'C'
end

#get_gpio_action(channel) ⇒ Object

Returns the GPIO action for a channel as set by BrickletSilentStepperV2#set_gpio_action.



862
863
864
865
866
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 862

def get_gpio_action(channel)
  check_validity

  send_request FUNCTION_GET_GPIO_ACTION, [channel], 'C', 12, 'L'
end

#get_gpio_configuration(channel) ⇒ Object

Returns the GPIO configuration for a channel as set by BrickletSilentStepperV2#set_gpio_configuration.



840
841
842
843
844
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 840

def get_gpio_configuration(channel)
  check_validity

  send_request FUNCTION_GET_GPIO_CONFIGURATION, [channel], 'C', 12, 'S S'
end

#get_gpio_state ⇒ Object

Returns the GPIO state for both channels. True if the state is “high“ and false if the state is “low“.



870
871
872
873
874
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 870

def get_gpio_state
  check_validity

  send_request FUNCTION_GET_GPIO_STATE, [], '', 9, '?2'
end

#get_identity ⇒ Object

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|



1014
1015
1016
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 1014

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end

#get_input_voltage ⇒ Object

Returns the external input voltage. The external input voltage is given via the black power input connector on the Silent Stepper Bricklet 2.0.

If there is an external input voltage and a stack input voltage, the motor will be driven by the external input voltage. If there is only a stack voltage present, the motor will be driven by this voltage.

.. warning

This means, if you have a high stack voltage and a low external voltage, the motor will be driven with the low external voltage. If you then remove the external connection, it will immediately be driven by the high stack voltage



450
451
452
453
454
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 450

def get_input_voltage
  check_validity

  send_request FUNCTION_GET_INPUT_VOLTAGE, [], '', 10, 'S'
end

#get_max_velocity ⇒ Object

Returns the velocity as set by BrickletSilentStepperV2#set_max_velocity.



268
269
270
271
272
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 268

def get_max_velocity
  check_validity

  send_request FUNCTION_GET_MAX_VELOCITY, [], '', 10, 'S'
end

#get_minimum_voltage ⇒ Object

Returns the minimum voltage as set by BrickletSilentStepperV2#set_minimum_voltage.



771
772
773
774
775
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 771

def get_minimum_voltage
  check_validity

  send_request FUNCTION_GET_MINIMUM_VOLTAGE, [], '', 10, 'S'
end

#get_misc_configuration ⇒ Object

Returns the configuration as set by BrickletSilentStepperV2#set_misc_configuration.



697
698
699
700
701
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 697

def get_misc_configuration
  check_validity

  send_request FUNCTION_GET_MISC_CONFIGURATION, [], '', 10, '? C'
end

#get_motor_current ⇒ Object

Returns the current as set by BrickletSilentStepperV2#set_motor_current.



468
469
470
471
472
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 468

def get_motor_current
  check_validity

  send_request FUNCTION_GET_MOTOR_CURRENT, [], '', 10, 'S'
end

#get_remaining_steps ⇒ Object

Returns the remaining steps of the last call of BrickletSilentStepperV2#set_steps. For example, if BrickletSilentStepperV2#set_steps is called with 2000 and BrickletSilentStepperV2#get_remaining_steps is called after the motor has run for 500 steps, it will return 1500.



382
383
384
385
386
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 382

def get_remaining_steps
  check_validity

  send_request FUNCTION_GET_REMAINING_STEPS, [], '', 12, 'l'
end

#get_speed_ramping ⇒ Object

Returns the acceleration and deacceleration as set by BrickletSilentStepperV2#set_speed_ramping.



299
300
301
302
303
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 299

def get_speed_ramping
  check_validity

  send_request FUNCTION_GET_SPEED_RAMPING, [], '', 12, 'S S'
end

#get_spitfp_error_count ⇒ Object

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.



887
888
889
890
891
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 887

def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end

#get_spreadcycle_configuration ⇒ Object

Returns the configuration as set by BrickletSilentStepperV2#set_basic_configuration.



595
596
597
598
599
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 595

def get_spreadcycle_configuration
  check_validity

  send_request FUNCTION_GET_SPREADCYCLE_CONFIGURATION, [], '', 17, 'C ? C C c c C C ?'
end

#get_status_led_config ⇒ Object

Returns the configuration as set by BrickletSilentStepperV2#set_status_led_config



955
956
957
958
959
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 955

def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end

#get_stealth_configuration ⇒ Object

Returns the configuration as set by BrickletSilentStepperV2#set_stealth_configuration.



631
632
633
634
635
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 631

def get_stealth_configuration
  check_validity

  send_request FUNCTION_GET_STEALTH_CONFIGURATION, [], '', 14, '? C C ? ? C'
end

#get_step_configuration ⇒ Object

Returns the step mode as set by BrickletSilentStepperV2#set_step_configuration.



406
407
408
409
410
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 406

def get_step_configuration
  check_validity

  send_request FUNCTION_GET_STEP_CONFIGURATION, [], '', 10, 'C ?'
end

#get_steps ⇒ Object

Returns the last steps as set by BrickletSilentStepperV2#set_steps.



372
373
374
375
376
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 372

def get_steps
  check_validity

  send_request FUNCTION_GET_STEPS, [], '', 12, 'l'
end

#get_target_position ⇒ Object

Returns the last target position as set by BrickletSilentStepperV2#set_target_position.



355
356
357
358
359
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 355

def get_target_position
  check_validity

  send_request FUNCTION_GET_TARGET_POSITION, [], '', 12, 'l'
end

#get_time_base ⇒ Object

Returns the time base as set by BrickletSilentStepperV2#set_time_base.



790
791
792
793
794
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 790

def get_time_base
  check_validity

  send_request FUNCTION_GET_TIME_BASE, [], '', 12, 'L'
end

#read_uid ⇒ Object

Returns the current UID as an integer. Encode as Base58 to get the usual string version.



998
999
1000
1001
1002
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 998

def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



1019
1020
1021
1022
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 1019

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end

#reset ⇒ Object

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!



979
980
981
982
983
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 979

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end

#set_all_callback_configuration(period) ⇒ Object

Sets the period with which the CALLBACK_ALL_DATA callback is triggered periodically. A value of 0 turns the callback off.



817
818
819
820
821
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 817

def set_all_callback_configuration(period)
  check_validity

  send_request FUNCTION_SET_ALL_CALLBACK_CONFIGURATION, [period], 'L', 8, ''
end

#set_basic_configuration(standstill_current, motor_run_current, standstill_delay_time, power_down_time, stealth_threshold, coolstep_threshold, classic_threshold, high_velocity_chopper_mode) ⇒ Object

Sets the basic configuration parameters for the different modes (Stealth, Coolstep, Classic).

  • Standstill Current: This value can be used to lower the current during stand still. This might be reasonable to reduce the heating of the motor and the Bricklet 2.0. When the motor is in standstill the configured motor phase current will be driven until the configured Power Down Time is elapsed. After that the phase current will be reduced to the standstill current. The elapsed time for this reduction can be configured with the Standstill Delay Time. The maximum allowed value is the configured maximum motor current (see BrickletSilentStepperV2#set_motor_current).

  • Motor Run Current: The value sets the motor current when the motor is running. Use a value of at least one half of the global maximum motor current for a good microstep performance. The maximum allowed value is the current motor current. The API maps the entered value to 1/32 … 32/32 of the maximum motor current. This value should be used to change the motor current during motor movement, whereas the global maximum motor current should not be changed while the motor is moving (see BrickletSilentStepperV2#set_motor_current).

  • Standstill Delay Time: Controls the duration for motor power down after a motion as soon as standstill is detected and the Power Down Time is expired. A high Standstill Delay Time results in a smooth transition that avoids motor jerk during power down.

  • Power Down Time: Sets the delay time after a stand still.

  • Stealth Threshold: Sets the upper threshold for Stealth mode. If the velocity of the motor goes above this value, Stealth mode is turned off. Otherwise it is turned on. In Stealth mode the torque declines with high speed.

  • Coolstep Threshold: Sets the lower threshold for Coolstep mode. The Coolstep Threshold needs to be above the Stealth Threshold.

  • Classic Threshold: Sets the lower threshold for classic mode. In classic mode the stepper becomes more noisy, but the torque is maximized.

  • High Velocity Chopper Mode: If High Velocity Chopper Mode is enabled, the stepper control is optimized to run the stepper motors at high velocities.

If you want to use all three thresholds make sure that Stealth Threshold < Coolstep Threshold < Classic Threshold.



536
537
538
539
540
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 536

def set_basic_configuration(standstill_current, motor_run_current, standstill_delay_time, power_down_time, stealth_threshold, coolstep_threshold, classic_threshold, high_velocity_chopper_mode)
  check_validity

  send_request FUNCTION_SET_BASIC_CONFIGURATION, [standstill_current, motor_run_current, standstill_delay_time, power_down_time, stealth_threshold, coolstep_threshold, classic_threshold, high_velocity_chopper_mode], 'S S S S S S S ?', 8, ''
end

#set_bootloader_mode(mode) ⇒ Object

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.



902
903
904
905
906
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 902

def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end

#set_coolstep_configuration(minimum_stallguard_value, maximum_stallguard_value, current_up_step_width, current_down_step_width, minimum_current, stallguard_threshold_value, stallguard_mode) ⇒ Object

Note: If you don’t know what any of this means you can very likely keep all of the values as default!

Sets the configuration relevant for Coolstep.

  • Minimum Stallguard Value: If the Stallguard result falls below this value*32, the motor current is increased to reduce motor load angle. A value of 0 turns Coolstep off.

  • Maximum Stallguard Value: If the Stallguard result goes above (Min Stallguard Value + Max Stallguard Value + 1) * 32, the motor current is decreased to save energy.

  • Current Up Step Width: Sets the up step increment per Stallguard value. The value range is 0-3, corresponding to the increments 1, 2, 4 and 8.

  • Current Down Step Width: Sets the down step decrement per Stallguard value. The value range is 0-3, corresponding to the decrements 1, 2, 8 and 16.

  • Minimum Current: Sets the minimum current for Coolstep current control. You can choose between half and quarter of the run current.

  • Stallguard Threshold Value: Sets the level for stall output (see BrickletSilentStepperV2#get_driver_status). A lower value gives a higher sensitivity. You have to find a suitable value for your motor by trial and error, 0 works for most motors.

  • Stallguard Mode: Set to 0 for standard resolution or 1 for filtered mode. In filtered mode the Stallguard signal will be updated every four full-steps.



664
665
666
667
668
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 664

def set_coolstep_configuration(minimum_stallguard_value, maximum_stallguard_value, current_up_step_width, current_down_step_width, minimum_current, stallguard_threshold_value, stallguard_mode)
  check_validity

  send_request FUNCTION_SET_COOLSTEP_CONFIGURATION, [minimum_stallguard_value, maximum_stallguard_value, current_up_step_width, current_down_step_width, minimum_current, stallguard_threshold_value, stallguard_mode], 'C C C C C c C', 8, ''
end

#set_current_position(position) ⇒ Object

Sets the current steps of the internal step counter. This can be used to set the current position to 0 when some kind of starting position is reached (e.g. when a CNC machine reaches a corner).



322
323
324
325
326
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 322

def set_current_position(position)
  check_validity

  send_request FUNCTION_SET_CURRENT_POSITION, [position], 'l', 8, ''
end

#set_enabled(enabled) ⇒ Object

Enables/Disables the driver chip. The driver parameters can be configured (maximum velocity, acceleration, etc) before it is enabled.

.. warning

Disabling the driver chip while the motor is still turning can damage the driver chip. The motor should be stopped calling BrickletSilentStepperV2#stop function before disabling the motor power. The BrickletSilentStepperV2#stop function will not wait until the motor is actually stopped. You have to explicitly wait for the appropriate time after calling the BrickletSilentStepperV2#stop function before calling the BrickletSilentStepperV2#set_enabled with false function.



484
485
486
487
488
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 484

def set_enabled(enabled)
  check_validity

  send_request FUNCTION_SET_ENABLED, [enabled], '?', 8, ''
end

#set_error_led_config(config) ⇒ Object

Configures the error LED to be either turned off, turned on, blink in heartbeat mode or show an error.

If the LED is configured to show errors it has three different states:

  • Off: No error present.

  • 250ms interval blink: Overtemperature warning.

  • 1s interval blink: Input voltage too small.

  • full red: motor disabled because of short to ground in phase a or b or because of overtemperature.



712
713
714
715
716
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 712

def set_error_led_config(config)
  check_validity

  send_request FUNCTION_SET_ERROR_LED_CONFIG, [config], 'C', 8, ''
end

#set_gpio_action(channel, action) ⇒ Object

Sets the GPIO action for the given channel.

The action can be a normal stop, a full brake or a callback. Each for a rising edge or falling edge. The actions are a bitmask they can be used at the same time. You can for example trigger a full brake and a callback at the same time or for rising and falling edge.

The deceleration speed for the normal stop can be configured with BrickletSilentStepperV2#set_gpio_configuration.



855
856
857
858
859
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 855

def set_gpio_action(channel, action)
  check_validity

  send_request FUNCTION_SET_GPIO_ACTION, [channel, action], 'C L', 8, ''
end

#set_gpio_configuration(channel, debounce, stop_deceleration) ⇒ Object

Sets the GPIO configuration for the given channel. You can configure a debounce and the deceleration that is used if the action is configured as “normal stop“. See BrickletSilentStepperV2#set_gpio_action.



833
834
835
836
837
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 833

def set_gpio_configuration(channel, debounce, stop_deceleration)
  check_validity

  send_request FUNCTION_SET_GPIO_CONFIGURATION, [channel, debounce, stop_deceleration], 'C S S', 8, ''
end

#set_max_velocity(velocity) ⇒ Object

Sets the maximum velocity of the stepper motor. This function does not start the motor, it merely sets the maximum velocity the stepper motor is accelerated to. To get the motor running use either BrickletSilentStepperV2#set_target_position, BrickletSilentStepperV2#set_steps, BrickletSilentStepperV2#drive_forward or BrickletSilentStepperV2#drive_backward.



261
262
263
264
265
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 261

def set_max_velocity(velocity)
  check_validity

  send_request FUNCTION_SET_MAX_VELOCITY, [velocity], 'S', 8, ''
end

#set_minimum_voltage(voltage) ⇒ Object

Sets the minimum voltage, below which the CALLBACK_UNDER_VOLTAGE callback is triggered. The minimum possible value that works with the Silent Stepper Bricklet 2.0 is 8V. You can use this function to detect the discharge of a battery that is used to drive the stepper motor. If you have a fixed power supply, you likely do not need this functionality.



764
765
766
767
768
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 764

def set_minimum_voltage(voltage)
  check_validity

  send_request FUNCTION_SET_MINIMUM_VOLTAGE, [voltage], 'S', 8, ''
end

#set_misc_configuration(disable_short_to_ground_protection, synchronize_phase_frequency) ⇒ Object

Note: If you don’t know what any of this means you can very likely keep all of the values as default!

Sets miscellaneous configuration parameters.

  • Disable Short To Ground Protection: Set to false to enable short to ground protection, otherwise it is disabled.

  • Synchronize Phase Frequency: With this parameter you can synchronize the chopper for both phases of a two phase motor to avoid the occurrence of a beat. The value range is 0-15. If set to 0, the synchronization is turned off. Otherwise the synchronization is done through the formula f_sync = f_clk/(value*64). In Classic Mode the synchronization is automatically switched off. f_clk is 12.8MHz.



690
691
692
693
694
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 690

def set_misc_configuration(disable_short_to_ground_protection, synchronize_phase_frequency)
  check_validity

  send_request FUNCTION_SET_MISC_CONFIGURATION, [disable_short_to_ground_protection, synchronize_phase_frequency], '? C', 8, ''
end

#set_motor_current(current) ⇒ Object

Sets the current with which the motor will be driven.

.. warning

Do not set this value above the specifications of your stepper motor. Otherwise it may damage your motor.



461
462
463
464
465
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 461

def set_motor_current(current)
  check_validity

  send_request FUNCTION_SET_MOTOR_CURRENT, [current], 'S', 8, ''
end

#set_speed_ramping(acceleration, deacceleration) ⇒ Object

Sets the acceleration and deacceleration of the stepper motor. An acceleration of 1000 means, that every second the velocity is increased by 1000 steps/s.

For example: If the current velocity is 0 and you want to accelerate to a velocity of 8000 steps/s in 10 seconds, you should set an acceleration of 800 steps/s².

An acceleration/deacceleration of 0 means instantaneous acceleration/deacceleration (not recommended)



291
292
293
294
295
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 291

def set_speed_ramping(acceleration, deacceleration)
  check_validity

  send_request FUNCTION_SET_SPEED_RAMPING, [acceleration, deacceleration], 'S S', 8, ''
end

#set_spreadcycle_configuration(slow_decay_duration, enable_random_slow_decay, fast_decay_duration, hysteresis_start_value, hysteresis_end_value, sine_wave_offset, chopper_mode, comparator_blank_time, fast_decay_without_comparator) ⇒ Object

Note: If you don’t know what any of this means you can very likely keep all of the values as default!

Sets the Spreadcycle configuration parameters. Spreadcycle is a chopper algorithm which actively controls the motor current flow. More information can be found in the TMC2130 datasheet on page 47 (7 spreadCycle and Classic Chopper).

  • Slow Decay Duration: Controls duration of off time setting of slow decay phase. 0 = driver disabled, all bridges off. Use 1 only with Comparator Blank time >= 2.

  • Enable Random Slow Decay: Set to false to fix chopper off time as set by Slow Decay Duration. If you set it to true, Decay Duration is randomly modulated.

  • Fast Decay Duration: Sets the fast decay duration. This parameters is only used if the Chopper Mode is set to Fast Decay.

  • Hysteresis Start Value: Sets the hysteresis start value. This parameter is only used if the Chopper Mode is set to Spread Cycle.

  • Hysteresis End Value: Sets the hysteresis end value. This parameter is only used if the Chopper Mode is set to Spread Cycle.

  • Sine Wave Offset: Sets the sine wave offset. This parameters is only used if the Chopper Mode is set to Fast Decay. 1/512 of the value becomes added to the absolute value of the sine wave.

  • Chopper Mode: 0 = Spread Cycle, 1 = Fast Decay.

  • Comparator Blank Time: Sets the blank time of the comparator. Available values are

    • 0 = 16 clocks,

    • 1 = 24 clocks,

    • 2 = 36 clocks and

    • 3 = 54 clocks.

    A value of 1 or 2 is recommended for most applications.

  • Fast Decay Without Comparator: If set to true the current comparator usage for termination of the fast decay cycle is disabled.



588
589
590
591
592
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 588

def set_spreadcycle_configuration(slow_decay_duration, enable_random_slow_decay, fast_decay_duration, hysteresis_start_value, hysteresis_end_value, sine_wave_offset, chopper_mode, comparator_blank_time, fast_decay_without_comparator)
  check_validity

  send_request FUNCTION_SET_SPREADCYCLE_CONFIGURATION, [slow_decay_duration, enable_random_slow_decay, fast_decay_duration, hysteresis_start_value, hysteresis_end_value, sine_wave_offset, chopper_mode, comparator_blank_time, fast_decay_without_comparator], 'C ? C C c c C C ?', 8, ''
end

#set_status_led_config(config) ⇒ Object

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.



948
949
950
951
952
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 948

def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end

#set_stealth_configuration(enable_stealth, amplitude, gradient, enable_autoscale, force_symmetric, freewheel_mode) ⇒ Object

Note: If you don’t know what any of this means you can very likely keep all of the values as default!

Sets the configuration relevant for Stealth mode.

  • Enable Stealth: If set to true the stealth mode is enabled, if set to false the stealth mode is disabled, even if the speed is below the threshold set in BrickletSilentStepperV2#set_basic_configuration.

  • Amplitude: If autoscale is disabled, the PWM amplitude is scaled by this value. If autoscale is enabled, this value defines the maximum PWM amplitude change per half wave.

  • Gradient: If autoscale is disabled, the PWM gradient is scaled by this value. If autoscale is enabled, this value defines the maximum PWM gradient. With autoscale a value above 64 is recommended, otherwise the regulation might not be able to measure the current.

  • Enable Autoscale: If set to true, automatic current control is used. Otherwise the user defined amplitude and gradient are used.

  • Force Symmetric: If true, A symmetric PWM cycle is enforced. Otherwise the PWM value may change within each PWM cycle.

  • Freewheel Mode: The freewheel mode defines the behavior in stand still if the Standstill Current (see BrickletSilentStepperV2#set_basic_configuration) is set to 0.



624
625
626
627
628
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 624

def set_stealth_configuration(enable_stealth, amplitude, gradient, enable_autoscale, force_symmetric, freewheel_mode)
  check_validity

  send_request FUNCTION_SET_STEALTH_CONFIGURATION, [enable_stealth, amplitude, gradient, enable_autoscale, force_symmetric, freewheel_mode], '? C C ? ? C', 8, ''
end

#set_step_configuration(step_resolution, interpolation) ⇒ Object

Sets the step resolution from full-step up to 1/256-step.

If interpolation is turned on, the Silent Stepper Bricklet 2.0 will always interpolate your step inputs as 1/256-step. If you use full-step mode with interpolation, each step will generate 256 1/256 steps.

For maximum torque use full-step without interpolation. For maximum resolution use 1/256-step. Turn interpolation on to make the Stepper driving less noisy.

If you often change the speed with high acceleration you should turn the interpolation off.



399
400
401
402
403
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 399

def set_step_configuration(step_resolution, interpolation)
  check_validity

  send_request FUNCTION_SET_STEP_CONFIGURATION, [step_resolution, interpolation], 'C ?', 8, ''
end

#set_steps(steps) ⇒ Object

Sets the number of steps the stepper motor should run. Positive values will drive the motor forward and negative values backward. The velocity, acceleration and deacceleration as set by BrickletSilentStepperV2#set_max_velocity and BrickletSilentStepperV2#set_speed_ramping will be used.



365
366
367
368
369
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 365

def set_steps(steps)
  check_validity

  send_request FUNCTION_SET_STEPS, [steps], 'l', 8, ''
end

#set_target_position(position) ⇒ Object

Sets the target position of the stepper motor in steps. For example, if the current position of the motor is 500 and BrickletSilentStepperV2#set_target_position is called with 1000, the stepper motor will drive 500 steps forward. It will use the velocity, acceleration and deacceleration as set by BrickletSilentStepperV2#set_max_velocity and BrickletSilentStepperV2#set_speed_ramping.

A call of BrickletSilentStepperV2#set_target_position with the parameter x is equivalent to a call of BrickletSilentStepperV2#set_steps with the parameter (x - BrickletSilentStepperV2#get_current_position).



348
349
350
351
352
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 348

def set_target_position(position)
  check_validity

  send_request FUNCTION_SET_TARGET_POSITION, [position], 'l', 8, ''
end

#set_time_base(time_base) ⇒ Object

Sets the time base of the velocity and the acceleration of the Silent Stepper Bricklet 2.0.

For example, if you want to make one step every 1.5 seconds, you can set the time base to 15 and the velocity to 10. Now the velocity is 10steps/15s = 1steps/1.5s.



783
784
785
786
787
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 783

def set_time_base(time_base)
  check_validity

  send_request FUNCTION_SET_TIME_BASE, [time_base], 'L', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

Sets the firmware pointer for BrickletSilentStepperV2#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.



921
922
923
924
925
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 921

def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end

#stop ⇒ Object

Stops the stepper motor with the deacceleration as set by BrickletSilentStepperV2#set_speed_ramping.



432
433
434
435
436
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 432

def stop
  check_validity

  send_request FUNCTION_STOP, [], '', 8, ''
end

#write_firmware(data) ⇒ Object

Writes 64 Bytes of firmware at the position as written by BrickletSilentStepperV2#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.



935
936
937
938
939
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 935

def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end

#write_uid(uid) ⇒ Object

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.



990
991
992
993
994
 
# File 'lib/tinkerforge/bricklet_silent_stepper_v2.rb', line 990

def write_uid(uid)
  check_validity

  send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
end