background image

BVS ID-M1280xF1-xx-xxx

82

  deutsch

Benutzer anmelden

Resource: 

users/login

URL: 

http://HOSTNAME/api/balluff/v1/vision/users/login

Der "

expert

" - Benutzer ist der einzige gültige REST-Benutzer mit dem in der SensorApp vergebenen Passwort.

Anfrage:

Objekt

Inhalt

username

UTF-8-kodierter Benutzername

password

UTF-8-kodiertes Passwort

Beispiel:

{
    "username":"expert",
    "password":"0123456789012"
}

Antwort:

Objekt

Inhalt

Bearer

String mit dem Session-Token 

roles

Array von Strings mit den Benutzerrollen.

Beispiel:

{
 "Bearer": "fad5fdab-61fc-4a7e-a28a-a802d4f1bedd",
 "roles" : [
           "expert"
           ]
}

Der Session-Token (Bearer) muss bei aktivierter Benutzerverwaltung für die POST-Befehle zur Authentifizierung 
benutzt werden.

Summary of Contents for BVS ID-M1280 F1 Series

Page 1: ...deutsch Konfigurationsanleitung english Configuration Guide BVS ID M1280xF1 xx xxx...

Page 2: ...www balluff com...

Page 3: ...deutsch Konfigurationsanleitung BVS ID M1280xF1 xx xxx...

Page 4: ...www balluff com...

Page 5: ...rades 8 1 7 Marken 8 2 SensorApp Webinterface 9 2 1 Einleitung 9 2 1 1 Die SensorApp Oberfl che 10 2 2 Systemmen 10 2 2 1 Hilfesystem 10 2 2 2 Systemeinstellungen 11 2 2 3 Benutzerinformationen und Sp...

Page 6: ...O Link Feldbus Prozessdatenprotokoll 84 4 3 1 Einleitung 84 4 3 2 Funktionsbausteine 85 4 3 3 Prozessdaten 86 4 3 4 Protokollablauf 91 4 3 5 Befehle 95 4 4 bersicht IO Link Daten und Funktionen 102 4...

Page 7: ...rheberrechtlich gesch tzt Alle Rechte einschlie lich der Vervielf ltigung Ver ffentlichung 1 2 Verwendete Symbole und Konventionen In diesem Handbuch werden folgende Darstellungsmittel verwendet 1 2 1...

Page 8: ...on von UTF 8 kodierten Zeichenketten Im UTF 8 Code zu bertragenden Zeichen sind in Hochkomma gesetzt z B L 1 3 Bedeutung der Warnhinweise Beachten Sie unbedingt die Warnhinweise in dieser Anleitung un...

Page 9: ...ei IO Link Kommunikationssystem zur Anbindung intelligenter Sensoren und Aktoren IP Internet Protocol ISDU Indexed Service Data Unit LAN Local Area Network LPS Limited Power Source MAC Media Access Co...

Page 10: ...ge Lizenzen erfordern es dass der Quellcode sowie die Modifikationen ver ffentlicht werden m ssen Diese Quellen sind auf der Produkthomepage ver ffentlicht Die Lizenztexte aller verwendeter Softwarepr...

Page 11: ...68 10 2 Best tigen Sie die Eingabe Abh ngig von der Netzwerktopologie sind unterschiedliche Netzwerkeinstellungen notwendig blicherweise sind in einem Firmennetz bzw in einer Produktionsst tte die IP...

Page 12: ...Anzeige des Live Bildes 5 Ger te Info F r die Anzeige von Ger te Infos Status und Fehlern 2 2 Systemmen Das Systemmen befindet sich im oberen rechten Teil der Bedienoberfl che Es besteht aus folgende...

Page 13: ...eriennummer Die Seriennummer des BVS ID Log Dateien erlauben es nderungen und Fehler im System nachzuvollziehen Die Dateien k nnen ber den Link Download log files erreicht werden Es existieren drei Ar...

Page 14: ...one in welcher sich der BVS ID befindet PC Zeit synchronisieren bernimmt die PC Browser Zeit und Datum im Sensor Diese Funktion ist nur verf gbar wenn NTP Server verwenden abgeschaltet ist HINWEIS F r...

Page 15: ...erden HINWEIS Beim automatischen Bezug einer IP Adresse kann es manchmal eine Weile dauern bis eine Verbindung zum BVS ID anhand des Hostnamens hergestellt werden kann bis der DNS Server den Hostname...

Page 16: ...Gateway eingetragen werden HINWEIS Um nderungen an den Netzwerkeinstellungen zu bernehmen muss der BVS ID neu gestartet werden HINWEIS Die oben genannten Parameter IP Adresse automatisch beziehen Sta...

Page 17: ...n Das h chstwertigste Byte wird zuerst gesendet Port UDP TCP Port ber welchen die UDP TCP Kommunikation stattfindet Statusinformationen senden UDP TCP Aktiviert das automatische Senden von Statusnachr...

Page 18: ...cate Authority File M glichkeit das CA Zertifikat des Brokers f r den Modus MQTT verschl sselt mit CA Datei hochzuladen Verbindungsstatus Zeigt an ob eine aktive Verbindung zum MQTT Broker vorhanden i...

Page 19: ...t connection settings Einstellung Beschreibung Protokoll Das Protokoll das zur bermittlung der Berichte verwendet wird Unterst tzt werden FTP FTPS und SMB Server Die IP Adresse oder die URL beginnend...

Page 20: ...gt fest ob Bilder im Erfolgsfall als BMP Dateien abgelegt werden sollen NOK Inspektionsergebnisse Legt fest ob Pr fergebnisse im Fehlerfall als XML Bericht abgelegt werden sollen NOK Bilder JPG Legt f...

Page 21: ...t nur nach einem Restart des BVS ID in Kraft Einrichten der Zugriffskontrolle Initial sind die Passw rter aller Benutzer admin expert and user leer d h diese m ssen im folgenden Dialog gesetzt werden...

Page 22: ...h rigen Berechtigungen f r die GUI an Deaktiviert Aktiviert Funktion Nicht eingeloggt user expert admin Wechsel Import und Export von Inspektionsprogrammen Bilder speichern Monitor Ansicht ndern des I...

Page 23: ...x deutsch 21 2 2 3 Benutzerinformationen und Spracheinstellungen In diesem Bereich wird angezeigt welcher Benutzer angemeldet ist Hier kann der Benutzer auch abgemeldet werden Des Weiteren wird die Sy...

Page 24: ...m Start das zuletzt ge ffnete Inspektionsprogramm im Monitor Modus 2 3 1 Monitor ber Monitor werden die aktuellen Ergebnisse der laufenden Pr fung dargestellt Die Men punkte haben folgende Funktionali...

Page 25: ...Analyse kann der LIVE Modus jederzeit wieder eingeschaltet werden Im ausgeschalteten LIVE Modus wenn im Hintergrund weiter getriggert wird wird die Statistik automatisch aktualisiert Hier kann es pass...

Page 26: ...t aktiviert ist kann hiermit ein Einzellauf ausgel st werden Dieser f hrt ebenfalls zu einer Bildaufnahme Auto Setup ber diesen Button kann der Auto Setup Prozess gestartet werden Tools Eine Inspektio...

Page 27: ...ogrammverwaltungsdialog ge ffnet mit dem man die Liste von importierten Programmen verwaltet Das aktuell ge ffnete Programm ist blau hinterlegt Ein Programm kann lokal ber exportiert werden Ein andere...

Page 28: ...ndet werden eine Mischung von Datenpaketen per UDP TCP mit einem Trigger per digitalem Eingang wird daher nicht empfohlen HINWEIS Sind Unicode Zeichen im Referenzwert enthalten ist zu beachten dass be...

Page 29: ...rt kann damit im folgenden Inspektionsprogrammdurchlauf nicht mehr verwendet werden Ist Neue Referenz pro Testzyklus deaktiviert wird ein einmal eingelesener Referenzwert so lange verwendet bis er dur...

Page 30: ...d LEDs je nach Modell Roten infraroten internen LEDs werden zum Blitzen verwendet External lightning Externe Beleuchtung wird verwendet External lightning with boost Externe Beleuchtung wird verwendet...

Page 31: ...che nach dem zu lesenden Code standardm ig das volle Bildfeld Um den Lesevorgang zu beschleunigen oder robuster zu machen kann das Suchfeld mithilfe eines Bildausschnitts verkleinert werden HINWEIS Di...

Page 32: ...Barcodes 2D Barcodes General settings 2 4 2 1 1D Barcodes 2D Barcodes Aufgabe Hier werden die Codes bestimmt nach welchem das Tool suchen soll Codes werden dabei innerhalb des Auswertebereichs gesucht...

Page 33: ...en Schnell Bietet eine gute Lesegeschwindigkeit Allerdings k nnen damit Codes deren Parameter f r H he Breite Modulgr e Verzerrung usw von den blichen Werten abweichen eventuell nicht gefunden werden...

Page 34: ...R Code PDF417 QR Code Referenzlage HINWEIS Zur stabilen Dekodierung von 2D Codes muss die Aufl sung mindestens 4 Pixel pro Modul sein f r den Code Typ PDF417 gen gen 3 Pixel pro Modul F r den kleinste...

