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

Descrição das funções de PIX4. Mais...

int AbreConexaoDisplay (const char *porta)
 Método utilizado para estabelecer conexão usb com PIX4. Mais...
 
int ObtemVersaoFirmware ()
 Método utilizado para obter a versão atual do firmware. Mais...
 
boolean ObtemConexao ()
 Método utilizado para obter o estado atual da conexão do equipamento. Mais...
 
int DesconectarDisplay ()
 Método usado para desconectar o PIX4. Mais...
 
int InicializaDisplay ()
 Método utilizado na inicialização e limpeza da tela para novas apresentações. Mais...
 
int ReinicializaDisplay ()
 Método usado na reinicialização do Display PIX4, após reinicialização necessário realizar uma nova abertura de conexão. Mais...
 
int CarregaImagemDisplay (const char *fileName, const char *filePath, final int largura, final int altura)
 Método utilizado para gravar imagem no dispositivo. Mais...
 
int ApresentaImagemDisplay (const char *fileName, int posY, int posX, int tipo)
 Método utilizado para apresentar uma imagem gravada anteriormente usando método CarregaImagemDisplay(). Mais...
 
int ApresentaQRCode (const char *qrCode, int tamanho, int posY, int posX)
 Método utilizado para apresentar o qrCode na coordenada especificada. Mais...
 
int ApresentaTextoColorido (const char *texto, int idTexto, int tamanho, int posY, int posX, const char *hexadecimal)
 Método utilizado para apresentar um texto colorido na coordenada especificada. Mais...
 
void ApresentaListaCompras (const char *descricao, const char *valor)
 Método utilizado para apresentar uma lista dinâmica de compras. Mais...
 
void InicializaLayoutPagamento (const char *subTotal, const char *desconto, const char *totalPagar)
 Método utilizado para inicializar a tela de finalização de venda. Mais...
 
int AdicionaFormaPagamento (int tipoPagamento, const char *valor)
 Método utilizado para adicionar uma forma de pagamento ao layout de finalização da venda. Mais...
 

Descrição detalhada

Descrição das funções de PIX4.

Funções

◆ AbreConexaoDisplay()

int AbreConexaoDisplay ( const char *  porta)

Método utilizado para estabelecer conexão usb com PIX4.

Parâmetros
portachar* Parâmetro do tipo cadeia de caracteres que recebe a porta COM em que o PIX4 está conectado, por exemplo: "COM4".
Retorna
int O retorno da função é do tipo inteiro.
A função bem sucedida deve retornar 0.
A função mal sucedida deve retornar -1.
Código Erro Descrição
-12 Dispositivo não existe
-13 Permissão Negada
-14 Erro Desconhecido
-19 Dispositivo Removido Inesperadamente

◆ ObtemVersaoFirmware()

int ObtemVersaoFirmware ( )

Método utilizado para obter a versão atual do firmware.

Retorna
int O retorno da função é do tipo numérico.
A função bem sucedida deve retornar a versao atual do firmware (ex: 13).
A função mal sucedida deve retornar -1.
Código Erro Descrição
-4 Porta Fechada
-44 Erro Escrita

◆ ObtemConexao()

boolean ObtemConexao ( )

Método utilizado para obter o estado atual da conexão do equipamento.

Retorna
boolean O retorno da função é do tipo boolean.
A função bem sucedida deve retornar TRUE.
A função mal sucedida deve retornar FALSE.

◆ DesconectarDisplay()

int DesconectarDisplay ( )

Método usado para desconectar o PIX4.

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

◆ InicializaDisplay()

int InicializaDisplay ( )

Método utilizado na inicialização e limpeza da tela para novas apresentações.

Retorna
int O retorno da função é do tipo numérico.
A função bem sucedida deve retornar 0.
A função mal sucedida deve retornar -1.
Código Erro Descrição
-4 Porta Fechada
-44 Erro Escrita

◆ ReinicializaDisplay()

int ReinicializaDisplay ( )

Método usado na reinicialização do Display PIX4, após reinicialização necessário realizar uma nova abertura de conexão.

Retorna
int O retorno da função é do tipo numérico.
A função bem sucedida deve retornar 0.
A função mal sucedida deve retornar -1.
Código Erro Descrição
-4 Porta Fechada

◆ CarregaImagemDisplay()

int CarregaImagemDisplay ( const char *  fileName,
const char *  filePath,
final int  largura,
final int  altura 
)

Método utilizado para gravar imagem no dispositivo.

Observação
A resolução máxima do hardware é 320x480, então qualquer imagem acima desta resolução não será visualizado como deveria.
Parâmetros
fileNameDefine o nome identificador da imagem a ser salva. Ex:
fileName filePath
Imagem Inicial logo.jpg
Imagem 1 p1.jpg
Imagem 2 p3.jpg

