Shell - Performance DC Bricklet¶

Configuration¶

Download (example-configuration.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Performance DC Bricklet

tinkerforge call performance-dc-bricklet $uid set-drive-mode drive-mode-drive-coast
tinkerforge call performance-dc-bricklet $uid set-pwm-frequency 10000 # Use PWM frequency of 10 kHz
tinkerforge call performance-dc-bricklet $uid set-motion 4096 4096 # Slow ac-/deceleration (12.5 %/s)
tinkerforge call performance-dc-bricklet $uid set-velocity 32767 # Full speed forward (100 %)
tinkerforge call performance-dc-bricklet $uid set-enabled true # Enable motor power

echo "Press key to exit"; read dummy

# Stop motor before disabling motor power
tinkerforge call performance-dc-bricklet $uid set-motion 4096 16384 # Fast decceleration (50 %/s) for stopping
tinkerforge call performance-dc-bricklet $uid set-velocity 0 # Request motor stop
sleep 2 # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
tinkerforge call performance-dc-bricklet $uid set-enabled false # Disable motor power

Callback¶

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Performance DC Bricklet

# Use velocity reached callback to swing back and forth
# between full speed forward and full speed backward
tinkerforge dispatch performance-dc-bricklet $uid velocity-reached\
 --execute "if   [ {velocity} -eq  32767 ]; then tinkerforge call performance-dc-brick $uid set-velocity -32767;
            elif [ {velocity} -eq -32767 ]; then tinkerforge call performance-dc-brick $uid set-velocity  32767;
            else echo error; fi" &

# Enable velocity reached callback
tinkerforge call performance-dc-bricklet $uid set-velocity-reached-callback-configuration true

# The acceleration has to be smaller or equal to the maximum
# acceleration of the DC motor, otherwise the velocity reached
# callback will be called too early
tinkerforge call performance-dc-bricklet $uid set-motion 4096 4096 # Slow acceleration (12.5 %/s)
tinkerforge call performance-dc-bricklet $uid set-velocity 32767 # Full speed forward (100 %)

# Enable motor power
tinkerforge call performance-dc-bricklet $uid set-enabled true

echo "Press key to exit"; read dummy

# Stop motor before disabling motor power
tinkerforge call performance-dc-bricklet $uid set-motion 4096 16384 # Fast decceleration (50 %/s) for stopping
tinkerforge call performance-dc-bricklet $uid set-velocity 0 # Request motor stop
sleep 2 # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
tinkerforge call performance-dc-bricklet $uid set-enabled false # Disable motor power

kill -- -$$ # Stop callback dispatch in background

Command Structure¶

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call performance-dc-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the Performance DC Bricklet. It can take several options:

• --help shows help for the specific call command and exits
• --list-functions shows a list of known functions of the Performance DC Bricklet and exits

tinkerforge dispatch performance-dc-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the Performance DC Bricklet. It can take several options:

• --help shows help for the specific dispatch command and exits
• --list-callbacks shows a list of known callbacks of the Performance DC Bricklet and exits

tinkerforge call performance-dc-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

• --help shows help for the specific function and exits

Getter functions can take the following options:

• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

• --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch performance-dc-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: String

The <callback> to be dispatched can take several options:

• --help shows help for the specific callback and exits
• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions¶

tinkerforge call performance-dc-bricklet <uid> set-enabled <enabled>¶

Parameters:	<enabled> – Type: Bool
Output:	no output

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

tinkerforge call performance-dc-bricklet <uid> get-enabled¶

Output:	enabled – Type: Bool, Default: false

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

tinkerforge call performance-dc-bricklet <uid> set-velocity <velocity>¶

Parameters:	<velocity> – Type: Int, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1], Default: 0
Output:	no output

Sets the velocity of the motor. Whereas -32767 is full speed backward, 0 is stop and 32767 is full speed forward. Depending on the acceleration (see set-motion), the motor is not immediately brought to the velocity but smoothly accelerated.