Page 35: ...t Der initiale Wert akzeptiert beliebige Codes String Erwartete Anzahl Codes Die maximale Anzahl an Codes die bei der Bildanalyse gesucht werden soll Sobald die Bildanalyse diese Anzahl erreicht wird...

Page 36: ...lten Timeout beendet wird Int HINWEIS Die Sortierung findet nach der Codesuche statt Das bedeutet dass die gefundenen Codes nicht von der Sortierung abh ngen Lediglich die Reihenfolge der Ergebnisse i...

Page 37: ...kation lesbar ist oder nicht kann daher nur die Werte A nach Spezifikation lesbar oder F nicht nach Spezifikation lesbar einnehmen Der Code kann trotz Bewertung F f r das System lesbar sein c Symbolko...

Page 38: ...ohl Kameraverkippung wie auch Druckqualit t verantwortlich sein kann g Allgemeine Verzerrung Grid nonuniformity Kommt zus tzlich zur affinen Verzerrung eine perspektivische Deformation hinzu wird dies...

Page 39: ...er Implementation immer A f Axiale Verzerrung Axial nonuniformity Verh ltnis der Breite und H he der einzelnen Module und gibt damit eine Aussage zur affinen Verzerrung des Codes wobei daf r sowohl Ka...

Page 40: ...String L nge festgelegt werden sofern die zu versendende Information nicht eine konstante L nge hat 2 4 3 2 Einstellen der Parameter Mit einem neuen Inspektionsprogramm sind standardm ig alle relevan...

Page 41: ...BVS ID M1280xF1 xx xxx deutsch 39...

Page 42: ...nkts des gefundenen Codes UINT16 4 Rotation 1 n Drehung des gefundenen Codes UINT16 2 Interpretation der gesendeten Daten Das Tool schickt die Daten ber den in den Systemeinstellungen definierten Komm...

Page 43: ...lone Betrieb ohne Bedienoberfl che betreiben Falls der BVS ID mit ge ffneter SensorApp Oberfl che betrieben wird die Livebildanzeige der SensorApp Oberfl che deaktivieren Durch geeignete Wahl des Para...

Page 44: ...bar Status Bedeutung Ready Ob der BVS ID bereit ist Device Locked Ob eine SPS alleinige Hoheit ber die Steuerung des BVS ID hat Die folgenden Fehler sind sichtbar Fehler Bedeutung Trigger Error Ob ein...

Page 45: ...endigen Fehlersuche w hrend der SPS Programmierung durch vorheriges Pr fen der IO Link Verdrahtung Schnellere Fehlererkennung durch Vergleichen der geplanten IO Link Topologie mit der im Feld vorhande...

Page 46: ...ich initialisiert kann im n chsten Schritt die Topologie eingerichtet werden Beim Start hat das Balluff Engineering Tool BET hierf r schon eine leere Topologie erstellt Als n chster Schritt werden der...

Page 47: ...h 45 2 3 Auf Scan starten klicken Nach dem Scan werden alle gefundenen IO Link Ger te aufgelistet Anschlie end Alle hinzuf gen ausw hlen und auf bernehmen Aktualisieren klicken Danach werden die Ger t...

Page 48: ...BVS ID M1280xF1 xx xxx 46 deutsch Durch einen Doppelklick auf das jeweilige Ger t k nnen die IO Link Details angezeigt werden...

Page 49: ...utsch 47 Weitere Details zur Bedienung des Balluff Engineering Tools BET kann dem Balluff Engineering Tool User manual entnommen werden Hierzu auf das Fragezeichen Symbol in der Balluff Engineering To...

Page 50: ...it dieses ber den aktuellen Zustand vom BVS ID informiert ist Da TCP auf Datenstr men basiert k nnen mehrere Nachrichten vom BVS ID unter einem gemeinsamen TCP Header zusammengefasst werden Es wird da...

Page 51: ...e Kategorien von Nachrichten Ereignisnachrichten vom BVS ID Statusnachricht Ergebniscontainer Aktionsnachrichten an den BVS ID die dann nach erfolgter Aktion eine Antwort sendet Connect Disconnect Sta...

Page 52: ...NT16 Nutzdatenl nge in Bytes Nutzdaten Jede Nachricht hat eine eindeutige ID ID Nachricht 01hex Connect 02hex Disconnect 12hex Statusnachricht und Status anfordern 16hex Fehler zur cksetzen 20hex Erge...

Page 53: ...valid Command 13hex Es wurde ein Ung ltiger Befehlscode bertragen NOK Busy 16hex Befehl konnte nicht ausgef hrt werden weil der Status Ready nicht gesetzt ist M gliche Gr nde daf r dass der Ready Stat...

Page 54: ...e als Bildquelle ausgew hlt ist Die Simulation File Device dient zur Anzeige gespeicherter Bilder Automatisch sobald eine andere Bildquelle gew hlt wird HINWEIS Der BVS ID unterst tzt zwei unterschied...

Page 55: ...heit hat Automatisch sobald die SPS ihre Verbindung zum BVS ID beendet sich ein Benutzer als expert oder admin am Client anmeldet oder die Benutzerverwaltung deaktiviert wird 256 00 01 8 Trigger Overf...

Page 56: ...t sind bin r 1 Daher zeigt diese Statusnachricht an dass der BVS ID Ready ist und ein Trigger Error aufgetreten ist HINWEIS Wenn das Ready Bit nicht gesetzt ist bin r 0 werden die Fehlerbits Input Dat...

Page 57: ...ystem Der Aufbau der Nutzdaten h ngt von der Konfiguration im BVS ID ab In diesem Beispiel wird angenommen dass eine Inspektion konfiguriert wurde die einen String von 20 Bytes 14hex liefert Der BVS I...

Page 58: ...okollversion Die folgenden Beispiele zeigen wie die Nachrichten aufgebaut sind und wie sie bertragen werden Die Nachrichten ID f r Connect ist 01hex als UINT16 Little Endian 01hex 00hex Dann folgt die...

Page 59: ...erden ignoriert L nge in Bytes Struktur Wert Bezeichnung 2 UINT16 02hex Nachrichten ID 2 UINT16 00hex Nutzdatenl nge in Bytes Der BVS ID antwortet darauf mit ihrer Disconnect Nachricht L nge in Bytes...

Page 60: ...r 0 waren Die Antwort erfolgt auch unabh ngig von der gew hlten Option f r Statusinformationen automatisch senden Beispiel Die letzte Statusnachricht vom BVS ID an den Client war 12 00 02 00 20 01 Das...

Page 61: ...n Bytes Struktur Wert Bezeichnung 2 UINT16 30hex Nachrichten ID 2 UINT16 04hex Nutzdatenl nge in Bytes 2 UINT16 Ergebniscode 02hex f r OK Inspection ID oder 16hex f r NOK Busy 2 UINT16 bei OK Inspecti...

Page 62: ...n auf ein Inspektionsprogramm mit der ID 0 nicht gewechselt werden Das Inspektionsprogramm mit der angeforderten ID existiert nicht Die maximale Anzahl von Inspektionsprogrammen wurde berschritten Ein...

Page 63: ...80xF1 xx xxx deutsch 61 Die beiden Bytes 1A 00 signalisieren dass der Wechsel nicht erfolgreich war Das aktive Inspektionsprogramm ist in den letzten beiden Bytes festgehalten 01 00 welche der ID 1 en...

Page 64: ...olgender Nachricht die den Zeitstempel enth lt L nge in Bytes Struktur Wert Bezeichnung 2 UINT16 32hex Nachrichten ID 2 UINT16 0Ehex Nutzdatenl nge in Bytes 2 UINT16 Ergebniscode 2 UINT16 Jahr 2 UINT1...

Page 65: ...chnung 2 UINT16 33hex Nachrichten ID 2 UINT16 02hex Nutzdatenl nge in Bytes 2 UINT16 Ergebniscode Beispiel Es soll das Datum und die Uhrzeit 2016 03 02 12 14 10 gesetzt werden Nachricht vom Client an...

Page 66: ...2 UINT16 02hex Nutzdatenl nge in Bytes 2 UINT16 Ergebniscode Beispiel Der Benutzer m chte den Referenzwert Hello World senden In einem vorangegangenen Schritt hat der Benutzer im Webinterface f r den...

Page 67: ...Client an den BVS ID 40 00 00 00 Der BVS ID antwortet im Erfolgsfall darauf mit 40 00 02 00 00 00 4 1 6 Kommunikation testen 4 1 6 1 Unter Linux Unter Linux kann eine UDP Kommunikation mit dem Tool Ne...

Page 68: ...aten die an die REST API gesandt und von ihr empfangen werden entsprechen dem JSON Datenformat JavaScript Object Notation Ausnahmen von dieser Regel werden unten erw hnt Die Programmierschnittstelle i...

Page 69: ...s mit Bearer Aufgrund des selbst signierten Zertifikates des BVS ID ist hier der Parameter insecure wichtig curl X POST https 192 168 165 84 api balluff v1 vision inspection trigger H accept H Authori...

