especificação técnica de requisitos · a) sensibilidade mínima de -160 dbm; b) primeira...

39
Especificação Técnica de Requisitos Data de Criação: 15 de Julho de 2015 Última Atualização: 15 de Agosto de 2017 Versão: ER MFE-CFe 1.3.20

Upload: others

Post on 26-Aug-2020

0 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos

Data de Criação: 15 de Julho de 2015

Última Atualização: 15 de Agosto de 2017

Versão: ER MFE-CFe 1.3.20

Page 2: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.20 (Direitos Reservados) I

CONTROLE DE VERSÕES

Versão Data Legislação Notas Técnicas incorporadas

1.0.0 20/07/2015

1.0.1 27/07/2015

1.0.2 15/09/2015

1.1.0 10/11/2015

1.3.2 20/06/2016

1.3.8 08/08/2016

1.3.16 21/11/2016

1.3.17 21/02/2017

1.3.18 02/03/2017

1.3.19 31/05/2017

1.3.20 15/08/2017

Page 3: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.20 (Direitos Reservados) II

DEFINIÇÕES E SIGLAS

Termo Descrição

AC Aplicativo Comercial Aplicativo para gestão das vendas e solicitação de emissão de Cupons Fiscais de Venda e de Cancelamento. Deve ser compatível com o MFE.

AC SEFAZ-CE Autoridade Certificadora que gerencia (emite e revoga) certificados digitais e-SAT de equipamentos MFE reconhecidos pela ICP-Brasil e providos pela própria SEFAZ-CE.

CFe Cupom Fiscal Eletrônico de Venda ou de Cancelamento.

Configurador Aplicativo para configuração e ativação do MFE.

Integrador Plataforma de comunicação disponibilizada pela Secretaria da Fazenda do Estado do Ceará para a integração de AC/PDV´s dos estabelecimentos contribuintes do ICMS do estado.

MFE

Módulo Fiscal Eletrônico Equipamento adotado pelo Estado do Ceará para emissão de Cupons Fiscais eletrônicos, nos termos do Projeto CFe, dotado de recursos de hardware e software adicionais necessários ao modelo de negócios do Ceará.

PDV Ponto do Venda Equipamento do Contribuinte onde está conectado o MFE e que realiza a emissão de CFes de venda ou de cancelamento.

Projeto CFe

Conjunto de especificações técnicas definidas pelos documentos de Especificação de Requisitos (ER), Manual de Orientação (MO) e demais documentos estabelecidos pela COTEPE conforme AJUSTE SINIEF nº 11 de 24 de Setembro de 2010 e posteriores alterações.

Projeto MFE

Projeto da SEFAZ-CE para implantação do Cupom Fiscal Eletrônico, baseado no Projeto CFE porém acrescido de funcionalidades específicas para o Estado do Ceará definidas pela SEFAZ-CE no documento de Especificação de Requisitos do MFE (ER-MFE) e demais documentos de apoio disponíveis no sítio eletrônico: HTTP://CFE.SEFAZ.CE.GOV.BR.

SEFAZ-CE Secretaria da Fazenda do Estado do Ceará.

Page 4: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.20 (Direitos Reservados) III

ÍNDICE

1. INTRODUÇÃO ................................................................................................................................. 1

2. ARQUITETURA DA SOLUÇÃO MFE .............................................................................................. 2

3. MÓDULO FISCAL ELETRÔNICO – MFE ......................................................................................... 4

3.1. Requisitos de hardware ................................................................................................................... 4

3.1.1. Bateria operacional .................................................................................................................... 4

3.1.1.1. Características ....................................................................................................................... 4

3.1.1.2. Autonomia ............................................................................................................................ 4

3.1.1.3. Bateria removível ................................................................................................................... 5

3.1.1.4. Vida útil ................................................................................................................................ 5

3.1.2. Interfaces de comunicação .......................................................................................................... 5

3.1.2.1. Interface Modem celular ......................................................................................................... 5

3.1.2.2. Interface WIFI ....................................................................................................................... 5

3.1.3. Informação de Localização ......................................................................................................... 5

3.1.4. Sensor de queda/impacto ............................................................................................................ 6

3.1.5. Unidade de processamento .......................................................................................................... 6

3.1.6. Memória de trabalho e parametrização ......................................................................................... 6

3.1.7. Módulo Criptográfico ................................................................................................................. 6

3.2. Identificação .................................................................................................................................. 7

3.3. Ativação do MFE ........................................................................................................................... 7

3.3.1. Certificado somente via processo automatizado ............................................................................ 7

3.3.2. Tags da CSR .............................................................................................................................. 7

3.4. Função EnviarDadosVenda – tempo de resposta ............................................................................... 8

3.5. Softwares embarcados no MFE ....................................................................................................... 9

3.5.1. Sistema Operacional ................................................................................................................... 9

3.5.2. Software Básico ......................................................................................................................... 9

3.5.2.1. Comunicação com o PDV ..................................................................................................... 10

3.5.2.2. Comunicação com o Componente de Segurança ..................................................................... 10

3.5.2.3. Chaveamento do Canal de Comunicação internet .................................................................... 10

3.5.3. Componente de Segurança ........................................................................................................ 11

3.5.3.1. Função ConsultarStatusMFE – informações sobre o MFE ....................................................... 11

4. SOFTWARES DO PONTO DE VENDA ........................................................................................... 15

4.1. Aplicativo comercial .................................................................................................................... 15

4.2. Software de Ativação e Configuração ............................................................................................ 16

4.3. Driver MFE ................................................................................................................................. 16

4.3.1. Biblioteca de funções MFE ....................................................................................................... 16

Page 5: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.20 (Direitos Reservados) IV

4.3.2. Comunicador MFE ................................................................................................................... 17

4.3.3. Monitor MFE........................................................................................................................... 18

4.4. Driver de Comunicação USB-Serial............................................................................................... 18

5. ANEXO I – FUNÇÕES ADICIONAIS BIBLIOTECA MFE ............................................................... 19

5.1. Função ConfigurarInterfaceDeRedeMFE ....................................................................................... 19

5.2. Função ConsultarStatusOperacionalMFE ....................................................................................... 25

5.3. Função EnviarStatusAC ................................................................................................................ 31

6. ANEXO 2 – Controle de modificações do documento ......................................................................... 33

Page 6: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 1 / 34

1. INTRODUÇÃO

Este documento tem por objetivo a definição das especificações e critérios técnicos necessários para

orientar a fabricação do MFE (Módulo Fiscal Eletrônico) que será o equipamento emissor de Cupom

Fiscal Eletrônico (CFe) no Estado do Ceará.

A SEFAZ-CE atende a todas as Especificações Técnicas do Projeto CFe estabelecidos pela CONFAZ

porém, visando o modelo de negócios do Estado do Ceará, adotou componentes de hardware e

software adicionais.

Além disso, a SEFAZ-CE proverá componentes de software que objetivam facilitar o desenvolvimento

do Cupom Fiscal Eletrônico no Estado do Ceará, reduzindo esforços e custos para os Contribuintes e

Fabricantes de soluções para o Cupom Fiscal eletrônico.

O escopo deste documento refere-se a:

Arquitetura da Solução MFE

Requisitos de Hardware do MFE

