16. Weitere Schnittstellen
16.1. SSH öffentlichen Schlüssel abrufen
1/**
2* @brief SSH öffentlichen Schlüssel abrufen
3* @param [out] keygen Öffentlicher Schlüssel (als String-Array der Länge 1 übergeben)
4* @return Fehlercode
5*/
6int GetSSHKeygen(String[] keygen)
16.2. SCP-Befehl senden
Neu in Version Java: SDK-v1.0.6-3.8.3
1/**
2* @brief SCP-Befehl senden
3* @param [in] mode 0 - Hochladen (PC -> Controller), 1 - Herunterladen (Controller -> PC)
4* @param [in] sshname Benutzername auf dem PC
5* @param [in] sship IP-Adresse des PCs
6* @param [in] usr_file_url Dateipfad auf dem PC
7* @param [in] robot_file_url Dateipfad auf der Robotersteuerung
8* @return Fehlercode
9*/
10int SetSSHScpCmd(int mode, String sshname, String sship, String usr_file_url, String robot_file_url)
16.3. MD5-Wert einer Datei unter einem bestimmten Pfad berechnen
1/**
2* @brief MD5-Wert einer Datei unter einem bestimmten Pfad berechnen
3* @param [in] file_path Dateipfad inklusive Dateiname. Standard-Traj-Ordnerpfad: "/fruser/traj/", z.B. "/fruser/traj/trajHelix_aima_1.txt"
4* @param [out] md5 MD5-Wert der Datei (als String-Array der Länge 1 übergeben)
5* @return Fehlercode
6*/
7int ComputeFileMD5(String file_path, String[] md5)
16.4. Codebeispiel für SSH- und MD5-Befehle des Roboters
1public static int TestSSHMd5(Robot robot)
2{
3 String file_path= "/fruser/airlab.lua";
4 String[] md5 =new String[]{""};
5
6 String[] ssh_keygen=new String[]{""};
7 int retval = robot.GetSSHKeygen(ssh_keygen);
8 System.out.println(ssh_keygen[0]);
9
10 String ssh_name = "fr";
11 String ssh_ip = "192.168.58.45";
12 String ssh_route = "/home/fr";
13 String ssh_robot_url = "/root/robot/dhpara.config";
14 retval = robot.SetSSHScpCmd(1, ssh_name, ssh_ip, ssh_route, ssh_robot_url);
15 System.out.println("SetSSHScpCmd retval is:"+ retval);
16 System.out.println("robot url is:"+ ssh_robot_url);
17
18 robot.ComputeFileMD5(file_path, md5);
19 System.out.println("md5 is:+"+ md5[0]);
20 return 0;
21}
16.5. Rückmeldezyklus für den Roboter-Port 20004 einstellen
1/**
2* @brief Rückmeldezyklus für den Roboter-Port 20004 einstellen
3* @param [in] period Rückmeldezyklus für Port 20004 (ms)
4* @return Fehlercode
5*/
6public int SetRobotRealtimeStateSamplePeriod(int period)
16.6. Rückmeldezyklus für den Roboter-Port 20004 abrufen
1/**
2* @brief Rückmeldezyklus für den Roboter-Port 20004 abrufen
3* @return List[0]: Fehlercode; List[1]: Rückmeldezyklus für Port 20004 (ms)
4*/
5public List<Integer> GetRobotRealtimeStateSamplePeriod()
16.7. Codebeispiel für die Konfiguration des Statusrückmeldezyklus (Port 20004)
1public static int TestRealtimePeriod(Robot robot)
2{
3 robot.SetRobotRealtimeStateSamplePeriod(10);
4 List<Integer> getPeriod = new ArrayList<>();
5 getPeriod=robot.GetRobotRealtimeStateSamplePeriod();
6 robot.Sleep(1000);
7
8 return 0;
9}
16.8. Roboter-Software-Upgrade
1/**
2 * @brief Roboter-Software-Upgrade
3 * @param [in] filePath Vollständiger Pfad zum Software-Upgrade-Paket
4 * @param [in] block Blockierend bis zum Upgrade-Abschluss? true: blockierend, false: nicht blockierend
5 * @return Fehlercode
6 */
7public int SoftwareUpgrade(String filePath, boolean block)
16.9. Status des Roboter-Software-Upgrades abrufen
1/**
2* @brief Status des Roboter-Software-Upgrades abrufen
3* @return List[0]: Fehlercode; List[1]: Status (0 - inaktiv oder Upload läuft; 1~100 - Fortschritt in %; -1: Upgrade fehlgeschlagen; -2: Prüfsummenfehler; -3: Versionsprüfung fehlgeschlagen; -4: Entpacken fehlgeschlagen; -5: Upgrade der Benutzerkonfiguration fehlgeschlagen; -6: Upgrade der Peripheriekonfiguration fehlgeschlagen; -7: Upgrade der Erweiterungsachsenkonfiguration fehlgeschlagen; -8: Upgrade der Roboterko nfiguration fehlgeschlagen; -9: Upgrade der DH-Parameterkonfiguration fehlgeschlagen)
4*/
5public List<Integer> GetSoftwareUpgradeState()
16.10. Codebeispiel für Roboter-Software-Upgrade
1public static int TestUpgrade(Robot robot)
2{
3 robot.SoftwareUpgrade("D://zUP/QNX382/software.tar.gz", false);
4 while (true)
5 {
6 List<Integer> inter=new ArrayList<>();
7 inter=robot.GetSoftwareUpgradeState();
8 System.out.println("upgrade state is:"+ inter.get(1));
9 robot.Sleep(300);
10 }
11}
16.11. Punktetabellen-Datenbank herunterladen
1/**
2* @brief Punktetabellen-Datenbank herunterladen
3* @param [in] pointTableName Name der herunterzuladenden Punktetabelle, z.B. "pointTable1.db"
4* @param [in] saveFilePath Speicherpfad für die heruntergeladene Punktetabelle, z.B. "C://test/"
5* @return Fehlercode
6*/
7int PointTableDownLoad(String pointTableName, String saveFilePath);
16.12. Punktetabellen-Datenbank hochladen
1/**
2* @brief Punktetabellen-Datenbank hochladen
3* @param [in] pointTableFilePath Vollständiger Pfad zur hochzuladenden Punktetabelle, z.B. "C://test/pointTable1.db"
4* @return Fehlercode
5*/
6int PointTableUpLoad(String pointTableFilePath);
16.13. Lua-Datei mit Punktetabelle aktualisieren
1/**
2* @brief Lua-Datei mit Punktetabelle aktualisieren
3* @param [in] pointTableName Name der zu verwendenden Punktetabelle, z.B. "pointTable1.db". Wenn der Name leer ist (""), wird das Lua-Programm auf das ursprüngliche Programm ohne Punktetabelle zurückgesetzt.
4* @param [in] luaFileName Name der zu aktualisierenden Lua-Datei, z.B. "testPointTable.lua"
5* @param [out] errorStr Fehlermeldung beim Wechsel der Punktetabelle (als String-Array der Länge 1 übergeben)
6* @return Fehlercode
7*/
8int PointTableUpdateLua(String pointTableName, String luaFileName, String[] errorStr);
16.14. Codebeispiel für Roboter-Punktetabellen-Operationen
1public static int TestPointTable(Robot robot)
2{
3 String save_path = "D://zDOWN/";
4 String point_table_name = "point_table_FR5.db";
5 int rtn = robot.PointTableDownLoad(point_table_name, save_path);
6
7 String upload_path = "D://zUP/point_table_FR5.db";
8 rtn = robot.PointTableUpLoad(upload_path);
9
10 String point_tablename = "point_table_FR5.db";
11 String lua_name = "airlab.lua";
12 String err="";
13 rtn = robot.PointTableUpdateLua(point_tablename, lua_name,err);
14
15 robot.CloseRPC();
16 return 0;
17}
16.15. Controller-Protokolle herunterladen
Neu in Version Java: SDK-v1.0.4-3.8.1
1/**
2* @brief Controller-Protokolle herunterladen
3* @param [in] savePath Pfad zum Speichern der Datei, z.B. "D://zDown/"
4* @return Fehlercode
5*/
6int RbLogDownload(String savePath);
16.16. Alle Datenquellen herunterladen
Neu in Version Java: SDK-v1.0.4-3.8.1
1/**
2* @brief Alle Datenquellen herunterladen
3* @param [in] savePath Pfad zum Speichern der Datei, z.B. "D://zDown/"
4* @return Fehlercode
5*/
6int AllDataSourceDownload(String savePath);
16.17. Daten-Backup-Paket herunterladen
Neu in Version Java: SDK-v1.0.4-3.8.1
1/**
2* @brief Daten-Backup-Paket herunterladen
3* @param [in] savePath Pfad zum Speichern der Datei, z.B. "D://zDown/"
4* @return Fehlercode
5*/
6int DataPackageDownload(String savePath);
16.18. Codebeispiel zum Herunterladen von Controller-Daten
1public static int TestDownLoadRobotData(Robot robot)
2{
3 int rtn = robot.RbLogDownload("D://zDOWN/");
4
5 rtn = robot.AllDataSourceDownload("D://zDOWN/");
6
7 rtn = robot.DataPackageDownload("D://zDOWN/");
8 return 0;
9}
16.19. Encoder-Upgrade einstellen
Neu in Version Java: SDK-v1.0.7-3.8.4
1/**
2* @brief Encoder-Upgrade einstellen
3* @param [in] path Vollständiger Pfad zum lokalen Upgrade-Paket (z.B. D://zUP/XXXXX.bin)
4* @return Fehlercode
5*/
6int SetEncoderUpgrade(String path)
16.20. Gelenk-Firmware-Upgrade einstellen
Neu in Version Java: SDK-v1.0.7-3.8.4
1/**
2* @brief Gelenk-Firmware-Upgrade einstellen
3* @param [in] type Dateityp für das Upgrade: 1 - Firmware-Upgrade, 2 - Upgrade der Slave-Konfigurationsdatei
4* @param [in] path Vollständiger Pfad zum lokalen Upgrade-Paket (z.B. D://zUP/XXXXX.bin)
5* @return Fehlercode
6*/
7public int SetJointFirmwareUpgrade(int type, String path)
16.21. Steuerkasten-Firmware-Upgrade einstellen
Neu in Version Java: SDK-v1.0.7-3.8.4
1/**
2* @brief Steuerkasten-Firmware-Upgrade einstellen
3* @param [in] type Dateityp für das Upgrade: 1 - Firmware-Upgrade, 2 - Upgrade der Slave-Konfigurationsdatei
4* @param [in] path Vollständiger Pfad zum lokalen Upgrade-Paket (z.B. D://zUP/XXXXX.bin)
5* @return Fehlercode
6*/
7public int SetCtrlFirmwareUpgrade(int type, String path)
16.22. Endeffektor-Firmware-Upgrade einstellen
Neu in Version Java: SDK-v1.0.7-3.8.4
1/**
2* @brief Endeffektor-Firmware-Upgrade einstellen
3* @param [in] type Dateityp für das Upgrade: 1 - Firmware-Upgrade, 2 - Upgrade der Slave-Konfigurationsdatei
4* @param [in] path Vollständiger Pfad zum lokalen Upgrade-Paket (z.B. D://zUP/XXXXX.bin)
5* @return Fehlercode
6*/
7public int SetEndFirmwareUpgrade(int type, String path)
16.23. Upgrade der vollständigen Gelenkparameter-Konfigurationsdatei
Neu in Version Java: SDK-v1.0.7-3.8.4
1/**
2* @brief Upgrade der vollständigen Gelenkparameter-Konfigurationsdatei
3* @param [in] path Vollständiger Pfad zum lokalen Upgrade-Paket (z.B. D://zUP/XXXXX.bin)
4* @return Fehlercode
5*/
6public int JointAllParamUpgrade(String path)
16.24. Codebeispiel für Roboter-Slave-Firmware-Upgrade
1public static void TestFirmWareUpgrade(Robot robot)
2{
3 robot.RobotEnable(0);
4 robot.Sleep(200);
5 int rtn = robot.JointAllParamUpgrade("D://zUP/standardQX/jointallparametersFR56.0.db");
6 System.out.println("robot JointAllParamUpgrade rtn is:"+ rtn);
7
8 rtn = robot.SetCtrlFirmwareUpgrade(2, "D://zUP/upgrade/FAIR_Cobot_Cbd_Asix_V2.0.bin");
9 System.out.println("robot SetCtrlFirmwareUpgrade config param rtn is:"+ rtn);
10
11 rtn = robot.SetEndFirmwareUpgrade(2, "D://zUP/upgrade/FAIR_Cobot_Axle_Asix_V2.4.bin");
12 System.out.println("robot SetEndFirmwareUpgrade config param rtn is:"+ rtn);
13
14 robot.SetSysServoBootMode();
15 rtn = robot.SetCtrlFirmwareUpgrade(1, "D://zUP/standardQX/FR_CTRL_PRIMCU_FV201010_MAIN_U4_T01_20240529.bin");
16 System.out.println("robot SetCtrlFirmwareUpgrade rtn is:"+ rtn);
17
18 rtn = robot.SetEndFirmwareUpgrade(1, "D://zUP/standardQX/FR_END_FV201010_MAIN_U01_T01_20250522.bin");
19 System.out.println("robot SetEndFirmwareUpgrade rtn is:"+ rtn);
20
21 rtn = robot.SetJointFirmwareUpgrade(1, "D://zUP/standardQX/FR_SERVO_FV502211_MAIN_U7_T07_20250217.bin");
22 System.out.println("robot SetJointFirmwareUpgrade rtn is:"+ rtn);
23
24 robot.CloseRPC();
25}
16.25. Upgrade des Roboter-Betriebssystems (LA-Steuerkasten)
Neu in Version Java: SDK-v1.0.9-3.8.6
1/**
2 * @brief Upgrade des Roboter-Betriebssystems (LA-Steuerkasten)
3 * @param [in] filePath Vollständiger Pfad zum Betriebssystem-Upgrade-Paket
4 * @return Fehlercode
5 */
6public int KernelUpgrade(String filePath)
16.26. Ergebnis des Roboter-Betriebssystem-Upgrades abrufen (LA-Steuerkasten)
Neu in Version Java: SDK-v1.0.9-3.8.6
1/**
2 * @brief Ergebnis des Roboter-Betriebssystem-Upgrades abrufen (LA-Steuerkasten)
3 * @param [out] result Upgrade-Ergebnis (als int-Array der Länge 1 übergeben): 0 = Erfolg, -1 = Fehlschlag
4 * @return Fehlercode
5 */
6public int GetKernelUpgradeResult(int[] result)
16.27. Roboter-MCU-Protokoll generieren
1/**
2* @brief Roboter-MCU-Protokoll generieren
3* @return Fehlercode
4*/
5public int RobotMCULogCollect()
16.28. Roboter bei getrennter Port-Kommunikation stoppen
1/**
2* @brief Roboter bei getrennter Port-Kommunikation stoppen
3* @param portID Portnummer 0-8080; 1-8083; 2-20002; 3-20004
4* @param enable 0-deaktiviert; 1-aktiviert
5* @param confirmTime Bestätigungsdauer der Kommunikationsunterbrechung (ms)[0-5000]
6* @return Fehlercode
7*/
8public int SetRobotStopOnComDisc(int portID, bool enable, int confirmTime)
16.29. Parameter für Roboterstopp bei Kommunikationsunterbrechung abrufen
1/**
2* @brief Parameter für Roboterstopp bei Kommunikationsunterbrechung abrufen
3* @param portID Portnummer 0-8080; 1-8083; 2-20002; 3-20004
4* @param enable Ergebnisarray, Index 0: 0-deaktiviert; 1-aktiviert
5* @param confirmTime Ergebnisarray, Index 0: Bestätigungsdauer der Kommunikationsunterbrechung (ms)[0-5000]
6* @return Fehlercode
7*/
8public int GetRobotStopOnComDisc(int portID, int[] enable, int[] confirmTime)
16.30. Codebeispiel für Parameter Roboterstopp bei Kommunikationsunterbrechung
1void TestRobotStopOnComDisc(Robot robot)
2{
3 int[] enable = {0};
4 int[] confirmTime = {0};
5 int rtn = 0;
6 rtn = robot.SetRobotStopOnComDisc(0, true, 330);
7 rtn = robot.SetRobotStopOnComDisc(1, true, 550);
8 rtn = robot.SetRobotStopOnComDisc(2, true, 110);
9 rtn = robot.SetRobotStopOnComDisc(3, true, 220);
10 System.out.printf("SetRobotStopOnComDisc %d\n", rtn);
11
12 robot.GetRobotStopOnComDisc(0, enable, confirmTime);
13 System.out.printf("GetRobotStopOnComDisc 8080 rtn %d; enable is %d; confirm time is %d\n", rtn, enable[0], confirmTime[0]);
14 robot.GetRobotStopOnComDisc(1, enable, confirmTime);
15 System.out.printf("GetRobotStopOnComDisc 8083 rtn %d; enable is %d; confirm time is %d\n", rtn, enable[0], confirmTime[0]);
16 robot.GetRobotStopOnComDisc(2, enable, confirmTime);
17 System.out.printf("GetRobotStopOnComDisc 20002 rtn %d; enable is %d; confirm time is %d\n", rtn, enable[0], confirmTime[0]);
18 robot.GetRobotStopOnComDisc(3, enable, confirmTime);
19 System.out.printf("GetRobotStopOnComDisc 20004 rtn %d; enable is %d; confirm time is %d\n", rtn, enable[0], confirmTime[0]);
20
21 return;
22}
16.31. UDP-Befehlframe senden
1/**
2* @brief UDP-Befehlframe senden
3* @param frame Befehlframe
4* @return Fehlercode
5*/
6public int SendUDPFrame(String frame)
16.32. SDK-Codebeispiel für UDP-Kommunikation
1public static void TestRobotUDP (Robot robot) {
2 robot.udpCmdClient.SetUDPCmdRpyCallback((srcType, count, cmdID, dataLen, content) -> {
3 System.out.println("\n[Roboter-UDP-Antwort erhalten]");
4 System.out.println("srcType: " + srcType);
5 System.out.println("count: " + count);
6 System.out.println("cmdID: " + cmdID);
7 System.out.println("dataLen: " + dataLen);
8 System.out.println("Inhalt: " + content);
9 return 0;
10 });
11 // Frame senden
12 String frameToSend = "/f/bIII52III236III7IIIMode(1)III/b/f";
13 robot.SendUDPFrame(frameToSend);
14 robot.Sleep(2000);
15 frameToSend = "/f/bIII52III236III7IIIMode(0)III/b/f";
16 robot.SendUDPFrame(frameToSend);
17 robot.Sleep(2000);
18 frameToSend = "/f/bIII41III201III153IIIMoveJ(53.857,-89.441,119.453,-22.664,61.059,3.369,-54.249,-491.930,375.396,96.474,-6.896,-7.783,0,0,100,100,100,0.000,0.000,0.000,0.000,-1,0,0,0,0,0,0,0)III/b/f";
19 robot.SendUDPFrame(frameToSend);
20 robot.Sleep(2000);
21 frameToSend = "/f/bIII42III203III163IIIMoveL(81.736,-85.284,114.974,-23.261,88.746,6.799,125.744,-506.570,375.396,96.474,-6.896,-7.783,0,0,100,100,100,-1,0,0.000,0.000,0.000,0.000,0,0,0,0,0,0,0,0,100,0)III/b/f";
22 robot.SendUDPFrame(frameToSend);
23 robot.Sleep(2000);
24 frameToSend = "/f/bIII47III400III15IIIGetMCVersion(1)III/b/f/f/bIII48III424III21IIIGetSlaveFirmVersion()III/b/f";
25 robot.SendUDPFrame(frameToSend);
26 robot.Sleep(2000);
27}
16.33. Benutzerdefinierte LED-Farbe des Roboterendeffektors einstellen
1/**
2* @brief Benutzerdefinierte LED-Farbe des Roboterendeffektors einstellen
3* @param r End-Rot-LED-Steuerung; 0-aus; 1-ein
4* @param g End-Grün-LED-Steuerung; 0-aus; 1-ein
5* @param b End-Blau-LED-Steuerung; 0-aus; 1-ein
6* @return Fehlercode
7*/
8public int SetUserLEDColor(bool r, bool g, bool b)
16.34. SDK-Codebeispiel zum Einstellen der benutzerdefinierten LED-Farbe des Roboterendeffektors
1public void testled(robot)
2{
3 robot.SetUserLEDColor(true, true, true);
4 robot.Sleep(1000);
5 robot.SetUserLEDColor(false, false, false);
6 robot.Sleep(1000);
7 robot.SetUserLEDColor(true, false, false);
8 robot.Sleep(1000);
9 robot.SetUserLEDColor(false, true, false);
10 robot.Sleep(1000);
11 robot.SetUserLEDColor(false, false, true);
12}