Page 70: ...er Fehler in der URL 429 Too many requests Die bertragungsrate ist aufgrund einer zu hohen Anfragefrequenz begrenzt 500 Internal Server Error Ein interner Fehler des Servers ist aufgetreten z B mit de...

Page 71: ...wendet wird version Die aktuelle API Version Beispiel description Current version of the REST API url v1 version 1 0 0 API Beschreibung abfragen Ressource apidocs URL http HOSTNAME api balluff v1 apid...

Page 72: ...uktes productName Der Name des Produktes productText Beschreibung der vorhandenen Merkmale serialNumber Seriennummer vendorName Name des Herstellers vendorUrl URL zur Website des Herstellers Beispiel...

Page 73: ...E api balluff v1 documents Antwort Objekt Inhalt categories Beschreibung der einzelnen Handbuch Kategorien documents Enth lt Links und Beschreibungen zu den vorhandenen Handb chern Beispiel categories...

Page 74: ...e totalOperatingHours Gesamtbetriebsstundenz hler f r die Betriebsstunden seit Auslieferung des Ger ts operatingHoursSinceBoot Betriebsstundenz hler f r die Betriebsstunden seit Start des Ger ts bootC...

Page 75: ...it supplyVoltage value 23 unit V humidity value 9 unit health value NORMAL_0 HINWEIS Diagnose Werte k nnen auch einzeln abgefragt werden indem dem Befehl diagnostics angeh ngt wird z B http HOSTNAME a...

Page 76: ...ann seine vorgesehene Funktion nicht aus ben CHECK_FUN CTION_2 Die Prozessdaten sind vor bergehend ung ltig da der BVS ID momentan konfiguriert wird OFF_SPEC_ 3 Auch wenn die Prozessdaten g ltig sind...

Page 77: ...024 09 01T07 20 06 000 00 00Z Inspektions ID abfragen Ressource vision inspection id URL http HOSTNAME api balluff v1 vision inspection id Antwort Objekt Inhalt inspectionID ID des aktiven Inspektions...

Page 78: ...des aktiven Inspektionsprogramms inspectionResult Inspektionsergebnis resultMessage Ergebnisnachricht type Code Typen text Gelesene Texte expectedValue Erwartete Texte qualityMin Minimale Code Qualit...

Page 79: ...id 1 inspectionResult true resultMessage type Code 1 QR Code text Code 1 Matrix expectedValue Code 1 qualityMin Code 1 B qualityFull Code 1 AAABABBA moduleSize Code 1 20 83460968299469 centerX Code 1...

Page 80: ...en ein Inputbuffer Unterlauf aufgetreten ist es wurden mehr Inspektionen durchgef hrt als Input Container empfangen wurden ein Input Container wurde mehr als einmal verwendet ready Wahr falls BVS ID a...

Page 81: ...resultDataError false simulationMode true systemError false triggerOverflow false waitingForTrigger false HINWEIS Status Werte k nnen auch einzeln abgefragt werden indem dem Befehl vision status ange...

Page 82: ...L http HOSTNAME api balluff v1 vision inspection id Anfrage Objekt Inhalt inspectionID Nummer des zu ladenden Inspektionsprogramms Beispiel inspectionID 2 HINWEIS F r die POST und Login Befehle muss a...

Page 83: ...nceValue UTF 8 codierter Referenzwert Beispiel referenceValue Balluff Inspektion triggern Resource vision inspection trigger URL http HOSTNAME api balluff v1 vision inspection trigger LED aufleuchten...

Page 84: ...age Objekt Inhalt username UTF 8 kodierter Benutzername password UTF 8 kodiertes Passwort Beispiel username expert password 0123456789012 Antwort Objekt Inhalt Bearer String mit dem Session Token role...

Page 85: ...en Bearer bei aktivierter Benutzerverwaltung Das Session Token muss im HTTP Authorization Header per Authorization Bearer 23d6c502 6e5d 433f 8213 35bab1a37c39 mitgegeben werden Beispiel curl X POST ht...

Page 86: ...Eingangspuffers bei CCM Variante Prozessdaten in beiden Richtungen davon 2 Byte Synchronisationsdaten 1 und 2 Bitleiste bertragen Zum Austausch von Daten und Befehlen zwischen BVS ID und dem steuernd...

Page 87: ...steine zur Verf gung Diese k nnen von der Balluff Website www balluff com im Downloadbereich des Produkts heruntergeladen werden Diese Funktionsbausteine bernehmen alle Protokoll eventuelle Toggle und...

Page 88: ...Daten zwischen dem BVS ID und dem steuernden System SPS stellt der BVS ID zwei Felder Eingangs und Ausgangspuffer bereit Die Signalisierung ber die Bitleiste wird in jedem SPS Zyklus aktuell bertrage...

Page 89: ...tleiste TO Job Error Job End Job Start n 3 Statusbyte erster Toggle Zyklus Daten n 4 Datenl nge Byte 0 erster Toggle Zyklus Daten n 5 Datenl nge Byte 1 erster Toggle Zyklus Daten n 6 Daten n 7 Daten n...

Page 90: ...ck Produktstartprozess Ladeprozess eines Inspektionsprogramms BVS ID befindet sich im Konfigurationsmodus Auto Setup Prozess Bei der Analyse von gespeicherten Bildern System Error 6 7 Device Locked D...

Page 91: ...cher Fehler w hrend einer Inspektion 1 Diese Bits bleiben gesetzt auch wenn der Status nicht mehr vorliegt Mit dem Steuerbit Reset Warning k nnen sie zur ckgesetzt werden HINWEIS Wenn das Ready Bit ni...

Page 92: ...m BVS ID gelesen Beschreibung der Einzelsignale Bitleiste Bit Nummer Name Funktionsbeschreibung 0 Job 0 Kein neuer Job liegt vor 1 Ein neuer Job liegt vor 1 Trigger L st einen Trigger Signal im BVS ID...

Page 93: ...fers besteht die M glichkeit das Ger t von der SPS zu steuern SPS beschreibt den Ausgangspuffer Befehlskennung Datenl nge und Daten SPS setzt das Job Bit ber das Job Bit erkennt der BVS ID dass ein Be...

Page 94: ...ndet wurde und die Daten g ltig sind SPS l scht das Job Bit BVS ID l scht das Job End Bit und Job Start Bit zur ck ber die SPS kann der BVS ID ber Signale der Bitleiste in jedem Steuerungszyklus geste...

Page 95: ...n auf 0 SPS beschreibt im Ausgangspuffer Befehlskennung Datenl nge und den ersten Teil der Daten Die Datenl nge ist die L nge der gesamten zu bertragenen Daten SPS l scht TI falls noch gesetzt SPS set...

Page 96: ...BVS ID M1280xF1 xx xxx 94 deutsch Ablaufdiagramm Handshake mit Input Toggle...

Page 97: ...en Befehl enth lt CMD Status und die entsprechenden Daten Befehl Befehlscode Funktionsbeschreibung Set Inspection ID 0x01 Setzt anhand der bergebenen ID das aktuelle Inspektionsprogramm Get Inspection...

Page 98: ...f hrt 0x16 Befehl konnte nicht ausgef hrt werden weil noch ein anderer Befehl verarbeitet wurde oder nach einem Neustart noch nicht bereit ist 0x1A Das Inspektionsprogramm konnte nicht gewechselt werd...

Page 99: ...0 Status Byte n 01 Error Byte n 02 0x02 1 Bitleiste Job Start n 03 CMD Status 0x02 Befehl wurde erfolgreich ausgef hrt 0x10 Bei der Abfrage der Inspektions ID trat ein Fehler auf 0x16 Die Applikation...

Page 100: ...elt Befehl Subadresse Daten Bedeutung n 00 0x02 1 Bitleiste Job Start n 01 0x03 Ergebnisse abfragen n 02 n 03 n 31 0x02 2 Bitleiste Antwort Subadresse Daten Bedeutung n 00 Status Byte n 01 Error Byte...

Page 101: ...lt Befehl Subadresse Daten Bedeutung n 00 0x02 1 Bitleiste Job Start n 01 0x04 Referenzwerten setzen n 02 Nutzdatenl nge Byte 0 n 03 Nutzdatenl nge Byte 1 n 04 Input Byte 0 n 05 Input Byte 1 n 06 Inpu...

Page 102: ...esse Daten Bedeutung n 00 Status Byte n 01 Error Byte n 02 0x02 1 Bitleiste Job Start n 03 CMD Status 0x06 Befehl wurde erfolgreich ausgef hrt Zeitstempeldaten werden bermittelt 0x10 Bei der Abfrage d...

Page 103: ...1 0x07 Datum Zeit setzen n 02 0x00 n 03 Jahrhundert n 04 Jahr n 05 Monat n 06 Tag n 07 Stunde n 08 Minute n 09 Sekunde n 31 0x02 2 Bitleiste Antwort Subadresse Daten Bedeutung n 00 Status Byte n 01 Er...

Page 104: ...er Umweltbedingung Extreme Environment Status Interne Temperatur Internal Temperature Neigungsdetektion und Einstellhilfe Inclination and Installation Aid Vibrationsdetektion Vibration Feuchtigkeitsde...