Componentes de software do MFE

Componentes de software do Ponto de Venda

Especificações adicionais do Software Básico

Interfaces de comunicação entre os componentes

Componentes fornecidos pela SEFAZ-CE

A SEFAZ-CE fornecerá todo o apoio técnico necessário aos fabricantes de MFE na integração do

Componente de Segurança com o Software Básico e às Software Houses quanto às dúvidas na

emissão de Cupons Fiscais eletrônicos, através dos seguintes meios:

Sítio eletrônico

o SEFAZ: http://www.sefaz.ce.gov.br

o Projeto MFE: http://cfe.sefaz.ce.gov.br

Email

o Contribuintes: [email protected]

o Fabricantes de MFE e Software Houses: [email protected]

Telefone

o Call Center: 0800-707-8585

Page 7: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 2 / 34

2. ARQUITETURA DA SOLUÇÃO MFE

A arquitetura da Solução MFE é ilustrada abaixo:

Figura 1 – Componentes de software da Solução MFE

A Solução MFE é composta pelos seguintes componentes:

Ponto de Venda - PDV

Módulo Fiscal eletrônico - MFE

Web services do MFE - Retaguarda

O Ponto de Venda, ou PDV, é o equipamento do contribuinte responsável pelo processo de emissão

de Cupons Fiscais, através de um Aplicativo Comercial, e onde o MFE é conectado a uma porta USB.

Além do Aplicativo Comercial o PDV poderá também executar o Software de Ativação e Configuração

fornecido pelo Fabricante do MFE.

No PDV serão instalados também componentes de software disponibilizados pela SEFAZ-CE

necessários para a comunicação com o MFE e descritos adiante.

Page 8: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 3 / 34

O MFE é o equipamento responsável pela emissão dos Cupons Fiscais Eletrônicos de venda e de

cancelamento e executa o Software Básico, desenvolvido pelo Fabricante do MFE, e o Componente

de Segurança, disponibilizado pela SEFAZ-CE.

O MFE se comunica com a Retaguarda da SEFAZ-CE via internet através de web services.

Todos os softwares e documentos disponibilizados pela SEFAZ-CE poderão ser obtidos no sítio

eletrônico:

http://cfe.sefaz.ce.gov.br

Page 9: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 4 / 34

3. MÓDULO FISCAL ELETRÔNICO – MFE

3.1. Requisitos de hardware

O equipamento MFE deverá possuir todo o hardware e proteções contra violação definidos no Projeto

CFe e, adicionalmente, terá os recursos listados abaixo.

3.1.1. Bateria operacional

O MFE deverá possuir uma bateria recarregável, cuja presença tem os seguintes objetivos:

Permitir que contribuintes usuários de notebooks e tablets possam operar mesmo na ausência de

energia elétrica;

Garantir a finalização da operação em andamento;

Permitir o desligamento de forma segura;

Impedir que o MFE desligue em razão de oscilações de energia.

3.1.1.1. Características

A bateria deverá atender às seguintes características:

Deverá ser capaz de operar em temperaturas de 0ºC a +60ºC;

Não deverá possuir chumbo em sua composição;

Implementação facultativa até 31.12.2017 e obrigatória a partir de 01.01.2018:

Deverá possuir sensor de temperatura para garantir a segurança durante o processo de

carga;

Deverá possuir circuito de proteção contra descarga total.

3.1.1.2. Autonomia

A bateria deverá permitir a operação do MFE por, no mínimo, 01h (uma hora) sem alimentação

externa no seguinte cenário operacional:

Operação de uma venda a cada 3 minutos;

Envio de lote com a cada 30 minutos (CFeRecepcao);

Consulta a comandos a cada 30 minutos;

Não execução do comando ou da função de atualização do Software Básico;

Sem verificação de status de comunicação com a SEFAZ e sincronismo de relógio;

Consulta à verificação de recepção de CFe a cada 30 minutos (CFeRetRecepcao).

Page 10: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 5 / 34

3.1.1.3. Bateria removível

Caso a bateria seja removível:

Ela deverá ficar em um compartimento fora da área protegida mas interna ao corpo do módulo e

que não permita o acesso ao interior do MFE.

O MFE não poderá ser comercializado sem bateria ou com bateria com capacidade inferior à

utilizada na sua homologação.

3.1.1.4. Vida útil

A bateria deverá ter vida útil mínima de 05 (cinco) anos.

3.1.2. Interfaces de comunicação

3.1.2.1. Interface Modem celular

Além da comunicação via rede local do estabelecimento, através das interfaces Ethernet ou WIFI, o

MFE deverá possuir interface de modem celular com as seguintes características:

a) O modem celular deve suportar as tecnologias 2G e 3G em utilização no Brasil;

b) Suportar 01 (um) ou 02 (dois) SIMCARDs instalados simultaneamente que deverão ficar fora da

área protegida pelos mecanismos de blindagem;

c) Deverá ser possível a instalação do(s) SIMCARD(s) através de abertura no gabinete;

d) A antena deverá ser interna ao gabinete e fora da área protegida pelos mecanismos de

blindagem;

e) A interface de modem celular é a única que poderá se conectar diretamente à Internet, podendo

receber endereçamento IP válido.

3.1.2.2. Interface WIFI

Caso o MFE possua uma interface WIFI, a sua antena:

a) Poderá ser interna ou externa ao gabinete;

b) Caso seja interna, deverá estar fora da área protegida pelos mecanismos de blindagem;

c) Caso seja externa ao gabinete, o conector externo não poderá ser removível.

3.1.3. Informação de Localização

O MFE deverá ter capacidade de informar a sua localização geográfica.

Por isso deverá possuir um receptor GPS com as seguintes características:

Page 11: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 6 / 34

a) Sensibilidade mínima de -160 dbm;

b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do

posicionamento <= 10m (dez metros) com visada limpa;

c) A antena deverá ser interna ao gabinete e fora da área protegida pelos mecanismos de

blindagem.

O MFE deverá ser capaz de fornecer sua localização mesmo na ausência de sinal GPS através de

localização assistida provida pelo hardware do modem celular ou GPS, sem a necessidade de

contratação de qualquer serviço adicional ao de comunicação de dados.

3.1.4. Sensor de queda/impacto

O MFE poderá ser dotado de um acelerômetro com sensibilidade suficiente para detectar queda livre

e impactos resultantes de uma queda a partir uma altura igual ou superior a 60 cm.

3.1.5. Unidade de processamento

A unidade de processamento que executará o Software Básico deverá:

a) Ter arquitetura de 32 bits ou superior;

b) Executar o sistema operacional Linux.

3.1.6. Memória de trabalho e parametrização

Implementação facultativa até 31.12.2017 e obrigatória a partir de 01.01.2018:

A Memória de trabalho e parametrização deverá ter pelo menos 2GB de capacidade.

3.1.7. Módulo Criptográfico

Serão aceitos somente MFEs com módulos criptográficos por hardware com homologação FIPS 140-

2.

Implementação obrigatória a partir de 01.01.2018:

Os módulos criptográficos deverão ser homologados pelo Comitê Gestor (CG) da ICP-Brasil,

conforme suas determinações.

Page 12: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 7 / 34

3.2. Identificação

