Projekt anfragen
Benešl Automation / BAVIS / SDK und Community
BAVIS 3.1Öffentliches SDK und offenes Repository

BAVIS SDK: Ihr eigener Treiber für jedes Gerät

Fehlt in BAVIS das Protokoll Ihres Geräts? Mit dem öffentlichen SDK schreiben Sie einen Kommunikationstreiber in Python, testen ihn ohne Hardware und installieren ihn als Paket. Auf eine neue BAVIS-Version müssen Sie nicht warten.

Stand: Das SDK API 1.0 ist Teil von BAVIS 3.1. Das Repository BAVIS-SDK ist öffentlich.

1.0Version des SDK API
Apache-2.0Lizenz des Repositorys
3 → 4ein SDK-Paket übersteht eine neue Hauptversion
drivers/my_scale.py · minimaler Treiber
from bavis.sdk import Driver, DriverSpec, FieldSpec, require_host


class ScaleDriver(Driver):
    def open(self):
        self.link = connect(self.conn.host, self.conn.port)

    def close(self):
        self.link.close()

    def poll(self):
        return {t.name: self.link.read(t.address)
                for t in self.tags}


SPECS = [DriverSpec(
    kind="my_scale", label="My scale", transport="tcp",
    default_port=4001, validate=require_host,
    make=lambda conn, tags, sink, data_dir:
        ScaleDriver(conn, tags, sink, data_dir),
    check_address=lambda a, typ:
        None if a.startswith("W") else "use W1, W2 …",
    fields=(FieldSpec("station", "Station", "number"),),
)]

Warum das SDK

Ein Treiber als Paket, kein Eingriff in den Kern

Das SDK ist die stabile öffentliche Schnittstelle für Treiber, die außerhalb des BAVIS-Kerns entstehen: in der Community, bei Integratoren oder bei uns als Auftragsarbeit für einen einzelnen Kunden.

SDK 1.0

Stabiles API

Ein Paket, das BAVIS nur über bavis.sdk importiert, lädt auch nach der nächsten Hauptversion des Kerns, etwa von 3.x auf 4.x.

SDK 1.0

Ohne neue Version

Ein Treiber ist ein .bavispkg-Paket. Sie laden es unter System → Projekte und Pakete hoch und es gilt sofort für alle Projekte.

SDK 1.0

Tests ohne Hardware

bavis.sdk.testing startet einen Treiber ohne BAVIS-Server gegen ein simuliertes Gerät. Tests brauchen nie ein echtes Gerät.

SDK 1.0

Den Rest macht der Kern

Ein Treiber liefert Rohwerte. Skalierung, Totband, Historie, Alarme und Wiederverbindung übernimmt BAVIS.

Erste Schritte

Vier Schritte zum eigenen Treiber

Der Generator legt ein funktionierendes Gerüst an: einen Treiber für ein einfaches zeilenbasiertes TCP-Protokoll, ein simuliertes Gerät für die Tests und Übersetzungsdateien. Dann tauschen Sie das Protokoll gegen Ihres aus.

  1. Gerüst erzeugen

    Ein Paket bavis_drv_<name> mit Treiber, Tests und Übersetzungen.

    python -m bavis.tools.novy_modul driver my_scale \
        --label "My scale" --balicek ~/drivers
  2. Protokoll schreiben

    Überschreiben Sie open(), poll() und bei Bedarf write(). Das Verbindungsformular beschreibt FieldSpec, Adressen prüft check_address.

    def poll(self):
        return {t.name: self.link.read(t.address)
                for t in self.tags}
  3. Testen

    Tests gegen ein simuliertes Gerät auf einem vom System vergebenen Port. Sie laufen parallel und ohne Hardware.

    cd ~/drivers
    python -m pytest -q tests
  4. Bauen und installieren

    Der Build lehnt ein defektes Modul oder eine ungültige Treiberbeschreibung ab und signiert das Paket, wenn Sie ihm einen Schlüssel geben. Dann laden Sie es unter System → Projekte und Pakete hoch.

    python -m bavis package build ~/drivers/bavis_drv_my_scale \
        --out drv_my_scale-1.0.0.bavispkg --key key.pem

Die vollständige API-Referenz, die Versionsregeln und die Beispiele stehen auf Englisch im Repository BAVIS-SDK. Texte für Bediener übersetzen Sie in i18n-Dateien (Tschechisch, Englisch, Deutsch, Slowakisch, Polnisch). Ab Version 4.0 hat jede Installation (Windows, Linux, Docker) den Befehl bavis sdk mit den Schritten new, test, check und build – den Quellcode des Kerns brauchen Sie nicht, die kostenlose Edition Lite oder Maker genügt. github.com/Tomoash/BAVIS-SDK

Community

Ein Treiber für einen, nützlich für alle

Wer einen Treiber für ein Gerät schreibt, das er braucht, kann ihn anderen anbieten. Beiträge nehmen wir im öffentlichen Repository BAVIS-SDK auf GitHub an.

01

Fehler melden oder Treiber vorschlagen

In den GitHub Issues des Repositorys BAVIS-SDK. Nennen Sie Gerät und Protokoll und verlinken Sie die Herstellerdokumentation. Fragen und Ideen gehören in die GitHub Discussions.

Issues öffnen
02

Pull Request senden

