Funcionalidade Listening Mode

Guia do desenvolvedor
 Configuração RTMP - Guia do instalador

Informação legal
NA EXTENSÃO MÁXIMA PERMITIDA PELA LEI APLICÁVEL, O DOCUMENTO É
FORNECIDO "COMO ESTÁ" E "COM TODAS AS FALHAS E ERROS". NOSSA
EMPRESA NÃO FAZ REPRESENTAÇÕES OU GARANTIAS, EXPRESSAS OU
IMPLÍCITAS, INCLUINDO, MAS NÃO SE LIMITANDO A, GARANTIAS DE
COMERCIALIZAÇÃO, ADEQUAÇÃO A UM DETERMINADO FIM OU NÃO
VIOLAÇÃO. EM NENHUM CASO, NOSSA EMPRESA SERÁ RESPONSÁVEL POR
QUAISQUER DANOS ESPECIAIS, CONSEQUENCIAIS, INCIDENTAIS OU INDIRETOS,
INCLUINDO, ENTRE OUTROS, DANOS POR PERDA DE LUCROS DE NEGÓCIOS,
INTERRUPÇÃO DE NEGÓCIOS OU PERDA DE DADOS, CORRUPÇÃO DE SISTEMAS
OU PERDA DE DOCUMENTAÇÃO, SEJA COM BASE POR VIOLAÇÃO DE
CONTRATO, ATO ILÍCITO (INCLUINDO NEGLIGÊNCIA), OU DE OUTRA FORMA,
RELACIONADO AO USO DO DOCUMENTO, MESMO QUE NOSSA EMPRESA
TENHA SIDO AVISADA DA POSSIBILIDADE DE TAIS DANOS OU PERDA

2
 Configuração RTMP - Guia do instalador

Conteúdo

Capítulo 1 - Visão geral 4

1.1. Introdução 4
1.2. Histórico de atualização 4

Capítulo 2 - Descrição 4

Capítulo 3 - Programas necessários 5

Capítulo 4 - Configurando dispositivo de controle de acesso 6

4.1. Configurar para qual servidor TCP serão enviados os eventos 6
4.2. Configurar NetAssist para receber os eventos do dispositivo 8
4.3. Selecionar quais eventos deseja receber no servidor TCP 11
4.4. Habilitar/Desabilitar o envio da imagem da face para o servidor TCP 11
4.5. Como converter os caracteres recebidos no Listening Mode em imagem 11

Capítulo 5 - Configurando dispositivo ANPR 12

5.1. Configurar protocolo de recebimento dos eventos 12
5.2. Configurar para qual servidor TCP serão enviados os eventos 12
5.3. Configurar NetAssist para receber os eventos do dispositivo 12
5.4. Exemplo de evento ANPR 12

Capítulo 6 - Configurando dispositivo Traffic 13

6.1. Configurar para qual servidor TCP serão enviados os eventos 13
6.2. Configurar NetAssist para receber os eventos do dispositivo 13
6.3. Exemplo de evento Traffic 13

Capítulo 7 - FAQ 13

3
 Configuração RTMP - Guia do instalador

Capítulo 1 - Visão geral

1.1. Introdução
Este manual apresenta os fluxos de utilização da funcionalidade de Listening Mode. Os
dados apresentados aqui não eliminam a necessidade de ler a documentação API do
produto.

1.2. Histórico de atualização

Resumo das alterações na versão 1.0 - novembro de 2021
Criação do documento inserindo guia para utilizar o Listening Mode com terminal
DS-K1T671MF
Resumo das alterações na versão 2.0 - julho de 2022
Atualização do documento inserindo dados sobre:
● Como adicionar resposta automática no NetAssist
● Como configurar dispositivos ANPR para recebimento de eventos
● Como configurar dispositivos Traffic para recebimento de eventos
Resumo das alterações na versão 2.1 - julho de 2022
Adicionar vídeo para converter caracteres em imagens

Capítulo 2 - Descrição
A funcionalidade de Listening Mode é utilizada para receber os eventos gerados pelo
dispositivo em tempo real no servidor do cliente. O processo consiste em configurar o
dispositivo com as informações do servidor que ele deve enviar os eventos. Quando algum
evento for gerado pelo dispositivo, ele será enviado para o servidor configurado e aguardará
uma confirmação de recebimento do servidor com a resposta “HTTP/1.1 200 ”

Nota:
A resposta deve ser igualmente ao descrito acima, adicionando o espaço após o 200. Caso a resposta não seja
enviada, quando o dispositivo estiver ocioso, ele voltará a enviar o mesmo evento, pois não tem a informação
que o evento anterior foi entregue com sucesso.

4
 Configuração RTMP - Guia do instalador

Capítulo 3 - Programas necessários