O MFE deverá conter identificação visual indelével em alto ou baixo relevo dos caracteres “MFE” na

face exposta ao observador conforme figura abaixo:

MFE

3.3. Ativação do MFE

As diferenças no processo de ativação do MFE são descritas a seguir.

3.3.1. Certificado somente via processo automatizado

Atendendo às normas estabelecidas pela ICP-Brasil, através da Resolução 115 de 11 de Novembro

de 2015, o MFE utilizará certificados digitais do tipo “A CF-e-SAT” (e-SAT) que serão fornecidos pela

SEFAZ-CE no momento da ativação automatizada do MFE, não sendo permitido o processo de

ativação manual com uso de certificado ICP-Brasil do Contribuinte.

3.3.2. Tags da CSR

A CSR possui algumas TAGs que devem ser preenchidas de acordo com o Estado em que o

equipamento é ativado.

Para o Ceará as TAGs específicas e seus respectivos valores são descritos abaixo:

TAG Valor Significado

O SEFAZ-CE Organização

OU AC-SEFAZ-CE Autoridade Certificadora

OU SEFAZ-CE Autoridade de Registro

ST Ceara Estado da Federação

Page 13: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 8 / 34

3.4. Função EnviarDadosVenda – tempo de resposta

Em função do tempo de processamento consumido pelo Componente de Segurança, os tempos de

resposta a um pedido de emissão de um CFe deverão ser:

Inferior a 2 segundos para cupons com até 50 itens;

Inferior a 4 segundos para cupons que com 51 a 200 itens;

Inferior a 6 segundos para cupons com 201 itens ou mais.

Page 14: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 9 / 34

3.5. Softwares embarcados no MFE

Os componentes de software embarcados no MFE são ilustrados abaixo:

Figura 2 – Softwares embarcados no MFE

3.5.1. Sistema Operacional

O Sistema Operacional Linux, por questões de segurança, estabilidade e de compatibilidade com o

Componente de Segurança deverá possuir Kernel e bibliotecas conforme consta no documento

Manual de Integração do Componente de Segurança.

3.5.2. Software Básico

É uma aplicação fornecida pelo Fabricante do MFE e responsável por executar todas as

funcionalidades previstas na Especificação de Requisitos do Projeto CFe.

As diferenças em relação à Especificação de Requisitos do Projeto CFe estão relacionadas a seguir:

Page 15: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 10 / 34

3.5.2.1. Comunicação com o PDV

O Software Básico se comunicará com o PDV através do Componente de Segurança, via protocolo

TCP/IP, e não mais diretamente através da porta USB.

A comunicação via porta USB será responsabilidade do Componente de Segurança que repassará ao

Software Básico todas as funções chamadas pelo Aplicativo Comercial e/ou Software de Ativação.

3.5.2.2. Comunicação com o Componente de Segurança

O Software Básico deverá disponibilizar 02 (duas) portas TCP para que o Componente de Segurança

possa se conectar:

9012/TCP: usada para repassar toda comunicação proveniente do Aplicativo Comercial ou

Software de Ativação.

9013/TCP: usada pelo Componente de Segurança para solicitar informações sobre o hardware e

status do MFE através da função ConsultarStatusMFE.

A comunicação proveniente do Componente de Segurança será compactada e o algoritmo de

compactação utilizado é baseado na biblioteca ZLIB.

ATENÇÃO: o Software Básico só deverá aceitar conexões provenientes de “localhost” não

permitindo, em hipótese alguma, conexões por qualquer interface de comunicação.

Para maiores informações consulte o “Manual de Integração do Componente de Segurança” para os

Fabricantes de MFE disponível no sítio: http://cfe.sefaz.ce.gov.br

3.5.2.3. Chaveamento do Canal de Comunicação internet

Caso o MFE tenha mais de uma interface de comunicação configurada, quando houver problemas de

comunicação com a SEFAZ-CE, o Software Básico deverá tentar todas as interfaces de rede

disponíveis, automaticamente, conforme a prioridade definida, exceto caso esteja operando em

bateria.

Page 16: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 11 / 34

3.5.3. Componente de Segurança

É uma aplicação fornecida pela SEFAZ-CE que será obrigatoriamente embarcada no MFE e operará

em conjunto com o Software Básico.

Ele será responsável por:

Realizar a comunicação com o PDV através do serviço Comunicador MFE pela porta USB;

Repassar para o Software Básico todas as funções chamadas pelo Aplicativo Comercial ou

Software de Ativação;

Coletar informações operacionais e fiscais do MFE através da função ConsultarStatusMFE;

Informar à SEFAZ-CE sobre eventuais problemas com o MFE e suas condições de operação;

O Componente de Segurança será disponibilizado na plataforma Linux.

Para maiores informações consulte o “Manual de Integração do Componente de Segurança”

disponível no sítio: http://cfe.sefaz.ce.gov.br

3.5.3.1. Função ConsultarStatusMFE – informações sobre o MFE

O Componente de Segurança solicitará ao Software Básico, através da função “ConsultarStatusMFE”

(porta 9013/TCP), informações sobre o estado de operação do MFE.

Se esta função não for solicitada pelo Componente de Segurança em até 05 (cinco) minutos deve-se

considerar que o Componente de Segurança entrou em modo de falha e devem ser tomadas as

medidas necessárias para restaurar o sistema.

O Software Básico deverá responder a essa função em até 10 segundos e retornar as seguintes

informações:

# Campo Ele Pai Tipo Ocor TAM Descrição

CSR01 statusMFE Raiz - - - - TAG raiz

CSR02 tpAmb E CSR01 N 1-1 1

Identificação do tipo de ambiente. Podendo

assumir os valores:

1: Produção

2: Testes

CSR03 UF E CSR01 N 1-1 2

Unidade federativa na qual o MFE está

habilitado. “00” se o MFE não estiver ativado

CSR04 numeroSerie E CSR01 N 1-1 9

Número de série do MFE

Formato: 999999999

Page 17: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 12 / 34

CSR05 MFE G CSR01

Agrupamento de dados referente a informações

do MFE

CSR06 versaoSoftwareBasico E CSR05 C 1-1 8

Versão do software básico

Formato “00.00.00”

CSR07 estado E CSR05 N 1-1 1-2

Estado do MFE:

0=DESBLOQUEADO

1=BLOQUEADO SEFAZ

2=BLOQUEADO CONTRIBUINTE

3=BLOQUEADO AUTONOMAMENTE

4=BLOQUEADO PARA DESATIVACAO

10=VIOLADO

Quando não estiver ativado o estado retornado

será BLOQUEADO SEFAZ

CSR08 violacao E CSR05 C 0-1 14

Data/hora da ocorrência de violação

Formato ”AAAAMMDDhhmmss”

Tag enviada somente se ocorreu violação

CSR09 impacto E CSR05 C 0-1 14

Data/hora da ocorrência do ultimo impacto:

Formato: ”AAAAMMDDhhmmss”

Tag enviada somente se ocorreu impacto.

Informação enviada imediatamente após a

ocorrência.

CSR10 alimentacao E CSR05 N 1-1 1

Status da alimentação:

0: Erro na leitura da fonte de alimentação

1: Fonte AC

2: Bateria

3: USB

