C/C++ - API Bindings

Bemerkung

Es gibt einen extra Abschnitt für Objective-C und iOS.

Die C/C++ Bindings ermöglichen es Bricks und Bricklets aus selbst erstellen C/C++ Programmen heraus zu steuern. Die ZIP Datei für die Bindings beinhaltet:

  • in source/ den Quelltext der Bindings

  • in examples/ die Beispiele für alle Bricks und Bricklets

Voraussetzungen

  • C-Compiler (C99-kompatibel) oder C++-Compiler

Installation

Um die C/C++ Bindings einfach zu halten haben sie nur externe Abhängigkeiten, die möglichst überall verfügbar sind, wodurch sie leicht in jegliches Projekt eingebunden werden können. Wir bieten keine vorkompilierte Bibliothek an, da dies zu viel Aufwand wäre alle möglichen Kombinationen von Architekturen und Betriebssystem zu versorgen. Die Bindings sollten aber auf den meisten Architekturen (ARM, x86, etc.) und den meisten Betriebssystemen (Windows und POSIX Systeme, wie Linux und macOS, usw.) lauffähig sein.

Da es keine vorkompilierte Bibliothek für die C/C++ Bindings gibt, gibt es in diese Sinne auch nichts zu installieren. Die empfohlene Art und Weise die Bindings zu verwenden, ist ihren Quelltext direkt in das jeweilige C/C++ Projekt mit einzubinden. Der folgenden Abschnitt zeigt an verschiedenen Beispielen auf wie dies gemacht werden kann.

Test eines Beispiels

Um ein C/C++ Beispiel testen zu können, müssen zuerst Brick Daemon und Brick Viewer installiert werden. Brick Daemon arbeitet als Proxy zwischen der USB Schnittstelle der Bricks und den API Bindings. Brick Viewer kann sich mit Brick Daemon verbinden und gibt Informationen über die angeschlossenen Bricks und Bricklets aus.

Als Beispiel werden wir das Stepper Brick Konfigurationsbeispiel mit GCC auf der Kommandozeile und in verschiedenen IDEs kompilieren. Dafür müssen zuerst die IP Connection und die Stepper Brick Bindings aus dem source/ Ordner sowie example_configuration.c aus dem examples/brick/stepper/ Ordner in ein neuen Ordner kopiert werden:

example_project/
 -> ip_connection.c
 -> ip_connection.h
 -> brick_stepper.c
 -> brick_stepper.h
 -> example_configuration.c

Am Anfang des Beispiels ist mit HOST und PORT angegeben unter welcher Netzwerkadresse der Stepper Brick zu erreichen ist. Ist er lokal per USB angeschlossen dann ist localhost und 4223 richtig. Als UID muss die UID des angeschlossen Stepper Bricks angegeben werden, diese kann über den Brick Viewer ermittelt werden:

#define HOST "localhost"
#define PORT 4223
#define UID "XXYYZZ" // Change XXYYZZ to the UID of your Stepper Brick

GCC

Die einzige Abhängigkeit auf Unix-artigen Systemen ist pthreads. Somit sieht der Befehl um das Beispiel mit GCC unter Linux und macOS zu kompilieren wie folgt aus:

gcc -pthread -o example *.c

Unter Windows wird Win32 für Threads und WinSock2 (ws2_32) für die Netzwerkverbindung verwendet. Mit MinGW lässt sich das Beispiel wie folgt kompilieren (Linker-Parameter müssen nach den Quelldateien angegeben werden):

gcc -o example.exe *.c -lws2_32 -ladvapi32

Der einfachste Weg die Bindings in einem C++ Projekt zu verwenden, ist es alle benötigten Dateien von *.c nach *.cpp umzubenennen. Dann behandelt der Compiler den Quelltext als C++ und tut automatisch das Richtige.

Visual Studio

