8. API

8.1. Instrução act

Todas as instruções act abaixo usam POST, com a URL /action/act.

8.1.1. Salvar Ponto de Ensino

Nome da instrução: save_point.

Parâmetros da instrução:

/**
* @param  string name Nome do ponto de ensino a ser registrado
* @param  string speed Velocidade
* @param  string elbow_speed Velocidade do cotovelo
* @param  string acc Aceleração
* @param  string elbow_acc Aceleração do cotovelo
* @param  string toolnum Número da ferramenta
* @param  string workpiecenum Número da peça
*/

Exemplo da instrução:

{
    cmd: "save_point",
    data:{
        name: "point1",
        speed: "100",
        elbow_speed: "100",
        acc: "100",
        elbow_acc: "100",
        toolnum: "1",
        workpiecenum: "1"
    }
}

Retorno da instrução:

/**
* @return status:200 "success"
* @return status:404 "fail"
*/

8.2. Instrução sta

Todas as instruções sta abaixo usam POST, com a URL /action/sta.

8.2.1. Obter Dados de Estado do Robô

Nome da instrução: basic.

Parâmetros da instrução: Nenhum.

Exemplo da instrução:

{
    cmd: "basic",
}

Retorno da instrução:

/**
* @return status:200
* @param  object joints Posições das juntas
* @param  object tcp Pose cartesiana
* @param  array exAxisPos Posições dos eixos externos
* @return status:404 "fail"
*/
{
    joints: {
        j1: "90",
        j2: "90",
        j3: "90",
        j4: "90",
        j5: "90",
        j6: "90",
    },
    tcp: {
        x: "100",
        x: "100",
        z: "100",
        rx: "90",
        ry: "90",
        rz: "90",
    },
    exAxisPos: [0,0,0,0]
}

8.3. Instrução get

Todas as instruções get abaixo usam POST, com a URL /action/get.

8.3.1. Obter Pontos de Ensino

Nome da instrução: get_points().

Parâmetros da instrução: Nenhum.

Exemplo da instrução:

{
    cmd: "get_points"
}

Retorno da instrução:

/**
* @return status:200 "success"
* @param  ${point_name}: object Informações relacionadas ao ponto de ensino
* @return status:404 "fail"
*/

Exemplo de retorno da instrução:

{
    "localpoint1": {
        "name":"localpoint1",
        "elbow_speed":"1",
        "elbow_acc":"1",
        "x": "1",
        "y": "1",
        "z": "1",
        "rx": "1",
        "ry": "1",
        "rz": "1",
        "j1": "1",
        "j2": "1",
        "j3": "1",
        "j4": "1",
        "j5": "1",
        "j6": "1",
        "toolnum": "1",
        "workpiecenum": "1",
        "speed": "1",
        "acc": "1",
        "E1": "1",
        "E2: "1",
        "E3": "1",
        "E4": "1"
    }
}

8.3.2. Obter Configuração do Sistema

Nome da instrução: get_syscfg().

Parâmetros da instrução: Nenhum.

Exemplo da instrução:

{
    cmd: "get_syscfg"
}

Retorno da instrução:

/**
* @return status:200 "success"
* @param  string log_count Número máximo de dias de log
* @param  string language Pacote de idioma atualmente em uso
* @param  string lifespan Tempo limite de inatividade
* * @return status:404 "fail"
*/

Exemplo de retorno da instrução:

{
    log_count:"10",
    language:"zh",
    lifespan:"1800"
}

8.4. Instrução set

Todas as instruções set abaixo usam POST, com a URL /action/set.

8.4.1. Instrução para Enviar Variável de Sistema

Nome da instrução: 511.

Parâmetros da instrução:

/**
* @param int index Número de sequência da variável de sistema: 1-20
* @param int value Valor da variável de sistema
*/

Exemplo da instrução:

{
    cmd: 511,
    data:{
        content:"SetSysVarValue(2,1)"
    }
}

Retorno da instrução:

/**
* @return status:200 1: sucesso, 0: falha
* @return status:404 "fail"
*/

Exemplo de retorno da instrução:

8.4.2. Instrução para Obter Variável de Sistema

Nome da instrução: 512.

Parâmetros da instrução:

/**
* @param int index Número de sequência da variável de sistema: 1-20
* /

Exemplo da instrução:

{
    cmd: 512,
    data:{
        content:"GetSysVarValue(2)"
    }
}

Retorno da instrução:

/**
* @return status:200
* @param int value Valor da variável de sistema
* @return status:404 "fail"
* /

Exemplo de retorno da instrução:

8.5. Instrução better-sqlite3

8.5.1. Consultar o Primeiro Registro no Banco de Dados

Parâmetros da instrução:

/**
* @param string db_name Nome do banco de dados (inclui caminho absoluto)
* @param string sql Comando SQL
* @return string result Primeiro registro encontrado
*/

Conteúdo da instrução:

queryget(string db_name, string sql);

8.5.2. Consultar Todos os Registros no Banco de Dados

Parâmetros da instrução:

/**
* @param string db_name Nome do banco de dados (inclui caminho absoluto)
* @param string sql Comando SQL
* @return string result Todos os registros encontrados
*/

Conteúdo da instrução:

queryall(string db_name, string sql);

8.5.3. Executar Comando SQL

/**
* @param string db_name Nome do banco de dados (inclui caminho absoluto)
* @param string sql Comando SQL
* @param object obj Parâmetros necessários para a execução do comando SQL
* @return \
*/

Parâmetros da instrução:

exec(string db_name, string sql, object obj);

Conteúdo da instrução:

8.6. Instrução socket

8.6.1. Envio via socket (socket send)

Parâmetros da instrução:

/**
* @param string send_content Conteúdo a ser enviado pelo comando de comunicação socket
* @return \
*/

Conteúdo da instrução:

socket_cmd.send(string send_content);//8065
socket_file.send(string send_content);//8067

8.6.2. Recepção via socket (socket recv)

Parâmetros da instrução:

/**
* @return string recv_content Conteúdo de resposta do comando de comunicação socket
*/

Conteúdo da instrução:

socket_cmd.recv();//8065
socket_file.recv();//8067

8.7. Instruções de Operação de Arquivo

8.7.1. Escrever Conteúdo em um Arquivo

/**
* @param String filename Caminho do arquivo
* @param string content Conteúdo a ser escrito
* @return true/false
*/

write(filename, content);

8.7.2. Ler Conteúdo de um Arquivo

/**
* @param String filename Caminho do arquivo
* @param string content Conteúdo a ser escrito
* @return String Conteúdo do arquivo
*/

read(filename);

8.7.3. Modificar Permissões de um Arquivo

/**
* @param String filename Caminho do arquivo
* @param Number mode Modo de permissão (ex: 0644)
* @return true/false
*/

chmod(filename, mode);

8.7.4. Ler Conteúdo de um Diretório, Incluindo Subdiretórios

/**
* @param String path Caminho do diretório
* @return Array Array de nomes de arquivos
*/

readdir(path);

8.8. Instruções de Compactação e Descompactação

Nota

Diferenciar entre versões LA e QX:

Importação do módulo LA: var execSync = require(“child_process”).execSync;

Importação do módulo QX: var tar_utils = require(“/usr/local/etc/node/sys/tools/tar_utils”);

8.8.1. Criar Arquivo Compactado tar.gz

Exemplo de criação de arquivo tar.gz (LA):

var cmd = 'cd / && tar -zcvf ' + FILENAME + '-C ' + DIR;
execSync(cmd);

Descrição da instrução para criar arquivo tar.gz (QX):

/**
* @param {Array|String} sourcePaths Array ou caminho único dos arquivos/diretórios de origem
* @param String targetFile Caminho do arquivo compactado de destino
* @param Function callback Função de retorno, parâmetro (error)
* @param String basePath Caminho base, padrão é '/'
* @return \
*/

createTarGz(sourcePaths, targetFile, callback, basePath);

8.8.2. Descompactar Arquivo tar.gz

Exemplo de descompactação de arquivo tar.gz (LA):

var cmd = 'cd / && tar -zxvf ' + FILENAME;
execSync(cmd);

Descrição da instrução para descompactar arquivo tar.gz (QX):

/**
* @param String sourceFile Caminho do arquivo compactado de origem
* @param String targetDir Diretório de destino para descompactação
* @param Function callback Função de retorno, parâmetro (error)
* @return \
*/
extractTarGz(sourceFile, targetDir, callback);