Plataforma de Comunicação Elgin versão 3.13.8
Documentação das bibliotecas de integração com hardware Elgin
|
Fornece funções para integração com impressoras ELGIN. Mais...
Funções | |
int | AbreConexaoImpressora (int tipo, const char *modelo, const char *conexao, int parametro) |
Abre conexão com a impressora. Mais... | |
int | FechaConexaoImpressora () |
Fecha conexão com a impressora. Mais... | |
int | EspacamentoEntreLinhas (int tamanho) |
EspacamentoEntreLinhas Altera o espaçamento entre linhas na impressão (line mode). Mais... | |
int | ImpressaoTexto (const char *dados, int posicao, int stilo, int tamanho) |
Envia informações de texto para o buffer da impressora. Mais... | |
int | Corte (int avanco) |
Realiza o corte do papel. Mais... | |
int | CorteTotal (int avanco) |
Realiza o corte total do papel. Mais... | |
int | ImpressaoQRCode (const char *dados, int tamanho, int nivelCorrecao) |
Impressão de QRCode. Mais... | |
int | ImpressaoPDF417 (int numCols, int numRows, int width, int height, int errCorLvl, int options, const char *dados) |
Impressão de código PDF417. Mais... | |
int | ImpressaoCodigoBarras (int tipo, const char *dados, int altura, int largura, int HRI) |
Impressão de código de barras. Mais... | |
int | AvancaPapel (int linhas) |
Imprime informações no buffer e avança o papel. Mais... | |
int | StatusImpressora (int param) |
Obtém o status da impressora. Mais... | |
int | AbreGavetaElgin () |
Abre gavetas Elgin. Mais... | |
int | AbreGaveta (int pino, int ti, int tf) |
Abre gaveta. Mais... | |
int | InicializaImpressora () |
Inicializa a impressora para novas tarefas. Mais... | |
int | DefinePosicao (int posicao) |
Define a posição do conteúdo a ser impresso. Mais... | |
int | SinalSonoro (int qtd, int tempoInicio, int tempoFim) |
Emite sinal sonoro. Mais... | |
int | DirectIO (unsigned char *writeData, unsigned int writeNum, unsigned char *readData, unsigned int *readNum) |
Envia comandos ESCPOS direto para a porta de comunicação. Mais... | |
int | ImprimeImagemMemoria (const char *key, int scala) |
Imprime imagem carregada em memória. Mais... | |
int | ImprimeXMLSAT (const char *dados, int param) |
Imprime Danfe SAT. Mais... | |
int | ImprimeXMLCancelamentoSAT (const char *dados, const char *assQRCode, int param) |
Imprime Danfe de cancelamento SAT. Mais... | |
int | ImprimeXMLNFCe (const char *dados, int indexcsc, const char *csc, int param) |
Imprime o Danfe NFCe. Mais... | |
int | ImprimeXMLCancelamentoNFCe (const char *dados, int param) |
ImprimeXMLCancelamentoNFCe Essa função recebe o conteúdo do XML de cancelamento do NFCe, valida o conteúdo, constrói o Danfe e realiza a impressão. Mais... | |
int | ModoPagina () |
Habilita Modo Página. Mais... | |
int | DirecaoImpressao (int direcao) |
Define Direção de Impressão. Mais... | |
int | DefineAreaImpressao (int oHorizontal, int oVertical, int dHorizontal, int dVertical) |
Define Área Impressão. Mais... | |
int | PosicaoImpressaoHorizontal (int nLnH) |
Define Posição de Impressão Horizontal. Mais... | |
int | PosicaoImpressaoVertical (int nLnH) |
Define a Posição da Impressão Vertical. Mais... | |
int | ImprimeModoPagina () |
Imprime Modo Página. Mais... | |
int | LimpaBufferModoPagina () |
Limpa Buffer em Modo Página. Mais... | |
int | ImprimeMPeRetornaPadrao () |
Imprime Modo Página e Retorna ao Modo Padrão. Mais... | |
int | ModoPadrao () |
Retorna ao Modo Padrão. Mais... | |
char * | GetVersaoDLL () |
Retorna a versão da DLL E1_Impressora. Mais... | |
int | ImprimeCupomTEF (const char *dados) |
Realiza a impressão do Cupom TEF . Mais... | |
int | ImprimeImagem (const char *path) |
Imprime imagem enviada à impressora diretamente, sem carregá-la na memória. Mais... | |
Fornece funções para integração com impressoras ELGIN.
Essa biblioteca fornece diversas funções de integração com as impresoras não Fiscais ELGIN.
Os modelos de impressoras compatíveis com essa biblioteca são:
Impressora i7
Impressora i7 Plus
Impressora i8
Impressora i9
Impressora ix
Impressora Fitpos
Impressora BK-T681
As impressoras de outras marcas compativeis são
Bematech MP-4200
Bematech MP-2800
Convenções usadas nas chamadas das funções da biblioteca:
Windows
__stdcall
Linux
__cdecl
int AbreConexaoImpressora | ( | int | tipo, |
const char * | modelo, | ||
const char * | conexao, | ||
int | parametro | ||
) |
Abre conexão com a impressora.
tipo | - Parâmetro do tipo numérico que define o tipo de comunicação que será estabelecido. Conforme tabela a seguir:
| ||||||||||||
modelo | - Parâmetro tipo caractere que especifica o modelo para conexão. Conforme lista:
| ||||||||||||
conexao | - Parâmetro tipo caractere que define detalhes de conexão. Detalhes de conexão:
| ||||||||||||
parametro | - Parâmetro do tipo numérico auxiliar para a conexão com a impressora. Utilizado para especificar baudrate ou porta de comunicação TCP/IP.
|
int FechaConexaoImpressora | ( | ) |
Fecha conexão com a impressora.
Finaliza a conexão que foi estabelecida em AbreConexaoImpressora.
int EspacamentoEntreLinhas | ( | int | tamanho | ) |
EspacamentoEntreLinhas Altera o espaçamento entre linhas na impressão (line mode).
tamanho | Define espaçamento. Valor entre 1 e 255. |
int ImpressaoTexto | ( | const char * | dados, |
int | posicao, | ||
int | stilo, | ||
int | tamanho | ||
) |
Envia informações de texto para o buffer da impressora.
As informações são impressas quando o buffer atinge o limite, quando é executada a
função AvancaPapel ou quando recebe um byte 10 (Line Feed – LF).
Caso nenhuma dessas opções seja executada um próximo comando pode apagar os dados do buffer.
dados | - Parâmetro tipo caractere com a informação que será enviada ao buffer de impressão. | ||||||||||||
posicao | - Parâmetro tipo numérico que define a posição do texto a ser impresso. Os possíveis valores são:
| ||||||||||||
stilo | - Parâmetro numérico que altera o estilo do texto impresso. O texto pode ser alterado entre os seguintes estilos:
|
tamanho | - Define o tamanho do texto a ser impresso. O texto pode ser aumentado em até 6 vezes na sua largura e altura. Os valores definidos são:
|
* Informações em buffer serão apagadas caso a função InicializaImpressora seja executada.
int Corte | ( | int | avanco | ) |
Realiza o corte do papel.
avanco | - Parâmetro numérico que indica o quanto o papel deve avançar antes do corte. |
int CorteTotal | ( | int | avanco | ) |
Realiza o corte total do papel.
avanco | - Parâmetro numérico que indica o quanto o papel deve avançar antes do corte. |
int ImpressaoQRCode | ( | const char * | dados, |
int | tamanho, | ||
int | nivelCorrecao | ||
) |
Impressão de QRCode.
Essa função imprime o código QRCode com possibilidade de variação de tamanho e nível de correção.
dados | - Conjunto de informações que irão compor o QRCode. | ||||||||||
tamanho | - Tamanho do QRCode.
| ||||||||||
nivelCorrecao | - Define o nível de correção a ser configurado para o QRCode. Conforme tabela a seguir:
|
* O QRCode pode não ser impresso caso a área de impressão seja ultrapassada.
Isso pode acontecer dependendo da quantidade de caracteres, tamanho do QRCode e nível de correção.
int ImpressaoPDF417 | ( | int | numCols, |
int | numRows, | ||
int | width, | ||
int | height, | ||
int | errCorLvl, | ||
int | options, | ||
const char * | dados | ||
) |
Impressão de código PDF417.
Realiza a impressão de PDF417, com possibilidade de variação de tamanho e nível de correção.
numCols | - Parâmetro do tipo numérico que define o número de colunas. Valores válidos:
| ||||||||||||||||||||
numRows | - Parâmetro do tipo numérico que define o número de linhas. Valores válidos:
| ||||||||||||||||||||
width | - Parâmetro do tipo numérico que define a largura do módulo, em pontos. Valores válidos:
| ||||||||||||||||||||
height | - Parâmetro do tipo numérico que define a altura da linha, multiplicando o valor definido pela largura do módulo (configurada em width). Valores válidos:
| ||||||||||||||||||||
errCorLvl | - Parâmetro do tipo numérico que define o nível de correção de erro. Valores válidos:
| ||||||||||||||||||||
options | - Parâmetro do tipo numérico que define a opção para PDF417. Valores válidos:
| ||||||||||||||||||||
dados | - Parâmetro do tipo caractere que define o código a ser impresso. Valores válidos:
|
int ImpressaoCodigoBarras | ( | int | tipo, |
const char * | dados, | ||
int | altura, | ||
int | largura, | ||
int | HRI | ||
) |
Impressão de código de barras.
Realiza a impressão de código de barras.
tipo | - Define o modelo do código de barras a ser impresso. Segue tabela de tipos disponíveis:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
dados | - Informação que compõe o código. | ||||||||||||||||||||||||||||||||||||||||||||||||||
altura | - Altura do código de barras. Valor de 1 até 255. | ||||||||||||||||||||||||||||||||||||||||||||||||||
largura | - Define a largura do código de barras. Valor de 1 até 6.
| ||||||||||||||||||||||||||||||||||||||||||||||||||
HRI | - Define a posição de impressão do conteúdo do código de barras.
|
int AvancaPapel | ( | int | linhas | ) |
Imprime informações no buffer e avança o papel.
linhas | - Indica o quanto o papel deve avançar. |
int StatusImpressora | ( | int | param | ) |
Obtém o status da impressora.
Essa função disponibiliza o status de gaveta, tampa, sensor de papel e do ejetor.
Gaveta | Tampa | Sensor de pouco papel | Sensor de papel presente | Ejetor | |
---|---|---|---|---|---|
i7 | x | x | x | ||
i8 | x | x | x | ||
i9 | x | x | x | x | |
ix | x | x | x | x | |
Fitpos | x | x | x | ||
BK-T681 | x | x | x | x | |
MP-4200 | x | x | x | x | |
MP-2800 | x | x | x | ||
DR800 | x | x | x | x | |
TM-T20 | x | x | x | ||
Print ID Touch | x | x | x | ||
SmartPOS | x | ||||
Mini PDV M8 | x | x |
param | - Parâmetro tipo numérico para indicar qual status deve ser retornado. Os possíveis valores são:
|
BIT | STATUS | DESCRIÇÃO |
---|---|---|
0 | LIGADO | Indica gaveta aberta |
DESLIGADO | Indica gaveta fechada | |
1 | LIGADO | Indica Tampa aberta |
DESLIGADO | Indica Tampa fechada | |
2 | LIGADO | Indica pouco papel |
DESLIGADO | Indica papel normal | |
3 | LIGADO | Indica papel ausente |
DESLIGADO | Indica papel presente | |
4 | LIGADO | Indica papel presente no ejetor |
DESLIGADO | Indica papel ausente no ejetor | |
5 | DESLIGADO | Fixo |
6 | DESLIGADO | Fixo |
7 | DESLIGADO | Fixo |
(*) Somente para impressora MP4200 ADV a partir da versão de FW 04.09.
int AbreGavetaElgin | ( | ) |
Abre gavetas Elgin.
Essa função usa parâmetros padrões para abertura de gavetas Elgin. Para abrir gavetas de marcas diferentes use AbreGaveta e envie os parâmetros necessários para abertura.
int AbreGaveta | ( | int | pino, |
int | ti, | ||
int | tf | ||
) |
Abre gaveta.
Essa função abre gavetas de acordo com os parâmetros fornecidos.
pino | - Indicação do pino a ser acionado.
|
ti | - Tempo de inicialização do pulso.
|
tf | - Tempo de desativação do pulso.
|
int InicializaImpressora | ( | ) |
Inicializa a impressora para novas tarefas.
Essa função inicializa a impressora para novas tarefas, redefine as configurações para o padrão da impressora e apaga as informações em buffer.
int DefinePosicao | ( | int | posicao | ) |
Define a posição do conteúdo a ser impresso.
posicao | - Parâmetro tipo numérico para indicar a posição. Os valores possíveis são:
|
int SinalSonoro | ( | int | qtd, |
int | tempoInicio, | ||
int | tempoFim | ||
) |
Emite sinal sonoro.
Emite sinal sonoro na impressora. Algumas impressoras não estão habilitadas para emitir sinal sonoro.
qtd | - Define quantidade de sinais emitidos.
|
tempoInicio | - Define o tempo em que o sinal deve ficar ativo. |
tempoFim | - Define o tempo entre um sinal e outro.
|
int DirectIO | ( | unsigned char * | writeData, |
unsigned int | writeNum, | ||
unsigned char * | readData, | ||
unsigned int * | readNum | ||
) |
Envia comandos ESCPOS 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.
writeData | - Sequência de comandos que devem ser enviados para a porta de comunicação. |
writeNum | - Quantidade de comandos enviados e que serão escritos. |
readData | - Alocação de memória que receberá os dados de retorno caso seja necessário. |
readNum | - Quantidade de dados que se espera ler. Após a execução da função, essa variável deve indicar a quantidade de dados lidos da porta. Para evitar a leitura da porta esse parâmetro deve estar em ZERO (0). |
int ImprimeImagemMemoria | ( | const char * | key, |
int | scala | ||
) |
Imprime imagem carregada em memória.
Essa função utiliza do par de chaves para imprimir a imagem carregada em memória.
O upload da imagem é feito através do aplicativo Elgin Utility.
key | - Par de chaves identificador da imagem. Valores entre (char)32 e (char)126.
|
scala | - Tamanho da impressão, podendo ser 1 ou 2 para normal e duplicado, respectivamente. |
int ImprimeXMLSAT | ( | const char * | dados, |
int | param | ||
) |
Imprime Danfe SAT.
Essa função recebe o XML de retorno da venda do SAT, valida o conteúdo, constrói o Danfe e realiza a impressão de acordo com a especificação da SEFAZ SP.
dados | - Conteúdo do XML de retorno da venda do SAT ou Caminho para arquivo com dados do SAT prefixado com "path=", ex: path=C:/Resposta SAT/CFe35210130197161000935590008544130085892910578.xml | |||||||||||||||||||||
param | - Parâmetro do tipo numérico para ativar bits que modificam o cupom a ser impresso. Os bits disponíveis e seus respectivos efeitos no cupom (quando ativados) são descritos a seguir:
O valor passado ao parâmetro deve ser a soma dos valores inteiros correspondentes aos bits desejados. O valor 0 não ativa nenhum bit e imprime o cupom padrão. |
Caso o XML apresente erros a função retornará a linha na qual encontrou o erro de acordo com XSD de validação.
Informações que não estejam presentes no XML serão desconsideradas.
int ImprimeXMLCancelamentoSAT | ( | const char * | dados, |
const char * | assQRCode, | ||
int | param | ||
) |
Imprime Danfe de cancelamento SAT.
Essa função recebe o XML de retorno da operação de cancelamento e os dados de assinatura do QRCode de venda, valida as informações, constrói o Danfe e realiza impressão de acordo com a especificação da SEFAZ SP.
dados | - Conteúdo do XML de cancelamento retornado pelo SAT ou Caminho para arquivo com dados do SAT prefixado com "path=", ex: path=C:/Resposta SAT/CFe35210130197161000935590008544130085892910578.xml | ||||||||||||
assQRCode | - Assinatura do QRCode retornado na operação de Venda. Essa informação é necessária porque o XML de retorno da operação de venda não a contém. | ||||||||||||
param | - Parâmetro do tipo numérico para ativar bits que modificam o cupom a ser impresso. Os bits disponíveis e seus respectivos efeitos no cupom (quando ativados) são descritos a seguir:
O valor passado ao parâmetro deve ser a soma dos valores inteiros correspondentes aos bits desejados. O valor 0 não ativa nenhum bit e imprime o cupom padrão. |
Caso o XML apresente erros a função retornará a linha na qual encontrou o erro de acordo com XSD de validação.
Informações que não estejam presentes no XML serão desconsideradas.
int ImprimeXMLNFCe | ( | const char * | dados, |
int | indexcsc, | ||
const char * | csc, | ||
int | param | ||
) |
Imprime o Danfe NFCe.
Essa função recebe o conteúdo do XML de venda do NFCe, valida o conteúdo, constrói o Danfe e realiza a impressão.
dados | - Conteúdo do XML retornado pela venda ou Caminho para arquivo com dados da NFCe prefixado com "path=", ex: path=C:/Resposta NFCe/33180705481336000137651000000916401000005909-nfce.xml | ||||||||||||||||||||||||||||||||||||
indexcsc | - Identificador do CSC (Código de Segurança do Contribuinte no Banco de Dados da SEFAZ).
| ||||||||||||||||||||||||||||||||||||
csc | - Código de Segurança do Contribuinte.
| ||||||||||||||||||||||||||||||||||||
param | - Parâmetro do tipo numérico para ativar bits que modificam o cupom a ser impresso. Os bits disponíveis e seus respectivos efeitos no cupom (quando ativados) são descritos a seguir:
O valor passado ao parâmetro deve ser a soma dos valores inteiros correspondentes aos bits desejados. O valor 0 não ativa nenhum bit e imprime o cupom padrão. |
int ImprimeXMLCancelamentoNFCe | ( | const char * | dados, |
int | param | ||
) |
ImprimeXMLCancelamentoNFCe Essa função recebe o conteúdo do XML de cancelamento do NFCe, valida o conteúdo, constrói o Danfe e realiza a impressão.
dados | - Conteúdo do XML retornado no processo de cancelamento ou Caminho para arquivo com dados da NFCe prefixado com "path=", ex: path=C:/Resposta NFCe/Canc_nfce.xml |
param | - Reservado para customizações. Passar valor ZERO. |
int ModoPagina | ( | ) |
Habilita Modo Página.
Deve ser utilizado para dar início aos trabalhos em modo página.
int DirecaoImpressao | ( | int | direcao | ) |
Define Direção de Impressão.
Função do modo página utilizada para definir a direção em que serão realizadas as impressões.
direcao | - Valor entre 0 e 3.
|
int DefineAreaImpressao | ( | int | oHorizontal, |
int | oVertical, | ||
int | dHorizontal, | ||
int | dVertical | ||
) |
Define Área Impressão.
Função do modo página usada para definir o tamanho da área de impressão.
oHorizontal | - Define o ponto inicial horizontal.
|
oVertical | - Define ponto inicial na direção vertical.
|
dHorizontal | - Define a dimensão na direção horizontal.
|
dVertical | Define a dimensão da direção vertical.
|
int PosicaoImpressaoHorizontal | ( | int | nLnH | ) |
Define Posição de Impressão Horizontal.
Função do modo página usada para definir a posição de impressão Horizontal.
nLnH | - Define o ponto inicial horizontal.
|
int PosicaoImpressaoVertical | ( | int | nLnH | ) |
Define a Posição da Impressão Vertical.
Função do modo página usada para definir a posição de impressão Vertical.
nLnH | - Define o ponto inicial Vertical.
|
int ImprimeModoPagina | ( | ) |
Imprime Modo Página.
Função que imprime em Modo Página.
int LimpaBufferModoPagina | ( | ) |
Limpa Buffer em Modo Página.
Função do modo página usada para Limpar o Buffer.
int ImprimeMPeRetornaPadrao | ( | ) |
Imprime Modo Página e Retorna ao Modo Padrão.
Função do modo página usada para Imprimir.
int ModoPadrao | ( | ) |
Retorna ao Modo Padrão.
Função do modo página usada para Retornar ao Modo Padrão.
char * GetVersaoDLL | ( | ) |
Retorna a versão da DLL E1_Impressora.
int ImprimeCupomTEF | ( | const char * | dados | ) |
Realiza a impressão do Cupom TEF
.
Essa função pode ser usada para imprimir o comprovante presente nos arquivos processados
nos TEF que utilizem modelo de troca de arquivos.
A função busca pelos registros 029-XXX.
dados | - Conteúdo a ser impresso ou Caminho para arquivo com dados da venda prefixado com "path=", ex: path=C:/Client/intpos.001 |
int ImprimeImagem | ( | const char * | path | ) |
Imprime imagem enviada à impressora diretamente, sem carregá-la na memória.
path | - Parâmetro do tipo caractere que define a imagem que será impressa. Este parâmetro recebe como argumento o caminho, no sistema de arquivos, onde a imagem está armazenada, incluindo seu nome. |