JavaScript - DC Brick¶

Configuration (Node.js)¶

Download (ExampleConfiguration.js)

 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
34
35
36
37
38
39
40
41

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XXYYZZ'; // Change XXYYZZ to the UID of your DC Brick

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var dc = new Tinkerforge.BrickDC(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        dc.setDriveMode(Tinkerforge.BrickDC.DRIVE_MODE_DRIVE_COAST);
        dc.setPWMFrequency(10000); // Use PWM frequency of 10 kHz
        dc.setAcceleration(4096); // Slow acceleration (12.5 %/s)
        dc.setVelocity(32767); // Full speed forward (100 %)
        dc.enable(); // Enable motor power
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        // Stop motor before disabling motor power
        dc.setAcceleration(16384); // Fast decceleration (50 %/s) for stopping
        dc.setVelocity(0); // Request motor stop

        setTimeout(function () {
            dc.disable(); // Disable motor power

            ipcon.disconnect();
            process.exit(0);
        }, 2000); // Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
    }
);

Callback (Node.js)¶

Download (ExampleCallback.js)

 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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XXYYZZ'; // Change XXYYZZ to the UID of your DC Brick

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var dc = new Tinkerforge.BrickDC(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // 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
        dc.setAcceleration(4096); // Slow acceleration (12.5 %/s)
        dc.setVelocity(32767); // Full speed forward (100 %)

        // Enable motor power
        dc.enable();
    }
);

// Register velocity reached callback
dc.on(Tinkerforge.BrickDC.CALLBACK_VELOCITY_REACHED,
    // Use velocity reached callback to swing back and forth
    // between full speed forward and full speed backward
    function (velocity) {
        if(velocity == 32767) {
            console.log('Velocity: Full speed forward, now turning backward');
            dc.setVelocity(-32767);
        }
        else if(velocity === -32767) {
            console.log('Velocity: Full speed backward, now turning forward');
            dc.setVelocity(32767);
        }
        else {
            console.log('Error'); // Can only happen if another program sets velocity
        }
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        // Stop motor before disabling motor power
        dc.setAcceleration(16384); // Fast decceleration (50 %/s) for stopping
        dc.setVelocity(0); // Request motor stop

        setTimeout(function () {
            dc.disable(); // Disable motor power

            ipcon.disconnect();
            process.exit(0);
        }, 2000); // Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
    }
);

Configuration (HTML)¶

Download (ExampleConfiguration.html), Test (ExampleConfiguration.html)

 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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>DC Brick Configuration Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var dc = new Tinkerforge.BrickDC(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        dc.setDriveMode(Tinkerforge.BrickDC.DRIVE_MODE_DRIVE_COAST);
                        dc.setPWMFrequency(10000); // Use PWM frequency of 10 kHz
                        dc.setAcceleration(4096); // Slow acceleration (12.5 %/s)
                        dc.setVelocity(32767); // Full speed forward (100 %)
                        dc.enable(); // Enable motor power
                    }
                );
            }
        </script>
    </body>
</html>

Callback (HTML)¶

