Plataforma de Comunicação Elgin versão 3.13.9
Documentação das bibliotecas de integração com hardware Elgin
Funções
Balança

Fornece funções para integração com balanças ELGIN. Mais...

Funções

int ObterModeloBalanca ()
 Obtém o modelo da balança configurado para uso na biblioteca. Mais...
 
int ConfigurarModeloBalanca (int modeloBalanca)
 Configura o modelo da balança para uso na biblioteca. Mais...
 
int ObterProtocoloComunicacao ()
 Obtém o protocolo de comunicação configurado para uso na biblioteca. Mais...
 
int ConfigurarProtocoloComunicacao (int protocoloComunicacao)
 Configura o protocolo de comunicação para uso na biblioteca. Mais...
 
int AbrirSerial (const char *device, int baudrate, int length, char parity, int stopbits)
 Abre uma conexão serial com a balança. Mais...
 
int AbrirUSB (int baudrate)
 Abre uma conexão usb com os conversores ch340 ou 341 e FTDI com a balança. Mais...
 
int DirectIO (const char *wbuffer, unsigned int wlen, char *rdbuffer, unsigned int rdlen)
 Envia comandos direto para a porta de comunicação. Mais...
 
int Fechar ()
 Fecha conexão com a balança. Mais...
 
int ObterTipoConexao ()
 Obtém o tipo de conexão em uso. Mais...
 
const char * LerPeso (int qtdLeituras)
 Função para leitura de peso. Mais...
 
const char * LerPreco (int qtdLeituras)
 Função para leitura de preço. Mais...
 
const char * LerTara ()
 Função para leitura de tara. Mais...
 
const char * LerTotal (double preco)
 Função para leitura de preço total (peso * preço). Mais...
 
int TararBalanca ()
 Função para tarar/destarar a balança. Mais...
 
int ZerarBalanca ()
 Função para zerar a balança. Mais...
 
int LigarDesligarDisplay ()
 Função para ligar/desligar a balança (display). Mais...
 
int GetContinuousReadTime ()
 Obtém o tempo máximo configurado para a duração da leitura contínua. Mais...
 
void SetContinuousReadTime (int continuousReadTime)
 Configura o tempo máximo para a duração da leitura contínua. Mais...
 

Descrição detalhada

Fornece funções para integração com balanças ELGIN.

Essa biblioteca fornece diversas funções de integração com as balanças ELGIN.
Os modelos de balanças compatíveis com essa biblioteca são:

‍DP-3005
DP-1502
SA-110
DPSC
DP30CK

Métodos para controle da balança:

‍LerPeso
LerPreco
LerTara
LerTotal
TararBalanca
ZerarBalanca
LigarDesligarDisplay

Para utilizar as funções de controle da balança, listadas acima, é necessário, antes, executar os três métodos abaixo:

‍ConfigurarModeloBalanca // Escolhe o modelo de balança para usar na biblioteca
ConfigurarProtocoloComunicacao // Define o protocolo em que as funções de controle devem trabalhar
AbrirSerial // Estabelece uma conexão com a balança

Após executar (com sucesso) as três funções listadas acima, os métodos para controle da balança estarão aptos para utilização.

Notas para o método ConfigurarModeloBalanca:

‍#1. É o primeiro método que deve ser executado;
#2. A conexão com a balança deve estar fechada toda vez que esse método for chamado;
#3. Sempre que o modelo da balança for trocado, configure novamente o protocolo através do método ConfigurarProtocoloComunicacao.

Atualmente, a versão Android desta biblioteca possui as seguintes limitações:

‍Ausência de suporte para comunicação com 7 bits de dados (length == 7)
Ausência de suporte para protocolos contínuos

Convenções usadas nas chamadas das funções da biblioteca:
Windows

‍__stdcall

Linux

‍__cdecl

Funções

◆ ObterModeloBalanca()

int ObterModeloBalanca ( )

Obtém o modelo da balança configurado para uso na biblioteca.

Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar o código correspondente à balança em uso, conforme tabela abaixo:
Código Modelo
0 DP-3005, DP-1502
1 SA-110
2 DPSC
3 DP30CK