CSR11 bateria E CSR05 N 1-1 1

Nivel da bateria de alimentação:

0 - Removida / Falha

1 - Baixo

2 - Medio

3 – Alto

Sempre deverá ser informado o status da bateria,

independente se está operando com alimentação

externa ou em bateria.

CSR12 canal E CSR05 C 1-1 2-4

Canal de comunicação ativo podendo assumir os

seguintes valores: “ETHE”, “WIFI”, “GPR1”,

“GPR2” ou “NA” se não houver comunicação

ativa

CSR13 CFE G CSR01

Agrupamento de dados referente a informações

de Cupom Fiscal Eletrônico

CSR14 qtdCFePendentes E CSR13 N 1-1 1-5 Quantidade de CFE´s pendentes de transmissão

CSR15 LOCALIZACAO G CSR01

Agrupamento de dados referente a informações

de localização

CSR16 GPSPosicao E CSR15 C 1-1 2-21

Posicionamento obtido via GPS. Latitude em

graus. S negativo e N positivo. Longitude em

graus. W negativo e E positivo, ou “NA” se não

Page 18: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 13 / 34

houver a informação

CSR17 GPSDH E CSR15 C 1-1 14

Data e hora do último posicionamento obtido via

GPS no formato ”AAAAMMDDhhmmss” ou 14

zeros “0” se não houver a informação

CSR18 GPSErro E CSR15 N 1-1 1-5

Erro da posição em metros ou 5 noves “9” se não

houver informação

CSR19 LBSPosicao E CSR15 C 1-1 2-21

Posicionamento obtido via LBS. Latitude em

graus. S negativo e N positivo. Longitude em

graus. W negativo e E positivo ou “NA” se não

houver informação

CSR20 LBSDH E CSR15 C 1-1 14

Data e hora do último posicionamento obtido via

LBS no formato ”AAAAMMDDhhmmss” ou 14

zeros “0” se não houver informação

CSR21 LBSErro E CSR15 N 1-1 1-5

Erro estimado em metros da posição adquirida

via LBS ou 5 noves “9” se não houver informação

CSR22 quantidadeSatelites E CSR15 N 1-1 1-2 Quantidade de satélite de GPS

CSR23 GSM G CSR01

Agrupamento de dados referente a informações

da rede GSM

CSR24

ICCID1 E CSR23 N 0-1 20 Identificador do SIMCARD1

CSR25 IMSI1 E CSR23 N 0-1 15

International Mobile Subscriber Identity do

SIMCARD1

CSR26 ICCID2 E CSR23 N 0-1 20 Identificador SIMCARD2

CSR27 IMSI2 E CSR23 N 0-1 15

International Mobile Subscriber Identity do

SIMCARD2

CSR28 GSM_Nivel E CSR23 N 1-1 3

Qualidade de sinal rede celular ou 999 se não

estiver conectado. Qualidade é definida entre 0 e

100

CSR29 WIFI G CSR01

Agrupamento de dados referente a informações

da rede WIFI

CSR30 SSID E CSR29 C 1-1 32

SSID da rede Wifi ou “NA” se não houver

informação. Se o nome for maior truncar em 32

caracteres.

CSR31 nivelWIFI E CSR29 N 1-1 3

Qualidade de sinal rede Wifi ou 999 se não

estiver conectado. Qualidade é definida entre 0 e

100

CSR32 PROXY G CSR01

Agrupamento de dados referente a informações

de configuração de Proxy

CSR33 tipo E CSR32 N 1-1 1

Tipo de proxy:

0 - “Sem proxy”

1 - “Proxy com configuração”

2 – “Proxy transparente”

CSR34 IP E CSR32 C 0-1 15

IP do servidor proxy.

Definido somente se for Tipo de proxy 1 ou 2

Page 19: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 14 / 34

CSR35 porta E CSR32 N 0-1 1-5

Porta TCP do servidor proxy

Definido somente se Tipo de proxy for 1 ou 2

CSR36 usuario E CSR32 C 0-1 1-64 Se o proxy precisar de usuário

CSR37 senha E CSR32 C 0-1 1-64 Se o proxy precisar de senha

Tabela 2 – Informações retornadas pelo Software Básico na função ConsultarStatusMFE

Page 20: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 15 / 34

4. SOFTWARES DO PONTO DE VENDA

Todos os softwares disponibilizados pela SEFAZ-CE poderão ser obtidos no sítio eletrônico:

http://cfe.sefaz.ce.gov.br

Os componentes de software que integram a comunicação entre o equipamento do Contribuinte

(PDV) e o MFE são descritos a seguir:

Figura 3 – Softwares do Ponto de Venda

4.1. Aplicativo comercial

Aplicativo para gestão de vendas e solicitação de emissão de Cupons Fiscais de venda e de

cancelamento.

O Contribuinte deverá utilizar um Aplicativo Comercial que seja compatível com o MFE, módulo

emissor de Cupom Fiscal Eletrônico.

Page 21: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 16 / 34

4.2. Software de Ativação e Configuração

Aplicativo usado para realizar a configuração, ativação e executar as funções do MFE conforme

descrito na Especificação de Requisitos do Projeto CFe.

O Fabricante do MFE deverá disponibilizar uma versão do Software de Ativação e Configuração junto

com o MFE.

As diferenças em relação ao Projeto CFe são:

Possibilidade de configurar múltiplas interfaces de comunicação ao mesmo tempo, incluindo a de

modem celular, através da função ConfigurarInterfaceDeRedeMFE;

Consultar as informações relativas ao hardware adicional, e outras não cobertas pela

Especificação de Requisitos do Projeto CFe, através da função ConsultarStatusOperacionalMFE.

4.3. Driver MFE

Visando facilitar a instalação e atualização dos componentes de software disponibilizados pela

SEFAZ-CE, eles foram empacotados em uma única instalação chamada Driver MFE.

O Driver MFE deverá ser instalado no equipamento (PDV) ao qual o MFE será conectado e será

disponibilizado para as seguintes versões de Windows e Linux, nas plataformas 32 e 64 bits:

Windows XP, Vista, 7, 8 e 10

Open Suse 12.3 e 13.2

Debian 7.3 e 8.2

Fedora 22.3 e 23.1

Maiores informações sobre os componentes podem ser obtidas no Manual do Driver MFE, disponível

no sítio: http://cfe.sefaz.ce.gov.br

O Driver MFE é composto pelos seguintes componentes:

4.3.1. Biblioteca de funções MFE

A Biblioteca MFE é uma biblioteca de funções (DLL no Windows) que disponibiliza para as aplicações

(Aplicativo Comercial, Software de Ativação) todas as funções previstas na Especificação de

Requisitos do Projeto CFe e no Projeto MFE, padronizando assim todas as interfaces entre as

aplicações e o MFE.

Page 22: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 17 / 34

As funções adicionais, chamadas Funções MFE, são descritas no capítulo 5 – ANEXO I

O protótipo de todas as funções disponíveis na Biblioteca MFE está no Manual do Driver MFE.

Para se comunicar com o MFE a Biblioteca MFE utiliza o serviço Comunicador MFE, por esta razão

este serviço nunca deverá ser interrompido.

A Biblioteca de Funções MFE estará disponível para as mesmas versões de Windows, Linux e