Page 105: ...61002 BVS ID M1280BF1 L3 090 0x061005 BVS ID M1280BF1 L3 090 CCM 0x061006 BVS ID M1280CF1 L3 000 0x061003 BVS ID M1280CF1 L3 000 CCM 0x061004 4 4 3 Prozessdatenprofile 4 4 3 1 Default PD Input Byte 0...

Page 106: ...RING n a Function Tag 0x0019 25 0 R W 32 Byte STRING Ja Location Tag 0x001A 26 0 R W 32 Byte STRING Ja Product Type Code 0x0700 1792 0 R 64 Byte STRING n a z B BVS ID M1280BF1 L3 000 Product Order Cod...

Page 107: ...Byte UINT16 Nein 100 Statistics Data Output 0x0427 1063 0 R 21 Byte n a Minimum 1 R 4 Byte FLOAT32 n a Maximum 2 R 4 Byte FLOAT32 n a Average 3 R 4 Byte FLOAT32 n a Moving Average 4 R 4 Byte FLOAT32...

Page 108: ...ndex Zugriff L nge Datentyp Data Storage Default Interne Temperatur Device Temperature 0x0052 82 0 R 10 Byte n a Device Temperature 1 R 2 Byte INT16 n a Minimum Device Temperature Since Reset 2 R 2 By...

Page 109: ...age Default Vibrationsdetektion Vibration Level 0x210E 8462 0 R 4 Byte FLOAT32 n a Vibration Alarm Configuration 0x210F 8463 0 R W 5 Byte Ja Vibration Alarm Enable 1 R W 1 Byte BOOL Nein 0 Vibration A...

Page 110: ...ata Storage Default Variantenkonfiguration Device Variant 0x0055 85 0 R W 2 Byte UINT16 ENUM Nein 1 Default Name Index Subindex Zugriff L nge Datentyp Data Storage Default Bedeutung der LED Zust nde u...

Page 111: ...0xA7 167 Statistics Reset Setzt alle Ausgangsparameter auf 0 und alle Benutzereinstellungen auf die Defaultwerte zur ck 0xA8 168 Statistics Start Min Max Avg Startet die Statistik der Minimalwert Max...

Page 112: ...ren Versorgungsspannung Abweichungen in der Versorgung pr fen 2 Out of Specification 0x8CD0 36048 Warnung Neigungsalarm Installation pr fen 1 Maintenance Required 0x8CD1 36049 Warnung Vibrationsalarm...

Page 113: ...gungen pr fen 1 Maintenance Required 0x8D13 36115 Warnung Eine oder mehrere Extrembedingungen liegen vor 0 Device is operating properly 0x8D15 36117 Warnung berlast an Pin 2 Verkabelung pr fen 2 Out o...

Page 114: ...ssdaten vom Master zum Device ProcessDataOut 0x00 0 Bit Herstellerkennung Vendor ID 0x378 Ger tekennung Device ID 0x061001 Um die grundlegenden Kommunikationsparameter flexibel an die Anwendung anzupa...

Page 115: ...ion 0x0016 22 0 R 2 Byte STRING n a Firmware Revision 0x0017 23 0 R 10 Byte STRING n a Application Specific Tag 0x0018 24 0 R W 32 Byte STRING n a Function Tag 0x0019 25 0 R W 32 Byte STRING Ja Locati...

Page 116: ...ennung Device Discovery Beschreibung Mit der Funktion Device Discovery kann ein IO Link Device wiedergefunden werden indem per System Command eine Signalisierung an der LED vom Device gestartet wird I...

Page 117: ...tzmaske Hier kann die Subnetzmaske der festen IP Konfiguration des BVS ID gesetzt und gelesen werden Siehe Netzwerkeinstellungen SensorApp Gateway Adresse Hier kann die Gateway Adresse der festen IP K...

Page 118: ...rreicht wird Der Signalzustand wir auch dadurch angezeigt das die IO Link LED orange aufleuchtet wenn die Signalqualit t unter dem Schwellenwert ist Die Funktion kann deaktiviert werden indem der Schw...

Page 119: ...nt Signal Quality 1 R 1 Byte UINT8 n a Signal Quality Bad 2 R 1 Bit BOOL n a Low Signal Quality Threshold Der Schwellenwert f r niedrige Signalqualit t kann eingestellt werden um die aktuelle Signalqu...

Page 120: ...x 2 ergibt immer FALSE 0x82 130 Reset Factory Settings Setzt den Schwellenwert mit ISDU Index 0xCE Low Signal Quality Threshold auf Default 0 zur ck Dadurch ist das Feature deaktiviert und die Evaluat...

Page 121: ...der Berechnung von Minimalwert Maximalwert und Durchschnitt Wie im Bild dargestellt wird die Berechnung durch den Startbefehl eingeleitet und durch den Stoppbefehl gestoppt Die Werte werden zwischen S...

Page 122: ...Name Beschreibung Richtung 0x0053 83 Minimum Minimalwert Eingang 0x0054 84 Maximum Maximalwert Eingang 0x0055 85 Average Durchschnitt Eingang 0x0056 86 Moving Average Wiederholt berechneter Durchschni...

Page 123: ...rwendet werden mit der Ausnahme von Boolean Die jeweiligen Object IDs sind in dem jeweiligen Kapitel der Funktion zu finden Defaultwert ist 0 dies entspricht kein Objekt Statistics Data Configuration...

Page 124: ...w hlt werden Wert Bedeutung Beschreibung 0x01 1 Seconds Sekunden 0x02 2 Minutes Minuten 0x03 3 Hours Stunden 0x04 4 Samples Messwerte Statistics Data Configuration Moving Average Window Value Der Wert...

Page 125: ...ur ck 0xA8 168 Statistics Start Min Max Avg Startet die Statistik der Minimalwert Maximalwert Durchschnitt Berechnung 0xA9 169 Statistics Stop Stoppt den Statistikbetrieb vollst ndig 0xAC 172 Statisti...

Page 126: ...anach 4 Minuten danach 8 Minuten bis zu einem maximalen Speicherintervall von 12 Minuten Process Data Object ID Name Beschreibung Richtung 0x001B 27 Current Operating Hours Ausgabe des aktuellen Betri...

Page 127: ...zweiter Boot Cycle Counter implementiert der zur ckgesetzt werden kann Die Ausgabe des aktuellen Boot Zyklus kann als Kontrolle f r das Service Intervall sowie f r die vorbeugende Wartung dienen Zeitp...

Page 128: ...g bei 31 V Process Data Object ID Name Beschreibung Richtung 0x0016 21 Overload short circuit pin 4 TRUE berlast oder Kurzschluss an Pin 4 erkannt Eingang 0x0016 22 Overload short circuit pin 2 TRUE b...

Page 129: ...0x8D15 36117 Warnung berlast an Pin 1 Verkabelung pr fen 2 Out of Specification 4 4 9 5 Status extremer Umweltbedingung Extreme Environment Status Beschreibung Mithilfe des Extreme Environment Status...

Page 130: ...iedriger Temperatur State Unter State kann der aktuelle Status abgelesen werden Bit Name Beschreibung 0 Vibration Die Vibrationen liegen oberhalb des Schwellenwerts 1 Upper Temperature Die Temperatur...

Page 131: ...nts Event Code Event Typ Event Beschreibung Abhilfe Device Status 0x8D13 36115 Warnung Eine oder mehrere Extrembedingungen liegen vor 0 Device is operating properly Variantenabh ngigkeit Die Funktiona...

Page 132: ...peratur in C Eingang ISDU Name Index Subinde x Zugrif f L nge Datentyp Data Storage Default Device Temperature 0x0052 82 0 R 10 Byte n a Device Temperature 1 R 2 Byte INT16 n a Minimum Device Temperat...

Page 133: ...rature Overrun Clear Heat Of Source Gefahr von Ger teschaden Der BVS ID ist zu hei Hitzequelle entfernen BVS ID ggf zus tzlich Hitzeisolieren 2 Out of Specification 0x4220 16928 Warnung Device Tempera...

Page 134: ...arallelverschiebungen zur Achse oder Rotation um diese Achse jedoch nicht Messdaten zur Neigungsdetektion Messbereich 0 180 Aufl sung 1 Genauigkeit 1 Messperiode 1000 ms Datenaktualisierungsrate 1 Sek...

Page 135: ...nclination Alarm Status Neigungsalarm Status Eingang 1 Unit degree ISDU Name Index Subinde x Zugrif f L nge Datentyp Data Storage Default Inclination Alarm Configuration 0x2151 8529 0 2 Byte Ja Inclin...

Page 136: ...Bit Beschreibung 0 Device ist in seiner eingelernten Position Orientierung 1 Device ist falsch ausgerichtet Neigung ist gleich gro oder gr er als der Schwellenwert Reference Taught Position X Y Z Koo...

Page 137: ...twert zur ck 0x82 130 Reset Factory Settings Setzt die Neigungsalarmkonfiguration auf den Firmware Defaultwert zur ck Events Event Code Event Typ Event Beschreibung Abhilfe Device Status 0x8CD0 36048...