The velocity describes the duty cycle of the PWM with which the motor is controlled, e.g. a velocity of 3277 sets a PWM with a 10% duty cycle. You can not only control the duty cycle of the PWM but also the frequency, see set-pwm-frequency.

tinkerforge call performance-dc-bricklet <uid> get-velocity¶

Output:	velocity – Type: Int, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1], Default: 0

Returns the velocity as set by set-velocity.

tinkerforge call performance-dc-bricklet <uid> get-current-velocity¶

Output:	velocity – Type: Int, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1], Default: 0

Returns the current velocity of the motor. This value is different from get-velocity whenever the motor is currently accelerating to a goal set by set-velocity.

tinkerforge call performance-dc-bricklet <uid> set-motion <acceleration> <deceleration>¶

Parameters:	<acceleration> – Type: Int, Unit: 100/32767 %/s, Range: [0 to 216 - 1], Default: 10000 <deceleration> – Type: Int, Unit: 100/32767 %/s, Range: [0 to 216 - 1], Default: 10000
Output:	no output

Sets the acceleration and deceleration of the motor. It is given in velocity/s. An acceleration of 10000 means, that every second the velocity is increased by 10000 (or about 30% duty cycle).

For example: If the current velocity is 0 and you want to accelerate to a velocity of 16000 (about 50% duty cycle) in 10 seconds, you should set an acceleration of 1600.

If acceleration and deceleration is set to 0, there is no speed ramping, i.e. a new velocity is immediately given to the motor.

tinkerforge call performance-dc-bricklet <uid> get-motion¶

Output:	acceleration – Type: Int, Unit: 100/32767 %/s, Range: [0 to 216 - 1], Default: 10000 deceleration – Type: Int, Unit: 100/32767 %/s, Range: [0 to 216 - 1], Default: 10000

Returns the acceleration/deceleration as set by set-motion.

tinkerforge call performance-dc-bricklet <uid> full-brake¶

Output:	no output

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 set-velocity with 0 if you just want to stop the motor.

tinkerforge call performance-dc-bricklet <uid> get-pwm-frequency¶

Output:	frequency – Type: Int, Unit: 1 Hz, Range: [1 to 20000], Default: 15000

Returns the PWM frequency as set by set-pwm-frequency.

tinkerforge call performance-dc-bricklet <uid> get-power-statistics¶

Output:	voltage – Type: Int, Unit: 1 mV, Range: [0 to 216 - 1] current – Type: Int, Unit: 1 mA, Range: [0 to 216 - 1] temperature – Type: Int, Unit: 1/10 °, Range: [-215 to 215 - 1]

Returns input voltage, current usage and temperature of the driver.

tinkerforge call performance-dc-bricklet <uid> set-thermal-shutdown <temperature>¶

Parameters:	<temperature> – Type: Int, Unit: 1 °, Range: [0 to 255], Default: 125
Output:	no output

Sets a temperature threshold that is used for thermal shutdown.

Additionally to this user defined threshold the driver chip will shut down at a temperature of 150°C.

If a thermal shutdown is triggered the driver is disabled and has to be explicitly re-enabled with set-enabled.

tinkerforge call performance-dc-bricklet <uid> get-thermal-shutdown¶

Output:	temperature – Type: Int, Unit: 1 °, Range: [0 to 255]

Returns the thermal shutdown temperature as set by set-thermal-shutdown.

tinkerforge call performance-dc-bricklet <uid> set-gpio-configuration <channel> <debounce> <stop-deceleration>¶

Parameters:	<channel> – Type: Int, Range: [0 to 1] <debounce> – Type: Int, Unit: 1 ms, Range: [0 to 216 - 1], Default: 200 <stop-deceleration> – Type: Int, Unit: 100/32767 %/s, Range: [0 to 216 - 1], Default: 216 - 1
Output:	no output

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 set-gpio-action.