Mit Visual Studio kann der example_project/ Ordner auch verwendet werden. Der einfachste Weg die Bindings in einem Visual C++ Projekt zu verwenden, ist es alle benötigten Dateien von *.c nach *.cpp umzubenennen. Dann behandelt der Compiler den Quelltext als C++ und tut automatisch das Richtige. Dadurch wird auch das Problem vermieden, dass der Visual Studio Compiler nur den C89 Standard unterstützt, die Bindings aber den neueren C99 Standard verwenden.

IDE

Jetzt kann ein neues Projekt in Visual Studio erzeugt werden:

  • Datei

  • Neu

  • Projekt aus vorhandenem Code...

  • Wähle als Typ "Visual C++"

  • Wähle example_project/

  • Wähle einen Projektnamen

  • Klicke Weiter

  • Wähle "Windows-Konsolenanwendung"

  • Klicke Fertig

Zusätzlich müssen noch ws2_32.lib (WinSock2) und advapi32.lib dem Projekt hinzugefügt werden:

  • Projekt

  • Eigenschaften

  • Linker

  • Eingabe, Option "Zusätzliche Abhängigkeiten"

  • Füge ws2_32.lib;advapi32.lib; hinzu

Ältere Versionen von Visual Studio bringen kein stdint.h mit. Eine kompatible Version gibt es hier. Falls nötig diese herunterladen und im example_project/ Ordner speichern.

Das Visual C++ Projekt hat vielleicht die "Vorkompilierte Header" Option standardmäßig aktiviert. Die C/C++ Bindings unterstützen dies nicht. Deaktiviere die "Vorkompilierte Header" Option für alle *.cpp Dateien die aus den Bindings verwendet werden, jeweils in deren Eigenschaftsdialog:

  • C/C++

  • Vorkompilierte Header, Option "Vorkompilierter Header"

  • Wähle "Vorkompilierte Header nicht verwenden"

Das waren alle nötigen Änderungen, jetzt kann das Projekt kompiliert und gestartet werden!

Kommandozeile

Der Visual Studio Compiler kann auch von der Kommandozeile aus verwendet werden im example_project/ Ordner:

cl.exe /I. *.cpp /link /out:example.exe ws2_32.lib advapi32.lib

Qt Creator

Ein neues Projekt für der example_project/ Ordner in Qt Creator kann wie folgt erzeugt werden:

  • File

  • New File or Project...

  • Wähle Other Project

  • Wähle Empty Qt Project

  • Klicke Choose...

  • Wähle "example_project" als Name

  • Wähle den Ordner der den example_project/ Ordner beinhaltet für "Create in"

  • Klicke Next

  • Klicke Next

  • Klicke Finish

Qt Creator sollte jetzt eine leere Datei namens example_project.pro anzeigen. In diesem müssen jetzt folgende Zeilen kopiert und das Ergebnis gespeichert werden:

TEMPLATE = app
CONFIG += console
TARGET = example_configuration
win32:LIBS += -lws2_32 -ladvapi32
unix:QMAKE_CXXFLAGS += -pthread
SOURCES += ip_connection.c brick_stepper.c example_configuration.c
HEADERS += ip_connection.h brick_stepper.h

Dies weist Qt Creator an, dass dies eine Konsolenanwendung namens "example_configuration" ist. Sie ist gegen die ws2_32 und advapi32 Bibliothekeb auf Windows gelinkt und verwendet pthreads auf Unix (Linux, macOS, etc).

Bevor das Programm jetzt gestartet werden kann muss noch der Haken bei "Run in terminal" auf dem Tab für die Run Konfiguration des Projekts gesetzt werden, ansonsten wird die Ausgabe des Programms nicht angezeigt.

Jetzt kann das Programm kompiliert und gestartet werden!

Dies ist ein Beispiel ein Projekt in C. Der einfachste Weg die Bindings in einem C++ Projekt zu verwenden, ist es alle benötigten Dateien von *.c nach *.cpp umzubenennen und die SOURCES Zeile in example_project.pro entsprechend anzupassen. Dann behandelt der Compiler den Quelltext als C++ und tut automatisch das Richtige.

Um die C/C++ Bindings zu einem bestehenden Qt Creator Projekt hinzuzufügen müssen nur die benötigten Dateien zu den SOURCES und HEADERS Variablen hinzugefügt und folgende zwei Zeilen in die .pro Datei des Projekts eingefügt werden:

win32:LIBS += -lws2_32 -ladvapi32
unix:QMAKE_CXXFLAGS += -pthread

Orwell Dev-C++

Ein neues Projekt für der example_project/ Ordner in Dev-C++ kann wie folgt erzeugt werden:

  • Datei

  • Neu

  • Projekt...

  • Wähle Console Application und C Projekt

  • Klicke Ok

Dev-C++ erzeugt eine neue Datei namens main.c. Diese benötigen wir nicht und sie kann durch einen Klick auf "Datei entfernen" in deren Kontextmenü in der Projektansicht entfernt werden. Als nächstes alle Dateien aus dem example_project/ Ordner zum Projekt hinzufügen über den "Zum Projekt hinzufügen" Eintrag im Kontextmenüs des Projekts.

Dann noch libws2_32.a (WinSock2) und libadvapi32.a zum Projekt hinzufügen:

  • Projekt

  • Projekt Optionen

  • Parameter

  • Klicke Bibliothek/Objekt hinzufügen

  • Wähle libws2_32.a und libadvapi32.a

  • Klicke Open

  • Klicke Ok

Jetzt kann das Programm kompiliert und gestartet werden!

Dies ist ein Beispiel ein Projekt in C. Der einfachste Weg die Bindings in einem C++ Projekt zu verwenden, ist es alle benötigten Dateien von *.c nach *.cpp umzubenennen. Dann behandelt der Compiler den Quelltext als C++ und tut automatisch das Richtige.

API Referenz und Beispiele

Links zur API Referenz der IP Connection, Bricks und Bricklets sowie die Beispiele aus der ZIP Datei der Bindings sind in der folgenden Tabelle aufgelistet. Anleitungen für weiterführende Projekte finden sich im Abschnitt über Kits.

, API, Beispiele

Sonstiges

IP Connection

API

Beispiele

Bricks

ESP32

API

ESP32 Ethernet

API

HAT

API

Beispiele

HAT Zero

API

Beispiele

IMU 2.0

API

Beispiele

Master

API

Beispiele

RED

API

Silent Stepper

API

Beispiele

Bricks (Abgekündigt)

DC

API

Beispiele

IMU

API

Beispiele

Servo

API

Beispiele

Stepper

API

Beispiele

Bricklets

Accelerometer 2.0

API

Beispiele

Air Quality

API

Beispiele

Ambient Light 3.0

API

Beispiele

Analog In 3.0

API

Beispiele

Analog Out 3.0

API

Beispiele

Barometer

API

Beispiele

Barometer 2.0

API

Beispiele

CAN

API

Beispiele

CAN 2.0

API

Beispiele

CO2 2.0

API

Beispiele

Color

API

Beispiele

Color 2.0

API

Beispiele

Compass

API

Beispiele

DC 2.0

API

Beispiele

Distance IR

API

Beispiele

Distance IR 2.0

API

Beispiele

Distance US 2.0

API

Beispiele

DMX

API

Beispiele

Dual Button 2.0

API

Beispiele

Dust Detector

API

Beispiele

E-Paper 296x128

API

Beispiele

Energy Monitor

API

Beispiele

GPS 2.0

API

Beispiele

GPS 3.0

API

Beispiele

Hall Effect

API

Beispiele

Hall Effect 2.0

API

Beispiele

Humidity 2.0

API

Beispiele

IMU 3.0

API

Beispiele

Industrial Analog Out 2.0

API

Beispiele

Industrial Counter

API

Beispiele

Industrial Digital In 4 2.0

API

Beispiele

Industrial Digital Out 4

API

Beispiele

Industrial Digital Out 4 2.0

API

Beispiele

Industrial Dual 0-20mA

API

Beispiele

Industrial Dual 0-20mA 2.0

API

Beispiele

Industrial Dual AC In

API

Industrial Dual AC Relay

API

Beispiele

Industrial Dual Analog In 2.0

API

Beispiele

