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

Funções

int IniciarConfigLayout ()
 
int AdicionarTexto (const char *info, int posicao, int estilo)
 
int AdicionarHTML (const char *info)
 
int AdicionarQuebraDeLinha (int quant)
 
int LimparLayout ()
 
int AdicionarCodigoBarras (int tipo, const char *dados, int altura, int largura, int HRI)
 
int AdicionarQRCode (const char *dados, int tamanho, int nivelCorrecao)
 
int AdicionarImagem (const char *path)
 
const char * ImprimirLayout ()
 
const char * ReimprimirLayout ()
 
const char * StatusImpressora ()
 

Descrição detalhada

As funções descritas nessa sessão tem como objetivo disponibilizar um meio de uso da impressora do POS.
Abaixo é detalhado o fluxo de uso das funções para realizar uma impressão simples.

Funções

◆ IniciarConfigLayout()

int IniciarConfigLayout ( )

Iniciar a configuração do layout a ser impresso.

Retorna
Retorno tipo int.
Retornos:
0 - Operação realizada com sucesso.
1 - Erro.

◆ AdicionarTexto()

int AdicionarTexto ( const char *  info,
int  posicao,
int  estilo 
)

Adiciona um texto ao arquivo base de acordo com as características informadas nos parâmetros.

Parâmetros
info- Informação e/ou texto a ser adicionado ao arquivo.
posicao- Parâmetro tipo numérico que define a posição do texto a ser impresso.

‍0 - Esquerda
1 - Centro
2 - Direita

estilo- Parâmetro numérico que altera o estilo do texto impresso.

‍0 - Normal
1 - Condensado
2 - Expandido
4 - Dupla altura
8 - Sublinhado
16 - Modo reverso
32 - Negrito

Obs. Para habilitar mais de um estilo deve-se realizar a soma dos valores
Retorna
Retorno tipo int.
Retornos:
0 - Operação realizada com sucesso.
1 - Erro.
2 - Arquivo não encontrado.
3 - Erro de parametro (incorreto).

◆ AdicionarHTML()

int AdicionarHTML ( const char *  info)

Adiciona um texto ou o conteúdo de determinado arquivo ao arquivo base, de acordo com as características informadas nos parâmetros.

Parâmetros
info- Texto : Informação e/ou texto a ser adicionado ao arquivo.
ou
Arquivo: "path=C:\\LocalDoArquivo/Arquivo.txt". O termo "path" sinaliza que será utilizado o conteúdo um arquivo (TXT) como parâmetro.
Consulte TAGs de impressão para mais detalhes
Retorna
Retorno tipo int.
Retornos:
0 - Operação realizada com sucesso.
1 - Erro.
2 - Arquivo não encontrado.
3 - Erro de parametro (incorreto).

◆ AdicionarQuebraDeLinha()

int AdicionarQuebraDeLinha ( int  quant)

Adicionar "N" quebras de linha no arquivo base.

Parâmetros
quant- Quantidade de quebras de linha a serem adicionadas ao arquivo base (inteiro).
Retorna
Retorno tipo int.
Retornos:
0 - Operação realizada com sucesso.
1 - Erro.
2 - Arquivo não encontrado.
3 - Erro de parametro (incorreto).

◆ LimparLayout()

int LimparLayout ( )

Limpar arquivo base de layout.

Retorna
Retorno tipo int.
Retornos:
0 - Operação realizada com sucesso.
1 - Erro.

◆ AdicionarCodigoBarras()

int AdicionarCodigoBarras ( int  tipo,
const char *  dados,
int  altura,
int  largura,
int  HRI 
)

Realizar a impressão de código de barras.

Parâmetros
tipo- Define o modelo do código de barras a ser impresso.
Valor Modelo Quantidade de dados Caracteres Regras
0 UPC-A 11 ou 12 0 até 9 -
1 UPC-E 6, 7, 8, 11 ou 12 0 até 9 Quantidade = 6 se 1º != 0
2 JAN13 / EAN 13 12 ou 13 0 até 9 -
3 JAN8 / EAN 8 7 ou 8 0 até 9 -
4 CODE 39 1 até 255 0 até 9, A até Z\nSP, $, %, *, +, -, \, . -
5 ITF 2 até 255 (números pares) 0 até 9 -
6 CODE BAR 1 até 255 0 até 9, A até D, a até d
$, +, -, ., /, :
1º e nº devem ser A até D ou a até d
7 CODE 93 1 até 255 00H até 7FH -
8 CODE 128 2 até 255 00H até 7FH 1º = {, 2º = A, B ou C
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. Se valor definido ultrapassar área de impressão o código não será impresso.
HRI- Define a posição de impressão do conteúdo do código de barras.
1 - Acima do código
2 - Abaixo do código
3 - Ambos
4 - Não impresso
Retorna
Retorno tipo int.
Retornos:
0 - Operação realizada com sucesso.
1 - Erro.
2 - Arquivo não encontrado.
3 - Erro de parametro (incorreto).

◆ AdicionarQRCode()

int AdicionarQRCode ( const char *  dados,
int  tamanho,
int  nivelCorrecao 
)

Essa função imprime o código QRCode com possibilidade de variação de tamanho e nível de correção.

Parâmetros
dados- Conjunto de informações que irão compor o QRCode.
tamanho- Tamanho do QRCode. Valor de 1 até 6.
nivelCorrecaode correção - Define o nível de correção a ser configurado para o QRCode.
1 - 7%
2 - 15%
3 - 25%
4 - 30%
Retorna
Retorno tipo int.
Retornos:
0 - Operação realizada com sucesso.
1 - Erro.
2 - Arquivo não encontrado.
3 - Erro de parametro (incorreto).

◆ AdicionarImagem()

int AdicionarImagem ( const char *  path)

Essa função imprime uma imagem de acordo com o path informado.

Parâmetros
path- Indica o "caminho" do arquivo de imagem a ser utilizado.
Retorna
Retorno tipo int.
Retornos:
0 - Operação realizada com sucesso.
1 - Erro.
2 - Arquivo não encontrado.
3 - Erro de parametro (incorreto).

◆ ImprimirLayout()

const char * ImprimirLayout ( )

Essa função imprime o layout configurado.

Retorna
Retorno tipo const char*.
Exemplo de retorno para impressão realizada com sucesso
{
"e1_brigde_code": 0,
"e1_brigde_msg": "Impressão E-HTML realizada com sucesso"
}

◆ ReimprimirLayout()

const char * ReimprimirLayout ( )

Essa função reimprime o layout configurado anteriormente.

Retorna
Retorno tipo const char*.
Exemplo de retorno para impressão realizada com sucesso
{
"e1_brigde_code": 0,
"e1_brigde_msg": "Impressão E-HTML realizada com sucesso"
}

◆ StatusImpressora()

const char * StatusImpressora ( )

Essa função verifica o status de papel na impressora do SmartPOS

Retorna
Retorno tipo const char* no formato JSON com o valor do status, vide exemplo abaixo:
Exemplo de retorno para papel ok
{
"e1_brigde_code": 5,
"e1_brigde_msg": "Status obtido com sucesso"
}
Possiveis valores para a propriedade e1_brigde_code:.
5- Indica que o papel está presente e não está próximo do fim.
6- Indica papel próximo do fim.
7- Indica papel ausente.