Para fazer os testes do Listening Mode de seu dispositivo, será necessários dois
programas, sendo:
● Postman
○ Download: https://www.postman.com/downloads/
○ Utilização: Através do postman, serão executados comandos para o
dispositivo, para informar para qual servidor os eventos devem ser enviados.
● NetAssist:
○ Download: NetAssist.exe
○ Utilização: O NetAssist será utilizado para simular um servidor TCP. Nele
serão recebidos os eventos gerados pelo dispositivo. Caso você esteja
implementando o servidor TCP em seu software e não esteja recebendo os
eventos, teste primeiramente no NetAssist se está recebendo. Caso o
NetAssist esteja recebendo os eventos, analise seu código.

5
 Configuração RTMP - Guia do instalador

Capítulo 4 - Configurando dispositivo de controle de acesso

4.1. Configurar para qual servidor TCP serão enviados os eventos

1. No postman selecione a opção PUT

2. Utilize a URL no formato “http://IP/ISAPI/Event/notification/httpHosts”:
● IP: Endereço IP do dispositivo HIKVISION;

3. Clique em Authorization;
4. Selecione o Type “Digest auth”;
5. No campo Username insira “admin”;
6. No campo Password insira a “senha de acesso web do dispositivo”;

6
 Configuração RTMP - Guia do instalador

7. Clique na aba Body

8. Selecione a opção “raw” e “XML”
9. No corpo do texto, insira os dados relacionados ao servidor TCP que escutará os eventos (IP do seu
computador para testes)
● <url>: Endereço IP do servidor TCP que receberá o evento. IP computador
● <ipAddress>: Endereço IP do servidor TCP que receberá o evento. IP computador
● <portNo>: Porta de conexão ao servidor que receberá os eventos

Exemplo de Body:

<HttpHostNotificationList version='2.0' xmlns='http://www.isapi.org/ver20/XMLSchema'>

<HttpHostNotification>
<id>1</id>
<url>/endpointQueDesejaReceberOsEventos</url>
<protocolType>HTTP</protocolType>
<parameterFormatType>JSON</parameterFormatType>
<addressingFormatType>ipaddress</addressingFormatType>
<ipAddress>192.168.2.5</ipAddress>
<portNo>8888</portNo>
<userName></userName>
<httpAuthenticationMethod>none</httpAuthenticationMethod>
</HttpHostNotification>
</HttpHostNotificationList>

10. Clique em Send e veja se o retorno do comando é 200 OK, mostrando que a mensagem foi
executada com sucesso.

7
 Configuração RTMP - Guia do instalador

4.2. Configurar NetAssist para receber os eventos do dispositivo

1. Descompacte o arquivo netassist.zip

2. Execute o arquivo NetAssit.exe
3. Em Protocol selecione a opção TCP Server
4. Em Local Host Addr selecione o IP do seu computador
5. Em Local Host Port coloque a porta que foi configurada para o servidor de escuta dos eventos no
modo Listening
6. Clique em Open
7. Clique em AutoReply (Caso não apareça, aumente o tamanho da janela do NetAssist)
8. Clique em ( + ) para adicionar uma resposta

8
 Configuração RTMP - Guia do instalador

9. Em Request Partner digite: POST

10. Em Reply Partner digite “HTTP/1.1 200 ” (Adicione espaço após o 200)
11. Clique em OK

9
 Configuração RTMP - Guia do instalador

12. Clique em Enable AutoReply, para habilitar as respostas automáticas

10
 Configuração RTMP - Guia do instalador

4.3. Selecionar quais eventos deseja receber no servidor TCP

Descrição: Caso você não queira receber todos os eventos no seu servidor TCP, ao configurar o dispositivo,
é possível informar quais eventos deseja receber. Para isso preencha o campo <minorEvent> com o código
dos eventos desejados.
O código dos eventos está disponível no documento de API.

Ver item 4.1.9.

Exemplo de Body selecionando apenas o evento de Face encontrada:

<HttpHostNotificationList version='2.0' xmlns='http://www.isapi.org/ver20/XMLSchema'>

<HttpHostNotification>
<id>1</id>
<url>/</url>
<protocolType>HTTP</protocolType>
<parameterFormatType>JSON</parameterFormatType>
<addressingFormatType>ipaddress</addressingFormatType>
<ipAddress>192.168.2.5</ipAddress>
<portNo>8888</portNo>
<userName></userName>
<httpAuthenticationMethod>none</httpAuthenticationMethod>
<SubscribeEvent>
<eventMode>list</eventMode>
<EventList>
<Event>
<type>AccessControllerEvent</type>
<minorAlarm></minorAlarm>
<minorException></minorException>
<minorOperation></minorOperation>
<minorEvent>0x4b</minorEvent>
</Event>
</EventList>
</SubscribeEvent>
</HttpHostNotification>
</HttpHostNotificationList>