plataformas do Driver MFE.

4.3.2. Comunicador MFE

O Comunicador MFE é uma aplicação executada como um serviço (MFE-COM), que atende pela

porta 9012/TCP, e é responsável por realizar a comunicação com o MFE pela porta serial.

Sem este serviço a comunicação com o MFE não é possível.

Ele desempenha as seguintes funções:

Identifica automaticamente quando um MFE é conectado ou desconectado do PDV e coleta

informações a seu respeito

Ao receber as funções chamadas via Biblioteca MFE realiza a comunicação com o Componente

de Segurança embarcado no MFE

Atualiza as informações exibidas pelo Monitor MFE

Uso de compactação na comunicação USB

O volume de dados a ser transmitido via USB pode ser grande e isto impacta diretamente no tempo

de transmissão e na possibilidade de erros na comunicação.

Para diminuir o tempo de transferência em cerca de 10 vezes, e minimizar o risco de erro nos dados,

o Comunicador MFE utiliza tecnologia de compressão de dados baseada na ZLIB na comunicação

com o Componente de Segurança.

Page 23: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 18 / 34

4.3.3. Monitor MFE

O Monitor MFE é uma aplicação (MFE-MON) que informa, através de ícones na barra de notificações,

a disponibilidade ou não de um MFE e permite a visualização de algumas informações.

Ela é responsável por:

Exibir as informações sobre o MFE coletadas pelo serviço Comunicador MFE

Exibir as versões de software do DRIVER MFE e seus componentes que estão instalados.

Notificar a existência de nova versão de DRIVER MFE e o caminho para download.

Ela recebe as informações do serviço Comunicador MFE através da porta 9100/TCP.

4.4. Driver de Comunicação USB-Serial

É um driver de fornecimento do fabricante do MFE e é responsável por fazer a conversão do

dispositivo USB, ao qual o MFE está conectado, em interface serial conforme o sistema operacional

do PDV, tais como COMxx (Windows) ou ttySxx (Linux), e disponibilizá-la para uso pelo serviço

Comunicador MFE.

Page 24: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 19 / 34

5. ANEXO I – FUNÇÕES ADICIONAIS BIBLIOTECA MFE

Além das funções previstas na Especificação de Requisitos do Projeto CFe as seguintes funções

estão disponíveis na Biblioteca MFE.

5.1. Função ConfigurarInterfaceDeRedeMFE

Deve ser usada para realizar a configuração das interfaces de rede do MFE, similar à função

“ConfigurarInterfaceDeRede” definida no Projeto CFe, que ainda poderá ser utilizada para configurar

a interface de rede cabeada ou WIFI, porém com um formato readequado para possibilitar:

A configuração de uma ou mais interfaces de rede simultaneamente;

A configuração da interface de modem celular;

A definição de uma prioridade para cada interface.

Observações:

Os parâmetros permitem que uma ou mais interfaces sejam configuradas ao mesmo tempo,

cabendo a cada fabricante determinar se este recurso será usado ou não para configurar o seu

produto;

Não é necessário que todas as TAGs sejam informadas, ou seja, para cada tipo de interface

somente as tags pertinentes ao seu tipo precisam ser preenchidas;

A possibilidade de definição de prioridade nas interfaces permite que seja criado um recurso de

contingência de comunicação automático. Neste caso se a interface principal perder a

comunicação a secundária assumirá se estiver configurada. Ficará a critério de cada fabricante

usar ou não este recurso;

As interfaces GPR1 e GPR2 representam os SIMCARDs 1 e 2 da interface de modem celular;

A. Parâmetros da Função

A função deve receber os parâmetros definidos abaixo.

Parâmetro Descrição Tipo Exemplo

numeroSessao Número aleatório gerado pelo AC para controle da comunicação

Numérico Ex: “002101”

codigoDeAtivacao Senha definida pelo contribuinte String Ex: “senha123456”

dadosConfiguracao 04 (quatro) arquivos de configuração no formato XML separados por “|” (pipe).

Mesmo que não exista o arquivo de

String Exemplo abaixo

Page 25: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 20 / 34

Parâmetro Descrição Tipo Exemplo

configuração o “|” (pipe) deverá ser informado.

Abaixo segue tabela com as descrições de todos os parâmetros do arquivo de configuração.

Tabela I-1 – Parâmetros da função ConfigurarInterfaceRedeMFE

B. Protótipo da função

char* ConfigurarInterfaceDeRedeMFE ( unsigned int numeroSessao, char* codigoDeAtivacao, char*

dadosConfiguracao);

Exemplo de chamada da função:

Retorno = ConfigurarInterfaceDeRedeMFE ( 123456, “senha123456”, “<?xml version="1.0"

encoding="UTF-8"?><config><tipoInter>ETHE</tipoInter><tipoLan>DHCP</tipoLan>

<proxy>0</proxy></config>|||”);

C. Parâmetro “dadosConfiguracao”

Neste parâmetro podem ser configuradas até 04 (quatro) interfaces de rede simultaneamente cuja

configuração deve ser separada por um “|” (pipe).

Os 03 (três) “|” (pipes) deverão ser sempre informados, mesmo que não exista configuração.

A configuração de uma interface é um arquivo XML, similar ao definido na função

“ConfigurarInterfaceDeRede” do Projeto CFe, e é descrito abaixo.

A TAG “tipoInter” teve seu conteúdo alterado para acrescentar a interface de modem;

As TAGs 2 a 17 não sofreram alterações;

As demais TAGs são adicionais ao Projeto CFe;

Page 26: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 21 / 34

Item TAG Quant. Caract.

Descrição Exemplo

1 tipoInter 4 Tipo de interface de rede utilizada pelo equipamento

“ETHE” = ethernet “WIFI” = WIFI “GPR1” = modem SIMCARD 1* “GPR2” = modem SIMCARD 2* *tipos não existentes no Projeto CFe

2 a 17 TAGs definidas no Projeto CFe, Função

ConfigurarInterfaceDeRede

18 prioridade - Prioridade de conexão (quanto menor, maior a prioridade).

0, 1, 2, 3

19 wepAuthType 2 Indica tipo de autenticação WEP.

OP = Open SH = Shared

20 wepDefTxKey 1 Indica índice da chave padrão de transmissão WEP.

1, 2, 3 ou 4

21 wepENC 3 Indica quantidade de bits de criptografia WEP.

64 ou 128

22

wepKey1 26 Chave 1 WEP. Máximo 10 digitos hexa para cript. 64 bits ou 26 digitos hexa para cript. 128 bits.

F4C71BA891 ou DBEFE3F9EF8E3239E5E34F258A

23 wepKey2 26 Chave 2 WEP. (Ídem Chave1)

24 wepKey3 26 Chave 3 WEP. (Ídem Chave1)

25 wepKey4 26 Chave 4 WEP. (Ídem Chave1)

26 phone 25 Número para iniciar conexão móvel

*99#

27 apn 64 APN (Access Point Name) para conexão móvel

tim.br, claro.com.br

Tabela I-2 – Dados de configuração das interfaces de rede

D. Arquivo de configuração em formato XML

TAGs não suportadas devem ser ignoradas pelo Software Básico, não possuindo nenhum efeito

para a configuração da rede;

