Indicador Líder DLL

A Líder Balanças apresenta a sua API (Application Programming Interface ou Interface de Programação para Aplicações), a qual é composta de um arquivo indicador.dll (Dynamic Link Library ou Biblioteca dinâmica).

A aplicação se destina a desenvolvedores de software, para que possam vir a realizar aplicações em diversas linguagens de programação, como por exemplo Delphi, C, C++, Java e outras e que através destas, consigam se comunicar com os produtos da Líder Balanças através da chamada a API indicador.dll em seus softwares.

O arquivo de API nada mais é do que um conjunto de rotinas e padrões de programação para acesso por um software.

As principais funções para as quais a API foi desenvolvida e se aplica são:

• Comunicação:
• Abrir a porta serial
• Abrir a comunicação via TCP
• Fechar a comunicação serial ou TCP
• Verificar se a porta está aberta
• Comandos de Básicos:
• Zerar o indicador
• Tarar o indicador (semiautomático e manual)
• Imprimir ou calcular a média
• Perguntar o peso (caso a frequência de transmissão (F303) seja por demanda)
• Informações da balança:
• Obter o peso líquido
• Obter o peso bruto
• Obter a tara
• Obter o status da balança
• Obter a unidade de medida
• Verificar se o indicador está no modo contadora de peças
• Verificar o protocolo da balança
• Obter o status e o nível da bateria do indicador
• Obter o nível da bateria do TransmissorTx1
• Obter o nível da bateria do TransmissorTx2
• Código e Produto:
• Cadastrar, alterar e deletar produtos da tabela do indicador
• Cadastrar uma tabela de produtos nova (sobrescrevendo a atual)
• Adquirir a tabela de produtos
• Deletar/Limpar a tabela de produtos
• Usuário:
• Adquirir o nome de usuário por ID
• Salvar usuário (necessário a senha do Menu)
• Configuração do Indicador:
• Get e Set de configurações do Indicador
• Relatório do Indicador
• Carrega relatórios do Indicador

COMUNICAÇÃO

      

        
int openSerial    ( const char* port, int baudRate, int dataBits, int stopBits, int parity  ); // Abre comunicação Serial
int openTcp       ( const char* ip  , int port      ); // Abre comunicação TCP
int isOpen        (  ); // Verifica se a comunicação está aberta
int close         (  ); // Fecha a comunicação Serial ou TCP
        
      
    

COMANDOS BÁSICOS

      

        
int zerar                 (  ); // Zera o indicador
int tarar                 (  ); // Tara Semiautomatica
int tararManual           ( int tara ); // Tara Manual
int imprimir_calcularMedia(  ); // Imprimir ou calcula a média (caso o calculo do peso médio estiver ativado)
int perguntarPeso         (  ); // Pergunta o peso manualmente (quando F303 = 0)
        
      
    

INFORMAÇÕES DA BALANÇA

      

        
double getPesoLiquido                 (  ); // Obtem o peso liquido
double getPesoBruto                   (  ); // Obtem o peso bruto
double getTara                        (  ); // Obtem a tara
int    getStatusBalanca               (  ); // Obtem o status da balanca
int    getUnidadeMedida               (  ); // Obtem a unidade do indicador
int    isModoContadoraDePecas         (  ); // Verifica se o indicador esta no modo contadora de pecas
int    getProtocolo                   (  ); // Obtem o protocolo do indicador
int    getStatusBateriaIndicador      (  ); // Obtem o status da bateria do indicador
int    getNivelBateriaIndicador       (  ); // Obtem o nivel da bateria do indicador
int    getNivelBateriaTransmissorTx1  (  ); // Obtem o nivel da bateria do TransmissorTx1
int    getNivelBateriaTransmissorTx2  (  ); // Obtem o nivel da bateria do TransmissorTx2
        
      
    

CÓDIGO E PRODUTO

      

        
// Função para iniciar cadastro na tabela de produtos
int ERF_tabelaProduto (  ); // Esta função deve ser chamada para de evitar lacunas 
                            // na memória e mau funcionamento
int cadastrarProduto  ( char* codigo, char* descricao );
int alterarProduto    ( char* codigo, char* descricao );
int deletarProduto    ( char* codigo );

// Função para iniciar tabela nova (sobrescreve tabela do indicador)
int EXC_iniciarTabelaProduto  (  );
int EXC_cadastrarProduto      ( char* codigo, char* descricao );
int EXC_finalizarTabelaProduto( int quantidadeProdutosTabelaEXC );

char* getTabelaProduto    (  ); // Retorna uma string com a tabela do indicador
int deletarTabelaProduto  (  ); // Exclui/limpa a tabela do indicador
        
      
    

