Rust - API Bindings

The Rust bindings allow you to control Bricks and Bricklets from your Rust programs. The ZIP file for the bindings contains:

  • in src/ the source code of the bindings
  • in examples/ the examples for every Brick and Bricklet

The Rust bindings are also hosted on crates.io.

Requirements

  • The Rust compiler version 1.31 or greater.

Installation

The Rust bindings can either be installed from the zip file, or by downloading them from crates.io.

If you add tinkerforge = "2.*" to your Cargo.toml's [dependencies] section, cargo will download the bindings and all dependencies on the next run.

If you want to install them from the zip file, download and extract it and register the dependency by adding tinkerforge = {path=[your/path/here]} to the [dependencies] section of your Cargo.toml, specifing the correct path (without src at the end) instead of the placeholder. The next run of cargo will download the binding's dependencies.

Testing an Example

To test a Rust example Brick Daemon and Brick Viewer have to be installed first. Brick Daemon acts as a proxy between the USB interface of the Bricks and the API bindings. Brick Viewer connects to Brick Daemon and helps to figure out basic information about the connected Bricks and Bricklets.

As an example let's compile the configuration example for the Stepper Brick from the command line. For this we create a new folder example_project, run cargo init in this folder, and then copy the example_configuration.rs file from the examples/StepperBrick/ folder into the src folder which was created by cargo. Rename the copied file to main.rs (overwriting the one created by cargo):

example_project/
 -> Cargo.toml
 -> src/main.rs (was example_configuration.rs)

Then add either tinkerforge = "2.*" or tinkerforge = {path=[your/path/here]} into the [dependencies] section of your project's Cargo.toml.

In the example HOST and PORT specify at which network address the Stepper Brick can be found. If it is connected locally to USB then localhost and 4223 is correct. The UID value has to be changed to the UID of the connected Stepper Brick, which you can figure out using Brick Viewer:

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XXYYZZ"; // Change XXYYZZ to the UID of your Stepper Brick.

Now we can build and run the project with cargo run.

API Reference and Examples

Links to the API reference for the IP Connection, Bricks and Bricklets as well as the examples from the ZIP file of the bindings are listed in the following table. Further project descriptions can be found in the Kits section.

Name API Examples
IP Connection API Examples
     
Bricks    
DC API Examples
HAT API Examples
HAT Zero API Examples
IMU 2.0 API Examples
Master API Examples
RED API Examples
Servo API Examples
Silent Stepper API Examples
Stepper API Examples
     
Bricks (Discontinued)    
IMU API Examples
     
Bricklets    
Accelerometer 2.0 API Examples
Air Quality API Examples
Ambient Light 3.0 API Examples
Analog In 3.0 API Examples
Analog Out 2.0 API Examples
Analog Out 3.0 API Examples
Barometer API Examples
Barometer 2.0 API Examples
CAN API Examples
CAN 2.0 API Examples
CO2 2.0 API Examples
Color API Examples
Color 2.0 API Examples
Compass API Examples
Distance IR API Examples
Distance IR 2.0 API Examples
Distance US 2.0 API Examples
DMX API Examples
Dual Button API Examples
Dual Button 2.0 API Examples
Dual Relay API Examples
Dust Detector API Examples
E-Paper 296x128 API Examples
Energy Monitor API Examples
GPS 2.0 API Examples
Hall Effect API Examples
Hall Effect 2.0 API Examples
Humidity 2.0 API Examples
Industrial Analog Out API Examples
Industrial Analog Out 2.0 API Examples
Industrial Counter API Examples
Industrial Digital In 4 2.0 API Examples
Industrial Digital Out 4 API Examples
Industrial Digital Out 4 2.0 API Examples
Industrial Dual 0-20mA API Examples
Industrial Dual 0-20mA 2.0 API Examples
Industrial Dual Analog In 2.0 API Examples
Industrial Dual Relay API Examples
Industrial Quad Relay 2.0 API Examples
IO-16 API Examples
IO-16 2.0 API Examples
IO-4 2.0 API Examples
Isolator API Examples
Joystick API Examples
Joystick 2.0 API Examples
Laser Range Finder 2.0 API Examples
LCD 128x64 API Examples
LCD 20x4 API Examples
LED Strip 2.0 API Examples
Line API Examples
Linear Poti API Examples
Linear Poti 2.0 API Examples
Load Cell 2.0 API Examples
Motion Detector API Examples
Motion Detector 2.0 API Examples
Motorized Linear Poti API Examples
Multi Touch API Examples
Multi Touch 2.0 API Examples
NFC API Examples
OLED 128x64 API Examples
OLED 128x64 2.0 API Examples
OLED 64x48 API Examples
One Wire API Examples
Outdoor Weather API Examples
Particulate Matter API Examples
Piezo Speaker API Examples
Piezo Speaker 2.0 API Examples
PTC 2.0 API Examples
Real-Time Clock API Examples
Real-Time Clock 2.0 API Examples
Remote Switch 2.0 API Examples
RGB LED API Examples
RGB LED 2.0 API Examples
RGB LED Button API Examples
Rotary Encoder 2.0 API Examples
Rotary Poti API Examples
Rotary Poti 2.0 API Examples
RS232 API Examples
RS232 2.0 API Examples
RS485 API Examples
Segment Display 4x7 API Examples
Segment Display 4x7 2.0 API Examples
Solid State Relay 2.0 API Examples
Sound Intensity API Examples
Sound Pressure Level API Examples
Temperature API Examples
Temperature 2.0 API Examples
Temperature IR 2.0 API Examples
Thermal Imaging API Examples
Thermocouple 2.0 API Examples
Tilt API Examples
UV Light API Examples
UV Light 2.0 API Examples
Voltage/Current 2.0 API Examples
XMC1400 Breakout API Examples
     
Bricklets (Discontinued)    
Accelerometer API Examples
Ambient Light API Examples
Ambient Light 2.0 API Examples
Analog In API Examples
Analog In 2.0 API Examples
Analog Out API Examples
CO2 API Examples
Current12 API Examples
Current25 API Examples
Distance US API Examples
GPS API Examples
Humidity API Examples
Industrial Digital In 4 API Examples
Industrial Dual Analog In API Examples
Industrial Quad Relay API Examples
IO-4 API Examples
Laser Range Finder API Examples
LCD 16x2 API Examples
LED Strip API Examples
Load Cell API Examples
Moisture API Examples
NFC/RFID API Examples
Piezo Buzzer API Examples
PTC API Examples
Remote Switch API Examples
RGB LED Matrix API Examples
Rotary Encoder API Examples
Solid State Relay API Examples
Temperature IR API Examples
Thermocouple API Examples
Voltage API Examples
Voltage/Current API Examples