◆ ConfigurarModeloBalanca()

int ConfigurarModeloBalanca ( int  modeloBalanca)

Configura o modelo da balança para uso na biblioteca.

Parâmetros
modeloBalanca- Parâmetro do tipo numérico que corresponde ao código da balança desejada, conforme tabela abaixo:
Código Modelo
0 DP-3005, DP-1502
1 SA-110
2 DPSC
3 DP30CK

Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar 0.

◆ ObterProtocoloComunicacao()

int ObterProtocoloComunicacao ( )

Obtém o protocolo de comunicação configurado para uso na biblioteca.

Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar o código correspondente ao protocolo em uso, conforme tabela abaixo:
Código Protocolo
0 Protocolo 0
1 Protocolo 1
2 Protocolo 2
3 Protocolo 3
4 Protocolo 4
5 Protocolo 5
7 Protocolo 7

◆ ConfigurarProtocoloComunicacao()

int ConfigurarProtocoloComunicacao ( int  protocoloComunicacao)

Configura o protocolo de comunicação para uso na biblioteca.

Parâmetros
protocoloComunicacao- Parâmetro do tipo numérico que corresponde ao código do protocolo desejado, conforme tabela abaixo:
Código Protocolo
0 Protocolo 0
1 Protocolo 1
2 Protocolo 2
3 Protocolo 3
4 Protocolo 4
5 Protocolo 5
7 Protocolo 7

Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar 0.

◆ AbrirSerial()

int AbrirSerial ( const char *  device,
int  baudrate,
int  length,
char  parity,
int  stopbits 
)

Abre uma conexão serial com a balança.

  • OBS: Os valores válidos listados nos parâmetros desta função não se aplicam à todas as balanças; para obter a lista dos valores suportados em uma balança específica, vide manual.
Parâmetros
device- Parâmetro do tipo caractere que define a porta serial desejada. Exemplo: COM2
  • OBS: Na versão Android desta biblioteca não é preciso especificar a porta serial, uma vez que esse parâmetro não está disponível.

baudrate- Parâmetro do tipo numérico que define o baudrate da conexão.
Valores válidos:

‍1200
2400
4800
9600
19200
38400
57600
115200


length- Parâmetro do tipo numérico que define o length da conexão.
Valores válidos:

‍5
6
7
8


parity- Parâmetro do tipo caractere que define a paridade da conexão.
Valores válidos:
Valor Paridade
n No Parity (Sem Paridade)
N No Parity (Sem Paridade)
e Even Parity (Paridade Par)
E Even Parity (Paridade Par)
o Odd Parity (Paridade Ímpar)
O Odd Parity (Paridade Ímpar)

stopbits- Parâmetro do tipo numérico que define o número de bits de parada.
Valores válidos:

‍1
2


Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar 0.

◆ AbrirUSB()

int AbrirUSB ( int  baudrate)

Abre uma conexão usb com os conversores ch340 ou 341 e FTDI com a balança.

  • OBS: Função disponível somente na biblioteca android.
Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar 0.

◆ DirectIO()

int DirectIO ( const char *  wbuffer,
unsigned int  wlen,
char *  rdbuffer,
unsigned int  rdlen 
)

Envia comandos direto para a porta de comunicação.

Função de despejo de comandos na porta de comunicação. Essa função também recebe dados da porta de comunicação.

Parâmetros
wbuffer- Sequência de comandos que devem ser enviados para a porta de comunicação.
wlen- Quantidade de comandos enviados e que serão escritos.
rdbuffer- Alocação de memória que receberá os dados de retorno caso seja necessário.
rdlen- Quantidade de dados que se espera ler.
Para evitar a leitura da porta esse parâmetro deve estar em ZERO (0).
O valor passado nesse parâmetro não pode ser maior do que a memória alocada em rdbuffer.
Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar a quantidade de bytes lidos (se rdlen > 0) ou a quantidade de bytes escritos (se rdlen == 0).

◆ Fechar()

int Fechar ( )

Fecha conexão com a balança.

Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar 0.

◆ ObterTipoConexao()

int ObterTipoConexao ( )