tinkerforge call performance-dc-bricklet <uid> get-gpio-configuration <channel>¶

Parameters:	<channel> – Type: Int, Range: [0 to 1]
Output:	debounce – Type: Int, Unit: 1 ms, Range: [0 to 216 - 1], Default: 200 stop-deceleration – Type: Int, Unit: 100/32767 %/s, Range: [0 to 216 - 1], Default: 216 - 1

Returns the GPIO configuration for a channel as set by set-gpio-configuration.

tinkerforge call performance-dc-bricklet <uid> set-gpio-action <channel> <action>¶

Parameters:	<channel> – Type: Int, Range: [0 to 1] <action> – Type: Int, Range: See symbols, Default: 0
Output:	no output

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 set-gpio-configuration.

The following symbols are available for this function:

For <action>:

• gpio-action-none = 0
• gpio-action-normal-stop-rising-edge = 1
• gpio-action-normal-stop-falling-edge = 2
• gpio-action-full-brake-rising-edge = 4
• gpio-action-full-brake-falling-edge = 8
• gpio-action-callback-rising-edge = 16
• gpio-action-callback-falling-edge = 32

tinkerforge call performance-dc-bricklet <uid> get-gpio-action <channel>¶

Parameters:	<channel> – Type: Int, Range: [0 to 1]
Output:	action – Type: Int, Range: See symbols, Default: 0

Returns the GPIO action for a channel as set by set-gpio-action.

The following symbols are available for this function:

For action:

• gpio-action-none = 0
• gpio-action-normal-stop-rising-edge = 1
• gpio-action-normal-stop-falling-edge = 2
• gpio-action-full-brake-rising-edge = 4
• gpio-action-full-brake-falling-edge = 8
• gpio-action-callback-rising-edge = 16
• gpio-action-callback-falling-edge = 32

tinkerforge call performance-dc-bricklet <uid> get-gpio-state¶

Output:	gpio-state – Type: Bool Array, Length: 2

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

Advanced Functions¶

tinkerforge call performance-dc-bricklet <uid> set-drive-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols, Default: 0
Output:	no output

Sets the drive mode. Possible modes are:

• 0 = Drive/Brake
• 1 = Drive/Coast

These modes are different kinds of motor controls.

In Drive/Brake mode, the motor is always either driving or braking. There is no freewheeling. Advantages are: A more linear correlation between PWM and velocity, more exact accelerations and the possibility to drive with slower velocities.

In Drive/Coast mode, the motor is always either driving or freewheeling. Advantages are: Less current consumption and less demands on the motor and driver chip.

The following symbols are available for this function:

For <mode>:

• drive-mode-drive-brake = 0
• drive-mode-drive-coast = 1

tinkerforge call performance-dc-bricklet <uid> get-drive-mode¶

Output:	mode – Type: Int, Range: See symbols, Default: 0

Returns the drive mode, as set by set-drive-mode.

The following symbols are available for this function:

For mode:

• drive-mode-drive-brake = 0
• drive-mode-drive-coast = 1

tinkerforge call performance-dc-bricklet <uid> set-pwm-frequency <frequency>¶

Parameters:	<frequency> – Type: Int, Unit: 1 Hz, Range: [1 to 20000], Default: 15000
Output:	no output

Sets the frequency of the PWM with which the motor is driven. Often a high frequency is less noisy and the motor runs smoother. However, with a low frequency there are less switches and therefore fewer switching losses. Also with most motors lower frequencies enable higher torque.

If you have no idea what all this means, just ignore this function and use the default frequency, it will very likely work fine.

tinkerforge call performance-dc-bricklet <uid> set-error-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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.
• 1s interval blinking: Input voltage too low (below 6V).
• 250ms interval blinking: Overtemperature or overcurrent.

The following symbols are available for this function:

For <config>:

• error-led-config-off = 0
• error-led-config-on = 1
• error-led-config-show-heartbeat = 2
• error-led-config-show-error = 3

