15. Outras Interfaces
15.1. Obter Chave Pública SSH
1/**
2* @brief Obter chave pública SSH
3* @param [out] keygen Chave pública
4* @return Código de erro
5*/
6int GetSSHKeygen(ref string keygen);
15.2. Enviar Comando SCP
Novo na versão C#SDK-V1.1.4: Web-3.8.3
1/**
2* @brief Enviar comando SCP
3* @param [in] mode 0-upload (PC -> controlador), 1-download (controlador -> PC)
4* @param [in] sshname Nome de usuário do PC
5* @param [in] sship Endereço IP do PC
6* @param [in] usr_file_url Caminho do arquivo no PC
7* @param [in] robot_file_url Caminho do arquivo no controlador do robô
8* @return Código de erro
9*/
10int SetSSHScpCmd(int mode, string sshname, string sship, string usr_file_url, string robot_file_url);
15.3. Calcular o Valor MD5 de um Arquivo em um Caminho Especificado
1/**
2* @brief Calcular o valor MD5 de um arquivo em um caminho especificado
3* @param [in] file_path Caminho do arquivo incluindo o nome do arquivo. O caminho padrão da pasta Traj é: "/fruser/traj/", ex: "/fruser/traj/trajHelix_aima_1.txt"
4* @param [out] md5 Valor MD5 do arquivo
5* @return Código de erro
6*/
7int ComputeFileMD5(string file_path, ref string md5);
15.4. Exemplo de Código de Comandos SSH e MD5 do Robô
Novo na versão C#SDK-V1.1.4: Web-3.8.3
1private void button46_Click(object sender, EventArgs e)
2{
3 string file_path = "/fruser/airlab.lua";
4 string md5 = "";
5 byte emerg_state = 0;
6 byte si0_state = 0;
7 byte si1_state = 0;
8 int sdk_com_state = 0;
9
10 string ssh_keygen = "";
11 int retval = robot.GetSSHKeygen(ref ssh_keygen);
12 Console.WriteLine("GetSSHKeygen retval is: {0}", retval);
13 Console.WriteLine("ssh key is: {0}", ssh_keygen);
14
15 string ssh_name = "fr";
16 string ssh_ip = "192.168.58.45";
17 string ssh_route = "/home/fr";
18 string ssh_robot_url = "/root/robot/dhpara.config";
19 retval = robot.SetSSHScpCmd(1, ssh_name, ssh_ip, ssh_route, ssh_robot_url);
20 Console.WriteLine("SetSSHScpCmd retval is: {0}", retval);
21 Console.WriteLine("robot url is: {0}", ssh_robot_url);
22
23 robot.ComputeFileMD5(file_path, ref md5);
24 Console.WriteLine("md5 is: {0}", md5);
25}
15.5. Definir o Período de Feedback da Porta 20004 do Robô
1/**
2* @brief Definir o período de feedback da porta 20004 do robô
3* @param [in] period Período de feedback da porta 20004 do robô (ms)
4* @return Código de erro
5*/
6int SetRobotRealtimeStateSamplePeriod(int period);
15.6. Obter o Período de Feedback da Porta 20004 do Robô
1/**
2* @brief Obter o período de feedback da porta 20004 do robô
3* @param [out] period Período de feedback da porta 20004 do robô (ms)
4* @return Código de erro
5*/
6int GetRobotRealtimeStateSamplePeriod(ref int period);
15.7. Exemplo de Código de Configuração do Período de Feedback de Estado da Porta 20004 do Robô
1private void button47_Click(object sender, EventArgs e)
2{
3 robot.SetRobotRealtimeStateSamplePeriod(10);
4 int getPeriod = 0;
5 robot.GetRobotRealtimeStateSamplePeriod(ref getPeriod);
6 Console.WriteLine("period is {0}", getPeriod);
7 Thread.Sleep(1000);
8}
15.8. Atualização de Software do Robô
1/**
2* @brief Atualização de software do robô
3* @param [in] filePath Caminho completo do pacote de atualização de software
4* @param [in] block Bloquear até a conclusão da atualização? true: bloqueante; false: não bloqueante
5* @return Código de erro
6*/
7int SoftwareUpgrade(string filePath, bool block);
15.9. Obter o Status da Atualização de Software do Robô
1/**
2* @brief Obter o status da atualização de software do robô
3* @param [out] state Status da atualização do pacote de software do robô: 0-ocioso ou enviando pacote de atualização; 1~100: porcentagem de conclusão da atualização; -1: falha na atualização do software; -2: falha na verificação; -3: falha na verificação de versão; -4: falha na descompactação; -5: falha na atualização da configuração do usuário; -6: falha na atualização da configuração do periférico; -7: falha na atualização da configuração do eixo extensor; -8: falha na atualização da configuração do robô; -9: falha na atualização da configuração dos parâmetros DH
4* @return Código de erro
5*/
6int GetSoftwareUpgradeState(ref int state);
15.10. Exemplo de Código de Atualização de Software do Robô
1private void button48_Click(object sender, EventArgs e)
2{
3 robot.SoftwareUpgrade("D://zUP/QNX382/software.tar.gz", false);
4 while (true)
5 {
6 int curState = -1;
7 robot.GetSoftwareUpgradeState(ref curState);
8 Console.WriteLine("upgrade state is {0}", curState);
9 Thread.Sleep(300);
10 }
11}
15.11. Baixar Tabela de Pontos
1/**
2* @brief Baixar tabela de pontos do controlador do robô para o computador local
3* @param [in] pointTableName Nome da tabela de pontos no controlador: pointTable1.db
4* @param [in] saveFilePath Caminho para onde a tabela de pontos será baixada no computador C://test/
5* @return Código de erro
6*/
7int PointTableDownLoad(string pointTableName, string saveFilePath);
15.12. Enviar Tabela de Pontos
1/**
2* @brief Enviar tabela de pontos do computador local para o controlador do robô
3* @param [in] pointTableFilePath Caminho absoluto da tabela de pontos no computador local C://test/pointTable1.db
4* @return Código de erro
5*/
6int PointTableUpLoad(string pointTableFilePath);
15.13. Atualizar Programa Lua com a Tabela de Pontos
1/**
2* @brief Atualizar pontos em um programa Lua usando a tabela de pontos fornecida
3* @param [in] pointTableName Nome da tabela de pontos no controlador: "pointTable1.db". Quando a tabela de pontos está vazia, ou seja, "", indica que o programa Lua deve ser atualizado para o programa inicial sem a aplicação da tabela de pontos.
4* @param [in] luaFileName Nome do arquivo Lua a ser atualizado: "test.lua"
5* @param [out] errorStr Mensagem de erro da atualização do programa Lua com a tabela de pontos
6* @return Código de erro
7*/
8int PointTableUpdateLua(string pointTableName, string luaFileName, ref string errorStr);
15.14. Alternar e Aplicar Tabela de Pontos
1/**
2* @brief Alternar e aplicar tabela de pontos
3* @param [in] pointTableName Nome da tabela de pontos para alternar: "pointTable1.db"
4* @param [out] errorStr Mensagem de erro da alternância da tabela de pontos
5* @return Código de erro
6*/
7int PointTableSwitch(string pointTableName, ref string errorStr);
15.15. Exemplo de Código de Operações com Tabela de Pontos do Robô
1private void btnUpload_Click(object sender, EventArgs e)
2{
3 string save_path = "D://zDOWN/";
4 string point_table_name = "test_point_A.db";
5 int rtn = robot.PointTableDownLoad(point_table_name, save_path);
6 Console.WriteLine("download : {0} fail: {1}", point_table_name, rtn);
7
8 string upload_path = "D://zUP/test_point_A.db";
9 rtn = robot.PointTableUpLoad(upload_path);
10 Console.WriteLine("retval is: {0}", rtn);
11
12 string point_tablename = "test_point_A.db";
13 string lua_name = "Text1.lua";
14
15 string errorStr = "";
16 rtn = robot.PointTableUpdateLua(point_tablename, lua_name, ref errorStr);
17 Console.WriteLine("retval is: {0}", rtn);
18}
15.16. Baixar Log do Controlador
1/**
2* @brief Baixar log do controlador
3* @param [in] savePath Caminho para salvar o arquivo "D://zDown/"
4* @return Código de erro
5*/
6int RbLogDownload(string savePath);
15.17. Baixar Todas as Fontes de Dados
1/**
2* @brief Baixar todas as fontes de dados
3* @param [in] savePath Caminho para salvar o arquivo "D://zDown/"
4* @return Código de erro
5*/
6int AllDataSourceDownload(string savePath);
15.18. Baixar Pacote de Backup de Dados
1/**
2* @brief Baixar pacote de backup de dados
3* @param [in] savePath Caminho para salvar o arquivo "D://zDown/"
4* @return Código de erro
5*/
6int DataPackageDownload(string savePath);
15.19. Exemplo de Código para Baixar Dados do Controlador
1private void button50_Click(object sender, EventArgs e)
2{
3 int rtn = robot.RbLogDownload("D://zDOWN/");
4 Console.WriteLine("RbLogDownload rtn is {0}", rtn);
5
6 rtn = robot.AllDataSourceDownload("D://zDOWN/");
7 Console.WriteLine("AllDataSourceDownload rtn is {0}", rtn);
8
9 rtn = robot.DataPackageDownload("D://zDOWN/");
10 Console.WriteLine("DataPackageDownload rtn is {0}", rtn);
11}
15.20. Atualização do Sistema Operacional do Robô (Painel de Controle LA)
Novo na versão C#SDK-V1.1.8: Web-3.8.6
1/**
2 * @brief Atualização do sistema operacional do robô (Painel de Controle LA)
3 * @param [in] filePath Caminho completo do pacote de atualização do sistema operacional
4 * @return Código de erro
5 */
6public int KernelUpgrade(string filePath)
15.21. Obter o Resultado da Atualização do Sistema Operacional do Robô (Painel de Controle LA)
Novo na versão C#SDK-V1.1.8: Web-3.8.6
1/**
2 * @brief Obter o resultado da atualização do sistema operacional do robô (Painel de Controle LA)
3 * @param [out] result Resultado da atualização: 0: sucesso; -1: falha
4 * @return Código de erro
5 */
6public int GetKernelUpgradeResult(ref int[] result)
15.22. Definir Atualização do Codificador
Novo na versão C#SDK-V1.1.5: Web-3.8.4
1/**
2* @brief Definir atualização do codificador
3* @param [in] path Caminho completo do pacote de atualização local (D://zUP/XXXXX.bin)
4* @return Código de erro
5*/
6int SetEncoderUpgrade(string path);
15.23. Definir Atualização de Firmware da Junta
Novo na versão C#SDK-V1.1.5: Web-3.8.4
1/**
2* @brief Definir atualização de firmware da junta
3* @param [in] type Tipo de arquivo de atualização; 1-atualizar firmware; 2-atualizar arquivo de configuração do escravo
4* @param [in] path Caminho completo do pacote de atualização local (D://zUP/XXXXX.bin)
5* @return Código de erro
6*/
7int SetJointFirmwareUpgrade(int type, string path);
15.24. Definir Atualização de Firmware do Painel de Controle
Novo na versão C#SDK-V1.1.5: Web-3.8.4
1/**
2* @brief Definir atualização de firmware do painel de controle
3* @param [in] type Tipo de arquivo de atualização; 1-atualizar firmware; 2-atualizar arquivo de configuração do escravo
4* @param [in] path Caminho completo do pacote de atualização local (D://zUP/XXXXX.bin)
5* @return Código de erro
6*/
7int SetCtrlFirmwareUpgrade(int type, string path);
15.25. Definir Atualização de Firmware da Extremidade
Novo na versão C#SDK-V1.1.5: Web-3.8.4
1/**
2* @brief Definir atualização de firmware da extremidade
3* @param [in] type Tipo de arquivo de atualização; 1-atualizar firmware; 2-atualizar arquivo de configuração do escravo
4* @param [in] path Caminho completo do pacote de atualização local (D://zUP/XXXXX.bin)
5* @return Código de erro
6*/
7int SetEndFirmwareUpgrade(int type, string path);
15.26. Atualização do Arquivo de Configuração de Parâmetros Completos da Junta
Novo na versão C#SDK-V1.1.5: Web-3.8.4
1/**
2* @brief Atualização do arquivo de configuração de parâmetros completos da junta
3* @param [in] path Caminho completo do pacote de atualização local (D://zUP/XXXXX.bin)
4* @return Código de erro
5*/
6int JointAllParamUpgrade(string path);
15.27. Exemplo de Código de Atualização de Firmware do Escravo do Robô
Novo na versão C#SDK-V1.1.5: Web-3.8.4
1private void button83_Click(object sender, EventArgs e)
2{
3 robot.RobotEnable(0);
4 Thread.Sleep(200);
5 int rtn = robot.JointAllParamUpgrade("D://zUP/upgrade/jointallparameters.db");
6 Console.WriteLine($"robot JointAllParamUpgrade rtn is{rtn}");
7 rtn = robot.SetCtrlFirmwareUpgrade(2, "D://zUP/upgrade/FAIR_Cobot_Cbd_Asix_V2.0.bin");
8 Console.WriteLine($"robot SetCtrlFirmwareUpgrade rtn is{rtn}");
9 rtn = robot.SetEndFirmwareUpgrade(2, "D://zUP/upgrade/FAIR_Cobot_Axle_Asix_V2.4.bin");
10 Console.WriteLine($"robot SetEndFirmwareUpgrade rtn is {rtn}");
11 robot.SetSysServoBootMode();
12 rtn = robot.SetCtrlFirmwareUpgrade(1, "D://zUP/upgrade/FR_CTRL_PRIMCU_FV201212_MAIN_U4_T01_20250428(MT).bin");
13 Console.WriteLine($"robot SetCtrlFirmwareUpgrade rtn is{rtn}");
14 rtn = robot.SetEndFirmwareUpgrade(1, "D://zUP/upgrade/FR_END_FV201009_MAIN_U1_T01_20250428.bin");
15 Console.WriteLine($"robot SetEndFirmwareUpgrade rtn is {rtn}");
16 rtn = robot.SetJointFirmwareUpgrade(1, "D://zUP/upgrade/FR_SERVO_FV504214_MAIN_U7_T07_20250519.bin");
17 Console.WriteLine($"robot SetJointFirmwareUpgrade rtn is{rtn}");
18}
15.28. Geração de Log do MCU do Robô
Novo na versão C#SDK-V1.1.9: Web-3.8.7
1/**
2* @brief Geração de log do MCU do robô
3* @return Código de erro
4*/
5public int RobotMCULogCollect();
15.29. Definir Parada do Robô ao Desconectar a Comunicação da Porta
1/**
2* @brief Definir parada do robô ao desconectar a comunicação da porta
3* @param [in] portID Número da porta 0-8080; 1-8083; 2-20002; 3-20004
4* @param [in] enable 0-desabilitar; 1-habilitar
5* @param [in] confirmTime Duração para confirmar a interrupção da comunicação (ms)[0-5000]
6* @return Código de erro
7*/
8public int SetRobotStopOnComDisc(int portID, bool enable, int confirmTime)
15.30. Obter Parâmetros de Parada do Robô ao Desconectar a Comunicação da Porta
1/**
2* @brief Obter parâmetros de parada do robô ao desconectar a comunicação da porta
3* @param [in] portID Número da porta 0-8080; 1-8083; 2-20002; 3-20004
4* @param [out] enable 0-desabilitar; 1-habilitar
5* @param [out] confirmTime Duração para confirmar a interrupção da comunicação (ms)[0-5000]
6* @return Código de erro
7*/
8public int GetRobotStopOnComDisc(int portID, ref bool enable, ref int confirmTime)
15.31. Exemplo de Código dos Parâmetros de Parada do Robô ao Desconectar a Comunicação da Porta
1void TestRobotStopOnComDisc()
2{
3 int rtn = 0;
4
5 // Definir parâmetros para as quatro portas
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 Console.WriteLine($"SetRobotStopOnComDisc {rtn}");
11
12 bool enable = false;
13 int confirmTime = 0;
14
15 // Obter e imprimir a configuração de cada porta
16 robot.GetRobotStopOnComDisc(0, ref enable, ref confirmTime);
17 Console.WriteLine($"GetRobotStopOnComDisc 8080 rtn {rtn}; enable is {(enable ? 1 : 0)}; confirm time is {confirmTime}");
18
19 robot.GetRobotStopOnComDisc(1, ref enable, ref confirmTime);
20 Console.WriteLine($"GetRobotStopOnComDisc 8083 rtn {rtn}; enable is {(enable ? 1 : 0)}; confirm time is {confirmTime}");
21
22 robot.GetRobotStopOnComDisc(2, ref enable, ref confirmTime);
23 Console.WriteLine($"GetRobotStopOnComDisc 20002 rtn {rtn}; enable is {(enable ? 1 : 0)}; confirm time is {confirmTime}");
24
25 robot.GetRobotStopOnComDisc(3, ref enable, ref confirmTime);
26 Console.WriteLine($"GetRobotStopOnComDisc 20004 rtn {rtn}; enable is {(enable ? 1 : 0)}; confirm time is {confirmTime}");
27
28}
15.32. Enviar Quadro de Instrução UDP
1/**
2* @brief Enviar quadro de instrução UDP
3* @param [in] Quadro de instrução
4* @return Código de erro
5*/
6public int SendUDPFrame(string frame)
15.33. Exemplo de Código SDK Baseado em Comunicação UDP
1void TestRobotUDP()
2{
3 robot.OnUdpFrameReceived += (comType, frameCount, frameCmdID, contentLen, content) =>
4 {
5 Console.WriteLine($"[Resposta UDP] comType={comType}, count={frameCount}, cmdID={frameCmdID}, content={content}");
6 };
7
8
9 // Enviar quadro
10 string frameToSend = "/f/bIII52III236III7IIIMode(1)III/b/f";
11 robot.SendUDPFrame(frameToSend);
12 Thread.Sleep(2000);
13 frameToSend = "/f/bIII52III236III7IIIMode(0)III/b/f";
14 robot.SendUDPFrame(frameToSend);
15 Thread.Sleep(2000);
16 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";
17 robot.SendUDPFrame(frameToSend);
18 Thread.Sleep(2000);
19 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";
20 robot.SendUDPFrame(frameToSend);
21 Thread.Sleep(2000);
22 frameToSend = "/f/bIII47III400III15IIIGetMCVersion(1)III/b/f/f/bIII48III424III21IIIGetSlaveFirmVersion()III/b/f";
23 robot.SendUDPFrame(frameToSend);
24 Thread.Sleep(2000);
25
26}
15.34. Definir Cor do LED da Extremidade do Robô Personalizada pelo Usuário
1/**
2* @brief Definir cor do LED da extremidade do robô personalizada pelo usuário
3* @param [in] r Controle do LED vermelho da extremidade; 0-apagado; 1-aceso
4* @param [in] g Controle do LED verde da extremidade; 0-apagado; 1-aceso
5* @param [in] b Controle do LED azul da extremidade; 0-apagado; 1-aceso
6* @return Código de erro
7*/
8public int SetUserLEDColor(bool r, bool g, bool b)
15.35. Exemplo de Código SDK para Definir Cor do LED da Extremidade do Robô Personalizada pelo Usuário
1public void testled()
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}