Page 138: ...Messung der Schwinggeschwindigkeit als physikalische Umgebungseigenschaft eines mechanischen Systems Hauptziel ist es signifikante nderungen oder Abweichungen der Schwingung zu erkennen Werden einste...

Page 139: ...ng der Werte ber die Zeit Die Genauigkeit der Messung wird durch die Anwendung eingeschr nkt weil BVS ID zur Erf llung der prim ren Funktion und nicht als Sensor zur Vibrationsmessung montiert wird So...

Page 140: ...ts Der Vergleich wird f r jede Achse und Gr e mit logischer ODER Verkn pfung durchgef hrt Die Hysterese ist fest und basiert auf der Zeit nicht auf der Amplitude Wenn der Schwingungswert den Schwellen...

Page 141: ...f L nge Datentyp Data Storage Default Humidity 0x005 C 92 0 R 9 Byte n a Humidity Bad 1 R 1 Byte BOOL n a Operating Hours At Exceedance 2 R 4 Byte UINT32 n a Temperature At Exceedance 3 R 4 Byte INT32...

Page 142: ...36132 Warnung Parameterschreibfehler Beim Schreiben der Daten ist ein Fehler aufgetreten dient nur zur Information 0 Device is operating properly 4 4 9 11 Ger testatus und detailierter Ger testatus D...

Page 143: ...ltig Der BVS ID ist nicht in der Lage seine vorgesehene Funktion auszuf hren Eine Neukonfiguration Zur cksetzen auf Werkseinstellungen kann weiterhelfen Sonst muss der Balluff Service kontaktiert ode...

Page 144: ...hert Wert Diagnoseniveau Beschreibungen 0 Alle Events Alle Diagnosemeldungen werden berichtet Default Einstellung 1 Warnungen und Fehler Alle Warnungen und Fehler werden berichtet Benachrichtigungen w...

Page 145: ...0x81 129 Application Reset Dieses Zur cksetzen wird anhand der IO Link Spezifikation V1 1 2 durchgef hrt R cksetzen aller Parameter und Ger teeinstellungen auf Standardwerte mit Ausnahme der Identifik...

Page 146: ...n IO Link Kompatibilit tsmodus ge ndert dann ist die nderung in diesem Parameter sofort sichtbar Dieser Parameter wird durch einen Reset nicht ver ndert Folgende Ger tevarianten sind verf gbar Wert Be...

Page 147: ...er BVS ID befindet sich gerade im Teach in Modus Z B Einlernen der Neigungsdetektion oder Auto Setup Maintenance Required Blau statisch Es muss eine Wartung durchgef hrt werden Z B Schwellenwert der N...

Page 148: ...ht Port ist erkannt worden Bad Signal Quality Orange blinkend 1 Hz Schlechte Signalqualit t Die Qualit t einer oder mehrerer Codes befindet sich unterhalb der konfigurierten Warnschwelle Out of Specif...

Page 149: ...abgebrochen ISDU Name Index Subinde x Zugriff L nge Datentyp Data Storage Default Process Data Input Descriptor 0x000E 14 0 R 96 Byte UINT8 n a Process Data Output Descriptor 0x000F 15 0 R 96 Byte UIN...

Page 150: ...riante nicht g ltig ist wird das Defaultprofil f r die entsprechende Variante ausgew hlt Event Code Event Typ Event Beschreibung Abhilfe Device Status 0x1850 6224 Benachrichtigung Process Data Profila...

Page 151: ...Profil ID Name Beschreibung 0x4000 Common Profile 0x0030 BLOB 0x0031 Firmware Update Alle Einzelfunktionen sind in dieser Anleitung beschrieben Genauere Bedeutungen der Profile k nnen in den entsprec...

Page 152: ...d etc verwendet werden 4 5 2 Daten bertragung F r die Verbindung zum MQTT Broker stehen drei verschiedene bertragungsmodi zur Verf gung MQTT Die Verbindung zum MQTT Broker verfolgt ber eine unverschl...

Page 153: ...bootCycles value 49 balluff HOSTNAME diagnostics vibration Aktuelle Vibration vibration value 0 060 unit mm s HINWEIS Die Zeichenfolge HOSTNAME muss im Folgenden durch den Namen des BVS ID ersetzt wer...

Page 154: ...diagnostics humidity Aktuelle Luftfeuchtigkeit humidity value 12 unit balluff HOSTNAME diagnostics supplyVoltage Aktuelle Versorgungsspannung supplyVoltage value 24 unit V balluff HOSTNAME diagnostics...

Page 155: ...ck Die Ergebnisliste enth lt alle Eintr ge die im Ausgabereiter der Konfigurationsseite selektiert sind Es ist zu beachten dass die aktuell gelesene Ergebnisliste auch von der letzten Inspektion stam...

Page 156: ...OSTNAME vision status triggerOverflow W hrend der letzten Ausf hrung musste ein Triggersignal verworfen das System war noch nicht Ready triggerOverflow false balluff HOSTNAME vision status waitingForT...

Page 157: ...956115_AB DE E23 nderungen vorbehalten Ersetzt K22...

Page 158: ......

Page 159: ...english Configuration Guide BVS ID M1280xF1 xx xxx...

Page 160: ...www balluff com...

Page 161: ...6 Updates and upgrades 8 1 7 Trademarks 8 2 SensorApp Webinterface 9 2 1 Introduction 9 2 1 1 The SensorApp interface 10 2 2 System Menu 10 2 2 1 Help system 10 2 2 2 System Settings 11 2 2 3 User in...

Page 162: ...ess Data Protocol 82 4 3 1 Introduction 82 4 3 2 Function modules 83 4 3 3 Process data 84 4 3 4 Protocol sequence 89 4 3 5 Commands 93 4 4 Overview of IO Link Data and Functions 100 4 4 1 Overview of...

Page 163: ...All content is protected by copyright All rights reserved including the right to reproduce publish edit and translate this document 1 2 Symbols and Conventions The following conventions are used in t...

Page 164: ...se strings are automatically UTF 8 encoded by definition 1 2 7 Representation of UTF 8 encoded strings Characters transmitted in their UTF 8 encoding are set in apostrophes e g L 1 3 Explanation of th...

Page 165: ...IO Input Output IODD IO Device Description IO Link Communications networking standard used for connecting digital sensors and actuators IP Internet Protocol ISDU Indexed Service Data Unit LAN Local Ar...

Page 166: ...nder various open source licenses Some licenses require that the source code and modifications be published These sources are published on the Product homepage The license texts for all software produ...

Page 167: ...web browser Enter the following URL http 192 168 10 2 Confirm the entry Depending on the network topology different network settings are required Usually in a company network or in a production facili...

Page 168: ...age Showing the live image 5 Device info Showing device information states and errors 2 2 System Menu The System menu is in the top right section of the user interface It consists of the following men...

Page 169: ...rial number of the BVS ID Log files allow to track changes and errors on the system You can access the log files by clicking on the hyperlink Download log files There are three kinds of log files Syst...

Page 170: ...Specifies in which time zone the BVS ID is located Use PC time for sensor Sets the PC Browser time in the Sensor This function is only available if the option Use NTP Server is deactivated NOTE In ord...

Page 171: ...en receiving an IP address automatically it sometimes could take a while to be able to connect to the BVS ID using the host name until the DNS Server resolves the host name to the received IP It is re...

Page 172: ...e usually only one gateway address is required NOTE To apply changes in network settings the BVS ID must be restarted NOTE The above mentioned parameters Obtain an IP address automatically IP Subnet m...

Page 173: ...Big endian The highest value byte is transferred first Port UDP TCP The UDP TCP communication port Send status information UDP TCP Enables automatic sending of status messages every time a status cha...

Page 174: ...ificate Authority File Possibility to upload the CA certificate of the broker in combination with the mode MQTT encrypted with CA file Connection Status Shows if there is an active connection to MQTT...

Page 175: ...gs Setting Description Protocol Protocol to be used to transmit report data Supported protocols are FTP FTPS and SMB Server The IP address or the URL both starting with ftp of the server to store the...

Page 176: ...RAW Determines whether images of successful inspections are stored as BMP files NOK inspection results Determines whether results of failed inspections are stored as XML reports NOK images JPG Determ...

Page 177: ...quest via HTTP is then redirected to the HTTPS connection request This setting is only applied after a restart of the BVS ID NOTE If the connection between web browser and the BVS ID takes place via a...

Page 178: ...manently to go on without setting passwords User groups The SensorApp has the following user types with their rights in the GUI Deactivated Activated Function Not logged in user expert admin Change im...

Page 179: ...ID M1280xF1 xx xxx english 21 2 2 3 User information and language settings In this area the user information is shown It is also possible to log out the user Furthermore the system language is indica...

Page 180: ...not change any system settings When starting BVS ID opens the last inspection program opened in the Monitor mode 2 3 1 Monitor You can use Monitor to display the actual results for the current inspect...

Page 181: ...automatically The LIVE mode can be reactivated at any time If the LIVE mode is deactivated and if there are new inspection runs triggered in the background they may overwrite the images of older inspe...