filePathchar* Define o caminho onde se encontra a imagem a ser salva.
largurachar* Define a largura imagem. (ex. 300)
alturachar* Define a altura imagem. (ex. 480)
Retorna
int O retorno da função é do tipo numérico.
A função bem sucedida deve retornar 0.
A função mal sucedida deve retornar -1.
Código Erro Descrição
-4 Porta Fechada
-44 Erro Escrita

◆ ApresentaImagemDisplay()

int ApresentaImagemDisplay ( const char *  fileName,
int  posY,
int  posX,
int  tipo 
)

Método utilizado para apresentar uma imagem gravada anteriormente usando método CarregaImagemDisplay().

Parâmetros
fileNamechar* Define o nome dado ao arquivo quando carregado.
posYchar* Define a coordenada posição vertical. 0 >= posV <= 480.
posXchar* Define a coordenada posição horizontal. 0 >= posH <= 300.
tipochar* Define o tipo de apresentação.
Valor Descrição
0 Apenas mostrar
1 Mostrar após limpar a tela

Retorna
int O retorno da função é do tipo numérico.
A função bem sucedida deve retornar 0.
A função mal sucedida deve retornar -1.
Código Erro Descrição
-4 Porta Fechada
-44 Erro Escrita

◆ ApresentaQRCode()

int ApresentaQRCode ( const char *  qrCode,
int  tamanho,
int  posY,
int  posX 
)

Método utilizado para apresentar o qrCode na coordenada especificada.

Parâmetros
qrCodechar* Define o valor do QRCode a ser apresentado.
tamanhoint Parâmetro do tipo inteiro que define o tamanho do qrCode. 15 >= tamanho <= 255.
posYint Parâmetro do tipo inteiro que define a coordenada posição vertical. 0 >= posH <= 480.
posXint Parâmetro do tipo inteiro que define a coordenada posição horizontal. 0 >= posV <= 300.
Retorna
int O retorno da função é do tipo numérico.
A função bem sucedida deve retornar 0.
A função mal sucedida deve retornar -1.
Código Erro Descrição
-4 Porta Fechada
-44 Erro Escrita

◆ ApresentaTextoColorido()

int ApresentaTextoColorido ( const char *  texto,
int  idTexto,
int  tamanho,
int  posY,
int  posX,
const char *  hexadecimal 
)

Método utilizado para apresentar um texto colorido na coordenada especificada.

Parâmetros
textochar* Parâmetro do tipo caractere que define o texto a ser apresentado.
idTextoint Parâmetro do tipo numérico que define o id do texto a ser apresentado. 1 >= idTexto =< 19.
tamanhoint Parâmetro do tipo numérico que define o tamanho da fonte. 10 >= tamanho =< 50.
posYint Parâmetro do tipo numérico que define a coordenada posição vertical. 0 >= posY <= 480.
posXint Parâmetro do tipo numérico que define a coordenada posição horizontal. 0 >= posX <= 300.
hexadecimalchar* Parâmetro do tipo cadeia de caracteres que define a cor da fonte em hexadecimal.
Retorna
int O retorno da função é do tipo numérico.
A função bem sucedida deve retornar 0.
A função mal sucedida deve retornar -1.
Código Erro Descrição
-4 Porta Fechada
-44 Erro Escrita

◆ ApresentaListaCompras()

void ApresentaListaCompras ( const char *  descricao,
const char *  valor 
)

Método utilizado para apresentar uma lista dinâmica de compras.

Parâmetros
descricaochar* Parâmetro do tipo caractere que define a descrição do produto.
valorchar* Parâmetro do tipo cadeia de caracteres que define o valor do Produto.

◆ InicializaLayoutPagamento()

void InicializaLayoutPagamento ( const char *  subTotal,
const char *  desconto,
const char *  totalPagar 
)

Método utilizado para inicializar a tela de finalização de venda.

Parâmetros
subTotalchar* Parâmetro do tipo cadeia de caracteres que define o valor do sub total da venda.
descontochar* Parâmetro do tipo cadeia de caracteres que define o valor desconto da venda.
totalPagarchar* Parâmetro do tipo cadeia de caracteres que define o valor total a pagar da venda.

◆ AdicionaFormaPagamento()

int AdicionaFormaPagamento ( int  tipoPagamento,
const char *  valor 
)

Método utilizado para adicionar uma forma de pagamento ao layout de finalização da venda.

Parâmetros
tipoPagamentoint Parâmetro do tipo inteiro que define qual tipo de pagamento sera adicionado. (1 >= tipoPagamento <= 4)
Valor Descrição
1 Dinheiro
2 Crédito
3 Débito
4 PIX

valorconst char* Parâmetro do tipo const char* que define o valor da forma de pagamento.
Retorna
int O retorno da função é do tipo numérico.
A função bem sucedida deve retornar 0.
A função mal sucedida deve retornar -1.