4.4. Habilitar/Desabilitar o envio da imagem da face para o servidor TCP

Descrição: Caso você opte por não receber a imagem da face autenticada, é possível desabilitar o upload da imagem para
o servidor TCP. Alguns parceiros que não tratam o evento acabam sofrendo com a sequência de caracteres recebida, então
caso você não utilize a imagem, recomendo desabilitar o upload.

Método: PUT
Endpoint: /ISAPI/AccessControl/AcsCfg?format=json

Body:
{
"AcsCfg": {
"uploadVerificationPic": false
}
}

4.5. Como converter os caracteres recebidos no Listening Mode em imagem

Para converter os caracteres recebidos em imagem, assista o vídeo disponível em:
https://hikvisionlatam-my.sharepoint.com/:v:/g/personal/giovani_bublitz_hikvisionlatam_onmicrosoft_com/EQFyuiYXhspJhMcC
E5df-qYBotE6rQSiIcAJG2wbOf8pEQ?e=DV4BrU

11
 Configuração RTMP - Guia do instalador

📢
Capítulo 5 - Configurando dispositivo ANPR
Importante:
Para recebimento dos eventos de placa, é necessário que a câmera esteja com as áreas de
detecção configuradas e a instalação esteja adequeada. Veja o manual do produto e teste
primeiramente se o dispositivo está detectando as placas. Após validada a configuração e
instalação de sequência com a integração do produto.

5.1. Configurar protocolo de recebimento dos eventos

Descrição: Para dispositivos ANPR é necessário configurar o protocolo de recebimento dos eventos para que os eventos
sejam enviados para o servidor TCP. Caso essa etapa não seja seguida, o servidor TCP configurado não receberá os
eventos.

Método: PUT
Endpoint: /ISAPI/Traffic/ANPR/alarmHttpPushProtocol

Exemplo de body:
<AlarmHttpPushProtocol version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<baseLineProtocolEnabled>true</baseLineProtocolEnabled>
</AlarmHttpPushProtocol>

5.2. Configurar para qual servidor TCP serão enviados os eventos

A configuração do servidor TCP para dispositivos ANPR segue o padrão de configuração descrito na documentação de API.

Ver item 4.1. Configurar para qual servidor TCP serão enviados os eventos deste manual.

5.3. Configurar NetAssist para receber os eventos do dispositivo

A configuração do NetAssist para dispositivos ANPR segue o padrão de configuração descrito na documentação de API.

Ver item 4.2. Configurar para qual servidor TCP serão enviados os eventos deste manual.

5.4. Exemplo de evento ANPR

Exemplo de log obtido ao detectar veículo: iDS-2CD7A46G0P-IZS_V5.7.80 build 220525.txt

12
 Configuração RTMP - Guia do instalador

Capítulo 6 - Configurando dispositivo Traffic

6.1. Configurar para qual servidor TCP serão enviados os eventos

A configuração do servidor TCP para dispositivos Traffic segue o padrão de configuração descrito na documentação de API.

Ver item 4.1. Configurar para qual servidor TCP serão enviados os eventos deste manual.

6.2. Configurar NetAssist para receber os eventos do dispositivo

A configuração do NetAssist para dispositivos Traffic segue o padrão de configuração descrito na documentação de API.

Ver item 4.2. Configurar para qual servidor TCP serão enviados os eventos deste manual.

6.3. Exemplo de evento Traffic

Exemplo de log obtido ao detectar veículo iDS-TCM403-BI

Capítulo 7 - FAQ
Quando tento abrir a porta no NETASSIST a porta não abre e aparece a mensagem no rodapé do programa
“bind()failed : Attempt to connect dataram socket to broadcast address failed ...”

R: A porta que você está tentando utilizar já está em uso.

(Use o comando netstat -aon | findstr “port” no prompt de comando para ver os serviços rodando nessa
porta)
Tente utilizar outra porta que esteja disponível.

Cliente está reclamando que os eventos da TCM estão chegando com delay de até 3min

R: Verificar se o cliente está com firmware atualizado V3.2.30_build211105 ou superior, e se o software do

cliente está respondendo os eventos com “HTTP/1.1 200 ”.
Entenda o modo de operação em: ListeningMode - Evento/Resposta esperado

Ao executar o comando para configurar o servidor Listening Mode, a resposta obtida não é 200 OK e sim
400 BAD REQUEST

R: Execute o comando GET com endpoint /ISAPI/Event/notification/httpHosts/capabilities para verificar se o

dispositivo possui a função de listening mode.
Caso retorno seja positivo, veja o Body enviado pois possivelmente algum parâmetro está faltando ou
incorreto.

13