Page 182: ...ration if the Loop is not activated This also causes an image acquisition Auto Setup With this button you can start the Auto Setup process Tools An inspection consists of 3 elements Inputs Analysis an...

Page 183: ...r dialog will be opened which is used to manage the list of imported inspection programs The current program is shown in blue Any program can be exported to a local file using Another program can be o...

Page 184: ...ion channel a mix of data container via UDP TCP with a trigger via digital input is therefore not recommended NOTE If Unicode characters are contained in the reference value note that the presupposed...

Page 185: ...nspection program run The reference value can thus no longer be used in the following inspection program run If New reference per cycle is deactivated the reference value is reused until it is overwri...

Page 186: ...BVS ID M1280xF1 xx xxx 28 english 2 4 1 2 Sensor device Task Used for selecting the sensor and setting sensor parameters Parameters...

Page 187: ...t Width pixel 1 Width of the image area AOI minimal 16 Pixel maximal 1280 Pixel Int Height pixel 1 Height of the image area AOI minimal 16 Pixel maximal 960 Pixel Int Position X pixel 1 Horizontal sta...

Page 188: ...wing sections 1D Barcodes 2D Barcodes General settings 2 4 2 1 1D Barcodes 2D Barcodes Task Specifies the 1D or 2D codes which should be read The tool searches for codes within the area of interest an...

Page 189: ...istortion etc differ from the usual values In this mode codes are only detected if their symbols are darker than the background Enum NOTE This selection is set automatically when the auto setup proces...

Page 190: ...BVS ID M1280xF1 xx xxx 32 english Reference Orientation 2D Codes Code type Aztec Code Datamatrix ECC 200 Micro QR Code PDF417 QR Code Reference orientation...

Page 191: ...ted value of 17 can be used to ensure that the read value begins with 17 The initial parameter accepts any codes String Expected number of codes The maximum number of codes to be found during image an...

Page 192: ...D code types Int NOTE Sorting takes place after the code search This means that the results are not dependent on the sort mode Only the order of results will change with the sorting mode NOTE Assessin...

Page 193: ...r worst quality of all characteristics b Decode Will indicate if the code can be read or not according to the specification for this reason the value can only be A readable after specification or F no...

Page 194: ...g centers and tests for uneven scaling of the symbol along the X or Y axis Reasons for this behavior can be the print quality or the tilt of the camera g Grid nonuniformity Measures and grades the lar...

Page 195: ...lementation it will always be A f Axial nonuniformity Measures and grades the spacing of the mapping centers and tests for uneven scaling of the symbol along the X or Y axis Reasons for this behavior...

Page 196: ...can be specified by modifying the string lengths of each result if the result type does not have a constant length 2 4 3 2 Setting the parameters For a new inspection program all result data of the ex...

Page 197: ...BVS ID M1280xF1 xx xxx english 39...

Page 198: ...point of the found code UINT16 4 Rotation 1 n Rotation of the found code UINT16 2 Interpretation of the sent data The tool sends the data via the communication channel defined in the system settings...

Page 199: ...alone mode without the user interface If the BVS ID is operated with the SensorApp interface open deactivate the live image display of the SensorApp interface By suitable selection of the parameter To...

Page 200: ...le State Meaning Ready If the BVS ID is ready Device Locked If a PLC has exclusive control over the BVS ID The following errors are visible Error Meaning Trigger Error If a trigger error is present Re...

Page 201: ...ion of time consuming troubleshooting during PLC programming by checking the IO Link wiring beforehand Faster error detection by comparing the planned IO Link topology with the topology existing in th...

Page 202: ...itiated successfully a project can be created the next step is to set up the topology At startup the Balluff Engineering Tool BET has already created an empty topology for this purpose The next step i...

Page 203: ...BVS ID M1280xF1 xx xxx english 45 2 3 Click on Start Scan After the scan all the IO Link devices found are listed Then select Add all and click on Apply Update...

Page 204: ...BVS ID M1280xF1 xx xxx 46 english The devices are then added to the topology By double clicking on the respective device the IO Link details can be displayed...

Page 205: ...glish 47 Further details on the operation of the Balluff Engineering Tool BET can be found in the Balluff Engineering Tool User manual To do this click on the question mark symbol in the Balluff Engin...

Page 206: ...he controlling system so that the latter is informed about the status of BVS ID Since TCP is based on data streams multiple messages sent by BVS ID may share a common TCP header It is therefore recomm...

Page 207: ...ssage begins with the message ID There are two different types of messages Event messages from BVS ID Status message Result container Request messages to the BVS ID replying with a response message Co...

Page 208: ...2 UINT16 User data length in bytes User data Every message has a unique ID ID Message 01hex Connect 02hex Disconnect 12hex Status message and get status 16hex Reset errors 20hex Result container 30hex...

Page 209: ...command e g wrong length is a possible reason NOK Invalid Command 13hex An invalid command code was transferred NOK Busy 16hex Command could not be executed since the status Ready is not set Possible...

Page 210: ...mulation Mode This bit signals that File Device is selected as image source The simulation File Device can be used to display stored images Automatically as soon as a different image source is selecte...

Page 211: ...tivated 256 00 01 8 Trigger Overflow This bit signals that a trigger has been received while BVS ID was not waiting for a trigger i e while the bit Waiting For Trigger was binary 0 The behavior upon s...

Page 212: ...he Ready bit is not set binary 0 the error bits Input Data Error Report Error and Trigger Overflow are automatically set to binary 0 and are no longer changed Those errors are accordingly not reported...

Page 213: ...ntrolling system The structure of the user data depends on the configuration in BVS ID In this example it is assumed that an inspection was configured which provides a string of 20 bytes 14hex BVS ID...

Page 214: ...code 2 UINT16 01hex Version of the protocol The following examples show how the connect message is structured and sent The messages ID for Connect is 01hex as UINT16 little endian 01hex 00hex Then th...

Page 215: ...a Reset errors response Length in bytes Structure Value Description 2 UINT16 16hex Message ID 2 UINT16 02hex User data length in bytes 2 UINT16 Result code BVS ID answers with a status message in whic...

Page 216: ...ription 2 UINT16 30hex Message ID 2 UINT16 00hex User data length in bytes BVS ID answers with a response message containing the Inspection ID Length in bytes Structure Value Description 2 UINT16 30he...

Page 217: ...o an inspection program with ID 0 is not possible via communication interfaces The inspection program with the given ID does not exist The maximum amount of inspection programs has been exceeded a cha...

Page 218: ...ning the current date and time of the system Length in bytes Structure Value Description 2 UINT16 32hex Message ID 2 UINT16 0Ehex User data length in bytes 2 UINT16 Result code 2 UINT16 Year 2 UINT16...

Page 219: ...ucture Value Description 2 UINT16 33hex Message ID 2 UINT16 02hex User data length in bytes 2 UINT16 Result code Example The date and time 2016 03 02 12 14 10 should be set Message from the client to...

Page 220: ...iption 2 UINT16 34hex Message ID 2 UINT16 02hex User data length in bytes 2 UINT16 Result code Example The user wants to send the reference value Hello World Beforehand the user has set the reference...

Page 221: ...length in bytes 2 UINT16 Result code Example Message from the client to BVS ID 40 00 00 00 BVS ID responds to it with 40 00 02 00 00 00 4 1 6 Testing the communication 4 1 6 1 Under Linux For testing...

Page 222: ...Notation JSON The API is designed to let the user retrieve so called resources as listed in Available resources using the HTTP GET request below Es gibt zwei verschiedene Kategorien von Nachrichten GE...

Page 223: ...with an authentication bearer Due to the self signed certificate used by the BVS ID the parameter insecure must be provided to work right Not every curl version worked with the secure HTTPS mode see...

Page 224: ...tax error in URL 429 Too many requests Rate limited due to excessive request frequency 500 Internal Server Error An internal server error occurred i e with incompatibilities in TLS encryption The foll...

Page 225: ...it is used in the URL version The current API version Example description Current version of the REST API url v1 version 1 0 0 Get API description Resource apidocs URL http HOSTNAME api balluff v1 ap...

Page 226: ...roduct s website productName Name of the product productText Description of the properties serialNumber Serial number vendorName Name the vendor vendorUrl URL to the vendor s website Example firmwareR...

Page 227: ...ponse Text data in Markdown format of MIME type text plain containing the license information of all used software libraries Get manuals Resource identification URL http HOSTNAME api balluff v1 docume...

Page 228: ...tle Configuration guide documents category ConfigurationGuide lang de origin local title German configuration guide url http localhost 9000 resources help Manual_BVSID_de pdf category ConfigurationGui...

Page 229: ...b objects totalOperatingHours Total number of operating hours since device production operatingHoursSinceBoot Current number of operating hours since the start of the device bootCycles Total number of...

Page 230: ...92 unit supplyVoltage value 23 451 unit V humidity value 9 unit health value NORMAL_0 NOTE Individual condition monitoring values can be requested by appending their name to the command diagnostics e...

Page 231: ...is unable to perform its intended function CHECK_FUN CTION_2 Process data are temporarily invalid due to intended manipulations on the device OFF_SPEC_ 3 Although the process data are valid internal d...

