Go - API Bindings¶

Requirements¶

• Go compiler 1.11 or newer

Installation¶

There are two ways to install the Go bindings: from GitHub or from source.

go get -u github.com/Tinkerforge/go-api-bindings

replace github.com/Tinkerforge/go-api-bindings => /path/to/your/github.com/Tinkerforge/go-api-bindings

Testing an Example¶

To test a Go 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 use the example_configuration.go file from the examples/StepperBrick/ folder of the ZIP file.

In the example ADDR specifies at which network address the Stepper Brick can be found. If it is connected locally to USB then localhost: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 ADDR string = "localhost:4223"
const UID string = "XXYYZZ" // Change XXYYZZ to the UID of your Stepper Brick.

Now we can build and run the project with go run example_configuration.go.

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.