Download (ExampleCallback.html), Test (ExampleCallback.html)

 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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>DC Brick Callback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var dc = new Tinkerforge.BrickDC(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // 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
                        dc.setAcceleration(4096); // Slow acceleration (12.5 %/s)
                        dc.setVelocity(32767); // Full speed forward (100 %)

                        // Enable motor power
                        dc.enable();
                    }
                );

                // Register velocity reached callback
                dc.on(Tinkerforge.BrickDC.CALLBACK_VELOCITY_REACHED,
                    // Use velocity reached callback to swing back and forth
                    // between full speed forward and full speed backward
                    function (velocity) {
                        if(velocity == 32767) {
                            textArea.value += 'Velocity: Full speed forward, now turning backward\n';
                            dc.setVelocity(-32767);
                        }
                        else if(velocity === -32767) {
                            textArea.value += 'Velocity: Full speed backward, now turning forward\n';
                            dc.setVelocity(32767);
                        }
                        else {
                            textArea.value += 'Error\n'; // Can only happen if another program sets velocity
                        }
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

Basic Functions¶

new BrickDC(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	dc – Type: BrickDC

Creates an object with the unique device ID uid:

var dc = new BrickDC("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected.

BrickDC.setVelocity(velocity[, returnCallback][, errorCallback])¶

Parameters:	velocity – Type: int, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

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 setAcceleration()), 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 setPWMFrequency().

BrickDC.getVelocity([returnCallback][, errorCallback])¶

Callback Parameters:	velocity – Type: int, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1], Default: 0
Returns:	undefined

Returns the velocity as set by setVelocity().

BrickDC.getCurrentVelocity([returnCallback][, errorCallback])¶

Callback Parameters:	velocity – Type: int, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1], Default: 0
Returns:	undefined

Returns the current velocity of the motor. This value is different from getVelocity() whenever the motor is currently accelerating to a goal set by setVelocity().

BrickDC.setAcceleration(acceleration[, returnCallback][, errorCallback])¶

Parameters:	acceleration – Type: int, Unit: 100/32767 %/s, Range: [0 to 216 - 1], Default: 10000
Callback Parameters:	undefined
Returns:	undefined

Sets the acceleration 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 is set to 0, there is no speed ramping, i.e. a new velocity is immediately given to the motor.

BrickDC.getAcceleration([returnCallback][, errorCallback])¶

Callback Parameters:	acceleration – Type: int, Unit: 100/32767 %/s, Range: [0 to 216 - 1], Default: 10000
Returns:	undefined

Returns the acceleration as set by setAcceleration().

BrickDC.fullBrake([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

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 setVelocity() with 0 if you just want to stop the motor.

BrickDC.enable([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

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

BrickDC.disable([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Disables the driver chip. The configurations are kept (velocity, acceleration, etc) but the motor is not driven until it is enabled again.

Warning

Disabling the driver chip while the motor is still turning can damage the driver chip. The motor should be stopped calling setVelocity() with 0 before disabling the motor power. The setVelocity() function will not wait until the motor is actually stopped. You have to explicitly wait for the appropriate time after calling the setVelocity() function before calling the disable() function.

BrickDC.isEnabled([returnCallback][, errorCallback])¶

Callback Parameters:	enabled – Type: boolean, Default: false
Returns:	undefined

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

Advanced Functions¶

BrickDC.setPWMFrequency(frequency[, returnCallback][, errorCallback])¶

Parameters:	frequency – Type: int, Unit: 1 Hz, Range: [1 to 20000], Default: 15000
Callback Parameters:	undefined
Returns:	undefined

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.

BrickDC.getPWMFrequency([returnCallback][, errorCallback])¶

Callback Parameters:	frequency – Type: int, Unit: 1 Hz, Range: [1 to 20000], Default: 15000
Returns:	undefined

Returns the PWM frequency as set by setPWMFrequency().

BrickDC.getStackInputVoltage([returnCallback][, errorCallback])¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1]
Returns:	undefined

Returns the stack input voltage. The stack input voltage is the voltage that is supplied via the stack, i.e. it is given by a Step-Down or Step-Up Power Supply.

BrickDC.getExternalInputVoltage([returnCallback][, errorCallback])¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1]
Returns:	undefined

Returns the external input voltage. The external input voltage is given via the black power input connector on the DC Brick.

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.

BrickDC.getCurrentConsumption([returnCallback][, errorCallback])¶

Callback Parameters:	voltage – Type: int, Unit: 1 mA, Range: [0 to 216 - 1]
Returns:	undefined

Returns the current consumption of the motor.

BrickDC.setDriveMode(mode[, returnCallback][, errorCallback])¶

Parameters:	mode – Type: int, Range: See constants, Default: 0
Callback Parameters:	undefined
Returns:	undefined

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 constants are available for this function:

For mode:

• BrickDC.DRIVE_MODE_DRIVE_BRAKE = 0
• BrickDC.DRIVE_MODE_DRIVE_COAST = 1

BrickDC.getDriveMode([returnCallback][, errorCallback])¶

Callback Parameters:	mode – Type: int, Range: See constants, Default: 0
Returns:	undefined

Returns the drive mode, as set by setDriveMode().

The following constants are available for this function:

For mode:

• BrickDC.DRIVE_MODE_DRIVE_BRAKE = 0
• BrickDC.DRIVE_MODE_DRIVE_COAST = 1

BrickDC.setSPITFPBaudrateConfig(enableDynamicBaudrate, minimumDynamicBaudrate[, returnCallback][, errorCallback])¶

Parameters:	enableDynamicBaudrate – Type: boolean, Default: true minimumDynamicBaudrate – Type: int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000
Callback Parameters:	undefined
Returns:	undefined

The SPITF protocol can be used with a dynamic baudrate. If the dynamic baudrate is enabled, the Brick will try to adapt the baudrate for the communication between Bricks and Bricklets according to the amount of data that is transferred.

The baudrate will be increased exponentially if lots of data is sent/received and decreased linearly if little data is sent/received.

This lowers the baudrate in applications where little data is transferred (e.g. a weather station) and increases the robustness. If there is lots of data to transfer (e.g. Thermal Imaging Bricklet) it automatically increases the baudrate as needed.

In cases where some data has to transferred as fast as possible every few seconds (e.g. RS485 Bricklet with a high baudrate but small payload) you may want to turn the dynamic baudrate off to get the highest possible performance.

The maximum value of the baudrate can be set per port with the function setSPITFPBaudrate(). If the dynamic baudrate is disabled, the baudrate as set by setSPITFPBaudrate() will be used statically.

New in version 2.3.5 (Firmware).

BrickDC.getSPITFPBaudrateConfig([returnCallback][, errorCallback])¶

Callback Parameters:	enableDynamicBaudrate – Type: boolean, Default: true minimumDynamicBaudrate – Type: int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000
Returns:	undefined

Returns the baudrate config, see setSPITFPBaudrateConfig().

New in version 2.3.5 (Firmware).

BrickDC.getSendTimeoutCount(communicationMethod[, returnCallback][, errorCallback])¶

Parameters:	communicationMethod – Type: int, Range: See constants
Callback Parameters:	timeoutCount – Type: int, Range: [0 to 232 - 1]
Returns:	undefined

Returns the timeout count for the different communication methods.

The methods 0-2 are available for all Bricks, 3-7 only for Master Bricks.

This function is mostly used for debugging during development, in normal operation the counters should nearly always stay at 0.

The following constants are available for this function:

For communication_method:

• BrickDC.COMMUNICATION_METHOD_NONE = 0
• BrickDC.COMMUNICATION_METHOD_USB = 1
• BrickDC.COMMUNICATION_METHOD_SPI_STACK = 2
• BrickDC.COMMUNICATION_METHOD_CHIBI = 3
• BrickDC.COMMUNICATION_METHOD_RS485 = 4
• BrickDC.COMMUNICATION_METHOD_WIFI = 5
• BrickDC.COMMUNICATION_METHOD_ETHERNET = 6
• BrickDC.COMMUNICATION_METHOD_WIFI_V2 = 7

New in version 2.3.3 (Firmware).

BrickDC.setSPITFPBaudrate(brickletPort, baudrate[, returnCallback][, errorCallback])¶

Parameters:	brickletPort – Type: char, Range: ['a' to 'b'] baudrate – Type: int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000
Callback Parameters:	undefined
Returns:	undefined

Sets the baudrate for a specific Bricklet port.

If you want to increase the throughput of Bricklets you can increase the baudrate. If you get a high error count because of high interference (see getSPITFPErrorCount()) you can decrease the baudrate.

If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (see setSPITFPBaudrateConfig()).

Regulatory testing is done with the default baudrate. If CE compatibility or similar is necessary in your applications we recommend to not change the baudrate.

New in version 2.3.3 (Firmware).

BrickDC.getSPITFPBaudrate(brickletPort[, returnCallback][, errorCallback])¶

Parameters:	brickletPort – Type: char, Range: ['a' to 'b']
Callback Parameters:	baudrate – Type: int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000
Returns:	undefined

Returns the baudrate for a given Bricklet port, see setSPITFPBaudrate().

New in version 2.3.3 (Firmware).

BrickDC.getSPITFPErrorCount(brickletPort[, returnCallback][, errorCallback])¶

Parameters:	brickletPort – Type: char, Range: ['a' to 'b']
Callback Parameters:	errorCountACKChecksum – Type: int, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: int, Range: [0 to 232 - 1] errorCountFrame – Type: int, Range: [0 to 232 - 1] errorCountOverflow – Type: int, Range: [0 to 232 - 1]
Returns:	undefined

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 Brick side. All Bricklets have a similar function that returns the errors on the Bricklet side.

New in version 2.3.3 (Firmware).

BrickDC.enableStatusLED([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Enables the status LED.

The status LED is the blue LED next to the USB connector. If enabled is is on and it flickers if data is transfered. If disabled it is always off.

The default state is enabled.

New in version 2.3.1 (Firmware).

BrickDC.disableStatusLED([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Disables the status LED.

The status LED is the blue LED next to the USB connector. If enabled is is on and it flickers if data is transfered. If disabled it is always off.

The default state is enabled.

New in version 2.3.1 (Firmware).

BrickDC.isStatusLEDEnabled([returnCallback][, errorCallback])¶

Callback Parameters:	enabled – Type: boolean, Default: true
Returns:	undefined

Returns true if the status LED is enabled, false otherwise.

New in version 2.3.1 (Firmware).

BrickDC.getChipTemperature([returnCallback][, errorCallback])¶

Callback Parameters:	temperature – Type: int, Unit: 1/10 °C, Range: [-215 to 215 - 1]
Returns:	undefined

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 an accuracy of ±15%. Practically it is only useful as an indicator for temperature changes.

BrickDC.reset([returnCallback][, errorCallback])¶

Callback Parameters:	undefined
Returns:	undefined

Calling this function will reset the Brick. Calling this function on a Brick inside of a stack will reset the whole stack.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickDC.getIdentity([returnCallback][, errorCallback])¶

Callback Parameters:

uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['0' to '8'] hardwareVersion – Type: [int, ...], 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] firmwareVersion – Type: [int, ...], 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] deviceIdentifier – Type: int, Range: [0 to 216 - 1]

Returns:

undefined

Returns the UID, the UID where the Brick is connected to, the position, the hardware and firmware version as well as the device identifier.

The position is the position in the stack from '0' (bottom) to '8' (top).

The device identifier numbers can be found here. There is also a constant for the device identifier of this Brick.

Callback Configuration Functions¶

BrickDC.on(callback_id, function[, errorCallback])¶

Parameters:	callback_id – Type: int function – Type: function
Returns:	undefined

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickDC.setMinimumVoltage(voltage[, returnCallback][, errorCallback])¶

Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 6000
Callback Parameters:	undefined
Returns:	undefined

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

BrickDC.getMinimumVoltage([returnCallback][, errorCallback])¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 6000
Returns:	undefined

Returns the minimum voltage as set by setMinimumVoltage()

BrickDC.setCurrentVelocityPeriod(period[, returnCallback][, errorCallback])¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 216 - 1], Default: 0
Callback Parameters:	undefined
Returns:	undefined

Sets a period with which the CALLBACK_CURRENT_VELOCITY callback is triggered. A period of 0 turns the callback off.

BrickDC.getCurrentVelocityPeriod([returnCallback][, errorCallback])¶

Callback Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 216 - 1], Default: 0
Returns:	undefined

Returns the period as set by setCurrentVelocityPeriod().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

dc.on(BrickDC.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

The available constants with inherent number and type of parameters are described below.

BrickDC.CALLBACK_UNDER_VOLTAGE¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1]

This callback is triggered when the input voltage drops below the value set by setMinimumVoltage(). The parameter is the current voltage.

BrickDC.CALLBACK_EMERGENCY_SHUTDOWN¶

Callback Parameters:	undefined

This callback is triggered if either the current consumption is too high (above 5A) or the temperature of the driver chip is too high (above 175°C). These two possibilities are essentially the same, since the temperature will reach this threshold immediately if the motor consumes too much current. In case of a voltage below 3.3V (external or stack) this callback is triggered as well.

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

Note

This callback only works in Drive/Brake mode (see setDriveMode()). In Drive/Coast mode it is unfortunately impossible to reliably read the overcurrent/overtemperature signal from the driver chip.

BrickDC.CALLBACK_VELOCITY_REACHED¶

Callback Parameters:	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 CALLBACK_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 setAcceleration()) 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.

BrickDC.CALLBACK_CURRENT_VELOCITY¶

Callback Parameters:	velocity – Type: int, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1]

This callback is triggered with the period that is set by setCurrentVelocityPeriod(). The parameter is the current velocity used by the motor.

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

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickDC.getAPIVersion()¶

Returns:	apiVersion – Type: [int, ...], 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]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickDC.getResponseExpected(functionId[, errorCallback])¶

Parameters:	functionId – Type: int, Range: See constants
Returns:	responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

• BrickDC.FUNCTION_SET_VELOCITY = 1
• BrickDC.FUNCTION_SET_ACCELERATION = 4
• BrickDC.FUNCTION_SET_PWM_FREQUENCY = 6
• BrickDC.FUNCTION_FULL_BRAKE = 8
• BrickDC.FUNCTION_ENABLE = 12
• BrickDC.FUNCTION_DISABLE = 13
• BrickDC.FUNCTION_SET_MINIMUM_VOLTAGE = 15
• BrickDC.FUNCTION_SET_DRIVE_MODE = 17
• BrickDC.FUNCTION_SET_CURRENT_VELOCITY_PERIOD = 19
• BrickDC.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
• BrickDC.FUNCTION_SET_SPITFP_BAUDRATE = 234
• BrickDC.FUNCTION_ENABLE_STATUS_LED = 238
• BrickDC.FUNCTION_DISABLE_STATUS_LED = 239
• BrickDC.FUNCTION_RESET = 243
• BrickDC.FUNCTION_WRITE_BRICKLET_PLUGIN = 246

BrickDC.setResponseExpected(functionId, responseExpected[, errorCallback])¶

Parameters:	functionId – Type: int, Range: See constants responseExpected – Type: boolean
Returns:	undefined

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

• BrickDC.FUNCTION_SET_VELOCITY = 1
• BrickDC.FUNCTION_SET_ACCELERATION = 4
• BrickDC.FUNCTION_SET_PWM_FREQUENCY = 6
• BrickDC.FUNCTION_FULL_BRAKE = 8
• BrickDC.FUNCTION_ENABLE = 12
• BrickDC.FUNCTION_DISABLE = 13
• BrickDC.FUNCTION_SET_MINIMUM_VOLTAGE = 15
• BrickDC.FUNCTION_SET_DRIVE_MODE = 17
• BrickDC.FUNCTION_SET_CURRENT_VELOCITY_PERIOD = 19
• BrickDC.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
• BrickDC.FUNCTION_SET_SPITFP_BAUDRATE = 234
• BrickDC.FUNCTION_ENABLE_STATUS_LED = 238
• BrickDC.FUNCTION_DISABLE_STATUS_LED = 239
• BrickDC.FUNCTION_RESET = 243
• BrickDC.FUNCTION_WRITE_BRICKLET_PLUGIN = 246

BrickDC.setResponseExpectedAll(responseExpected)¶

Parameters:	responseExpected – Type: boolean
Returns:	undefined

Changes the response expected flag for all setter and callback configuration functions of this device at once.

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.

BrickDC.getProtocol1BrickletName(port[, returnCallback][, errorCallback])¶

Parameters:	port – Type: char, Range: ['a' to 'b']
Callback Parameters:	protocolVersion – Type: int, Range: [0 to 255] firmwareVersion – Type: [int, ...], 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] name – Type: string, Length: up to 40
Returns:	undefined

Returns the firmware and protocol version and the name of the Bricklet for a given port.

This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet plugins.

BrickDC.writeBrickletPlugin(port, offset, chunk[, returnCallback][, errorCallback])¶

Parameters:	port – Type: char, Range: ['a' to 'b'] offset – Type: int, Range: [0 to 255] chunk – Type: [int, ...], Length: 32, Range: [0 to 255]
Callback Parameters:	undefined
Returns:	undefined

Writes 32 bytes of firmware to the bricklet attached at the given port. The bytes are written to the position offset * 32.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickDC.readBrickletPlugin(port, offset[, returnCallback][, errorCallback])¶

Parameters:	port – Type: char, Range: ['a' to 'b'] offset – Type: int, Range: [0 to 255]
Callback Parameters:	chunk – Type: [int, ...], Length: 32, Range: [0 to 255]
Returns:	undefined

Reads 32 bytes of firmware from the bricklet attached at the given port. The bytes are read starting at the position offset * 32.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Constants¶

BrickDC.DEVICE_IDENTIFIER¶

This constant is used to identify a DC Brick.

The getIdentity() function and the IPConnection.CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickDC.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a DC Brick.