go-api-bindings: github.com/Tinkerforge/go-api-bindings/dc_brick Index | Files

package dc_brick

import "github.com/Tinkerforge/go-api-bindings/dc_brick"

Drives one brushed DC motor with up to 28V and 5A (peak).

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricks/DC_Brick_Go.html.


Package Files



const DeviceDisplayName = "DC Brick"
const DeviceIdentifier = 11

type CommunicationMethod Uses

type CommunicationMethod = uint8
const (
    CommunicationMethodNone     CommunicationMethod = 0
    CommunicationMethodUSB      CommunicationMethod = 1
    CommunicationMethodSPIStack CommunicationMethod = 2
    CommunicationMethodChibi    CommunicationMethod = 3
    CommunicationMethodRS485    CommunicationMethod = 4
    CommunicationMethodWIFI     CommunicationMethod = 5
    CommunicationMethodEthernet CommunicationMethod = 6
    CommunicationMethodWIFIV2   CommunicationMethod = 7

type DCBrick Uses

type DCBrick struct {
    // contains filtered or unexported fields

func New Uses

func New(uid string, ipcon *ipconnection.IPConnection) (DCBrick, error)

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*DCBrick) DeregisterCurrentVelocityCallback Uses

func (device *DCBrick) DeregisterCurrentVelocityCallback(registrationId uint64)

Remove a registered Current Velocity callback.

func (*DCBrick) DeregisterEmergencyShutdownCallback Uses

func (device *DCBrick) DeregisterEmergencyShutdownCallback(registrationId uint64)

Remove a registered Emergency Shutdown callback.

func (*DCBrick) DeregisterUnderVoltageCallback Uses

func (device *DCBrick) DeregisterUnderVoltageCallback(registrationId uint64)

Remove a registered Under Voltage callback.

func (*DCBrick) DeregisterVelocityReachedCallback Uses

func (device *DCBrick) DeregisterVelocityReachedCallback(registrationId uint64)

Remove a registered Velocity Reached callback.

func (*DCBrick) Disable Uses

func (device *DCBrick) Disable() (err error)

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


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.

func (*DCBrick) DisableStatusLED Uses

func (device *DCBrick) DisableStatusLED() (err error)

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.

.. versionadded:: 2.3.1$nbsp;(Firmware)

func (*DCBrick) Enable Uses

func (device *DCBrick) Enable() (err error)

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

func (*DCBrick) EnableStatusLED Uses

func (device *DCBrick) EnableStatusLED() (err error)

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.

.. versionadded:: 2.3.1$nbsp;(Firmware)

func (*DCBrick) FullBrake Uses

func (device *DCBrick) FullBrake() (err error)

Executes an active full brake.


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.

func (*DCBrick) GetAPIVersion Uses

func (device *DCBrick) GetAPIVersion() [3]uint8

Returns the version of the API definition (major, minor, revision) 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.

func (*DCBrick) GetAcceleration Uses

func (device *DCBrick) GetAcceleration() (acceleration uint16, err error)

Returns the acceleration as set by SetAcceleration.

func (*DCBrick) GetChipTemperature Uses

func (device *DCBrick) GetChipTemperature() (temperature int16, err error)

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.

func (*DCBrick) GetCurrentConsumption Uses

func (device *DCBrick) GetCurrentConsumption() (voltage uint16, err error)

Returns the current consumption of the motor.

func (*DCBrick) GetCurrentVelocity Uses

func (device *DCBrick) GetCurrentVelocity() (velocity int16, err error)

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.

func (*DCBrick) GetCurrentVelocityPeriod Uses

func (device *DCBrick) GetCurrentVelocityPeriod() (period uint16, err error)

Returns the period as set by SetCurrentVelocityPeriod.

func (*DCBrick) GetDriveMode Uses

func (device *DCBrick) GetDriveMode() (mode DriveMode, err error)

Returns the drive mode, as set by SetDriveMode.

Associated constants:

* DriveModeDriveBrake
* DriveModeDriveCoast

func (*DCBrick) GetExternalInputVoltage Uses

func (device *DCBrick) GetExternalInputVoltage() (voltage uint16, err error)

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.


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.

func (*DCBrick) GetIdentity Uses

func (device *DCBrick) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

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 <device_identifier>`. |device_identifier_constant|

func (*DCBrick) GetMinimumVoltage Uses

func (device *DCBrick) GetMinimumVoltage() (voltage uint16, err error)

Returns the minimum voltage as set by SetMinimumVoltage

func (*DCBrick) GetPWMFrequency Uses

func (device *DCBrick) GetPWMFrequency() (frequency uint16, err error)

Returns the PWM frequency as set by SetPWMFrequency.

func (*DCBrick) GetProtocol1BrickletName Uses

func (device *DCBrick) GetProtocol1BrickletName(port rune) (protocolVersion uint8, firmwareVersion [3]uint8, name string, err error)

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.

func (*DCBrick) GetResponseExpected Uses

func (device *DCBrick) GetResponseExpected(functionID Function) (bool, error)

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.

See SetResponseExpected for the list of function ID constants available for this function.

func (*DCBrick) GetSPITFPBaudrate Uses

func (device *DCBrick) GetSPITFPBaudrate(brickletPort rune) (baudrate uint32, err error)

Returns the baudrate for a given Bricklet port, see SetSPITFPBaudrate.

.. versionadded:: 2.3.3$nbsp;(Firmware)

func (*DCBrick) GetSPITFPBaudrateConfig Uses

func (device *DCBrick) GetSPITFPBaudrateConfig() (enableDynamicBaudrate bool, minimumDynamicBaudrate uint32, err error)

Returns the baudrate config, see SetSPITFPBaudrateConfig.

.. versionadded:: 2.3.5$nbsp;(Firmware)

func (*DCBrick) GetSPITFPErrorCount Uses

func (device *DCBrick) GetSPITFPErrorCount(brickletPort rune) (errorCountACKChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

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.

.. versionadded:: 2.3.3$nbsp;(Firmware)

func (*DCBrick) GetSendTimeoutCount Uses

func (device *DCBrick) GetSendTimeoutCount(communicationMethod CommunicationMethod) (timeoutCount uint32, err error)

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.

.. versionadded:: 2.3.3$nbsp;(Firmware)

Associated constants:

* CommunicationMethodNone
* CommunicationMethodUSB
* CommunicationMethodSPIStack
* CommunicationMethodChibi
* CommunicationMethodRS485
* CommunicationMethodWIFI
* CommunicationMethodEthernet
* CommunicationMethodWIFIV2

func (*DCBrick) GetStackInputVoltage Uses

func (device *DCBrick) GetStackInputVoltage() (voltage uint16, err error)

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.

func (*DCBrick) GetVelocity Uses

func (device *DCBrick) GetVelocity() (velocity int16, err error)

Returns the velocity as set by SetVelocity.

func (*DCBrick) IsEnabled Uses

func (device *DCBrick) IsEnabled() (enabled bool, err error)

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

func (*DCBrick) IsStatusLEDEnabled Uses

func (device *DCBrick) IsStatusLEDEnabled() (enabled bool, err error)

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

.. versionadded:: 2.3.1$nbsp;(Firmware)

func (*DCBrick) ReadBrickletPlugin Uses

func (device *DCBrick) ReadBrickletPlugin(port rune, offset uint8) (chunk [32]uint8, err error)

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.

func (*DCBrick) RegisterCurrentVelocityCallback Uses

func (device *DCBrick) RegisterCurrentVelocityCallback(fn func(int16)) uint64

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

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

func (*DCBrick) RegisterEmergencyShutdownCallback Uses

func (device *DCBrick) RegisterEmergencyShutdownCallback(fn func()) uint64

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.


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.

func (*DCBrick) RegisterUnderVoltageCallback Uses

func (device *DCBrick) RegisterUnderVoltageCallback(fn func(uint16)) uint64

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

func (*DCBrick) RegisterVelocityReachedCallback Uses

func (device *DCBrick) RegisterVelocityReachedCallback(fn func(int16)) uint64

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 RegisterVelocityReachedCallback callback will be triggered after about 2 seconds, when the set velocity is actually reached.


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.

func (*DCBrick) Reset Uses

func (device *DCBrick) Reset() (err error)

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!

func (*DCBrick) SetAcceleration Uses

func (device *DCBrick) SetAcceleration(acceleration uint16) (err error)

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.

func (*DCBrick) SetCurrentVelocityPeriod Uses

func (device *DCBrick) SetCurrentVelocityPeriod(period uint16) (err error)

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

func (*DCBrick) SetDriveMode Uses

func (device *DCBrick) SetDriveMode(mode DriveMode) (err error)

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.

Associated constants:

* DriveModeDriveBrake
* DriveModeDriveCoast

func (*DCBrick) SetMinimumVoltage Uses

func (device *DCBrick) SetMinimumVoltage(voltage uint16) (err error)

Sets the minimum voltage, below which the RegisterUnderVoltageCallback 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.

func (*DCBrick) SetPWMFrequency Uses

func (device *DCBrick) SetPWMFrequency(frequency uint16) (err error)

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.

func (*DCBrick) SetResponseExpected Uses

func (device *DCBrick) SetResponseExpected(functionID Function, responseExpected bool) error

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.

func (*DCBrick) SetResponseExpectedAll Uses

func (device *DCBrick) SetResponseExpectedAll(responseExpected bool)

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

func (*DCBrick) SetSPITFPBaudrate Uses

func (device *DCBrick) SetSPITFPBaudrate(brickletPort rune, baudrate uint32) (err error)

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 you applications we recommend to not change the baudrate.

.. versionadded:: 2.3.3$nbsp;(Firmware)

func (*DCBrick) SetSPITFPBaudrateConfig Uses

func (device *DCBrick) SetSPITFPBaudrateConfig(enableDynamicBaudrate bool, minimumDynamicBaudrate uint32) (err error)

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.

.. versionadded:: 2.3.5$nbsp;(Firmware)

func (*DCBrick) SetVelocity Uses

func (device *DCBrick) SetVelocity(velocity int16) (err error)

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.

func (*DCBrick) WriteBrickletPlugin Uses

func (device *DCBrick) WriteBrickletPlugin(port rune, offset uint8, chunk [32]uint8) (err error)

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.

type DriveMode Uses

type DriveMode = uint8
const (
    DriveModeDriveBrake DriveMode = 0
    DriveModeDriveCoast DriveMode = 1

type Function Uses

type Function = uint8
const (
    FunctionSetVelocity               Function = 1
    FunctionGetVelocity               Function = 2
    FunctionGetCurrentVelocity        Function = 3
    FunctionSetAcceleration           Function = 4
    FunctionGetAcceleration           Function = 5
    FunctionSetPWMFrequency           Function = 6
    FunctionGetPWMFrequency           Function = 7
    FunctionFullBrake                 Function = 8
    FunctionGetStackInputVoltage      Function = 9
    FunctionGetExternalInputVoltage   Function = 10
    FunctionGetCurrentConsumption     Function = 11
    FunctionEnable                    Function = 12
    FunctionDisable                   Function = 13
    FunctionIsEnabled                 Function = 14
    FunctionSetMinimumVoltage         Function = 15
    FunctionGetMinimumVoltage         Function = 16
    FunctionSetDriveMode              Function = 17
    FunctionGetDriveMode              Function = 18
    FunctionSetCurrentVelocityPeriod  Function = 19
    FunctionGetCurrentVelocityPeriod  Function = 20
    FunctionSetSPITFPBaudrateConfig   Function = 231
    FunctionGetSPITFPBaudrateConfig   Function = 232
    FunctionGetSendTimeoutCount       Function = 233
    FunctionSetSPITFPBaudrate         Function = 234
    FunctionGetSPITFPBaudrate         Function = 235
    FunctionGetSPITFPErrorCount       Function = 237
    FunctionEnableStatusLED           Function = 238
    FunctionDisableStatusLED          Function = 239
    FunctionIsStatusLEDEnabled        Function = 240
    FunctionGetProtocol1BrickletName  Function = 241
    FunctionGetChipTemperature        Function = 242
    FunctionReset                     Function = 243
    FunctionWriteBrickletPlugin       Function = 246
    FunctionReadBrickletPlugin        Function = 247
    FunctionGetIdentity               Function = 255
    FunctionCallbackUnderVoltage      Function = 21
    FunctionCallbackEmergencyShutdown Function = 22
    FunctionCallbackVelocityReached   Function = 23
    FunctionCallbackCurrentVelocity   Function = 24

Package dc_brick imports 5 packages (graph). Updated 2020-07-28. Refresh now. Tools for package owners.