Plataforma de Comunicação Elgin versão 3.13.9
Documentação das bibliotecas de integração com hardware Elgin
|
Fornece funções específicas de comunicação com SAT Elgin. Mais...
Funções | |
char * | AtivarSAT (int numSessao, int subComando, const char *codAtivacao, const char *cnpj, int cUF) |
char * | EnviarDadosVenda (int numSessao, const char *codAtivacao, const char *dadosVenda) |
char * | CancelarUltimaVenda (int numSessao, const char *codAtivacao, const char *numeroCFe, const char *dadosCancelamento) |
char * | ConsultarSAT (int numSessao) |
char * | TesteFimAFim (int numSessao, const char *codAtivacao, const char *dadosVenda) |
char * | ConsultarStatusOperacional (int numSessao, const char *codAtivacao) |
char * | ConsultarNumeroSessao (int numSessao, const char *codAtivacao, int cNumeroDeSessao) |
char * | ConsultarUltimaSessaoFiscal (int numSessao, const char *codAtivacao) |
char * | ConfigurarInterfaceDeRede (int numSessao, const char *codAtivacao, const char *dadosConfiguracao) |
char * | AssociarAssinatura (int numSessao, const char *codAtivacao, const char *cnpjSH, const char *assinaturaAC) |
char * | AtualizarSoftwareSAT (int numSessao, const char *codAtivacao) |
char * | ExtrairLogs (int numSessao, const char *codAtivacao) |
char * | BloquearSAT (int numSessao, const char *codAtivacao) |
char * | DesbloquearSAT (int numSessao, const char *codAtivacao) |
char * | TrocarCodigoDeAtivacao (int numSessao, const char *codAtivacao, int opcao, const char *novoCodigo, const char *confNovoCodigo) |
char * | GetVersaoDLL () |
Retorna a versão da DLL E1_SAT. Mais... | |
void | HabilitarConexaoContinua (void) |
Permite que a biblioteca mantenha a conexão USB aberta até que a aplicação seja finalizada. Mais... | |
void | DesabilitarConexaoContinua (void) |
Fecha a conexao USB apos cada resposta ser recebida, permitindo que outras aplicacoes acessem o mesmo dispositivo. Mais... | |
int | FiltraSATNumSerie (const char *numero_serie) |
Configura a biblioteca para utilizar um SAT com o numero de serie especificado. Mais... | |
int | FiltraSATUsb (unsigned int bus, unsigned int port) |
Configura a biblioteca para utilizar um SAT na porta USB especificada. Mais... | |
void | LimpaFiltrosSAT (void) |
Configura a biblioteca para utilizar o primeiro SAT encontrado. Mais... | |
char * | ListAvailableSatAsJson (void) |
Lista todos os dispositivos SAT livres encontrados na máquina identificado o seu modelo, hub e port usb e número de série retornado em uma string json. Mais... | |
Fornece funções específicas de comunicação com SAT Elgin.
Os modelos compatíveis com essa biblioteca são:
Linker SAT Elgin II.
SmartSAT
Bematech RB 1000
Bematech RB 2000
Bematech SATGO
Convenções usadas nas chamadas das funções da biblioteca:
Windows**
__stdcall Linux**
__cdecl
A biblioteca (dll) irá procurar o arquivo de configuração nos seguintes diretórios:
Linux: /etc/elgin/sat-config.ini
Windows: C:\windows\system32\sat-config.ini
Se a biblioteca não encontrar o arquivo de configuração no diretório padrão, a lib irá procurar no diretório onde a aplicação está sendo executada.
Um exemplo do arquivo sat-config.ini pode ser visto abaixo:
char * AtivarSAT | ( | int | numSessao, |
int | subComando, | ||
const char * | codAtivacao, | ||
const char * | cnpj, | ||
int | cUF | ||
) |
Função utilizada no processo de ativação do sat.
numSessao | - Parâmetro do tipo numérico que informa o número de sessão. |
subComando | - Parâmetro do tipo numérico que define o tipo de certificação. |
codAtivacao | - Parâmetro do tipo caracter que informa a senha definida pelo contribuinte. |
cnpj | - Parâmetro do tipo caracter que informa o cnpj do contribuinte. |
cUF | - Parâmetro do tipo numérico que informa o codigo da federação estadual . |
** Exemplo json para uso com Serviço.**
** Exemplo de comando com separadores para uso do Serviço no modo troca de arquivos.**
char * EnviarDadosVenda | ( | int | numSessao, |
const char * | codAtivacao, | ||
const char * | dadosVenda | ||
) |
Função utilizada para enviar os dados de uma venda para que o SAT possa gerar um CFe de venda.
numSessao | - Parâmetro do tipo numérico que informa o número de sessão. |
codAtivacao | - Parâmetro do tipo caracter que informa a senha definida pelo contribuinte. |
dadosVenda | - Parâmetro do tipo caracter que define a entrada dos dados de venda. |
Exemplo json para uso com Serviço
Exemplo de comando com separadores para uso do Serviço no modo troca de arquivos
char * CancelarUltimaVenda | ( | int | numSessao, |
const char * | codAtivacao, | ||
const char * | numeroCFe, | ||
const char * | dadosCancelamento | ||
) |
Função utilizada para efetuar o cancelamento do cupom referente à última venda realizada.
numSessao | - Parâmetro do tipo numérico que informa o número de sessão. |
codAtivacao | - Parâmetro do tipo caractere que informa o código de ativação definido pelo usuário. |
numeroCFe | - Parâmetro do tipo caractere que permite ao usuário informar o número do CFe da venda a ser cancelada. |
dadosCancelamento | - Parâmetro do tipo caractere que define o XML de cancelamento referente ao número de CFe informado. |
** Exemplo JSON para uso com Serviço. **
** Exemplo de comando com separadores para uso com Serviço. **
char * ConsultarSAT | ( | int | numSessao | ) |
Função utilizada para testar comunicação com SAT.
numSessao | - Parâmetro tipo numérico que informa o numero de sessão |
** Exemplo json para uso com Serviço.**
** Exemplo de comando com separadores para uso do Serviço no modo troca de arquivos.**
char * TesteFimAFim | ( | int | numSessao, |
const char * | codAtivacao, | ||
const char * | dadosVenda | ||
) |
Função utilizada para realizar a emissão de um CFe de teste e verificar se os processo de emissão de CFes e de comunicação
com a Secretaria da Fazenda estão funcionando.
numSessao | - Parâmetro do tipo numérico que informa o numero de sessão. |
codAtivacao | - Parâmetro do tipo caracter que informa o codigo de ativação definido pelo usuário. |
dadosVenda | - Parâmetro do tipo caracter que recebe o xml com so dados da venda de teste. |
** Exemplo json para uso com Serviço.**
** Exemplo de comando com separadores para uso do Serviço no modo troca de arquivos.**
char * ConsultarStatusOperacional | ( | int | numSessao, |
const char * | codAtivacao | ||
) |
Função utilzada para obter informações do estado de operação do SAT.
numSessao | - Parâmetro do tipo numérico que informa o numero de sessão. |
codAtivacao | - Parâmetro do tipo caracter que informa o código de ativação definido pelo usuário. |
** Exemplo json para uso com Serviço.**
** Exemplo de comando com separadores para uso do Serviço no modo troca de arquivos.**
char * ConsultarNumeroSessao | ( | int | numSessao, |
const char * | codAtivacao, | ||
int | cNumeroDeSessao | ||
) |
Função utilizada para obter o número de sessão a ser consultado.
numSessao | - Parâmetro do tipo numérico que informa o numero de sessão. |
codAtivacao | - Parâmetro do tipo caracter que informa o código de ativação definido pelo usuário. |
cNumeroDeSessao | - Parâmetro do tipo numérico que informa o numero da sessão a ser consultada. |
** Exemplo json para uso com Serviço.**
** Exemplo de comando com separadores para uso do Serviço no modo troca de arquivos.**
char * ConsultarUltimaSessaoFiscal | ( | int | numSessao, |
const char * | codAtivacao | ||
) |
Função utilizada para consultar o resultado da última sessão fiscal processada, isto é, o resultado da última venda ou do último cancelamento de venda processado.
numSessao | - Parâmetro do tipo numérico que informa o número de sessão. |
codAtivacao | - Parâmetro do tipo caractere que informa o código de ativação definido pelo usuário. |
** Exemplo JSON para uso com Serviço. **
** Exemplo de comando com separadores para uso com Serviço. **
char * ConfigurarInterfaceDeRede | ( | int | numSessao, |
const char * | codAtivacao, | ||
const char * | dadosConfiguracao | ||
) |
Função utilizada para configurar o tipo de conexão de rede.
numSessao | - Parâmetro do tipo numérico que informa o numero de sessão. |
codAtivacao | - Parâmetro do tipo caracter que informa o código de ativação definido pelo usuário. |
dadosConfiguracao- | Parâmetro do tipo caracter que informa os dados a serem configurados em forma de XML. |
** Exemplo json para uso com Serviço.**
{"Modulo": "SAT","Comando": "ConfigurarInterfaceDeRede","Parametros": [{"numSessao": 00001,"codAtivacao": "123456789","dadosConfiguracao": "<?xml version=\"1.0\" encoding=\"UTF - 8\"?><config><tipoInter>ETHE</tipoInter><tipoLan>DHCP</tipoLan></config>"}]}
** Exemplo de comando com separadores para uso do Serviço no modo troca de arquivos.**
SAT:|ConfigurarInterfaceDeRede:|00001:|123456789:|<?xml version=\"1.0\" encoding=\"UTF - 8\"?><config><tipoInter>ETHE</tipoInter><tipoLan>DHCP</tipoLan></config>
char * AssociarAssinatura | ( | int | numSessao, |
const char * | codAtivacao, | ||
const char * | cnpjSH, | ||
const char * | assinaturaAC | ||
) |
Função utilizada para associar uma assinatura de Software House junto ao Sat.
numSessao | - Parâmetro do tipo numérico que informa o numero de sessão. |
codAtivacao | - Parâmetro do tipo caracter que informa o código de ativação definido pelo usuário. |
cnpjSH | - Parâmetro do tipo caracter que informa o cnpj da Software House. |
assinaturaAC | - Parâmetro do tipo caracter que informa a assinatura gerada e fornecida pela software house. |
** Exemplo json para uso com Serviço.**
** Exemplo de comando com separadores para uso do Serviço no modo troca de arquivos.**
char * AtualizarSoftwareSAT | ( | int | numSessao, |
const char * | codAtivacao | ||
) |
Função utilizada na atualização do software básico do SAT.
numSessao | - Parâmetro do tipo numérico que informa o numero de sessão. |
codAtivacao | - Parâmetro do tipo caracter que informa o código de ativação definido pelo usuário. |
** Exemplo json para uso com Serviço.**
** Exemplo de comando com separadores para uso do Serviço no modo troca de arquivos.**
char * ExtrairLogs | ( | int | numSessao, |
const char * | codAtivacao | ||
) |
Função utilizada para consultar o log gerado pelo equipamento SAT.
numSessao | - Parâmetro do tipo numérico que informa o numero de sessão. |
codAtivacao | - Parâmetro do tipo caracter que informa o código de ativação definido pelo usuário. |
** Exemplo json para uso com Serviço.**
** Exemplo de comando com separadores para uso do Serviço no modo troca de arquivos.**
char * BloquearSAT | ( | int | numSessao, |
const char * | codAtivacao | ||
) |
Função utilizada para efetuar o bloqueio do equipamento caso tenha uma solicitação junto a Secretaria da Fazenda.
numSessao | - Parâmetro do tipo numérico que informa o numero de sessão. |
codAtivacao | - Parâmetro do tipo caracter que informa o código de ativação definido pelo usuário. |
** Exemplo json para uso com Serviço.**
** Exemplo de comando com separadores para uso do Serviço no modo troca de arquivos.**
char * DesbloquearSAT | ( | int | numSessao, |
const char * | codAtivacao | ||
) |
Função utilizada para efetuar o desbloqueio de SAT.
numSessao | - Parâmetro do tipo numérico que informa o numero de sessão. |
codAtivacao | - Parâmetro do tipo caracter que informa o código de ativação definido pelo usuário. |
** Exemplo json para uso com Serviço.**
** Exemplo de comando com separadores para uso do Serviço no modo troca de arquivos.**
char * TrocarCodigoDeAtivacao | ( | int | numSessao, |
const char * | codAtivacao, | ||
int | opcao, | ||
const char * | novoCodigo, | ||
const char * | confNovoCodigo | ||
) |
Função utilizada para efetuar a troca do código de ativação do SAT.
numSessao | - Parâmetro do tipo numérico que informa o numero de sessão. |
codAtivacao | - Parâmetro do tipo caracter que informa o código de ativação definido pelo usuário. |
opcao | - Parâmetro do tipo inteiro que especifica qual opcao da troca : (1) Troca de Código tradicional (2) Troca usando Código de Emergência. |
novoCodigo | - Novo código de ativação a ser salvo no equipamento. |
confNovoCodigo | - Confirmação do novo código de ativação. |
char * GetVersaoDLL | ( | ) |
Retorna a versão da DLL E1_SAT.
** Exemplo JSON para uso com Serviço. **
** Exemplo de comando com separadores para uso com Serviço. **
void HabilitarConexaoContinua | ( | void | ) |
Permite que a biblioteca mantenha a conexão USB aberta até que a aplicação seja finalizada.
Esse modo é habilitado por padrão
void DesabilitarConexaoContinua | ( | void | ) |
Fecha a conexao USB apos cada resposta ser recebida, permitindo que outras aplicacoes acessem o mesmo dispositivo.
Aviso: Nesse modo de operação o número de sessão deve ser controlado externamente
int FiltraSATNumSerie | ( | const char * | numero_serie | ) |
Configura a biblioteca para utilizar um SAT com o numero de serie especificado.
numero_serie | - Número de série do equipamento a ser utilizado, Ex: 900020819-03 |
int FiltraSATUsb | ( | unsigned int | bus, |
unsigned int | port | ||
) |
Configura a biblioteca para utilizar um SAT na porta USB especificada.
bus | - Número do barramento em que o SAT está conectado. |
port | - Número da porta em que o equipamento está conectado. |
void LimpaFiltrosSAT | ( | void | ) |
Configura a biblioteca para utilizar o primeiro SAT encontrado.
Esse modo é habilitado por padrão.
char * ListAvailableSatAsJson | ( | void | ) |
Lista todos os dispositivos SAT livres encontrados na máquina identificado o seu modelo, hub e port usb e número de série retornado em uma string json.