Page 27: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 22 / 34

O arquivo XML poderá ser criado somente com as informações (TAGs) necessárias para a

configuração de um determinado tipo de interface de rede;

Cada interface deve possuir uma prioridade diferente;

Estrutura completa do arquivo de configuração:

<?xml version="1.0" encoding="UTF8"?>

<config>

<tipoInter></tipoInter>

<SSID></SSID>

<seg></seg>

<codigo></codigo>

<tipoLan></tipoLan>

<lanIP></lanIP>

<lanMask></lanMask>

<lanGW></lanGW>

<lanDNS1></lanDNS1>

<lanDNS2></landDNS2>

<usuario></usuario>

<senha></senha>

<proxy></proxy>

<proxy_ip></proxy_ip>

<proxy_porta></proxy_porta>

<proxy_user></proxy_user>

<proxy_senha></proxy_senha>

<prioridade></prioridade>

<wepAuthType></wepAuthType>

<wepDefTxKey></wepDefTxKey>

<wepENC></wepENC>

<wepKey1></wepKey1>

<wepKey2></wepKey2>

<wepKey3></wepKey3>

<wepKey4></wepKey4>

<phone></phone>

<apn></apn>

</config>

Page 28: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 23 / 34

E. Exemplos de arquivos XML

01 Interface: Rede ethernet com DHCP

<?xml version="1.0" encoding="UTF-8"?><config><tipoInter>ETHE</tipoInter>

<tipoLan>DHCP</tipoLan><proxy>0</proxy></config>|||

01 Interface: Rede ethernet com IP fixo

<?xml version="1.0" encoding="UTF-8"?><config><tipoInter>ETHE</tipoInter>

<tipoLan>IPFIX</tipoLan><lanIP>10.0.24.66</lanIP><lanMask>255.255.128.0</lanMask><lanGW>

10.0.24.1</lanGW><lanDNS1>8.8.8.8</lanDNS1><proxy>0</proxy></config>|||

01 Interface: Rede WIFI com DHCP

<?xml version="1.0" encoding="UTF-8"?><config><tipoInter>WIFI</tipoInter>

<tipoLan>DHCP</tipoLan><proxy>0</proxy><SSID>RedeWIFI</SSID><codigo>SenhaDaRede

</codigo><seg>WPA2-PERSONAL</seg></config>|||

02 Interfaces: Rede ethernet com IP fixo e WIFI com DHCP

<?xml version="1.0" encoding="UTF-8"?><config><tipoInter>ETHE</tipoInter><tipoLan>IPFIX

</tipoLan><lanIP>10.0.24.66</lanIP><lanMask>255.255.128.0</lanMask><lanGW>10.0.24.1

</lanGW><lanDNS1>8.8.8.8</lanDNS1><proxy>0</proxy></config>|<?xml version="1.0"

encoding="UTF-8"?><config><tipoInter>WIFI</tipoInter><tipoLan>DHCP</tipoLan><proxy>0</proxy>

<SSID>RedeWIFI</SSID><codigo>SenhaDaRede</codigo><seg>WPA2-PERSONAL</seg>

</config>||

01 Interface: Rede celular, SIM card 1, exemplo com operadora TIM

Deve-se verificar com a operadora os parâmetros corretos a serem utilizados na região do

Contribuinte.

<?xml version="1.0" encoding="UTF-8"?><config><name>gsm1</name><prioridade>2</prioridade>

<tipoInter>GPR1</tipoInter><tipoLan>DHCP</tipoLan><usuario>tim</usuario><senha>tim</senha>

<proxy>0</proxy><phone>*99#</phone><apn>tim.com.br</apn></config>|||

Page 29: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 24 / 34

04 Interfaces: Todas as interfaces de rede com DHCP e os 2 SIMcards, exemplo com as

operadoras TIM e Claro

Deve-se verificar com a operadora os parâmetros corretos a serem utilizados na região do

Contribuinte.

<?xml version="1.0" encoding="UTF-8"?><config><tipoInter>ETHE</tipoInter><tipoLan>DHCP

</tipoLan><proxy>0</proxy></config>|<?xml version="1.0" encoding="UTF-8"?><config><tipoInter>

WIFI</tipoInter><tipoLan>DHCP</tipoLan><proxy>0</proxy><SSID>RedeWIFI</SSID><codigo>

SenhaDaRede</codigo><seg>WPA2-PERSONAL</seg></config>|<?xml version="1.0"

encoding="UTF-8"?><config><tipoInter>GPR1</tipoInter><tipoLan>DHCP</tipoLan><phone>*99#

</phone><apn>tim.com.br</apn><usuario>tim</usuario><senha>tim</senha><proxy>0

</proxy></config>|<?xml version="1.0" encoding="UTF-8"?><config><tipoInter>GPR2</tipoInter>

<tipoLan>DHCP</tipoLan><phone>*99#</phone><APN>claro.com.br</APN><usuario>claro

</usuario><senha>claro</senha><proxy>0</proxy></config>

F. Retorno da Função

A função retornará um valor do tipo string contendo os dados separados por pipe “|”.

Retorno: “numeroSessao|EEEEE|mensagem|cod|mensagemSEFAZ”

Descrição:

Parâmetro Descrição Exemplo

numeroSessao Número aleatório gerado pelo AC para controle da comunicação

Ex: “000000”, “002101”

EEEE

O código EEEEE é substituído por um dentre os possíveis códigos de retorno conforme Projeto CFe, Tabela 49 – Códigos de Retorno – Função ConfigurarInterfaceDeRede

Ex: “12000”

mensagem

Descrição do código EEEE - conforme Projeto CFe, Tabela 49 – Códigos de Retorno – Função ConfigurarInterfaceDeRede

Ex: “Rede configurada com sucesso”

Cod

“cod” é o código de referência de cada mensagemSEFAZ - conforme Projeto CFe, Tabela 5 – Códigos para o Comando_008).

Ex: “002”, “999”

Page 30: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 25 / 34

mensagemSEFAZ

Mensagem de texto enviada pela SEFAZ referente ao “Envio de avisos ao usuário” (conforme Projeto CFe, Tabela 5 – Códigos para o Comando_008)

Ex: “Existem atualizações para o MFE, porém o prazo para instalação é menor que 30 dias”

Tabela I-3 – Parâmetros de retorno da função ConfigurarInterfaceDeRedeMFE

Descrições do código “EEEE”:

Código de Retorno

Fluxo Mensagem Observação

12000 MFE/AC Rede Configurada com Sucesso Efetuada a configuração de rede

12001 MFE/AC Código ativação inválido Verificar o código e tentar novamente

12002 MFE/AC Dados fora do padrão a ser informado

Corrigir dados

12098 MFE/AC MFE em processamento. Tente novamente.

Em casos onde o MFE estiver processando outra função

12099 MFE/AC Erro desconhecido Informar o administrador

TIMEOUT 20 SEGUNDOS

Tempo limite para o processamento da função

Tabela I-4 – Descrição das mensagens de retorno da função ConfigurarInterfaceDeRede

5.2. Função ConsultarStatusOperacionalMFE

Usada para consultar a situação de funcionamento e características do MFE, similar à função

“ConsultarStatusOperacional” definida no Projeto CFe, porém contendo informações relativas ao