Page 232: ...me 2024 09 01T07 20 06 000 00 00Z Get inspection ID Resource vision inspection id URL http HOSTNAME api balluff v1 vision inspection id Response Object Content inspectionID ID of the active inspection...

Page 233: ...nspection program inspectionResult Inspection result resultMessage Result message expectedNumberOfCode s Expected number of codes type Code types text Read texts expectedValue Expected texts qualityMi...

Page 234: ...n Code 1 85 Get results as a binary string Ressource vision inspection resultsAsBinaryString URL http HOSTNAME api balluff v1 vision inspection resultsAsBinaryString Response Object Content binaryData...

Page 235: ...w commands reportError True if a report file could not be transferred and got lost resultDataError True if a result container was not picked up by the REST client simulationMode True if either the Fil...

Page 236: ...t inspectionID ID of inspection program to be loaded Example inspectionID 2 NOTE Individual status values can be requested by appending their name to the command vision status e g http HOSTNAME api ba...

Page 237: ...Request Object Content referenceValue UTF 8 encoded reference value Example referenceValue Balluff Trigger inspection Resource vision inspection trigger URL http HOSTNAME api balluff v1 vision inspec...

Page 238: ...equest Object Content username UTF 8 encoded username password UTF 8 encoded password Example username expert password 0123456789012 Response Object Content Bearer String containing the session token...

Page 239: ...with session token Bearer with activated user management The session token Bearer has to be set as string in the request HTTP Authorization header Example curl X POST http 192 168 10 2 api balluff v1...

Page 240: ...of process data transferred in both directions 2 bytes of which are synchronization data 1st and 2nd bit string For the exchange of data and commands between BVS ID and the controlling fieldbus syste...

Page 241: ...mmon controllers These can be downloaded from the Balluff website www balluff com in the download area of the product These function blocks take over all protocol possible toggle and safety tasks auto...

Page 242: ...tween the BVS ID and the controlling system PLC the BVS ID provides two fields input and output buffer The signaling via the bit strip is currently transmitted in each PLC cycle Hereby the PLC recogni...

Page 243: ...2 1st bit string TO Job Error Job End Job Start n 3 Status byte first toggle cycle Data n 4 Data length byte 0 first toggle cycle Data n 5 Data length byte 1 first toggle cycle Data n 6 Data n 7 Data...

Page 244: ...d execute commands The following actions reset this bit Product start process Loading process of an inspection program BVS ID is in configuration mode Auto setup process During analysis of saved image...

Page 245: ...re of 90 C Error during import of an inspection program Critical error during an inspection 1 These bits remain set even if the status is no longer present They can be reset using the control bit Rese...

Page 246: ...output buffer is used by the PLC and read by the BVS ID Description of the individual signals Bit String Bit number Name Functional description 0 Job 0 No new job is available 1 A new job is present...

Page 247: ...f the output buffer it is possible to control the device from the PLC PLC describes the output buffer command identifier data length and data PLC sets the Job bit Via the Job bit the BVS ID recognizes...

Page 248: ...sponse has been sent and the data is valid The PLC deletes the Job bit BVS ID deletes the Job End bit and Job Start bit Via the PLC the BVS ID can be controlled by signals of the bit bar in each contr...

Page 249: ...on PLC writes in the output buffer command identifier data length and the first part of the data The data length is the length of the total data to be transmitted PLC deletes TI if still set PLC sets...

Page 250: ...BVS ID M1280xF1 xx xxx 92 english Flowchart Handshake with Input Toggle...

Page 251: ...ement of the command CMD status and the corresponding data Command Code Functional description Set Inspection ID 0x01 Sets the current inspection program based on the passed ID Get Inspection ID 0x02...

Page 252: ...00 Command was executed successfully 0x16 Command could not be executed because another command was still being processed or is not yet ready after a restart 0x1A The inspection program could not be c...

Page 253: ...ing n 00 Status byte n 01 Error byte n 02 0x02 1st bit string Job Start n 03 CMD status 0x02 Command was executed successfully 0x10 An error occurred when requesting the inspection ID 0x16 The applica...

Page 254: ...other Command Sub address Data Meaning n 00 0x02 1st bit string Job Start n 01 0x03 Get Results n 02 n 03 n 31 0x02 2nd bit string Response Sub address Data Meaning n 00 Status byte n 01 Error byte n...

Page 255: ...her Command Sub address Data Meaning n 00 0x02 1st bit string Job Start n 01 0x04 Set reference values n 02 User data length byte 0 n 03 User data length byte 1 n 04 Input byte 0 n 05 Input byte 1 n 0...

Page 256: ...g Response Sub address Data Meaning n 00 Status byte n 01 Error byte n 02 0x02 1st bit string Job Start n 03 CMD status 0x06 Command was executed successfully timestamp data is transmitted 0x10 An err...

Page 257: ...ob Start n 01 0x07 Set date time n 02 0x00 n 03 Century n 04 Year n 05 Month n 06 Day n 07 Hour n 08 Minute n 09 Second n 31 0x02 2 bit string Response Sub address Data Meaning n 00 Status byte n 01 E...

Page 258: ...Basic Statistics Operating Hours Counter Boot Cycle Counter Voltage and Current Monitoring Extreme Environment Status Internal Temperature Inclination and Installation Aid Vibration Humidity Storage U...

Page 259: ...CCM 0x061002 BVS ID M1280BF1 L3 090 0x061005 BVS ID M1280BF1 L3 090 CCM 0x061006 BVS ID M1280CF1 L3 000 0x061003 BVS ID M1280CF1 L3 000 CCM 0x061004 4 4 3 Process Data Profiles 4 4 3 1 Default PD Inp...

Page 260: ...R 10 bytes STRING n a Application Specific Tag 0x0018 24 0 R W 32 bytes STRING n a Function Tag 0x0019 25 0 R W 32 bytes STRING Yes Location Tag 0x001A 26 0 R W 32 bytes STRING Yes Product Type Code 0...

Page 261: ...asured values Moving Average Window Value 5 R W 2 bytes UINT16 No 100 Statistics Data Output 0x0427 1063 0 R 21 bytes n a Minimum 1 R 4 bytes FLOAT32 n a Maximum 2 R 4 bytes FLOAT32 n a Average 3 R 4...

Page 262: ...INT16 No 85 Lower Threshold Temperature 3 R W 2 bytes INT16 No 25 Lifetime Extreme Status 0x00D1 209 0 R 5 bytes n a State 1 R 1 byte UINT8 ENUM n a Time 2 R 4 bytes UINT32 n a Name Index Subindex Ac...

Page 263: ...n a Inclination Deviation Value 0x2154 8532 0 R 1 byte UINT8 n a Name Index Subindex Access Length Data type Data Storage Default Vibration Detection Vibration Level 0x210E 8462 0 R 4 bytes FLOAT32 n...

Page 264: ...Index Subindex Access Length Data type Data Storage Default Reset Commands System Commands 0x0002 2 0 W 1 byte UINT8 n a Name Index Subindex Access Length Data type Data Storage Default Variant Config...

Page 265: ...Application Reset 0x82 130 Reset Factory Settings 0xA5 165 Maintenance Reset 0xA7 167 Statistics Reset Resets all output parameters to 0 and all user settings to the default values 0xA8 168 Statistic...

Page 266: ...upply 2 Out of Specification 0x8CD0 36048 Warning Inclination alarm Check installation 1 Maintenance Required 0x8CD1 36049 Warning Vibration alarm Check machine 0 Device is operating properly 0x8CFF 3...

Page 267: ...esent 0 Device is operating properly 0x8D15 36117 Warning Overload at pin 2 check cabling 2 Out of Specification 0x8D20 36128 Warning Device Temperature Lower Warning The device temperature has fallen...

Page 268: ...the master to the device ProcessDataOut 0x00 0 Bit Manufacturer ID Vendor ID 0x378 Device identification Device ID 0x061001 In order to flexibly adapt the basic communication parameters to the applic...

Page 269: ...e Revision 0x0016 22 0 R 2 bytes STRING n a Firmware Revision 0x0017 23 0 R 10 bytes STRING n a Application Specific Tag 0x0018 24 0 R W 32 bytes STRING n a Function Tag 0x0019 25 0 R W 32 bytes STRIN...

Page 270: ...e in all variants 4 4 8 2 Device Discovery Description With the Device Discovery function an IO Link device can be found again by starting signaling on the LED of the device by means of a system comma...

Page 271: ...displayed here Subnet mask Here the subnet mask of the fixed IP configuration of the BVS ID can be set and read see SensorApp network settings Gateway address Here the gateway address of the fixed IP...

Page 272: ...al quality level is once again achieved The signal state is also indicated by an orange LED that illuminates if the signal quality is below the threshold value The function can be deactivated by setti...

Page 273: ...00C F 207 0 R 2 bytes n a Current Signal Quality 1 R 1 byte UINT8 n a Signal Quality Bad 2 R 1 Bit BOOL n a Low Signal Quality Threshold The threshold value for low signal quality can be set to monito...

