3. Fundamentos do Robô
3.1. Instanciar o Robô
1/**
2* @brief Construtor da classe de interface do robô
3*/
4FRRobot();
3.2. Estabelecer Comunicação com o Controlador
1/**
2* @brief Estabelece comunicação com o controlador do robô
3* @param [in] ip Endereço IP do controlador, padrão de fábrica é 192.168.58.2
4* @return Código de erro
5*/
6errno_t RPC(const char *ip);
3.3. Encerrar Comunicação com o Controlador
1/**
2 * @brief Encerra a comunicação com o controlador do robô
3 * @return Código de erro
4 */
5errno_t CloseRPC();
3.4. Consultar Número da Versão do SDK
1/**
2* @brief Consulta o número da versão do SDK
3* @param [out] version Número da versão do SDK
4* @return Código de erro
5*/
6errno_t GetSDKVersion(char *version);
3.5. Obter IP do Controlador
1/**
2* @brief Obtém o IP do controlador
3* @param [out] ip IP do controlador
4* @return Código de erro
5*/
6errno_t GetControllerIP(char *ip);
3.6. Controlar a Entrada ou Saída do Modo de Ensino por Arrasto do Robô
1/**
2* @brief Controla a entrada ou saída do modo de ensino por arrasto do robô
3* @param [in] state 0-sair do modo de ensino por arrasto, 1-entrar no modo de ensino por arrasto
4* @return Código de erro
5*/
6errno_t DragTeachSwitch(uint8_t state);
3.7. Verificar se o Robô está em Modo de Arrasto
1/**
2* @brief Verifica se o robô está em modo de ensino por arrasto
3* @param [out] state 0-não está em modo de ensino por arrasto, 1-está em modo de ensino por arrasto
4* @return Código de erro
5*/
6errno_t IsInDragTeach(uint8_t *state);
3.8. Controlar a Habilitação ou Desabilitação do Robô
1/**
2* @brief Controla a habilitação ou desabilitação do robô. Após ligar, o robô é habilitado automaticamente por padrão
3* @param [in] state 0-desabilitar, 1-habilitar
4* @return Código de erro
5*/
6errno_t RobotEnable(uint8_t state);
3.9. Controlar a Comutação entre Modo Manual e Automático do Robô
1/**
2* @brief Controla a comutação entre modo manual e automático do robô
3* @param [in] mode 0-modo automático, 1-modo manual
4* @return Código de erro
5*/
6errno_t Mode(int mode);
3.10. Desligar o Sistema Operacional do Robô
Novo na versão C++SDK-v2.2.1-3.8.1.
1/**
2* @brief Desliga o sistema operacional do robô
3* @return Código de erro
4*/
5errno_t ShutDownRobotOS();
3.11. Definir Parâmetros de Reconexão de Comunicação com o Robô
Novo na versão C++SDK-v2.1.5.0.
1/**
2* @brief Define os parâmetros de reconexão de comunicação com o robô
3* @param [in] enable Habilita a reconexão em caso de falha de rede true-habilitar false-desabilitar
4* @param [in] reconnectTime Tempo de reconexão, em ms
5* @param [in] period Período de reconexão, em ms
6* @return Código de erro
7*/
8errno_t SetReConnectParam(bool enable, int reconnectTime = 30000, int period = 50);
3.12. Desligar o Sistema Operacional do Robô
1/**
2* @brief Desliga o sistema operacional do robô
3* @return Código de erro
4*/
5int ShutDownRobotOS();
3.13. Inicializar Parâmetros de Log
Novo na versão C++SDK-v2.1.2.0.
1/**
2* @brief Inicializa os parâmetros de log;
3* @param output_model: Modo de saída, 0-saída direta; 1-saída com buffer; 2-saída assíncrona;
4* @param file_path: Caminho + nome do arquivo de salvamento, limite de comprimento 256, o nome deve estar no formato xxx.log, ex: /home/fr/linux/fairino.log;
5* @param file_num: Número de arquivos armazenados em rotação, 1~20. Limite máximo de 50 MB por arquivo;
6* @return errno_t Código de erro;
7*/
8errno_t LoggerInit(int output_model = 0, std::string file_path = "", int file_num = 5);
3.14. Definir Nível de Filtro de Log
Novo na versão C++SDK-v2.1.2.0.
1/**
2* @brief Define o nível de filtro de log;
3* @param lvl: Nível de filtro, quanto menor o valor, menos logs são exibidos. O valor padrão é 1. 1-erro, 2-aviso, 3-informação, 4-depuração;
4*/
5void SetLoggerLevel(int lvl = 1);
3.15. Exemplo de Código de Controle Básico do Robô
1int TestRobotCtrl(void)
2{
3 ROBOT_STATE_PKG pkg = {};
4 FRRobot robot;
5 robot.LoggerInit();
6 robot.SetLoggerLevel(1);
7 int rtn = robot.RPC("192.168.58.2");
8 robot.SetReConnectParam(true, 30000, 500);
9 char ip[64] = "";
10 char version[64] = "";
11 uint8_t state;
12 robot.GetSDKVersion(version);
13 printf("SDK version:%s\n", version);
14 robot.GetControllerIP(ip);
15 printf("controller ip:%s\n", ip);
16 robot.Mode(1);
17 robot.Sleep(1000);
18 robot.DragTeachSwitch(1);
19 robot.Sleep(1000);
20 robot.IsInDragTeach(&state);
21 printf("drag state :%u\n", state);
22 robot.Sleep(3000);
23 robot.DragTeachSwitch(0);
24 robot.Sleep(1000);
25 robot.IsInDragTeach(&state);
26 printf("drag state :%u\n", state);
27 robot.Sleep(3000);
28 robot.RobotEnable(0);
29 robot.Sleep(3000);
30 robot.RobotEnable(1);
31 robot.Mode(0);
32 robot.Sleep(1000);
33 robot.Mode(1);
34 robot.Sleep(3000);
35 robot.ShutDownRobotOS();
36 robot.CloseRPC();
37 return 0;
38}
3.16. Exemplo de Código para Obter Versão do Software do Robô
1/**
2* @brief Obtém a versão do software do robô
3* @param[out] robotModel Modelo do robô
4* @param[out] webVersion Versão web
5* @param[out] controllerVersion Versão do controlador
6* @return Código de erro
7*/
8errno_t GetSoftwareVersion(char robotModel[64], char webVersion[64], char controllerVersion[64]);
3.17. Obter Versão do Hardware do Robô
Novo na versão C++SDK-v2.1.1.0.
1/**
2* @brief Obtém a versão do hardware do robô
3* @param[out] ctrlBoxBoardversion Versão do hardware da placa base da caixa de controle
4* @param[out] driver1version Versão do hardware do driver 1
5* @param[out] driver2version Versão do hardware do driver 2
6* @param[out] driver3version Versão do hardware do driver 3
7* @param[out] driver4version Versão do hardware do driver 4
8* @param[out] driver5version Versão do hardware do driver 5
9* @param[out] driver6version Versão do hardware do driver 6
10* @param[out] endBoardversion Versão do hardware da placa da extremidade
11*/
12errno_t GetHardwareVersion(char ctrlBoxBoardversion[128], char driver1version[128], char driver2version[128], char driver3version[128], char driver4version[128], char driver5version[128], char driver6version[128], char endBoardversion[128]);
3.18. Obter Versão do Firmware do Robô
Novo na versão C++SDK-v2.1.1.0.
1/**
2* @brief Obtém a versão do firmware do robô
3* @param[out] ctrlBoxBoardversion Versão do firmware da placa base da caixa de controle
4* @param[out] driver1version Versão do firmware do driver 1
5* @param[out] driver2version Versão do firmware do driver 2
6* @param[out] driver3version Versão do firmware do driver 3
7* @param[out] driver4version Versão do firmware do driver 4
8* @param[out] driver5version Versão do firmware do driver 5
9* @param[out] driver6version Versão do firmware do driver 6
10* @param[out] endBoardversion Versão do firmware da placa da extremidade
11*/
12errno_t GetFirmwareVersion(char ctrlBoxBoardversion[128], char driver1version[128], char driver2version[128], char driver3version[128], char driver4version[128], char driver5version[128], char driver6version[128], char endBoardversion[128]);
3.19. Exemplo de Código para Obter Versões de Software e Firmware do Robô
1int TestGetVersions(void)
2 {
3 ROBOT_STATE_PKG pkg = {};
4 FRRobot robot;
5 robot.LoggerInit();
6 robot.SetLoggerLevel(1);
7 int rtn = robot.RPC("192.168.58.2");
8 if (rtn != 0)
9 {
10 return -1;
11 }
12 robot.SetReConnectParam(true, 30000, 500);
13 char robotModel[64] = { 0 };
14 char webversion[64] = { 0 };
15 char controllerVersion[64] = { 0 };
16 char ctrlBoxBoardversion[128] = { 0 };
17 char driver1version[128] = { 0 };
18 char driver2version[128] = { 0 };
19 char driver3version[128] = { 0 };
20 char driver4version[128] = { 0 };
21 char driver5version[128] = { 0 };
22 char driver6version[128] = { 0 };
23 char endBoardversion[128] = { 0 };
24 rtn = robot.GetSoftwareVersion(robotModel, webversion, controllerVersion);
25 printf("Getsoftwareversion rtn is: %d\n", rtn);
26 printf("robotmodel is: %s, webversion is: %s, controllerVersion is: %s \n\n", robotModel, webversion, controllerVersion);
27 rtn = robot.GetHardwareVersion(ctrlBoxBoardversion, driver1version, driver2version, driver3version, driver4version, driver5version, driver6version, endBoardversion);
28 printf("GetHardwareversion rtn is: %d\n", rtn);
29 printf("GetHardwareversion get hardware versoin is: %s, %s, %s, %s, %s, %s, %s, %s\n\n", ctrlBoxBoardversion, driver1version, driver2version, driver3version, driver4version, driver5version, driver6version, endBoardversion);
30 rtn = robot.GetFirmwareVersion(ctrlBoxBoardversion, driver1version, driver2version, driver3version, driver4version, driver5version, driver6version, endBoardversion);
31 printf("GetFirmwareversion rtn is: %d\n", rtn);
32 printf("GetHardwareversion get hardware versoin is: %s, %s, %s, %s, %s, %s, %s, %s\n\n", ctrlBoxBoardversion, driver1version, driver2version, driver3version, driver4version, driver5version, driver6version, endBoardversion);
33 robot.CloseRPC();
34 return 0;
35 }