hardware adicional.

A. Parâmetros da função

A função deve receber os parâmetros definidos abaixo.

Parâmetro Descrição Tipo Exemplo

numeroSessao Número aleatório gerado pelo AC para controle da comunicação

Numérico Ex: “002101”

codigoDeAtivacao Senha definida pelo contribuinte String Ex: “senha123456”

Page 31: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 26 / 34

Tabela I-5 – Parâmetros da função ConsultarStatusOperacionalMFE

B. Protótipo da função

char* ConsultarStatusOperacionalMFE ( unsigned int numeroSessao, char* codigoDeAtivacao);

Exemplo de chamada da função:

Retorno = ConsultarStatusOperacionalMFE(123456, “senha123456”);

C. Retorno da função

A função retornará um valor do tipo string contendo os dados separados por pipe “|”.

Retorno: “numeroSessao|EEEEE|mensagem|ConteudoRetorno|cod|mensagemSEFAZ”

Descrição:

Parâmetro Descrição Exemplo

numeroSessao Número aleatório gerado pelo AC para controle da comunicação

Ex: “000000”, “002101”

EEEE

O código EEEEE é substituído por um dentre os possíveis códigos de retorno conforme Projeto CFe, Tabela 49 – Códigos de Retorno – Função ConsultarStatusOperacional

Ex: “12345”

mensagem

Descrição do código EEEE - conforme Projeto CFe, Tabela 49 – Códigos de Retorno – Função ConsultarStatusOperacional

Ex: “Resposta com sucesso”

Cod “cod” é o código de referência de cada mensagemSEFAZ - conforme Projeto CFe, Tabela 5 – Códigos para o Comando_008

Ex: “002”, “999”

mensagemSEFAZ

Mensagem de texto enviada pela SEFAZ referente ao “Envio de avisos ao usuário” - conforme Projeto CFe, Tabela 5 – Códigos para o Comando_008

Ex: “Existem atualizações para o MFE, porém o prazo para instalação é menor que 30 dias”

ConteudoRetorno Corresponde às informações descritas no item “D”

Page 32: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 27 / 34

Tabela I-6 – Parâmetros de retorno da função ConsultarStatusOperacionalMFE

Descrições do código “EEEE”:

Código de Retorno

Fluxo Mensagem Observação

10000 MFE/AC Resposta com Sucesso Informações de status do MFE

10001 MFE/AC Código ativação inválido Verificar o código e tentar novamente

10098 MFE/AC MFE em processamento. Tente novamente.

Em casos onde o MFE estiver processando outra função

10099 MFE/AC Erro desconhecido Informar o administrador

TIMEOUT 20 SEGUNDOS

Tempo limite para o processamento da função

Tabela I-7 – Descrição das mensagens de retorno da função ConfigurarInterfaceDeRede

D. Conteúdo do campo ConteudoRetorno

Descrição das informações retornadas pelo MFe

Item TAG Quant Caract

Descrição Exemplo

1 a 23 TAGs definidas no Projeto CFe, Conteúdo de retorno - Função ConsultarStatusOperacional

24 TIPO_AMBIENTE 1 Identificação do ambiente 1= Produção

2= Testes

25 UF 2

Código do Estado da Federação no qual o MFE foi ativado. Se não foi ativado ainda informar “00”

“23”

26 BATERIA 1 Nível da bateria externa

“0”= Removida / falha

“1”= Baixo

“2”= Médio

“3”= Alto

27 ALIMENTACAO 1 Informa se o MFE está sendo alimentado pela bateria ou fonte externa

“0”= Erro leitura da fonte de

alimentação

“1”= Fonte externa

“2”= Bateria

“3”= USB

28 CANAL_ATIVO 4 Canal de comunicação em uso no momento

“ETHE”= ethernet

“WIFI”= wifi

Page 33: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 28 / 34

Descrição das informações retornadas pelo MFe

Item TAG Quant Caract

Descrição Exemplo

“GPR1”= modem SIMcard 1

“GPR2”= modem SIMcard 2

“NA”= se não houver canal de

comunicação disponível no

momento

29 LAN_CONFIGURACAO_1 1024

Configuração atual da primeira interface de rede ou “NA” se essa interface não estiver configurada. Devem ser retornadas as mesmas tags de configuração usadas na função ConfigurarInterfaceDeRedeMFE.

<?xml version="1.0"

encoding="UTF-8"?>

<config>

<prioridade>2</prioridade>

<tipoInter>GPR1</tipoInter>

<tipoLan>DHCP</tipoLan>

<usuario>tim</usuario>

<senha>tim</senha>

<proxy>0</proxy>

<phone>*99#</phone>

<apn>tim.br</apn>

</config>

30 LAN_CONFIGURACAO_2 1024 Configuração atual da segunda interface de rede ou “NA” se não estiver configurada

“NA”

31 LAN_CONFIGURACAO_3 1024 Configuração atual da terceira interface de rede ou “NA” se não estiver configurada

“NA”

32 LAN_CONFIGURACAO_4 1024 Configuração atual da quarta interface de rede ou “NA” se não estiver configurada

“NA”

33 GSM_OPERADORA 32 Nome da operadora de celular ou “NA” se não houver informação

“vivo”

34 GSM_REDE 5 Tecnologia da rede celular “GPRS”, “EDGE”, “3G”, “4G” ou

“NA” se não houver informação

35 ICCID1 20 Identificação do SIMCARD 1

36 IMSI1 15 Identificador do assinante na operadora do SIMCARD 1

37 ICCID2 20 Identificação do SIMCARD 2

38 IMSI2 15 Identificador do assinante na operadora do SIMCARD 2

39 VIOLACAO 1 Data e hora da violação no formato: “AAAAMMDDhhmmss” ou 14 ZEROS se não houve violação

“20150312011423”

Page 34: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 29 / 34

Descrição das informações retornadas pelo MFe

Item TAG Quant Caract

Descrição Exemplo

40 IMPACTO 1 Data e hora do último impacto no formato: “AAAAMMDDhhmmss” ou 14 ZEROS se não houve impacto

“20150312011423”

41 ETH_MAC 17 Endereço MAC address da interface de rede ethernet

“A1:B2:C3:D4:E5:F6”

42 ETH_WIFI 17 Endereço MAC address da interface de WIFI

“A1:B2:C3:D4:E5:F6”

43 IMEI 15 IMEI do MODEM ou “NA” se não houver interface deste tipo

“350845555897085”

44 GPS_POSICAO 21

Posicionamento obtido via GPS. Latitude em graus. S negativo e N positivo. Longitude em graus. W negativo e E positivo, ou “NA” se não houver informação

“23.321353, -45.312531”

45 GPS_DH 14

Data e hora do último posicionamento obtido via GPS no formato ”AAAAMMDDhhmmss” ou 14 zeros “0” se não houver informação

“2040101120000”

46 GPS_ERRO 5 Erro da posição em metros ou 5 noves “9” se não houver informação

“10”

47 LBS_POSICAO 21

Posicionamento obtido via LBS. Latitude em graus. S negativo e N positivo. Longitude em graus. W negativo e E positivo ou “NA” se não houver informação

“NA”

48 LBS_DH 14