CONFIGURAÇÃO DO INDICADOR

      

        
char* setConfiguracaoIndicador ( int funcao, char* input ); // funcao = codigo do comando
char* getConfiguracaoIndicador ( int funcao ); // retorna o valor atual da configuração
int saveConfiguracaoIndicador  (  ); // Salva todas as configurações feitas
        
      
    

RELATÓRIO DO INDICADOR

      

        
char* gerarRelatorio ( int tipo, char* input );
        
      
    

CONFIGURAÇÃO DE USUÁRIO

      

        
char* getUsuarioById  ( int id ); // Retorna o nome do usuário do ID especificado
char* setUsuario      ( char* senhaMenu, int idUsuario, char* senhaUsuario, char* nomeUsuario ); // Salva usuário
        
      
    

GUIA DE UTILIZAÇÃO

Obs.: Todas as funções correm o risco de demorarem para terem um retorno (por isso possuem o retorno de TIMEOUT), com exceção das funções isOpen() e todas as funções da categoria INFORMAÇÕES DA BALANÇA que retornam quase que imediatamente seus valores, já que elas não dependem diretamente da velocidade de comunicação com o indicador. Dessa forma, recomendo realizar as chamadas de algumas das funções de forma assíncrona para evitar uma lentidão em sua aplicação, de qualquer forma, realize alguns testes das funções em sua aplicação e verifique se há realmente a necessidade de chamá-las de forma assíncrona em uma nova thread.

Comunicação

Para que a DLL seja usada corretamente, é necessário que uma comunicação com um Indicador 2051 sejá estabelecida corretamente por meio das funções openSerial ou openTcp. Dessas duas funções de abertura de comunicação, na primeira (Serial), deve-se atentar aos parâmetros passados a função, pois, mesmo que ela tenha um retorno 1, não significa necessariamente que a conexão foi estabelecida corretamente, tanto os parâmetros da função quanto da comunicação serial configurada no Indicador devem estar iguais(baudrate, databits, stopbits e paridade).

No momento em que a comunicação é iniciada, uma thread é utilizada para monitorar e coletar constantemente os dados enviados pelo Indicador. Para encerrar a comunicação, tanto serial quanto TCP, basta chamar a função close, que encerrará a thread de monitoramento e fechrá a comunicação.

Comandos Básicos

Informações da Balança

Os valores do pesoLiquido, pesoBruto e tara devem ser utilizados juntos de outros 2 valores: o statusBalanca e o protocolo.

• Quando statusBalanca assume os valores -1, -2 ou -3, pesoLiquido, pesoBruto e tara devem ser desconsiderados, pois eles já não retornam um valor que reflete a realidade, mas sim, um valor simbólico sem importância/validade.
• Quando protocolo assume os valores 0 ou 2, somente pesoBruto e tara devem ser desconsiderados, pois, os protocolos Líder 1 e Líder 3 não retornam esses dois valores.

Código e Produto

Para cadastrar Código e Produto na tabela do Indicador temos 2 conjuntos de funções para fins diferentes:

• Funções ERF de Produto:

  Fornecem as operações básicas de manipulação da tabela de produtos do Indicador, cadastrar, alterar e deletar.

• ERF_tabelaProduto: busca espaços na memória do indicador desde o primento endereço. Sempre utilize esta função antes de cadastrarProduto para garantir que o produto será gravado em um espaço da memória do indicador que foi liberado pela funçao deletarProduto ou deletarTabelaProduto, assim isso evitará lacunas na memória que causam mau funcionamento.
• cadastrarProduto: cadastra um código e produto na tabela do indicador
• alterarProduto: altera um produto da tabela do indicador
• deletarProduto: deleta um produto da tabela do indicador


• Funções EXC de Produto:

  Fornecem uma forma de cadastrar uma nova tabela que irá sobrescrever toda a tabela do indicador, ou seja, qualquer registro que o indicador tenha, será perdido com outro registro novo sendo escrito por cima.

• EXC_iniciarTabelaProduto: inicia uma nova tabela no indicador
• EXC_cadastrarProduto: cadastra um produto da nova tabela
• EXC_finalizaTabelaProduto: finaliza a nova tabela

Configuração do Indicador

Ao chamar a função setConfiguracaoIndicador() alterando alguma configuração do Indicador, esta alteração é confirmada pelo próprio retorno da função, porém, ela só entra em vigência para o Indicador ao salvá-la com a função saveConfiguracaoIndicador(), antes disso, a alteração permanece na memória temporária do Indicador aguardando o comando de salvar. Dessa forma, essas alterações podem ser perdidas se a memória temporária do Indicador for apagada (normalmente ocorre quando o Indicador é reiniciado ou resetado) antes dela passar as alterações para a memória permanente.

Relatório do Indicador

Configuração de Usuário

          

            
void freeStringMemory (  );