tinkerforge call performance-dc-bricklet <uid> get-error-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the LED configuration as set by set-error-led-config

The following symbols are available for this function:

For config:

• error-led-config-off = 0
• error-led-config-on = 1
• error-led-config-show-heartbeat = 2
• error-led-config-show-error = 3

tinkerforge call performance-dc-bricklet <uid> set-cw-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

Configures the CW LED to be either turned off, turned on, blink in heartbeat mode or if the motor turn clockwise.

The following symbols are available for this function:

For <config>:

• cw-led-config-off = 0
• cw-led-config-on = 1
• cw-led-config-show-heartbeat = 2
• cw-led-config-show-cw-as-forward = 3
• cw-led-config-show-cw-as-backward = 4

tinkerforge call performance-dc-bricklet <uid> get-cw-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the LED configuration as set by set-cw-led-config

The following symbols are available for this function:

For config:

• cw-led-config-off = 0
• cw-led-config-on = 1
• cw-led-config-show-heartbeat = 2
• cw-led-config-show-cw-as-forward = 3
• cw-led-config-show-cw-as-backward = 4

tinkerforge call performance-dc-bricklet <uid> set-ccw-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

Configures the CCW LED to be either turned off, turned on, blink in heartbeat mode or if the motor turn counter-clockwise.

The following symbols are available for this function:

For <config>:

• ccw-led-config-off = 0
• ccw-led-config-on = 1
• ccw-led-config-show-heartbeat = 2
• ccw-led-config-show-ccw-as-forward = 3
• ccw-led-config-show-ccw-as-backward = 4

tinkerforge call performance-dc-bricklet <uid> get-ccw-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the LED configuration as set by set-ccw-led-config

The following symbols are available for this function:

For config:

• ccw-led-config-off = 0
• ccw-led-config-on = 1
• ccw-led-config-show-heartbeat = 2
• ccw-led-config-show-ccw-as-forward = 3
• ccw-led-config-show-ccw-as-backward = 4

tinkerforge call performance-dc-bricklet <uid> set-gpio-led-config <channel> <config>¶

Parameters:	<channel> – Type: Int, Range: [0 to 1] <config> – Type: Int, Range: See symbols, Default: 4
Output:	no output

Configures the GPIO LED to be either turned off, turned on, blink in heartbeat mode or the GPIO state.

The GPIO LED can be configured for both channels.

The following symbols are available for this function:

For <config>:

• gpio-led-config-off = 0
• gpio-led-config-on = 1
• gpio-led-config-show-heartbeat = 2
• gpio-led-config-show-gpio-active-high = 3
• gpio-led-config-show-gpio-active-low = 4

tinkerforge call performance-dc-bricklet <uid> get-gpio-led-config <channel>¶

Parameters:	<channel> – Type: Int, Range: [0 to 1]
Output:	config – Type: Int, Range: See symbols, Default: 4

Returns the LED configuration as set by set-gpio-led-config

The following symbols are available for this function:

For config:

• gpio-led-config-off = 0
• gpio-led-config-on = 1
• gpio-led-config-show-heartbeat = 2
• gpio-led-config-show-gpio-active-high = 3
• gpio-led-config-show-gpio-active-low = 4

tinkerforge call performance-dc-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum – Type: Int, Range: [0 to 232 - 1] error-count-message-checksum – Type: Int, Range: [0 to 232 - 1] error-count-frame – Type: Int, Range: [0 to 232 - 1] error-count-overflow – Type: Int, Range: [0 to 232 - 1]

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.

tinkerforge call performance-dc-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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.

The following symbols are available for this function:

For <config>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call performance-dc-bricklet <uid> get-status-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

For config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call performance-dc-bricklet <uid> get-chip-temperature¶

Output:	temperature – Type: Int, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

tinkerforge call performance-dc-bricklet <uid> reset¶

Output:	no output

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!

