Skip to content

Mit KI weiterarbeiten

Mit KI weiterarbeiten

Primärschnittstelle (XML RPC) ​

Ausführen von Methoden, wobei die Datenübertragung per http erfolgt. Die zu übertragenen Daten besitzen dabei eine XML-Formatierung.

Dieser Artikel ist sowohl für alle horstOS-Versionen, wie auch für horstFX gültig.

Die zu übertragenen Daten besitzen dabei eine XML-Formatierung. XML-RPC ist sprachenunabhängig, daher gibt es XML-RPC Clients in diversen Programmiersprachen, somit ist eine Integration in bestehende Projekte leicht möglich. Die Befehle werden unabhängig von der Programmiersprache beschrieben.
Für einen erleichterten Einstieg werden mehrere Beispiel-Clients zur Verfügung gestellt.

Dieser Artikel beschreibt wie über die Externe Schnittstelle die unten beschriebenen Aktionen ausgeführt werden können. Hierfür muss zuerst eine Verbindung mit dem Roboter hergestellt werden. Dies kann in dem Artikel Python 3: Verbindung mit dem Roboter herstellen nachgelesen werden.

horstOS/FX-Version: 2020.10 und neuer

1. Ansicht wechseln ​

1.1 Befehl

HorstFX.Activity.switchActivity(id)

1.2 Parameter

Welche Ansicht welcher ID zugeteilt wurde, kann in dem Artikel Dokumentation Ansichten horstOS/FX nachgelesen werden.

NameBeschreibungBeispielwert
idID der entsprechenden Ansicht0

1.3 Rückgabewert

true bei Erfolg.

2. Auf aktuelle Gelenkwinkel zugreifen ​

2.1 Befehl

HorstFX.Robotcontrol.getCurrentRobotJoints()

2.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

2.3 Rückgabewert

Liefert bei Erfolg eine Map zurück.

Gelenkwinkel werden in Grad angegeben.

NameBeschreibung
j1Achse 1
j2Achse 2
j3Achse 3
j4Achse 4
j5Achse 5
j6Achse 6

3. Auf aktuelle Pose zugreifen ​

3.1 Befehl

HorstFX.Robotcontrol.getCurrentRobotPose()

3.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

3.3 Rückgabewert

Liefert bei Erfolg eine Map zurück.

NameBeschreibung
xX-Koordinate im Basis-Koordinatensystem
yY-Koordinate im Basis-Koordinatensystem
zZ-Koordinate im Basis-Koordinatensystem
q0Quaternion 0
q1Quaternion 1
q2Quaternion 2
q3Quaternion 3
rxEulerwinkel X
ryEulerwinkel Y
rzEulerwinkel Z

4. Ausgang schalten ​

4.1 Befehl

HorstFX.Robotcontrol.setOutput(outputName, value)

4.2 Parameter

Name
Beschreibung
Beispielwert
outputNameName des Ausgangs"OUTPUT_1"
valueWert der gesetzt werden soll1

4.3 Rückgabewert

true bei Erfolg

5. Betriebsmoduswechsel bestätigen ​

5.1 Befehl

HorstFX.Safety.confirmChangeOperationMode()

5.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

5.3 Rückgabewert

true wenn der Betriebsmoduswechsel quittiert werden konnten.

6. Bool Register lesen ​

6.1 Befehl

HorstFX.Variable.getBoolRegister(registerIndex)

6.2 Parameter

Name
Beschreibung
Beispielwert
registerIndexIndexposition des Registers (0-127)0

6.3 Rückgabewert

aktueller Wert des angefragten Registers (Bool-Wert)

7. Bool Register schreiben ​

7.1 Befehl

HorstFX.Variable.setBoolRegister(registerIndex, value)

7.2 Parameter

Name
Beschreibung
Beispielwert
valueWert der gesetzt werden solltrue
registerIndexIndexposition des Bool Registers (0-127)0

7.3 Rückgabewert

true bei Erfolg

8. Eingang lesen ​

8.1 Befehl

HorstFX.Robotcontrol.getInput(inputName)

8.2 Parameter

Name
Beschreibung
Beispielwert
inputNameName des Eingangs"INPUT_1"

8.3 Rückgabewert

aktueller Wert des angefragten Inputs (Int-Wert)

9. Erweiterter Move-Befehl ​

9.1 Befehl

HorstFX.Robotcontrol.moveAdvanced(configMap)

9.2 Parameter

configMapMap <String, Object>

Die Map besitzt die gleichen Pflicht und Optionionale Parameter wie der erweiterte Move-Befehl im textuellen Programmiern.

Eine detaillierte Beschreibung ist in dem Artikel Erweiterter move Befehl zu finden.

9.3 Rückgabewert

true bei Erfolg

10. externer Nothalt quittieren ​

Kann nur quittiert werden, wenn der externe Nothalt zurückgesetzt wurde.

10.1 Befehl

HorstFX.Safety.confirmExternalEmergencyStop()

10.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

10.3 Rückgabewert

true wenn der externe Nothalt quittiert werden konnte.

11. Float Register lesen ​

11.1 Befehl

HorstFX.Variable.getFloatRegister(registerIndex)

11.2 Parameter

Name
Beschreibung
Beispielwert
registerIndexIndexposition des Registers (0-63)0

11.3 Rückgabewert

aktueller Wert des angefragten Registers (Float-Wert)

12. Float Register schreiben ​

12.1 Befehl

HorstFX.Variable.setFloatRegister(registerIndex, value)

12.2 Parameter

Name
Beschreibung
Beispielwert
registerIndexIndexposition des Float Registers (0-63)0
valueWert der gesetzt werden soll13.37

12.3 Rückgabewert

true bei Erfolg

13. Globale Geschwindigkeit auslesen ​

13.1 Befehl

HorstFX.Program.getGlobalSpeed()

13.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

13.3 Rückgabewert

aktueller globale Geschwindigkeit (Float-Wert zwischen 0 - 1 (0 - 100%))

14. Globale Geschwindigkeit setzen ​

14.1 Befehl

HorstFX.Program.setGlobalSpeed(globalSpeed)

14.2 Parameter

Name
Beschreibung
Beispielwert
globalSpeedNeuer Wert für die globale Geschwindigkeit0.5

14.3 Rückgabewert

true bei Erfolg

15. Interne Fehler quittieren ​

15.1 Befehl

HorstFX.Safety.confirmInternalError()

15.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

15.3 Rückgabewert

true wenn die internen Fehler quittiert werden konnten.

16. Int Register lesen ​

16.1 Befehl

HorstFX.Variable.getIntRegister(registerIndex)

16.2 Parameter

Name
Beschreibung
Beispielwert
registerIndexIndexposition des Registers (0-63)0

16.3 Rückgabewert

aktueller Wert des angefragten Registers (Int-Wert)

17. Int Register schreiben ​

17.1 Befehl

HorstFX.Variable.setIntRegister(registerIndex, value)

17.2 Parameter

Name
Beschreibung
Beispielwert
registerIndexIndexposition des Int Registers (0-63)0
valueWert der gesetzt werden soll42

17.3 Rückgabewert

true bei Erfolg

18. Joint Bewegung ​

18.1 Befehl

HorstFX.Robotcontrol.moveJoint(x, y, z, q0, q1, q2, q3, speed)

18.2 Parameter

Name
Beschreibung
Beispielwert
xX-Koordinate im Basis-Koordinatensystem0.50975
yY-Koordinate im Basis-Koordinatensystem0.0
zZ-Koordinate im Basis-Koordinatensystem0.82743
q0

Quaternion 0

0.7071
q1Quaternion 10
q2Quaternion 20.7071
q3Quaternion 30
speedGeschwindigkeit in Prozent (0-1)0.5

18.3 Rückgabewert

true bei Erfolg

19. Lineare Bewegung ​

Je nach Stellung des Roboters kann ein linearer Pfad nicht ausgeführt werden. Dies geschieht zum Beispiel wenn der Roboter mit sich selbst kollidieren würde, oder die Bewegung aufgrund der Kinematik nicht linear abgefahren werden kann.

19.1 Befehl

HorstFX.Robotcontrol.moveLinear(x, y, z, q0, q1, q2, q3, speed)

19.2 Parameter

Name
Beschreibung
Beispielwert
xX-Koordinate im Basis-Koordinatensystem0.50975
yY-Koordinate im Basis-Koordinatensystem0.0
zZ-Koordinate im Basis-Koordinatensystem0.82743
q0

Quaternion 0

0.7071
q1Quaternion 10
q2Quaternion 20.7071
q3Quaternion 30
speedGeschwindigkeit in Prozent (0-1)0.5

19.3 Rückgabewert

true bei Erfolg

20. nächsten Joints lesen ​

20.1 Befehl

HorstFX.Variable.getNextJoints(

20.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

20.3 Rückgabewert

Liefert bei Erfolg eine Map zurück.

| Name

|

Beschreibung

| | --- | --- | | j1 | Gelenkwinkel Achse 1 | | j2 | Gelenkwinkel Achse 2 | | j3 | Gelenkwinkel Achse3 | | j4 | Gelenkwinkel Achse 4 | | j5 | Gelenkwinkel Achse 5 | | j6 | Gelenkwinkel Achse 6 |

21. nächsten Joints setzen ​

21.1 Befehl

HorstFX.Variable.nextJoints(j1, j2, j3, j4, j5, j6)

21.2 Parameter

Name
Beschreibung
Beispielwert
j1Gelenkwinkel Achse 110
j2Gelenkwinkel Achse 2-5
j3Gelenkwinkel Achse 315
j4

Gelenkwinkel Achse 4

20
j5Gelenkwinkel Achse 50
j6Gelenkwinkel Achse 6100

21.3 Rückgabewert

true bei Erfolg

22. nächste Pose setzen ​

22.1 Befehl

HorstFX.Variable.nextPose(x, y, z, q0, q1, q2, q3, )

22.2 Parameter

Name
Beschreibung
Beispielwert
xX-Koordinate im Basis-Koordinatensystem0.50975
yY-Koordinate im Basis-Koordinatensystem0.0
zZ-Koordinate im Basis-Koordinatensystem0.82743
q0

Quaternion 0

0.7071
q1Quaternion 10
q2Quaternion 20.7071
q3Quaternion 30

22.3 Rückgabewert

true bei Erfolg

23. Nothalt quittieren ​

Kann nur quittiert werden, wenn der Nothalt am PANEL gelöst wurde.

23.1 Befehl

HorstFX.Safety.confirmEmergencyStop()

23.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

23.3 Rückgabewert**

true wenn der Nothalt quittiert werden konnte.

24. Programm abbrechen ​

24.1 Befehl

HorstFX.Program.abort()

24.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

24.3 Rückgabewert

true wenn das Programm abgebrochen werden kann.

25. Programm pausieren ​

25.1 Befehl

HorstFX.Program.pause()

25.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

25.3 Rückgabewert

true wenn das Programm gestoppt werden kann.

26. Programm senden und starten ​

26.1 Befehl

HorstFX.Program.execute()

26.2 Parameter

| Name

|

Beschreibung

| | --- | --- | | program | horstSCRIPT Programm als String |

26.3 Rückgabewert

true wenn das Programm gesendet und gestartet wurde.

27. Programm starten ​

27.1 Befehl

HorstFX.Program.play()

27.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

27.3 Rückgabewert

true wenn das Programm gestartet werden kann.

28. Programm weiter laufen lassen ​

28.1 Befehl

HorstFX.Program.proceed()

28.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

28.3 Rückgabewert

true wenn das Programm wieder gestartet werden kann.

29. Prüfen ob Programm ausgeführt wird ​

29.1 Befehl

HorstFX.Program.isRunning()

29.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

29.3 Rückgabewert

true wenn aktuell ein Programm ausgeführt wird.

30. Roboter Status abfragen ​

30.1 Befehl

HorstFX.Safety.status()

30.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

30.3 Rückgabewert

Liefert einen Text zurück, der den Fehler beschreibt. Falls kein Fehler vorliegt wird "OK" zurückgeliefert.

31. Tool ändern ​

31.1 Befehl

HorstFX.Robotcontrol.setTool(toolName)

31.2 Parameter

Name
Beschreibung
Beispielwert
toolNameName des Tools"No Tool"

31.3 Rückgabewert

true bei wenn das entsprechende Tool gefunden und gesetzt wurde.

32. Tool-Offset auslesen ​

4.1 Befehl

HorstFX.Robotcontrol.getToolOffset(toolName)

4.2 Parameter

Diese Funktion besitzt keine Funktionsargumente.

5.3 Rückgabewert

Liefert bei Erfolg eine Map zurück.

| Name

|

Beschreibung

| | --- | --- | | x | X-Koordinate im Basis-Koordinatensystem | | y | Y-Koordinate im Basis-Koordinatensystem | | z | Z-Koordinate im Basis-Koordinatensystem | | rx | Eulerwinkel X | | ry | Eulerwinkel Y | | rz | Eulerwinkel Z |