Beiträge stehen unter der Lizenz Apache-2.0, jeder Commit wird nach dem DCO abgezeichnet (git commit -s). Das Vorgehen steht in CONTRIBUTING.

Repository ansehen
03

Schwachstellen vertraulich melden

Eine Sicherheitslücke gehört nicht in die Issues. Senden Sie sie per E-Mail wie in SECURITY.md im Repository beschrieben.

benesl@benesl-automation.cz
04

Katalog der Community-Pakete

Ab BAVIS 4.0. Der Administrator wählt in der Anwendung vertrauenswürdige Paketquellen. Ein Paket aus dem Katalog wird nur installiert, wenn sein SHA-256-Fingerabdruck stimmt, und die Installation wird im Audit protokolliert. Von uns geprüfte Pakete tragen unsere Signatur und das Zeichen „geprüft“.

Was BAVIS 4.0 bringt

Regeln für Treiber

  • BAVIS nur aus bavis.sdk und bavis.sdk.testing importieren.
  • Nur Bibliotheken mit einer zu Apache-2.0 kompatiblen Lizenz (MIT, BSD, Apache). GPL-Bibliotheken nehmen wir nicht an.
  • Registerbelegung und Adressen nach der Herstellerdokumentation, mit Verweis darauf.
  • Sicheres Schreiben: nichts in schreibgeschützte Tags, Schreiben aus, wo ein falscher Wert die Anlage beschädigen kann, und nie zyklisch in Flash oder EEPROM.
  • Tests mit simuliertem Gerät; kein Test darf echte Hardware brauchen.

Maker-Lizenz

BAVIS Maker: kostenlos für Zuhause und Werkstatt

Für Enthusiasten, Bastler und Treiberentwickler. Die Edition Maker, kostenlos für die nichtkommerzielle Nutzung, ist mit der Wartungsversion BAVIS 3.1.1 erschienen.

5 000Tags im Projekt
kostenlosfür nichtkommerzielle Nutzung
  • Logik, Skripte und Berechnungen, Zeitprogramme und Energiemanagement
  • Protokolle für Smart Home und Zähler: KNX, M-Bus, wM-Bus, HTTP / REST, Home Assistant und weitere
  • die Basisprotokolle jeder Edition: Modbus, Siemens S7, OPC-UA-Client und MQTT

So funktioniert Maker

Maker schalten Sie direkt in der Anwendung ein, ohne Lizenzdatei. Die Installation meldet sich dann regelmäßig mit zusammengefassten Daten bei BAVIS Central: Versionen, Anzahlen und verwendete Treiber. Werte oder Namen von Tags sendet sie nie.

Kommerzielle Nutzung braucht eine Standard-Lizenz, auch bei einem kleinen Projekt. Kleinere nichtkommerzielle Projekte bis 150 Tags deckt die kostenlose Edition Lite ab.

Lizenz berechnen

Fragen

Häufige Fragen zum SDK

Was ist das BAVIS SDK?

Eine öffentliche Python-Schnittstelle für Kommunikationstreiber der Web-SCADA BAVIS. Ein Treiber wird als Paket .bavispkg geliefert und ohne neue BAVIS-Version installiert.

Funktioniert mein Treiber auch in BAVIS 4?

Ja, wenn er BAVIS nur über bavis.sdk importiert. Eine neue SDK-Hauptversion kommt nur mit einer neuen Hauptversion des Kerns, und die vorherige bleibt mindestens eine Version mit Langzeitunterstützung lang unterstützt.

Muss ich meinen Treiber veröffentlichen?

Nein. Sie können das Paket nur in Ihren eigenen Installationen nutzen. Beiträge zum öffentlichen Repository BAVIS-SDK sind freiwillig, unter der Lizenz Apache-2.0.

Ist die Installation eines fremden Pakets sicher?

Der Paketcode läuft im BAVIS-Prozess mit denselben Rechten wie der Kern, installieren Sie daher nur Pakete, denen Sie vertrauen. In Version 3.1 lässt sich ein unsigniertes Paket nur im Entwicklungsmodus installieren. Ab Version 4.0 installiert der Administrator einen unsignierten Community-Treiber nur mit der Bestätigung „auf eigenes Risiko“, Passwort und Begründung (elektronische Signatur), und die Installation wird im Betriebsprotokoll erfasst. Die Installation unsignierter Treiber kann der Administrator ganz abschalten.

Seit wann gibt es das SDK und die Maker-Lizenz?

Das SDK ist Teil von BAVIS 3.1, die Maker-Lizenz ist mit der Wartungsversion 3.1.1 erschienen. Sie aktivieren sie in der Anwendung unter System → Lizenz → BAVIS Maker. Im Repository BAVIS-SDK können Sie die Entwicklung verfolgen und Ideen melden.

Schreiben Sie den Treiber für mich?

Ja, als Auftragsarbeit. Senden Sie uns Gerät, Protokoll und Herstellerdokumentation, und wir melden uns mit einem Vorschlag.

Zusammenarbeit

Schreiben Sie einen Treiber oder integrieren Sie BAVIS?

Wir helfen gern beim Entwurf des Treibers, beim Protokoll und beim Paket. Integratoren unterstützen wir beim ersten Projekt.

Das SDK ist Teil von BAVIS 3.1, die Maker-Lizenz gilt ab der Wartungsversion 3.1.1. Siemens und S7 sind Marken der Siemens AG.