tinkerforge call performance-dc-bricklet <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] firmware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] device-identifier – Type: Int, Range: [0 to 216 - 1]

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 Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. 

Callback Configuration Functions¶

tinkerforge call performance-dc-bricklet <uid> set-emergency-shutdown-callback-configuration <enabled>¶

Parameters:	<enabled> – Type: Bool, Default: false
Output:	no output

Enable/Disable emergency-shutdown callback.

tinkerforge call performance-dc-bricklet <uid> get-emergency-shutdown-callback-configuration¶

Output:	enabled – Type: Bool, Default: true

Returns the callback configuration as set by set-emergency-shutdown-callback-configuration.

tinkerforge call performance-dc-bricklet <uid> set-velocity-reached-callback-configuration <enabled>¶

Parameters:	<enabled> – Type: Bool, Default: false
Output:	no output

Enable/Disable velocity-reached callback.

tinkerforge call performance-dc-bricklet <uid> get-velocity-reached-callback-configuration¶

Output:	enabled – Type: Bool, Default: false

Returns the callback configuration as set by set-velocity-reached-callback-configuration.

tinkerforge call performance-dc-bricklet <uid> set-current-velocity-callback-configuration <period> <value-has-to-change>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 <value-has-to-change> – Type: Bool, Default: false
Output:	no output

The period is the period with which the current-velocity 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.

tinkerforge call performance-dc-bricklet <uid> get-current-velocity-callback-configuration¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value-has-to-change – Type: Bool, Default: false

Returns the callback configuration as set by set-current-velocity-callback-configuration.

Callbacks¶

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch performance-dc-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch performance-dc-bricklet <uid> emergency-shutdown¶

Output:	no output

This callback is triggered if either the current consumption is too high or the temperature of the driver chip is too high (above 150°C) or the user defined thermal shutdown is triggered (see set-thermal-shutdown). n case of a voltage below 6V (input voltage) this callback is triggered as well.

If this callback is triggered, the driver chip gets disabled at the same time. That means, set-enabled has to be called to drive the motor again.

tinkerforge dispatch performance-dc-bricklet <uid> velocity-reached¶

Output:	velocity – Type: Int, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1]

This callback is triggered whenever a set velocity is reached. For example: If a velocity of 0 is present, acceleration is set to 5000 and velocity to 10000, the velocity-reached callback will be triggered after about 2 seconds, when the set velocity is actually reached.

Note

Since we can't get any feedback from the DC motor, this only works if the acceleration (see set-motion) 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.

tinkerforge dispatch performance-dc-bricklet <uid> current-velocity¶

Output:	velocity – Type: Int, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1]

This callback is triggered with the period that is set by set-current-velocity-callback-configuration. The parameter is the current velocity used by the motor.

The current-velocity callback is only triggered after the set period if there is a change in the velocity.

tinkerforge dispatch performance-dc-bricklet <uid> gpio-state¶

Output:	gpio-state – Type: Bool Array, Length: 2

This callback is triggered by GPIO changes if it is activated through set-gpio-action.

New in version 2.0.1 (Plugin).

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

tinkerforge call performance-dc-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols
Output:	status – Type: Int, Range: See symbols

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.

The following symbols are available for this function:

For <mode>:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call performance-dc-bricklet <uid> get-bootloader-mode¶

Output:	mode – Type: Int, Range: See symbols

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

For mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call performance-dc-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> – Type: Int, Unit: 1 B, Range: [0 to 232 - 1]
Output:	no output

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

tinkerforge call performance-dc-bricklet <uid> write-firmware <data>¶

Parameters:	<data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:	status – Type: Int, Range: [0 to 255]

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

tinkerforge call performance-dc-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> – Type: Int, Range: [0 to 232 - 1]
Output:	no output

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.

tinkerforge call performance-dc-bricklet <uid> read-uid¶

Output:	uid – Type: Int, Range: [0 to 232 - 1]

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