Obtém o tipo de conexão em uso.

Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar o código correspondente ao tipo de conexão em uso, conforme tabela abaixo:
Código Conexão
0 Sem Conexão
1 Conexão Serial

◆ LerPeso()

const char * LerPeso ( int  qtdLeituras)

Função para leitura de peso.

  • OBS: Verifique se o protocolo em uso suporta esta funcionalidade.
Parâmetros
qtdLeituras- Parâmetro do tipo numérico que determina a quantidade de vezes em que o peso sobre a balança deve ser consultado.
Valores válidos:

‍Números maiores que zero (1, 2, 3, ...).

* OBS: Caso o protocolo seja contínuo, esse parâmetro é ignorado.
Retorna
O retorno da função é do tipo caractere.
A função bem-sucedida deve retornar uma cadeia de caracteres que representa o peso lido da balança, conforme protocolo configurado em ConfigurarProtocoloComunicacao.

◆ LerPreco()

const char * LerPreco ( int  qtdLeituras)

Função para leitura de preço.

  • OBS: Verifique se o protocolo em uso suporta esta funcionalidade.
Parâmetros
qtdLeituras- Parâmetro do tipo numérico que determina a quantidade de vezes em que o preço configurado na balança deve ser consultado.
Valores válidos:

‍Números maiores que zero (1, 2, 3, ...).

* OBS: Caso o protocolo seja contínuo, esse parâmetro é ignorado.
Retorna
O retorno da função é do tipo caractere.
A função bem-sucedida deve retornar uma cadeia de caracteres que representa o preço configurado na balança, conforme protocolo configurado em ConfigurarProtocoloComunicacao.

◆ LerTara()

const char * LerTara ( )

Função para leitura de tara.

  • OBS: Verifique se o protocolo em uso suporta esta funcionalidade.
Retorna
O retorno da função é do tipo caractere.
A função bem-sucedida deve retornar uma cadeia de caracteres que representa a tara feita na balança, conforme protocolo configurado em ConfigurarProtocoloComunicacao.

◆ LerTotal()

const char * LerTotal ( double  preco)

Função para leitura de preço total (peso * preço).

  • OBS: Nos protocolos 0, 1, 2, 3 e 7, a biblioteca calculará o total com base no peso lido da balança e no valor passado ao parâmetro preco; nos protocolos 4 e 5, o preco será enviado à balança e o próprio protocolo fará o cálculo.
Parâmetros
preco- Parâmetro do tipo numérico que configura o preço/kg da balança, em R$ (reais), usado no cálculo do preço total.
Valores válidos:

‍Números entre 0.00 e 9999.99 (0.00, ..., 9999.99).

* OBS: A precisão é de duas casas decimais.
Retorna
O retorno da função é do tipo caractere.
A função bem-sucedida deve retornar uma cadeia de caracteres que representa o preço total, em R$ (reais).

◆ TararBalanca()

int TararBalanca ( )

Função para tarar/destarar a balança.

  • OBS: Verifique se o protocolo em uso suporta esta funcionalidade.
Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar 0.

◆ ZerarBalanca()

int ZerarBalanca ( )

Função para zerar a balança.

  • OBS: Verifique se o protocolo em uso suporta esta funcionalidade.
Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar 0.

◆ LigarDesligarDisplay()

int LigarDesligarDisplay ( )

Função para ligar/desligar a balança (display).

  • OBS: Verifique se o protocolo em uso suporta esta funcionalidade.
Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar 0.

◆ GetContinuousReadTime()

int GetContinuousReadTime ( )

Obtém o tempo máximo configurado para a duração da leitura contínua.

  • OBS: O valor padrão é de 500 ms.
Retorna
O retorno da função é do tipo numérico.
A função bem-sucedida deve retornar o tempo máximo, em milissegundos, que a operação de leitura contínua deve durar.

◆ SetContinuousReadTime()

void SetContinuousReadTime ( int  continuousReadTime)

Configura o tempo máximo para a duração da leitura contínua.

Parâmetros
continuousReadTime- Parâmetro do tipo numérico que define o tempo máximo, em milissegundos, que a operação de leitura contínua deve durar.