Industrial Dual Relay

API

Beispiele

Industrial PTC

API

Beispiele

Industrial Quad Relay 2.0

API

Beispiele

IO-16

API

Beispiele

IO-16 2.0

API

Beispiele

IO-4 2.0

API

Beispiele

Isolator

API

Beispiele

Joystick

API

Beispiele

Joystick 2.0

API

Beispiele

Laser Range Finder 2.0

API

Beispiele

LCD 128x64

API

Beispiele

LCD 20x4

API

Beispiele

LED Strip 2.0

API

Beispiele

Line

API

Beispiele

Linear Poti

API

Beispiele

Linear Poti 2.0

API

Beispiele

Load Cell 2.0

API

Beispiele

Motion Detector 2.0

API

Beispiele

Motorized Linear Poti

API

Beispiele

Multi Touch

API

Beispiele

Multi Touch 2.0

API

Beispiele

NFC

API

Beispiele

OLED 128x64 2.0

API

Beispiele

OLED 64x48

API

Beispiele

One Wire

API

Beispiele

Outdoor Weather

API

Beispiele

Particulate Matter

API

Beispiele

Performance DC

API

Beispiele

Piezo Speaker

API

Beispiele

Piezo Speaker 2.0

API

Beispiele

Real-Time Clock

API

Beispiele

Real-Time Clock 2.0

API

Beispiele

Remote Switch 2.0

API

Beispiele

RGB LED 2.0

API

Beispiele

RGB LED Button

API

Beispiele

Rotary Encoder 2.0

API

Beispiele

Rotary Poti

API

Beispiele

Rotary Poti 2.0

API

Beispiele

RS232

API

Beispiele

RS232 2.0

API

Beispiele

RS485

API

Beispiele

Segment Display 4x7

API

Beispiele

Segment Display 4x7 2.0

API

Beispiele

Servo 2.0

API

Beispiele

Silent Stepper 2.0

API

Beispiele

Solid State Relay 2.0

API

Beispiele

Sound Intensity

API

Beispiele

Sound Pressure Level

API

Beispiele

Temperature

API

Beispiele

Temperature 2.0

API

Beispiele

Temperature IR 2.0

API

Beispiele

Thermal Imaging

API

Beispiele

Thermocouple 2.0

API

Beispiele

Tilt

API

Beispiele

UV Light 2.0

API

Beispiele

Voltage/Current 2.0

API

Beispiele

XMC1400 Breakout

API

Beispiele

Bricklets (Abgekündigt)

Accelerometer

API

Beispiele

Ambient Light

API

Beispiele

Ambient Light 2.0

API

Beispiele

Analog In

API

Beispiele

Analog In 2.0

API

Beispiele

Analog Out

API

Beispiele

Analog Out 2.0

API

Beispiele

CO2

API

Beispiele

Current12

API

Beispiele

Current25

API

Beispiele

Distance US

API

Beispiele

Dual Button

API

Beispiele

Dual Relay

API

Beispiele

GPS

API

Beispiele

Humidity

API

Beispiele

Industrial Analog Out

API

Beispiele

Industrial Digital In 4

API

Beispiele

Industrial Dual Analog In

API

Beispiele

Industrial Quad Relay

API

Beispiele

IO-4

API

Beispiele

Laser Range Finder

API

Beispiele

LCD 16x2

API

Beispiele

LED Strip

API

Beispiele

Load Cell

API

Beispiele

Moisture

API

Beispiele

Motion Detector

API

Beispiele

NFC/RFID

API

Beispiele

OLED 128x64

API

Beispiele

Piezo Buzzer

API

Beispiele

PTC

API

Beispiele

PTC 2.0

API

Beispiele

Remote Switch

API

Beispiele

RGB LED

API

Beispiele

RGB LED Matrix

API

Rotary Encoder

API

Beispiele

Solid State Relay

API

Beispiele

Temperature IR

API

Beispiele

Thermocouple

API

Beispiele

UV Light

API

Beispiele

Voltage

API

Beispiele

Voltage/Current

API

Beispiele