Data e hora do último posicionamento obtido via LBS no formato ”AAAAMMDDhhmmss” ou 14 zeros “0” se não houver informação

“00000000000000”

49 LBS_ERRO 5 Erro estimado em metros da posição adquirida via LBS ou 5 noves “9” se não houver informação

“99999”

50 QUANTIDADE_SATELITES 2 Quantidade de satélite de GPS “5”

51 GSM_NIVEL 3

Qualidade de sinal rede celular ou “NA” se não estiver conectado. Qualidade é definida entre 0 e 100%.

40

52 WIFI_REDES 2048

Lista até 15 redes Wifi disponíveis com melhor nível de sinal em formato XML ou “NA” caso não existam redes disponíveis. Formato do XML “REDES” descrito abaixo

<?xml version="1.0"

encoding="UTF-8"?>

<redes>

<rede>

<ssid>rede1</ssid>

<cripto>WEP</cripto>

<cripto>WPA-

Page 35: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 30 / 34

Descrição das informações retornadas pelo MFe

Item TAG Quant Caract

Descrição Exemplo

PERSONAL</cripto>

<sinal>80</sinal>

</rede>

<rede>

<ssid>rede2</ssid>

<cripto>WEP</cripto>

<sinal>30</sinal>

</rede>

</redes>

53 CFEPEND 4 Quantidade de Cupons pendentes de envio

“12”

Tabela I-8 – Informações retornadas pela função ConsultarStatusOperacionalMFE

Formato do XML “REDES”

<?xml version="1.0" encoding="UTF-8"?> <redes>

<rede> <ssid>nome da rede<;ssid> <cripto>criptografia 1 disponível</cripto> <cripto>criptografia 2 disponível</cripto> <sinal>qualidade do sinal de 0 a 100</sinal>

</rede> </redes> a) Tipos de criptografia: NONE WEP WPA-PERSONAL WPA2-PERSONAL WPA-ENTERPRISE b) Caso a rede permita mais de um tipo de criptografia informar cada uma em uma tag <cripto>. c) Limitar o SSID aos 100 primeiros caracteres do nome da rede.

Page 36: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 31 / 34

E. Preenchimento quando não ativado

Os seguintes campos devem ser preenchidos com ZEROs caso o MFE não tenha sido ativado ainda.

Ordem Campo Tam Max

Descrição Valor

16 ULTIMO_CF-E-SAT 44 Número sequencial do último CFe Emitido

Preencher com 44 zeros “0”

17 LISTA_INICIAL 44 Número sequencial do primeiro CFe armazenado na memória de trabalho

Preencher com 44 zeros “0”

18 LISTA_FINAL 44 Número sequencial do último CFe armazenado na memória de trabalho

Preencher com 44 zeros “0”

19 DH_CFe 14 Data e hora da última transmissão de CFe para SEFAZ no formato AAAAMMDDhhmmss

Preencher com 14 zeros “0”

20 DH_ULTIMA 14 Última comunicação com a SEFAZ no formato aaaammddHHMMSS

Preencher com 14 zeros “0”

21 CERT_EMISSAO 08 Data de emissão do certificado instalado no formato AAAAMMDD

Preencher com 8 zeros “0”

22 CERT_VENCIMENTO 08 Data de vencimento do certificado instalado no formato AAAAMMDD

Preencher com 8 zeros “0”

Tabela I-9 – Preenchimento das informações função ConsultarStatusOperacionalMFE

5.3. Função EnviarStatusAC

Usada pelo Aplicativo Comercial para informar a versão em uso.

O período máximo de envio da função EnviarStatusAC será definido pela SEFAZ-CE. Logo essa

funcionalidade deverá ser parametrizável no Aplicativo Comercial. A princípio considerar um período

de 24 horas.

Não deve ser implementada no Software Básico, pois é de uso exclusivo do Componente de

Segurança.

A. Parâmetros da função

A função deve receber os parâmetros definidos abaixo.

Page 37: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 32 / 34

Parâmetro Descrição Tipo Exemplo

descricaoFabricante Fabricante do AC String Ex: “SEFAZ-CE”

versaoAC Versão do AC String Ex: “01.01.01”

Tabela I-10 – Parâmetros da função EnviarStatusAC

B. Protótipo da função

void EnviarStatusAC(unsigned int numeroSessao, char* codigoDeAtivacao, char*

descricaoFabricante, char* versaoAC);

Exemplo de chamada da função:

EnviarStatusAC(123456,“senha123456”,”SEFAZ-CE”,”01.00.00”);

C. Retorno da função

Não há retorno para esta função.

Page 38: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 33 / 34

6. ANEXO 2 – Controle de modificações do documento

Da versão 1.3.8 para a 1.3.16

Alteração Item

Capítulo 3 – Módulo Fiscal eletrônico - MFE

Alterado

3.1.1 Bateria operacional

- Redução do tempo de autonomia para 1h e cenário operacional

Acrescidos:

- Tempo de vida útil da bateria

- Características

- Comportamento do MFE quando estiver sem alimentação externa

- Requisitos para a bateria caso seja removível

Novo Criado item 3.1.2 para agregar todas as especificações das interfaces de

comunicação.

Novo 3.1.2.2 Interface WIFI

Requisitos para a antena da interface WIFI.

Novo Criado item 3.1.6 aumentado para 2 GB a capacidade da Memória de Trabalho

e Parametrização a partir de 01.01.2018.

Novo 3.4 Função EnviarDadosVenda – tempo de resposta

Alterados os tempos de resposta na geração dos cupons fiscais.

Alterado 3.5.2.2 Comunicação com o Componente de Segurança

- Software Básico só deverá aceitar conexões provenientes de “localhost”.

Alterado

3.5.3.1 Função ConsultarStatusMFE

- Corrigido erro de grafia no nome da função (faltou a letra “r”).

- Estabelecido parâmetro de comportamento em caso de timeout do

Componente de Segurança

- Informação CSR11-bateria: sempre deverá ser informado o status da bateria,

mesmo que esteja operando com alimentação externa.

- Acrescidas informações sobre o proxy utilizado na configuração de rede

Da versão 1.3.16 para a 1.3.17

Alteração Item

Alterado

5.3 Função EnviarStatusAC

- Período máximo de envio da função EnviarStatusAC passa a ser configurável

e definido pela SEFAZ-CE.

Page 39: Especificação Técnica de Requisitos · a) Sensibilidade mínima de -160 dbm; b) Primeira localização (cold start) não superior a 60 segundos e precisão horizontal do posicionamento

Especificação Técnica de Requisitos MFE-CFe 1.3.19 (Direitos Reservados) 34 / 34

Da versão 1.3.17 para a 1.3.18

Alteração Item

Alterado

Item 3.1.1.1 Características da Bateria Operacional

- Sensor de temperatura e circuito de proteção de descarga total passam a ter

implementação facultativa até 31.12.2017 e obrigatória a partir de 01.01.2018.

Da versão 1.3.18 para a 1.3.19

Alteração Item

Incluído Item 3.1.7 Módulo Criptográfico

Da versão 1.3.19 para a 1.3.20

Alteração Item

Alterado Item 3.1.2.1 Interface Modem Celular

Alterado Item 3.1.7 Módulo Criptográfico