Page 274: ...index 2 always results in FALSE 0x82 130 Reset Factory Settings Sets the threshold value with ISDU index 0xCE Low Signal Quality Threshold to default 0 The feature is thereby deactivated and the evalu...

Page 275: ...ealistic view of the calculation of minimum value maximum value and average As shown in the figure the calculation is initiated by the start command and stopped by the stop command The values are kept...

Page 276: ...escription Direction 0x0053 83 Minimum Minimum value Input 0x0054 84 Maximum Maximum value Input 0x0055 85 Average Average Input 0x0056 86 Moving Average Repeatedly calculated average value Input 0x00...

Page 277: ...T32 n a Average 3 R 4 bytes FLOAT32 n a Moving Average 4 R 4 bytes FLOAT32 n a Number Of Samples 5 R 4 bytes UINT32 n a Status 6 R 1 byte UINT8 n a Statistics Data Configuration Input Signal All data...

Page 278: ...n is made for Time Period Value a standard error is returned Time Period Unit Time Period Value value range Seconds 1 1000 Minutes 1 100 Hours 1 24 Days 1 7 Measurement values 1 1000 Statistics Data C...

Page 279: ...lue average function Statistics Data Output Status Bit position Meaning Description 0 Configured 1 all inputs are configured 1 Started Min Max Avg 1 Min Max Avg running 2 Started Moving Average 1 Movi...

Page 280: ...low 0 Device is operating properly 0x8D0E 36110 Notification The time has elapsed This event reports the timeout of the minimum value maximum value average calculation It does not report a timeout for...

Page 281: ...after 1 minute then after 2 minutes then after 4 minutes then after 8 minutes up to a maximum storage rate of 12 minutes Process Data Object ID Name Description Direction 0x001B 27 Current Operating H...

Page 282: ...orage interval than doubles after every save operation This is limited to a storage interval of 12 minutes The intervals are 1 2 4 8 12 minutes 0x01 1 Static Operating hours counters are stored every...

Page 283: ...0x0058 88 0 R 8 bytes n a Boot Cycle Counter 1 R 4 bytes UINT32 n a Custom Boot Cycle Counter 2 R 4 bytes UINT32 n a Boot Cycle Counter This parameter saves the value of the current boot cycle which i...

Page 284: ...RUE the voltage level at pin 1 3 is above the threshold value Input 0x0019 25 Cable break pin 4 TRUE cable break detected at pin 4 Input 0x001A 26 Cable break pin 2 TRUE cable break detected at pin 2...

Page 285: ...1 20753 Warning Primary supply voltage below minimum value Check for deviations in the supply 2 Out of Specification 0x8D0B 36107 Warning Overload or short circuit at pin 1 Check wiring 2 Out of Speci...

Page 286: ...ed total time in which the BVS ID was exposed to an extreme condition Input ISDU Name Index Subinde x Acces s Length Data Type Data Storage Default Lifetime Extreme Thresholds 0x00D0 208 0 R W 8 bytes...

Page 287: ...in seconds in which the BVS ID was exposed to an extreme condition can be read out System Commands Command Value Device Action 0x81 129 Application Reset Resets writable parameters to the default valu...

Page 288: ...s s Length Data Type Data Storage Default Device Temperature 0x0052 82 0 R 10 bytes n a Device Temperature 1 R 2 bytes INT16 n a Minimum Device Temperature Since Reset 2 R 2 bytes INT16 n a Maximum De...

Page 289: ...Overrun Clear Heat Of Source Risk of device damage The BVS ID is too hot Remove heat source provide the BVS ID e with heat insulation if necessary 2 Out of Specification 0x4220 16928 Warning Device Te...

Page 290: ...the axis or rotation around this axis cannot Measurement data for inclination detection Measurement range 0 180 Resolution 1 Accuracy 1 Measurement period 1000 ms data refresh rate 1 second With the i...

Page 291: ...on deviation is compared neither directly with the horizontal plane nor with the vertical gravitational field but rather with the orientation taught in by the end user In summary Inclination deviation...

Page 292: ...0x2153 8531 0 R 12 bytes n a X Reference Value 1 R 4 bytes FLOAT32 n a Y Reference Value 2 R 4 bytes FLOAT32 n a Z Reference Value 3 R 4 bytes FLOAT32 n a Inclination Deviation Value 0x2154 8532 0 R 1...

Page 293: ...mmands System Commands for teaching in and defining the reference orientation Command Vlaue Device Action 0xC0 192 Set Reference Orientation Sets the reference orientation of the actual position of th...

Page 294: ...16 g 16 g Mathematics Algorithm The example shows a typical application of vibration monitoring Application example with vibration frequency spectrum as input Total result of the measurement as output...

Page 295: ...de x Acces s Lenght Data Type Data Storage Default Vibration Level 0x210E 8462 0 R 4 bytes FLOAT32 n a Vibration Alarm Configuration 0x210F 8463 0 R W 5 bytes Yes Vibration Alarm Enable 1 R W 1 byte B...

Page 296: ...us The status flag is TRUE if the vibration exceeds the alarm threshold value 0 no alarm 255 alarm Events Event Code Event Type Event Description Remedy Device Status 0x8CD1 36049 Warning Vibration al...

Page 297: ...a Storage Default Humidity 0x005 C 92 0 R 9 bytes n a Humidity Bad 1 R 1 byte BOOL n a Operating Hours At Exceedance 2 R 4 bytes UINT32 n a Temperature At Exceedance 3 R 4 bytes INT32 n a Humidity Bad...

Page 298: ...ll data segments are protected with a CRC32 checksum Events Event Code Event Type Event Description Remedy Device Status 0x8D22 36130 Warning Warning limit for write cycles reached maintenance monitor...

Page 299: ...s UINT8 n a 0x00 0x00 0x00 Device Status The parameters are accessed via subindex 0 The output values are to be interpreted as follows Value Status Description 0 Device is operating properly BVS ID wo...

Page 300: ...ng on the number of entries Each entry in the list consists of the EventQualifier and the EventCode and has a data length of 3 bytes The total list can be queried via subindex 0 individual entries wit...

Page 301: ...Event Code Suppression 0x0071 113 0 R W 10 bytes Yes Event Code Suppression 1 5 R W 2 bytes UINT16 No 0 Event Code Suppression Teach in 0x0072 114 0 W 2 bytes UINT16 n a Event Code Suppression Delete...

Page 302: ...tored in non volatile memory Value 0x0000 0 is the default value and is interpreted as FREE Each event message is structured as follows Byte1 MSB Byte0 LSB Event Code High Byte Event Code Low Byte Eve...

Page 303: ...any change made to the parameter values 0x81 129 Application Reset This reset is performed using IO Link specification V1 1 2 Resets all parameters and device settings to default values except for th...

Page 304: ...ink compatibility mode the change in this parameter is visible immediately This parameter is not changed by a reset The following device variants are available Value Meaning Description 0x0001 1 Defau...

Page 305: ...s currently in teach in mode e g teach in of inclination detection Maintenance Required Blue static Maintenance must be performed E g threshold of the inclination is exceeded default function is switc...

Page 306: ...has been detected Bad Signal Quality Orange flashing 1 Hz Poor signal quality the quality of one code or several codes is below the configured warning threshold Out of Specification Yellow flashing 3...

Page 307: ...ta Type Data Storage Default Process Data Input Descriptor 0x000E 14 0 R 96 bytes UINT8 n a Process Data Output Descriptor 0x000F 15 0 R 96 bytes UINT8 n a PD Description This parameter is used to spe...

Page 308: ...sponding PD profile is not valid for this variant the default profile for the corresponding variant is selected Event Code Event Type Event Description Remedy Device Status 0x1850 6224 Notification Pr...

Page 309: ...ollowing profiles Profil ID Name Description 0x4000 Common Profile 0x0030 BLOB 0x0031 Firmware Update All individual functions are described in this guide For more exact descriptions of the profiles r...

Page 310: ...ypted with CA file The connection to the MQTT broker is established via an encrypted connection However the certificate provided by the broker for this purpose is additionally checked by the BVS ID us...

Page 311: ...s firmwareRevision 1 0 0 hardwareRevision 00 nameOfStation B00005521200115 productId BVS ID M1280CF1 L3 000 productInstanceUri https products balluff com BVS 20ID M1280CF1 L3 000 BVS0061 productName B...

Page 312: ...unit mm s balluff HOSTNAME diagnostics inclination Current inclination inclination value 175 unit balluff HOSTNAME diagnostics internalTemperature Current internal temperature internalTemperature val...

Page 313: ...esult data The result data includes all entries which are specified by the user in the Outputs tab of the configuration page Note that only one result is available which might originate from the previ...

Page 314: ...discarded since it was still busy with the analysis of the previous image triggerOverflow false balluff HOSTNAME vision status waitingForTrigger True if BVS ID is waiting for a trigger signal waiting...

Page 315: ...956115_AB EN E23 Subject to modification Replaces K22...

Page 316: ...hengshan Rd 8F Building A Yunding International Commercial Plaza 200125 Pudong Shanghai Phone 86 400 820 0016 Fax 86 400 920 2622 service cn balluff com cn DACH Service Center Germany Balluff GmbH Sch...

Reviews: