BEACON LINE Dokumentation

Willkommen

Vielen Dank für Ihr Interesse an der Beacon Line.

Konzept-Beschreibung

Hier werden die Kommunikationsstruktur und der Aufbau der einzelnen Komponenten gezeigt, um folgender Konzept-Beschreibung besser folgen zu können.

Getting Started

Hier finden Sie einige Key-Value Beispiele

Beacon Line RESTful API

Hier finden Sie einige Key-Value Beispiele

Observer-Daten

Die Observer-Daten können über den TCP-Port ("scanport: 4000" in Bline-Server.yaml), welches das Programm Bline-Server zur Verfügung stellt, erhalten werden.

Konfiguration

Der Bline-Server kann mit mehreren Beacon Line Gateways beziehungsweise Ankern eine Verbindung aufbauen. Das lässt sich in der Bline-Server.yaml Datei einstellen.

Technische Referenz

Technische Daten zur Beacon Line

Support

Support

Unterabschnitte von BEACON LINE Dokumentation

Kapitel 1

Willkommen

Beacon Line Bedienungslanleitung

Vielen Dank für Ihr Interesse an der Beacon Line.

System Schaubild

Version 4.0

(c) taskit GmbH Berlin

1.1 Vielen Dank

Vielen Dank für Ihr Interesse an der Beacon Line. Die Beacon Line ist eine BLE (Bluetooth Low Energy) Infrastruktur. Mit einem Gateway und bis zu 20 Ankern in einer Beacon Line können Sie viele BLE-Ideen umsetzen. Die Beacon Line ist eine batterielose, PoE-betriebene Netzwerklösung für wartungsfreie Festinstallationen auf der Basis von kabelgebundenen Funkknoten. Sie können die Beacon Line entweder als Beacon-Netzwerk oder als Beacon-Beobachtungsnetzwerk verwenden, um sich bewegende Beacons zu verfolgen, oder Sie können beides gleichzeitig verwenden.

1.2 Hinweise

Alle Rechte an dieser Dokumentation und an dem/den darin beschriebenen Produkt(en) liegen bei der taskit GmbH. Alle hier erwähnten Marken und eingetragenen Marken sind Eigentum ihrer jeweiligen Eigentümer. Weder die taskit GmbH noch der Verkäufer oder Vertreiber übernehmen irgendeine Haftung, die aus der Verwendung dieses Handbuchs oder eines hierin beschriebenen Produkts resultieren. Die Informationen in diesem Dokument können ohne vorherige Ankündigung geändert werden. Dieses Dokument wurde mit Sorgfalt erstellt, dennoch können Fehler nicht ausgeschlossen werden.

1.3 Warnung

Warnung Warnung Warnungserkärung Schließen Sie den PoE-Ausgang des Netzteils nicht an einen Nicht-PoE-Ethernet-Port an. Ein solcher Ethernet-Anschluss kann beschädigt oder sogar in Brand gesetzt werden. Dieses Netzteil ist für die Stromversorgung des taskit Gateways bestimmt. Dies ist ein einfaches PoE-Netzteil. Es schützt keine ungeeigneten (nicht-PoE) Ethernet-Ports. Das Netzteil darf nur von qualifiziertem Personal gehandhabt werden, das sich der Risiken eines unsachgemäßen Gebrauchs von elektrischen Geräten bewusst ist. Jede andere Verwendung als die oben genannte führt zum Erlöschen der Garantie.

Unterabschnitte von Willkommen

1.1 Vielen Dank

Vielen Dank für Ihr Interesse an der Beacon Line. Die Beacon Line ist eine BLE (Bluetooth Low Energy) Infrastruktur. Mit einem Gateway und bis zu 20 Ankern in einer Beacon Line können Sie viele BLE-Ideen umsetzen.

Die Beacon Line ist eine batterielose, PoE-betriebene Netzwerklösung für wartungsfreie Festinstallationen auf der Basis von kabelgebundenen Funkknoten. Sie können die Beacon Line entweder als Beacon-Netzwerk oder als Beacon-Beobachtungsnetzwerk verwenden, um sich bewegende Beacons zu verfolgen, oder Sie können beides gleichzeitig verwenden.

Die Einfachheit des Netzwerkkonzepts der Beacon Line macht es Ihnen leicht, groß angelegte drahtlose Ideen mit einem hohen Maß an technischer Flexibilität und modularer Erweiterung umzusetzen.

Abbildung eines Gatways Abbildung eines Ankers
Beacon Line Ether Gateway Beacon Line Ether Anchor

1.2 Hinweise

  • Alle Rechte an dieser Dokumentation und an dem/den darin beschriebenen Produkt(en) liegen bei der taskit GmbH.
  • Alle hier erwähnten Marken und eingetragenen Marken sind Eigentum ihrer jeweiligen Eigentümer.
  • Weder die taskit GmbH noch der Verkäufer oder Vertreiber übernehmen irgendeine Haftung, die aus der Verwendung dieses Handbuchs oder eines hierin beschriebenen Produkts resultieren.
  • Die Informationen in diesem Dokument können ohne vorherige Ankündigung geändert werden.
  • Dieses Dokument wurde mit Sorgfalt erstellt, dennoch können Fehler nicht ausgeschlossen werden.
  • Dieses Dokument darf ohne schriftliche Genehmigung weder ganz noch teilweise vervielfältigt, bearbeitet, kopiert oder verbreitet werden.
  • FCC-Konformitätserklärung: Das verwendete BLE-Modul entspricht den Bestimmungen von Teil 15 der FCC-Bestimmungen. FCC-ID: TFB-1002

1.3 Warnung

Warnung

Warnung Warnungserkärung
Warnung
  • Schließen Sie den PoE-Ausgang des Netzteils nicht an einen Nicht-PoE-Ethernet-Port an. Ein solcher Ethernet-Anschluss kann beschädigt oder sogar in Brand gesetzt werden. Dieses Netzteil ist für die Stromversorgung des taskit Gateways bestimmt.
  • Dies ist ein einfaches PoE-Netzteil. Es schützt keine ungeeigneten (nicht-PoE) Ethernet-Ports.
  • Das Netzteil darf nur von qualifiziertem Personal gehandhabt werden, das sich der Risiken eines unsachgemäßen Gebrauchs von elektrischen Geräten bewusst ist. Jede andere Verwendung als die oben genannte führt zum Erlöschen der Garantie. Die taskit GmbH übernimmt keine Verantwortung für Schäden, die durch unsachgemäßen Gebrauch des Netzteils entstehen.
  • Trennen Sie das Gerät vor Wartungsarbeiten von der Stromversorgung.
Kapitel 2

Konzept-Beschreibung

Die folgende Abbildung zeigt die Kommunikationsstruktur und den Aufbau der einzelnen Komponenten. Das Schaubild soll helfen, der folgenden Konzept-Beschreibung besser folgen zu können.

System Schaubild

2.1 Beacon Line

Beacon Line ist eine BLE (Bluetooth Low Energy) Infrastruktur und basiert auf einem Gateway mit bis zu 20 Ankern, welche über ein Twisted-Pair-Kabel (Cat 5) seriell miteinander verbunden und stromversorgt werden.

2.2 Anker

Jeder Anker enthält ein Bluetooth Low Energy Modul, das für die Funkkommunikation zuständig ist. Die Firmware wurde als HCI-Controller (Host Controller Interface) implementiert und ermöglicht alle BLE Rollen (Central, Observer und Broadcaster) und Funktionalitäten.

2.3 Gateway

Das Gateway ermöglicht die Kommunikation zwischen den Ankern und den Bline-Servern über TCP/IP. Das Gateway als TCP-Server bekommt seine IP-Adresse dynamisch von einem DHCP Server und ist erreichbar über die IP-Adresse oder Hostname (BLGD-MAC). Die MAC-Adresse ist auf dem Gehäuse des Gateways abgebildet (z.B. BLGD-8C8E7601441E). Um mit dem Gateway zu kommunizieren wird ein “.local” an den Hostnamen (MAC-Adresse) gehängt, also bei diesem Beispiel: BLGD-8C8E7601441E.local

2.4 HCI

Das HCI ist eine standardisierte Bluetooth-Schnittstelle zum Senden von Befehlen, Empfangen von Ereignissen und zum Senden und Empfangen von Daten. Gemäß Bedeutung von HCI wird dieses verwendet, um die Host- und Controller-Geräte zu überbrücken. Der Nutzer hat mit dieser Ebene keinen Kontakt. Es sind nur die Beacon Line Schnittstellen zugänglich.

2.5 Bline-Server

Die Software wurde für die Linux, Windows und macOS entwickelt. Der Bline-Server deckt auf einer Seite die HCI Host Role ab und auf andere Seite bietet es eine RESTful API für die Kommunikation mit den Ankern und ein TCP Port zum Folgen der Observer-Daten. Diese Dokumentation erklärt die RESTful API und Observer-Daten über TCP.

2.6 RESTful API

Representational State Transfer (REST) ist ein Paradigma für die Softwarearchitektur, die eine einheitliche Schnittstelle zwischen getrennten Komponenten in einer HTTP-fähigen Client-Server-Architektur beschreibt.

2.7 OpenAPI

Die OpenAPI Specification (vormals Swagger Specification) ist ein Standard zur Beschreibung von REST-konformen Programmierschnittstellen (API).

Unterabschnitte von Konzept-Beschreibung

2.1 Beacon Line

Beacon Line ist eine BLE (Bluetooth Low Energy) Infrastruktur und basiert auf einem Gateway mit bis zu 20 Ankern, welche über ein Twisted-Pair-Kabel (Cat 5) seriell miteinander verbunden und stromversorgt werden.

2.2 Anker

Jeder Anker enthält ein Bluetooth Low Energy Modul, das für die Funkkommunikation zuständig ist. Die Firmware wurde als HCI-Controller (Host Controller Interface) implementiert und ermöglicht alle BLE Rollen (Central, Observer und Broadcaster) und Funktionalitäten.

2.3 Gateway

Das Gateway ermöglicht die Kommunikation zwischen den Ankern und den Bline-Servern über TCP/IP. Das Gateway als TCP-Server bekommt seine IP-Adresse dynamisch von einem DHCP Server und ist erreichbar über die IP-Adresse oder Hostname (BLGD-MAC). Die MAC-Adresse ist auf dem Gehäuse des Gateways abgebildet (z.B. BLGD-8C8E7601441E). Um mit dem Gateway zu kommunizieren wird ein “.local” an den Hostnamen (MAC-Adresse) gehängt, also bei diesem Beispiel:

BLGD-8C8E7601441E.local

2.4 HCI

Das HCI ist eine standardisierte Bluetooth-Schnittstelle zum Senden von Befehlen, Empfangen von Ereignissen und zum Senden und Empfangen von Daten. Gemäß Bedeutung von HCI wird dieses verwendet, um die Host- und Controller-Geräte zu überbrücken.

Der Nutzer hat mit dieser Ebene keinen Kontakt. Es sind nur die Beacon Line Schnittstellen zugänglich.

2.5 Bline-Server

Die Software wurde für die Linux, Windows und macOS entwickelt. Der Bline-Server deckt auf einer Seite die HCI Host Role ab und auf andere Seite bietet es eine RESTful API für die Kommunikation mit den Ankern und ein TCP Port zum Folgen der Observer-Daten.

Diese Dokumentation erklärt die RESTful API und Observer-Daten über TCP.

2.6 RESTful API

Representational State Transfer (REST) ist ein Paradigma für die Softwarearchitektur, die eine einheitliche Schnittstelle zwischen getrennten Komponenten in einer HTTP-fähigen Client-Server-Architektur beschreibt.

2.7 OpenAPI

Die OpenAPI Specification (vormals Swagger Specification) ist ein Standard zur Beschreibung von REST-konformen Programmierschnittstellen (API).

Kapitel 3

Getting Started

Die folgenden Komponenten sind zum Starten erforderlich: Beacon Line Starterkit

  1. Ein Beacon Line Starterkit.
  2. Die Bline-Server Software.
  3. Die Bline-Log Software.
3.1 Beacon Line Starterkit

Die Einfachheit des Netzwerkkonzepts der Beacon Line macht es Ihnen leicht, große drahtlose BLE-Ideen mit einem hohen Maß an technischer Flexibilität und modularer Erweiterung zu realisieren. Im Lieferumfang enthalten: 1x Ethernet Gateway 9x Anker 3x Bluetooth Low Energy Beacon 1x POE (Power over Ethernet Netzteil) 10x Cat5-Kabel (5 Meter Länge) Wir verbinden die Anker mit dem Gateway. Das Gateway wird mit dem POE Port vom POE Netzteil verbunden. Den LAN Port verbinden wir mit unserem Switch (bis 1000 MBit/s).

3.2 Bline-Server Software

Die Bline-Server Software kann unter Linux, Windows und macOS gestartet werden. Der Bline-Server kann mit mehreren Beacon Line Gateways beziehungsweise Ankern eine Verbindung aufbauen. Das lässt sich in der Bline-Server.yaml Datei einstellen. Ein Beispiel (Bline-Server.yaml): Download: Bline-Server.yaml server: jwt: false # JSON Web Token basepath: /bline/v1 # HTTP Prefix www: vue/dist httpport: 8080 # Port Nummer für RESTful API scanport: 4000 # Scan TCP Port Nummer errorport: 4001 # Error Port Nummer grpcport: 50051 # gRPC Port Nummer verbose: false # Verbose Flag monitor: true # Monitor Flag monitorinterval: 30 # Monitoring Interval in Sekunden lines: line1: # Name des Gateways anchors: 1 # Anzahl der Anker verbunden mit dem Gateway desciption: blgd-8c8e76011316 # Die Beschreibung der Line url: blgd-8c8e76011316:3001 # Die IP-Adresse oder Hostname vom Gateway enabled: true # Enabled Flag scan: true # Scan Flag broadcast: false # Broadcast Flag line2: anchors: 3 desciption: blgd-8c8e76010477 url: blgd-8c8e76010477:3001 enabled: true scan: true broadcast: true Wir starten die Bline-Server:

3.3 Bline-Log Software

Die Bline-Log Software kann unter Linux, Windows und macOS gestartet werden. Der Bline-Log kann die Scan-Daten vom Bline-Server loggen. Ein Beispiel (Bline-Log.yaml): Download: Bline-Log.yaml cfgpath: . datapath: . logpath: log scanport: 4000 errorport: 3001 verbose: false Unter Windows starten wir in der Eingabeaufforderung mit folgendem Befehl: C:\beacon_line_2023\Bline-Log.221211\windows>Bline-Log.exe Log wird gestartet: datapath: . logpath: log ScanLog ([::1]:3936) connected to tcp://localhost:4000 Die Observerdaten werden in csv-Dateien umgeleitet Nähere Erklärung zu den Observer-Daten finden Sie in Kapitel 5.

Unterabschnitte von Getting Started

3.1 Beacon Line Starterkit

Die Einfachheit des Netzwerkkonzepts der Beacon Line macht es Ihnen leicht, große drahtlose BLE-Ideen mit einem hohen Maß an technischer Flexibilität und modularer Erweiterung zu realisieren.

Im Lieferumfang enthalten:

  1. 1x Ethernet Gateway
  2. 9x Anker
  3. 3x Bluetooth Low Energy Beacon
  4. 1x POE (Power over Ethernet Netzteil)
  5. 10x Cat5-Kabel (5 Meter Länge) Beacon Line Starterkit

Wir verbinden die Anker mit dem Gateway. Das Gateway wird mit dem POE Port vom POE Netzteil verbunden. Den LAN Port verbinden wir mit unserem Switch (bis 1000 MBit/s).

Das Gateway bekommt seine IP-Adresse dynamisch vom DHCP Server und ist erreichbar über die IP-Adresse oder Hostname (BLGD-MAC). Die MAC-Adresse ist auf dem Gehäuse des Gateways abgebildet (z.B. BLGD-8C8E7601441E). Um mit dem Gateway zu kommunizieren wird ein “.local” an den Hostnamen (MAC-Adresse) gehängt, also bei diesem Beispiel:

BLGD-8C8E7601441E.local

3.2 Bline-Server Software

Die Bline-Server Software kann unter Linux, Windows und macOS gestartet werden.

Der Bline-Server kann mit mehreren Beacon Line Gateways beziehungsweise Ankern eine Verbindung aufbauen. Das lässt sich in der Bline-Server.yaml Datei einstellen.

Bline-Server im Explorer

Ein Beispiel (Bline-Server.yaml):

Download: Bline-Server.yaml

server:
    jwt: false                              # JSON Web Token
    basepath: /bline/v1                     # HTTP Prefix
    www: vue/dist
    httpport: 8080                          # Port Nummer für RESTful API
    scanport: 4000                          # Scan TCP Port Nummer
    errorport: 4001                         # Error Port Nummer
    grpcport: 50051                         # gRPC Port Nummer
    verbose: false                          # Verbose Flag
    monitor: true                           # Monitor Flag
    monitorinterval: 30                     # Monitoring Interval in Sekunden
lines:
    line1:                                  # Name des Gateways
        anchors: 1                          # Anzahl der Anker verbunden mit dem Gateway
        desciption: blgd-8c8e76011316       # Die Beschreibung der Line
        url: blgd-8c8e76011316:3001         # Die IP-Adresse oder Hostname vom Gateway
        enabled: true                       # Enabled Flag
        scan: true                          # Scan Flag
        broadcast: false                    # Broadcast Flag
    line2:
        anchors: 3
        desciption: blgd-8c8e76010477
        url: blgd-8c8e76010477:3001
        enabled: true
        scan: true
        broadcast: true

Wir starten die Bline-Server:

Unter Windows starten wir in der Eingabeaufforderung mit folgendem Befehl:

C:\beacon_line_2023\Bline-Server.230210\windows>Bline-Server.exe

Dann wird der Bline-Server gestartet und initialisiert die Beacon Line:

#./Bline-Server
Bline-Server, V1.0 (24.09.2023), (C) taskit GmbH, 2023

Scan server listen to port 4000
Error server listen to port 4001

Web-Hosting: vue/dist
API Basepath: /bline/v1
⇨ http server started on [::]:8080

Connect Lines
    line1      with 1 anchors   Port: 48236 <-> blgd-8c8e76011316
    line2      with 3 anchors   Port: 48237 <-> blgd-8c8e76010477
Initialise Lines
    Waiting for Anchors
    Initialising Complete
Statup Lines     1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20
    line1       S-
    line2       SB  SB  SB

3.3 Bline-Log Software

Die Bline-Log Software kann unter Linux, Windows und macOS gestartet werden.

Der Bline-Log kann die Scan-Daten vom Bline-Server loggen.

Bline-Log im Explorer

Ein Beispiel (Bline-Log.yaml):

Download: Bline-Log.yaml

cfgpath: .
datapath: .
logpath: log
scanport: 4000
errorport: 3001
verbose: false

Unter Windows starten wir in der Eingabeaufforderung mit folgendem Befehl:

C:\beacon_line_2023\Bline-Log.221211\windows>Bline-Log.exe

Log wird gestartet:

datapath: .
logpath: log
ScanLog ([::1]:3936) connected to tcp://localhost:4000

Die Observerdaten werden in csv-Dateien umgeleitet

Bline-Log im Explorer

Nähere Erklärung zu den Observer-Daten finden Sie in Kapitel 5.

Kapitel 4

Beacon Line RESTful API

Die Bline-Server RESTful API wird mit OpenAPI beschrieben (Version: 1.0.230924). Es bietet bei der Entwicklung und fortlaufenden Pflege eine Möglichkeit, über die API deren Implementation für Dokumentation und Tests in Einklang zu halten.

4.1.1 lines

Beacon Line Lines-Einstellungen.

4.1.2 line/{Name}

Key-Value Beispiele

4.2.1 anchors

Key-Value Beispiele

4.2.2 anchor/{AnchorID}

Key-Value Beispiele

4.2.3 anchor/{AnchorID}/broadcast?on={false/true}

Key-Value Beispiele

4.2.3 anchor/{AnchorID}/scan?on={false/true}

Key-Value Beispiele

4.2.4 anchor/{AnchorID}/connect/{MAC}

Key-Value Beispiele

4.2.5 anchor/{AnchorID}/disconnect/{MAC}

Key-Value Beispiele

4.2.6 anchor/{AnchorID}/handle/{MAC}/{Handle}

Die Struktur der Generic Attribute Profile (GATT) Tabelle eines BLE Peripheral Gerät herauszufinden (Discovery) ist ein energieintensiver Prozess...

4.3.1 nodes

Beacon Line Nodes Einstellungen.

4.3.2 node/{MAC}

Key-Value Beispiele

Unterabschnitte von Beacon Line RESTful API

4.1.1 lines

Beacon Line Lines Einstellungen.

key value
URL /{PREFIX}/lines
Method GET
Description Returns all Beacon Lines
Parameters N/A
Response JSON

Example:

#curl -X GET localhost:8080/bline/v1/lines
[
    {
        "anchors":1,
        "broadcast":false,
        "description":"",
        "enabled":true,
        "name":"line1",
        "scan":true,
        "url":"blgd-8c8e76011316:3001"
    },
    {
        "anchors":3,
        "broadcast":true,
        "description":"",
        "enabled":true,
        "name":"line2",
        "scan":true,
        "url":"blgd-8c8e76010477:3001"
    }
]

4.1.2 line/{Name}

key value
URL /{PREFIX}/line/{Name}
Method GET
Description Returns a Beacon Line by Name Parameters Name of Beacon Line [STRING]
Response JSON

Beispiel:

#curl -X GET localhost:8080/bline/v1/line/line1
{
    "anchors":1,
    "broadcast":false,
    "description":"",
    "enabled":true,
    "name":"line1",
    "scan":true,
    "url":"blgd-8c8e76011316:3001"
}
key value
URL /{PREFIX}/line/{Name}
Method PUT
Description Writes a Beacon Line by Name Parameters Name of Beacon Line [STRING]
Response JSON

Beispiel:

#curl -X PUT localhost:8080/bline/v1/line/line3
-H 'Content-Type: application/json'
-d '{"anchors":20,"broadcast":true,"description":"","enabled":true,"name":"line3","scan":true,"url":"blgd-8c8e7601441e:3001"}'
key value
URL /{PREFIX}/line/{Name}
Method DELETE
Description Deletes a Beacon Line by Name Parameters Name of Beacon Line [STRING]
Response JSON

Beispiel:

#curl -X DELETE localhost:8080/bline/v1/line/line3

4.2.1 anchors

key value
URL /{PREFIX}/anchors
Method GET
Description Returns all Anchors of a Beacon Line
Parameters N/A
Response JSON

Beispiel:

#curl -X GET localhost:8080/bline/v1/anchors
[
  {
    "Angle":0,
    "Description":"",
    "Fixed":false,
    "Location":"",
    "Url":"",
    "mac":"",
    "name":"line1-01"
  },
  {
    "Angle":0,
    "Description":"",
    "Fixed":false,
    "Location":"",
    "Url":"",
    "mac":"",
    "name":"line2-01"
  },
  {
    "Angle":0,
    "Description":"",
    "Fixed":false,
    "Location":"",
    "Url":"",
    "mac":"",
    "name":"line2-02"
  },
  {
    "Angle":0,
    "Description":"",
    "Fixed":false,
    "Location":"",
    "Url":"",
    "mac":"",
    "name":"line2-03"
  }
]

4.2.2 anchor/{AnchorID}

key value
URL /{PREFIX}/anchor/{AnchorID}
Method GET
Description Returns the full state of a specific Anchors
Parameters N/A
Response JSON

Beispiel:

#curl localhost:8080/bline/v1/anchor/line1-01
{
  "Angle":0,
  "Description":"",
  "Fixed":false,
  "Location":"",
  "Url":"",
  "mac":"",
  "name":"line1-01"
}

4.2.3 anchor/{AnchorID}/broadcast?on={false/true}

key value
URL /{PREFIX}/anchor/{AnchorID}/broadcast?on={false/true}
Method PUT
Description Switches the scan mode on or off
Parameters N/A
Response TEXT

Beispiel:

#curl -X PUT localhost:8080/bline/v1/anchor/line1-01/broadcast?on=true
Anchor: line1-01 broadcasting is active!

4.2.3 anchor/{AnchorID}/scan?on={false/true}

key value
URL /{PREFIX}/anchor/{AnchorID}/scan?on={false/true}
Method PUT
Description Switches the scan mode on or off
Parameters N/A
Response TEXT

Beispiel:

#curl -X PUT localhost:8080/bline/v1/anchor/line1-01/scan?on=false
Anchor: line1-01 scanning is stopped!

4.2.4 anchor/{AnchorID}/connect/{MAC}

Hinweis: Um eine Verbindung zu einem Peripheriegerät herzustellen, muss das Scannen des Ankers, der die Verbindung herstellen möchte, ausgeschaltet werden.

key value
URL /{PREFIX}/anchor/{AnchorID}/connect/{MAC}
Method PUT
Description Tries to connect the specified Anchor with the specified Node
Parameters N/A
Response TEXT

Beispiel:

#curl -X PUT localhost:8080/bline/v1/anchor/line1-01/connect/F6:49:C6:33:6D:B3
Anchor: line1-01 is connected to Node: F6:49:C6:33:6D:B3!

4.2.5 anchor/{AnchorID}/disconnect/{MAC}

key value
URL /{PREFIX}/anchor/{AnchorID}/disconnect/{MAC}
Method PUT
Description Disconnects the Amchor from the Node
Parameters N/A
Response TEXT

Example:

#curl -X PUT localhost:8080/bline/v1/anchor/line1-01/disconnect/F6:49:C6:33:6D:B3
Anchor: line1-01 is disconnected from Node: F6:49:C6:33:6D:B3!

4.2.6 anchor/{AnchorID}/handle/{MAC}/{Handle}

Handle:

Die Struktur der Generic Attribute Profile (GATT) Tabelle eines BLE Peripheral Gerät herauszufinden (Discovery) ist ein energieintensiver Prozess. Um es zu verhindern, verwenden wir die Handle Nummer auf der GATT-Tabelle. In dieser Methode kann der Beacon Line Anker (Central) die Characteristics Werte lesen und schreiben. Das bedeutet, dass zum Lesen oder Schreiben von einem bestimmten Characteristic die Handle Nummer für das Frontend Programm bekannt sein muss.

key value
URL /{PREFIX}/anchor/{AnchorID}/handle/{MAC}/{Handle}
Method GET
Description Reads a BLE handle of a Node over an Anchor
Parameters N/A
Response HEX

Beispiel:

#curl localhost:8080/bline/v1/anchor/line1-01/handle/F6:49:C6:33:6D:B3/13
00
key value
URL /{PREFIX}/anchor/{AnchorID}/handle/{MAC}/{Handle}
Method PUT
Description Writes a BLE handle of a Node over an Anchor
Parameters JSON
Response TEXT

Beispiel:

#curl -X PUT localhost:8080/bline/v1/anchor/line1-01/handle/F6:49:C6:33:6D:B3/13 -H 'Content-Type: application/json' -d '{"data":"0x01"}'
Anchor: line1-01 has written handle 13 on Node: F6:49:C6:33:6D:B3 with 01!

4.3.1 nodes

Beacon Line Nodes Einstellungen.

key value
URL /{PREFIX}/nodes
Method GET
Description Reads all BLE-Nodes
Parameters N/A
Response JSON

Beispiel:

#curl localhost:8080/bline/v1/nodes
[{
	"AnchorList": [{
		"AnchorID": "line1-01",
		"RSSI": -21,
		"Timestamp": 1695799643418
	}, {
		"AnchorID": "line1-01",
		"RSSI": -24,
		"Timestamp": 1695799644268
	}, {
		"AnchorID": "line1-01",
		"RSSI": -24,
		"Timestamp": 1695799644477
	}, {
		"AnchorID": "line1-01",
		"RSSI": -24,
		"Timestamp": 1695799644477
	}, {
		"AnchorID": "line1-01",
		"RSSI": -24,
		"Timestamp": 1695799645318
	}],
	"Connectable": true,
	"Data": "0201060dff7b0140000000b36d33c649f6",
	"LastAnchor": "line1-01",
	"LastTime": 1695799645318,
	"mac": "f6:49:c6:33:6d:b3",
	"name": ""
}]

4.3.2 node/{MAC}

key value
URL /{PREFIX}/node/{MAC}
Method GET
Description Reads all BLE-Nodes
Parameters MAC of Beacon, STRING
Response JSON

Beispiel:

#curl localhost:8080/bline/v1/node/F6:49:C6:33:6D:B3
{
	"AnchorList": [{
		"AnchorID": "line1-01",
		"RSSI": -47,
		"Timestamp": 1695801593893
	}, {
		"AnchorID": "line1-01",
		"RSSI": -44,
		"Timestamp": 1695801593518
	}, {
		"AnchorID": "line1-01",
		"RSSI": -41,
		"Timestamp": 1695801594169
	}, {
		"AnchorID": "line2-01",
		"RSSI": -20,
		"Timestamp": 1695801593518
	}, {
		"AnchorID": "line2-02",
		"RSSI": -47,
		"Timestamp": 1695801594328
	}],
	"Connectable": true,
	"Data": "0201060dff7b0140000000b36d33c649f6",
	"LastAnchor": "line1-01",
	"LastTime": 1695801594328,
	"mac": "f6:49:c6:33:6d:b3",
	"name": ""
}
Kapitel 5

Observer-Daten

Die Observer-Daten können über den TCP-Port (“scanport: 4000” in Bline-Server.yaml), welcher das Programm Bline-Server zur Verfügung stellt, erhalten werden. Datenformat:

CSV (Comma-separated values)

Beispiel:

beispieldaten.csv

Erklärung

key value Type
Time Timestamp in milliseconds Integer
Anchor Beacon Line Anchor Name String
MAC MAC adresse vom BLE Gerät HEX
RSSI RSSI Level vom BLE Gerät INT8
Connectable C: Connectable, N: Non-connectable
Advertising payload HEX
Name Name des BLE Gerät, wenn es existiert String

Beispiel:

Time Anchor MAC RSSI Connectable Advertising payload Name
1682327807376 line1-01 ed:96:ca:78:2c:f5 -81 C 0201061aff4c000215e2c56db5dffb48d2b060d0f5a71096e000000000c5 blinky
Kapitel 6

Konfiguration

Hardware Konfiguration

Konfiguration


Software Konfiguration

Der Bline-Server kann mit mehreren Beacon Line Gateways beziehungsweise Ankern eine Verbindung aufbauen. Das lässt sich in der Bline-Server.yaml Datei einstellen…

Unterabschnitte von Konfiguration

6.1 Hardware Konfiguration


Voraussetungen
Betriebssystem Windows 7 oder höher
Kommunikation Bluetooth Low Energy (BLE) (Line-to-Beacon)
Kommunikation Seriell (Leitung zu Leitung)
Unterstützte Geräte Beacon Line WiFi (Gateway), Beacon Line Node (Beobachter)

Installation der Hardware

Schließen Sie alle Teile sorgfältig an.

Der Beacon Line Node (Beobachter) ist auf der Oberseite schwarz und die Unterseite orange. Die Beacon Line Wifi (Gateway) ist oben schwarz und die Unterseite ist ebenfalls schwarz. Die Stromversorgung ist eine passive PoE-Verbindung (wie Ubiquiti).

  1. Verbinden Sie die Beacon Line Nodes, Stecker “A” geht in den Stecker “B”.
  2. Beacon Line WiFi muss mit dem mitgelieferten Netzstecker versorgt werden.

Konfiguration

Hinweis: Bitte schließen Sie den letzten Node nicht an einen PC oder eine andere Hardware an. (Sehen Sie sich die Warnungen im Kapitel 1.3. “Warnung” an.)

6.2 Software Konfiguration

Der Bline-Server kann mit mehreren Beacon Line Gateways beziehungsweise Ankern eine Verbindung aufbauen. Das lässt sich in der Bline-Server.yaml Datei einstellen.

Ein Beispiel (Bline-Server.yaml):

server:
    jwt: false                              # JSON Web Token
    basepath: /bline/v1                     # HTTP Prefix
    www: vue/dist
    httpport: 8080                          # Port Nummer für RESTful API
    scanport: 4000                          # Scan TCP Port Nummer
    errorport: 4001                         # Error Port Nummer
    grpcport: 50051                         # gRPC Port Nummer
    verbose: false                          # Verbose Flag
    monitor: true                           # Monitor Flag
    monitorinterval: 30                     # Monitoring Interval in Sekunden
lines:
    line1:                                  # Name des Gateways
        anchors: 1                          # Anzahl der Anker verbunden mit dem Gateway
        desciption: blgd-8c8e76011316       # Die Beschreibung der Line
        url: blgd-8c8e76011316:3001         # Die IP-Adresse oder Hostname vom Gateway
        enabled: true                       # Enabled Flag
        scan: true                          # Scan Flag
        broadcast: false                    # Broadcast Flag
    line2:
        anchors: 3
        desciption: blgd-8c8e76010477
        url: blgd-8c8e76010477:3001
        enabled: true
        scan: true
        broadcast: true
Kapitel 7

Technische Referenz

Technische Daten zur Beacon Line

Beacon Line Ether Gateway

7.1 Überblick

Technische Daten des Gateways - Überblick Bemerkung Werte Gehäuse 91 x 41 x 26 (max.) mm, PC-Macrolon (UL-94-V2), black Gewicht 58 g Arbeitstemperatur -25 to 85 °C Lagertemperatur -40 to 85°C Sicherheitsklasse IP40 Verbindungskabel RJ45 Stromzufuhr Passive PoE1 (12-24 V) Stromverbrauch 0.8 W Maximale Anzahl von Ankern in einer Beacon Line 20 Schnittstellen Schnittstellen Werte LAN Ethernet 100Base-T, TCP/IP Protokoll, RJ45-Connector, includes 24 V Power Supply Lines for passive PoE (Power over Ethernet) Serial RS422 via RJ45-Connector Technische Daten des Ankers - Überblick

7.2 Bestimmungen

CE-Zertifizierung Bemerkung Wert CE Compliant to standards IEC 61000-1-2:2016 Funk-Zertifizierungen Bemerkung Werte USA FCC ID: TFB-1002, 15.247 Canada IC ID: 5969A-1002, RSS 210 Europe CE Compliant to standards EN 62368-1, EN 300 328 and EN 301 489 Japan Giteki: 209-J00169 Australia / New Zealand RCM Erläuterungen Passive PoETM (Power over Ethernet) ist eine einfache Möglichkeit, die Beacon Line über ein Ethernet Kabel mit Strom zu versorgen. Passives PoETM verwendet freie Adern im Ethernet-Kabel (Plus 4;5 / GND 7;8), um die Stromversorgung des Geräts von einem Ende zum anderen zu übertragen.

7.3 Merkmale

Maximaler Abstand zwischen den Knotenpunkten: 30m Mindestabstand zwischen den Knoten: 13cm Die Datenübertragungsleitungen (Ethernet / RS232 / RS422) liegen auf Pin 1, 2, 3 und 6. Die Spannungsversorgung ist positiv an Pin 4 und 5 und mit dem negativen Potential (normalerweise GND) an Pin 7 und 8. Es ist nicht relevant, an welchem Ende Sie eine Beacon Line mit Strom versorgen (Gateway oder letzter Node). Die Richtung ist neutral.

Unterabschnitte von Technische Referenz

7.1 Überblick

Technische Daten des Gateways - Überblick

Bemerkung Werte
Gehäuse 91 x 41 x 26 (max.) mm, PC-Macrolon (UL-94-V2), black
Gewicht 58 g
Arbeitstemperatur -25 to 85 °C
Lagertemperatur -40 to 85°C
Sicherheitsklasse IP40
Verbindungskabel RJ45
Stromzufuhr Passive PoE1 (12-24 V)
Stromverbrauch 0.8 W
Maximale Anzahl von Ankern in einer Beacon Line 20

Schnittstellen

Schnittstellen Werte 
LAN Ethernet 100Base-T, TCP/IP Protokoll, RJ45-Connector, includes 24 V Power Supply Lines for passive PoE (Power over Ethernet)
Serial RS422 via RJ45-Connector

Technische Daten des Ankers - Überblick

Bemerkung Werte
Größe (PCB inkl. Anschlüsse) 90 x 33.4 x 16 mm
Gehäuse 91 x 41 x 26 (max.) mm, PC-Macrolon (UL-94-V2)
Gewicht (incl. Anschlüsse) 55 g (inkl. Gehäuse)
Arbeitstemeperatur -40 to 85 °C
Sicherheitsklasse IP40
Verbindungskabel RJ45
Stromzufuhr Passive PoE1 (12-24 V)
Bluetooth class Bluetooth LE 4.1 (Bluetooth Smart)
Maximale Anzahl von Ankern in einer Beacon Line 20
BLE Role alle
BLE Filterung einstellbar
BLE Antenne Interne PCB-Antenne (2.4 GHz ~ 2.48 GHz)

Verbrauch der Haupt-CPU und Line-Kommunikation

Bemerkung Werte
CPU Cortex M0, 32 MHz
Line Kommunikation (Anker zu Anker, Anker zu Gateway) RS422 via RJ45
Host-Modul Verbrauch (Durchschnitt) 110 mW pro Anker
Komplettes Beacon Line System (1 Gateway Ether, 2 Anker) 1.1 W @ 24 VDC
Komplettes Beacon Line System (1 Gateway Wifi, 2 Nodes) 1.3 W @ 24 VDC

Technische Daten des BLE Modul

Bemerkung Werte
CPU(s) Cortex M0 incl. BLE-stack, Cortex M3, 24 MHz incl. RTOS
Speicher 128 kB Flash, 20 kB SRAM
Aktiver Strom 61 uA/MHz
Standby Strom 1 uA
Shutdown Strom 200 nA
BLE-stack Bluetooth LE 4.1 (Bluetooth Smart)
TX-Power Programmierbar +5dBm to 0dBm (1dBm steps), 0dBm to -21dBm (3dBm steps)
Unerwünschte Emission -43 dBm @ f < 1 GHz, -46dBM @ f > 1GHz
RF Frequenz Spanne 2402 MHz to 2480 MHz, einstellbar in 1-MHz Schritten
RF Sensitivität -95 dBm
Sättigung +4 dBm
Frequenz Fehler Tolleranz +/- 250 kHz
Intermodulation -36 dBm
Antenne internal PCB antenna
Arbeitstemperatur -40 to +85 °C

Technische Daten - CPU-Modul im Gateway

Bemerkung Werte
Prozessor Atmel SAMA5D22, mit ARM Cortex-A5 Core, 500 MHz
RAM 256 MB LPDDR1, 128 kB SRAM
Flash 1 MB Serial NOR-Flash
Memory Card MicroSD-Card 8 GB, Industrietauglich (-25..+85 °C Arbeitstemperatur)
Sensors Überhitzungs-Sensor
Watchdog Hardware Watchdog, um das System im Fehlerfall neu zu starten
Operating System Linux 4.7, bootet von MicroSD-Card

7.2 Bestimmungen

  CE-Zertifizierung

Bemerkung Wert
CE Compliant to standards IEC 61000-1-2:2016

Funk-Zertifizierungen

Bemerkung Werte
USA FCC ID: TFB-1002, 15.247
Canada IC ID: 5969A-1002, RSS 210
Europe CE Compliant to standards EN 62368-1, EN 300 328 and EN 301 489
Japan Giteki: 209-J00169
Australia / New Zealand RCM

Erläuterungen

Passive PoETM (Power over Ethernet) ist eine einfache Möglichkeit, die Beacon Line über ein Ethernet Kabel mit Strom zu versorgen. Passives PoETM verwendet freie Adern im Ethernet-Kabel (Plus 4;5 / GND 7;8), um die Stromversorgung des Geräts von einem Ende zum anderen zu übertragen.

BEACON LINE

Web: www.beacon-line.com

Tel: +49(0)30 / 611295-46

Fax: +49(0)30 / 611295-10

Beacon Line, a brand of taskit GmbH

Groß-Berliner Damm 37, 12487 Berlin, Deutschland

Amtsgericht Berlin-Charlottenburg HRB 39014

Geschäftsführer Dipl.-Ing. (FH) Thorsten Raulfs

7.3 Merkmale

  • Maximaler Abstand zwischen den Knotenpunkten: 30m
  • Mindestabstand zwischen den Knoten: 13cm

Technical_Reference


Die Datenübertragungsleitungen (Ethernet / RS232 / RS422) liegen auf Pin 1, 2, 3 und 6. Die Spannungsversorgung ist positiv an Pin 4 und 5 und mit dem negativen Potential (normalerweise GND) an Pin 7 und 8.

Es ist nicht relevant, an welchem Ende Sie eine Beacon Line mit Strom versorgen (Gateway oder letzter Node). Die Richtung ist neutral.

Der Nennspannungsbereich reicht von 12VDC…bis….24VDC. Die maximale Spannung beträgt 28 Volt. Die Mindestspannung ist abhängig von Ihrem Layout (Anzahl der Nodes und Länge der Kabel), aber bitte geben Sie niemals weniger als 6VDC an eine Beacon Line.

Ein Beispiel: Ein Gateway mit zwei Nodes und 10 Meter Kabel mit je 12VDC ist ausreichend.

Der Strom beträgt nicht mehr als 400mA und liegt normalerweise im Bereich von 200mA.

Geringe Überspannungen werden durch den internen Netzstromkreis abgefangen. Hohe elektrische Spannung wie man sie manchmal in einem Fahrzeug hat, sollte vorher abgefangen werden, da sie sonst zu Schäden an Hardware, Menschen und Umwelt führen kann.

Kapitel 8

Support

Unser Kundenservice für Ihre Fragen zur Beacon Line

Telefonische Unterstützung und Beratung unter:

+49 30 611 295 - 0

Mo-Do: 09:00 - 16:00 Uhr, Fr: 09:00 - 13:00 Uhr

Schriftliche Beratung via E-Mail unter:

info@taskit.de

Download des Software Pakets:

Software Paket

Oder nutzen Sie unser Kontaktformular:

Kontaktformular

Beacon Line im Webshop:

Beacon Line Shop

Beacon Line Informationen auf der Website:

Beacon Line Website

Beacon Line Informationen im Forum:

Beacon Line Forum