manual kimaldi biomax

Kimal

Kimaldi de

Manual de instalación y

Programación

Control OCX

PrKBusCtl

v. 4.0

di Electronics, S. L. Terrassa (Barcelona) – Spain Tel. +34 93 736 1510 Fax +34 93 736 1511 [email protected] Lusa, Lda. Lisboa – Portugal Tel. +351 21 715 6303 Fax +351 21 715 6295 [email protected]

México, S.A. Puebla – México Tel +52 222 1309463 Int Rep 01222 1309463 Fax +52 222 1309464 [email protected] www.kimaldi.com

mailto:[email protected]



http://www.kimaldi.com

Índice

Kima

1. Introducción. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42. El Control KBUSXctl. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.1. Descripción. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52.2. Empleo del Control. Fases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.2.1. Configurar modo de direccionamiento empleado por el concentrador. . . . . . 52.2.2. Abrir el puerto de comunicaciones. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52.2.3. Comprobar las comunicaciones con el concentrador . . . . . . . . . . . . . . . . . . 62.2.4. Establecer las comunicaciones con los nodos. . . . . . . . . . . . . . . . . . . . . . . . 62.2.5. Utilizar los recursos hardware de los nodos. . . . . . . . . . . . . . . . . . . . . . . . . . 62.2.6. Cerrar las comunicaciones. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2.3. Instrucciones y Respuestas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72.3.1. GetVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72.3.2. Extended . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72.3.3. OpenPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82.3.4. ClosePort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82.3.5. TestCtrLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92.3.6. SetUpNdCan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92.3.7. SetUpNdCanMax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102.3.8. SetUpNdKreta . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102.3.9. SetUpNdCanMaxH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112.3.10. SetUpNdCanFP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122.3.11. TestNodeLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122.3.12. HotReset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132.3.13. GetFirmwareVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132.3.14. SetCFG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142.3.15. GetCFG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152.3.16. WriteCodeOFL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152.3.17. ReadCodeOFL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162.3.18. EraseCodeOFL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172.3.19. WrDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172.3.20. SaveAndRestoreDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182.3.21. ClrDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192.3.22. CloseRelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192.3.23. SwitchRelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202.3.24. TxDigitalInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212.3.25. ActivateLed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212.3.26. SwitchLed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222.3.27. ActivateBuzzer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232.3.28. EjectCard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232.3.29. CaptureCard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242.3.30. OutputPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242.3.31. OutputFP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Kimaldi Electronics, S. L. Terrassa (Barcelona) – Spain Tel. +34 93 736 1510 Fax +34 93 736 1511 [email protected] Lusa, Lda. Lisboa – Portugal Tel. +351 21 715 6303 Fax +351 21 715 6295 [email protected]

ldi de México, S.A. Puebla – México Tel +52 222 1309463 Int Rep 01222 1309463 Fax +52 222 1309464 [email protected] www.kimaldi.com





Índice

Kima

2.4. Sucesos. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262.4.1. TCPClose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262.4.2. OnFncKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262.4.3. OnTrack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262.4.4. OnDigitalInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272.4.5. AnsGetPortAnswer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272.4.6. AnsInputFP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272.4.7. AnsAutonomousIdentify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282.4.8. AnsOpticBarrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

2.5. Timeout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292.5.1. CtrTimeOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292.5.2. NodeTimeOut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

3. Formato de trama. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304. Resolución de problemas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31







Control OCX PrKBusCtl - Manual de Programación - 4

Kima

1. Introducción.

El sistema de comunicaciones de Kimaldi está indicado para todas aquellas aplicaciones que requieran de una red de dispositivos estándar como lectores de banda magnética, proximidad, motorizados, teclados, contadores… para adquirir datos y actuar en consecuencia sobre cerraduras eléctricas, displays, leds, buzzers, impresoras de tickets… La rapidez de las comunicaciones hace posible que el software realice toda la gestión de los dispositivos on-line, aunque es igualmente posible hacer aplicaciones off-line. El sistema de comunicaciones se basa en un bus al que se le unen todos los elementos que lo conforman a los que llamamos nodos. Se conecta al PC mediante el concentrador, el cual permite la comunicación con el resto de equipos. Cada nodo se articula alrededor de una tarjeta de comunicaciones. Existen varios modelos de electrónicas a elegir en función de la aplicación a desarrollar.Las comunicaciones están basadas en el bus CAN con optoacoplamiento. Este potente bus industrial admite longitudes de cable de hasta 800m y soporta la conexión de un centenar de nodos al mismo cable del bus. Para las instalaciones con mayor longitud o mayor número de nodos se requerirá el uso de repetidores de señal. Con ellos se puede construir una red rápida y fiable de hasta 1016 nodos.

El software puede controlar el bus mediante comandos ascii o bien mediante un control ACTIVEX para VisualBasic. En ambos casos el control de los dispositivos hardware del bus es muy sencillo ya que los nodos NdCan y NdCanMax se encargan de gestionar el protocolo específico de cada dispositivo. Así, para el programador no hay apenas diferencia entre la captura de datos mediante un lector motorizado de banda magnética, y mediante un lector de proximidad.

En este manual encontrará la totalidad de los comandos que son implementables a partir del OCX. La explicación de la funcionalidad de cada uno de estos comandos así como a qué electrónicas son aplicables la encontrará en los manuales del hardware de cada uno de los productos. A su vez, para controlar el bus mediante comandos ascii consultar también los manuales de los productos.








Kima

2. El Control KBUSXctl.

2.1. Descripción.

El control ActiveX KBUSXCTL es el driver del sistema de comunicaciones de Kimaldi.

La función del control ActiveX es triple:

• Establece las comunicaciones con el puerto COM al que está conectado el concen-trador del bus.

• Permite enviar instrucciones a los nodos mediante los Métodos del control y recibir respuestas y sucesos mediante los Eventos del control.

• Supervisa las comunicaciones instrucción-respuesta con cada elemento del bus y, avisa mediante los eventos CtrTimeOut y NodeTimeOut en caso de fallo de comunicaciones.

2.2. Empleo del Control. Fases.

El empleo del control comprende de seis fases.

2.2.1. Configurar modo de direccionamiento empleado por el concentrador.

Por defecto el control KBUSctl asume que el concentrador trabaja en modo de direccionamiento estándar. Si nuestro concentrador está configurado en modo de direccionamiento extendido, emitiremos el método Extended en esta fase.

2.2.2. Abrir el puerto de comunicaciones.

Luego hay que abrir el puerto COM al que se encuentra conectado el concentrador del bus. Para ello usaremos el método OpenPort. Podemos emplear un puerto local del PC en el que se ejecuta el control, o un puerto remoto de cualquier otro PC del que se conozca su dirección TCP. Si este último es el caso, deberá ejecutar el programa COMRemote en el PC físicamente conectado al concentrador. El control KBUSXctl informará mediante un evento si se produjese una interrupción de la comunicación TCP.








Kima

2.2.3. Comprobar las comunicaciones con el concentrador

Es una buena práctica comprobar las comunicaciones con el concentrador en esta fase, pues de ella depende la correcta ejecución de la fase siguiente. Para ello emplearemos el método TestCtrLink. Si las comunicaciones funcionan correctamente se disparará el evento AnsTestCtrLink. En caso contrario se disparará el evento CtrTimeout.

2.2.4. Establecer las comunicaciones con los nodos.

A continuación hay que declarar todos los nodos conectados al bus y las direcciones que tienen asignadas. Los métodos destinados a ese fin son SetUpNdCan, SetUpNdCanMax, SetUpKreta, SetUpNdCanMaxH, SetUpNdCanFP y SetUpKBio. Emplearemos el que corresponda según el tipo de nodo. Estos métodos envían automáticamente la instrucción HotReset. Si el nodo responde, el control ACTIVEX disparará el evento AnsHotReset. En caso contrario se disparará el evento NodeTimeout. Esto permite comprobar el funcionamiento de las comunicaciones con los nodos en esta fase.

2.2.5. Utilizar los recursos hardware de los nodos.

A continuación ya pueden emplearse los métodos y eventos que permiten utilizar los recursos del hardware (displays, relés, lectores, etc.) de que se componen los nodos. También es posible comprobar las comunicaciones con cada nodo mediante el método TestNodeLink, que disparará el evento AnsTestNodeLink si las comunicaciones funcionan correctamente y, NodeTimeOut en caso de fallo.Más adelante se describe el formato de los métodos y eventos para poder enviar las instrucciones y recibir las respuestas y sucesos de cada nodo.En esta fase es posible seguir utilizando el método GetVersion presentado en la fase 1, así como el método TestCtrLink descrito en la fase 3.

2.2.6. Cerrar las comunicaciones.

Al finalizar la sesión deberá cerrarse el puerto de comunicaciones empleando el método ClosePort.








Kima

2.3. Instrucciones y Respuestas.

2.3.1. GetVersion

2.3.2. Extended

Descripción: Devuelve la versión del control ActiveX empleado.

Aplica a: Control KBUSXctl

Empleo: A partir de la fase 1

Declaración: GetVersion() As String

Argumentos: Ninguno

Valores de retorno: Cadena de caracteres conteniendo la versión del control.

Evento de respuesta:

Ninguno

Valores de retorno: Ninguno

Descripción: Instruye al control KBUSXctl para que utilice el modo de direc-cionamiento extendido.



Declaración: Extended()

Argumentos: Ninguno



Ninguno









Kima

2.3.3. OpenPort

2.3.4. ClosePort

Descripción: Abre el puerto de comunicaciones.



Declaración: OpenPort(ByVal PortNo As Byte, ByVal TCPaddress As String, ByVal TCPshocket As Long) As Byte

Argumentos: -PortNo: Numero del puerto serie empleado.-TCPaddress : Dirección TCP del PC donde se ejecuta Com-Remot-TCPshocket: Socket TCP (5001 si se usa ComRemot, 0 si se usa puerto local)

Valores de retorno: 0: Ok.1: El puerto está abierto.2: Nº del puerto incorrecto.3: Dirección TCP incorrecta.4: Error de apertura del puerto.255: Otros errores.


Ninguno


Descripción: Cierra el puerto de comunicaciones.



Declaración: ClosePort()

Argumentos: Ninguno



Ninguno








Kima

2.3.5. TestCtrLink

2.3.6. SetUpNdCan


Descripción: Comprueba las comunicaciones con el concentrador.

Aplica a: Concentrador


Declaración: TestCtrLink() As Byte

Argumentos: Ninguno

Valores de retorno: 0: Ok.1: No se ha abierto el puerto.255: Otros errores.


AnsTestCtrLink()


Descripción: Declara e inicializa un nodo como NdCan.

Aplica a: NdCan


Declaración: SetUpNdCan(ByVal ApId As Integer) As Byte

Argumentos: ApId: Dirección del nodo.

Valores de retorno: 0: Ok.1: No se ha abierto el puerto.2: ApId no válido.10: Llamada cancelada. Operación en curso.255: Otros errores.


AnsHotReset








Kima

2.3.7. SetUpNdCanMax

2.3.8. SetUpNdKreta

Valores de retorno: Ver método HotReset

Descripción: Declara e inicializa un nodo como NdCanMax

Aplica a: NdCanMax


Declaración: SetUpNdCanMax(ByVal ApId As Integer) As Byte




AnsHotReset


Descripción: Declara e inicializa un nodo como Kreta.

Aplica a: Kreta


Declaración: SetUpKreta(ByVal ApId As Integer) As Byte









Kima

2.3.9. SetUpNdCanMaxH



AnsHotReset


Descripción: Declara e inicializa un nodo como NdCanMaxH.

Aplica a: NdCanMaxH


Declaración: SetUpNdCanMaxH(ByVal ApId As Integer) As Byte




AnsHotReset









Kima

2.3.10. SetUpNdCanFP

2.3.11. TestNodeLink

Descripción: Declara e inicializa un nodo como NdCanFP

Aplica a: NdCanFP


Declaración: SetUpNdCanFP(ByVal ApId As Integer) As Byte




AnsHotReset


Descripción: Comprueba las comunicaciones con un nodo

Aplica a: NdCan,NdCanMax,Kreta,NdCanMaxH,KBio


Declaración: TestNodeLink(ByVal ApId As Integer) As Byte


Valores de retorno: 0: Ok.1: No se ha abierto el puerto.2: No se ha establecido el nodo.3: El nodo no admite la instrucción.10: Llamada cancelada. Operación en curso.255: Otros errores.


AnsTestNodeLink (ApId As Integer)








Kima

2.3.12. HotReset

2.3.13. GetFirmwareVersion

Valores de retorno: ApId: Dirección del nodo.

Descripción: Inicializa un nodo



Declaración: HotReset(ByVal ApId As Integer) As Byte




AnsHotReset (ApId As Integer)

Valores de retorno: ApId: Dirección del nodo.

Descripción: Pregunta la versión de firmware de un nodo



Declaración: GetFirmwareVersion(ByVal ApId As Integer) As Byte









Kima

2.3.14. SetCFG



AnsGetFirmwareVersion(ApId As Integer, Code1 As Byte, Code2 As Byte)

Valores de retorno: ApId: Dirección del nodo.Code1: versión del firmware (major)Code2: versión del firmware (minor)

Descripción: Envia los bytes de configuración

Aplica a: NdCan,NdCanMax,NdCanMaxH,NdCanMaxFP


Declaración: SetCFG(ByVal ApId As Integer, ByVal Cfg0 As Byte, ByVal Cfg1 As Byte, ByVal Cfg2 As Byte, ByVal Cfg3 As Byte, ByVal Cfg4 As Byte, ByVal Cfg5 As Byte) As Byte

Argumentos: ApId: Dirección del nodo.Cfg0..5: bytes de configuración.



Ninguno









Kima

2.3.15. GetCFG

2.3.16. WriteCodeOFL

Descripción: Pregunta los bytes de configuración



Declaración: GetCFG(ByVal ApId As Integer) As Byte




AnsGetCFG(ApId As Integer, Cfg0 As Byte, Cfg1 As Byte, Cfg2 As Byte,Cfg3 As Byte, Cfg4 As Byte, Cfg5 As Byte)

Valores de retorno: ApId: Dirección del nodo que responde Cfg0..5: Los seis bytes de configuración.

Descripción: Graba un código Offline en la eeprom

Aplica a: NdCan,NdCanMax


Declaración: WriteCodeOFL (ByVal ApId As Integer, ByVal Pos As Byte, ByVal CodeOFL As String) As Byte

Argumentos: ApId: Dirección del nodo. Pos: Posición de la Tabla de Codigos Off LineCodeOFL: Valor del código a grabar. Puede expresarse indistin-tamente en formato hexadecimal de diez dígitos o en su equiva-lente decimal mediante trece dígitos, según convenga.








Kima

2.3.17. ReadCodeOFL

Valores de retorno: 0: Ok.1: No se ha abierto el puerto.2: No se ha establecido el nodo.3: El nodo no admite la instrucción.10: Llamada cancelada. Operación en curso.11: Valor erróneo de Pos.12: Valor erróneo de CodeOFL.255: Otros errores.


AnsWriteCodeOFL(ApId As Integer, Pos As Byte, HexCodeOFL As String, DecCodeOFL As String)

Valores de retorno: ApId: Dirección del nodo que responde Pos: Posición en la Tabla de Códigos Off Line.HexCodeOFL: Código expresado en hexadecimal.DecCodeOFL: Código expresado en decimal.

Descripción: Lee un código Offline de la eeprom



Declaración: ReadCodeOFL (ByVal ApId As Integer, ByVal Pos As Byte) As Byte

Argumentos: ApId: Dirección del nodo.Pos: Posición de la Tabla de Codigos Off Line

Valores de retorno: 0: Ok.1: No se ha abierto el puerto.2: No se ha establecido el nodo.3: El nodo no admite la instrucción.10: Llamada cancelada. Operación en curso.11: Valor erróneo de Pos.255: Otros errores.


AnsReadCodeOFL(ApId As Integer, Pos As Byte, HexCodeOFL As String, DecCodeOFL As String)

Valores de retorno: ApId: Dirección del nodo que responde Pos: Posición en la Tabla de Códigos Off Line.HexCodeOFL: Código expresado en hexadecimal.DecCodeOFL: Código expresado en decimal.








Kima

2.3.18. EraseCodeOFL

2.3.19. WrDisplay

Descripción: Borra los códigos Offline de la eeprom



Declaración: EraseCodeOFL (ByVal ApId As Integer) As Byte




AnsEraseCodeOFL(ApId As Integer)

Valores de retorno: ApId: Dirección del nodo que responde

Descripción: Escribe una linea de texto en el dislpay

Aplica a: NdCanMax


Declaración: WrDisplay(ByVal ApId As Integer, ByVal Line As Byte, ByVal Text As String) AsByte

Argumentos: ApId: Dirección del nodo.Line: Línea del display 1 o 2.Text: Texto de hasta 20 caracteres.








Kima

2.3.20. SaveAndRestoreDisplay

Valores de retorno: 0: Ok.1: No se ha abierto el puerto.2: No se ha establecido el nodo.3: El nodo no admite la instrucción.10: Llamada cancelada. Operación en curso.11: Line fuera de rango.255: Otros errores.


Ninguno


Descripción: Guarda el contenido del display y lo restaura transcurrido un intervalo de tiempo.

Aplica a: NdCanMax


Declaración: SaveAndRestoreDisplay(ByVal ApId As Integer, ByVal TTime As Byte) As Byte

Argumentos: ApId: Dirección del nodo.Ttime: Espera a la restauración en décimas de segundo desde la grabación (0..255).



OnDisplaySave (ApId As Integer, Status As Byte)

Valores de retorno: ApId: Dirección del nodo que responde Status: 0: copia correcta / 255: copia cancelada.








Kima

2.3.21. ClrDisplay

2.3.22. CloseRelay

Descripción: Borra el display.

Aplica a: NdCanMax


Declaración: ClrDisplay(ByVal ApId As Integer) As Byte




Ninguno


Descripción: Cierra un contacto relé durante un intervalo de tiempo



Declaración: CloseRelay(ByVal ApId As Integer, ByVal Rel As Byte, ByVal TTime As Byte) As Byte

Argumentos: ApId: Dirección del nodo.Rel: Numero de relé (0..n). TTime: Tiempo de activación en décimas de segundo (0..255).








Kima

2.3.23. SwitchRelay

Valores de retorno: 0: Ok.1: No se ha abierto el puerto.2: No se ha establecido el nodo.3: El nodo no admite la instrucción.10: Llamada cancelada. Operación en curso.11: Valor Rel no válido.255: Otros errores.


Ninguno


Descripción: Abre/Cierra un contacto relé

Aplica a: NdCan,NdCanMax,NdCanMaxH, NdCanMaxFP


Declaración: SwitchRelay(ByVal ApId As Integer, ByVal Rel As Byte, ByVal Mode As Boolean) As Byte

Argumentos: ApId: Dirección del nodoRel: Numero de relé (0..n).Mode: True para activar / False para desactivar.

Valores de retorno: 0: Ok.1: No se ha abierto el puerto.2: No se ha establecido el nodo.3: El nodo no admite la instrucción.10: Llamada cancelada. Operación en curso.11: Valor Rel no válido.255: Otros errores.


Ninguno









Kima

2.3.24. TxDigitalInput

2.3.25. ActivateLed

Descripción: Pregunta el estado de las entradas digitales

Aplica a: NdCanMax,NdCanMaxH


Declaración: TxDigitalInput(ByVal ApId As Integer) As Byte




OnDigitalInput (Ver suceso OnDigitalInput)

Valores de retorno: (Ver suceso OnDigitalInput)

Descripción: Enciende un led durante un intervalo de tiempo



Declaración: ActivateLed(ByVal ApId As Integer, ByVal Led As Byte, ByVal TTime As Byte) As Byte

Argumentos: ApId: Dirección del nodo. Led: Numero de Led. ( 0- Verde / 1 – Rojo ). TTime: Tiempo de activación en décimas de segundo (0..255) .








Kima

2.3.26. SwitchLed

Valores de retorno: 0: Ok.1: No se ha abierto el puerto.2: No se ha establecido el nodo.3: El nodo no admite la instrucción.10: Llamada cancelada. Operación en curso.11: Valor Led no válido.255: Otros errores.


Ninguno


Descripción: Enciende/Apaga un led



Declaración: SwitchLed(ByVal ApId As Integer, ByVal Led As Byte, ByVal Mode As Boolean)As Byte

Argumentos: ApId: Dirección del nodo.Led: Numero de Led. ( 0- Verde / 1 – Rojo ).Mode: True para encender / False para apagar.

Valores de retorno: 0: Ok.1: No se ha abierto el puerto.2: No se ha establecido el nodo.3: El nodo no admite la instrucción.10: Llamada cancelada. Operación en curso.11: Valor Led no válido.255: Otros errores.


Ninguno









Kima

2.3.27. ActivateBuzzer

2.3.28. EjectCard

Descripción: Activa el zumbador durante un intervalo de tiempo



Declaración: ActivateBuzzer(ByVal ApId As Integer, ByVal TTime As Byte) As Byte

Argumentos: ApId: Dirección del nodo.TTime: Tiempo de activación en décimas de segundo (0..255) .



Ninguno


Descripción: Intruye al lector motorizado para que expulse la tarjeta



Declaración: EjectCard(ByVal ApId As Integer) As Byte










Kima

2.3.29. CaptureCard

2.3.30. OutputPort


Ninguno


Descripción: Intruye al lector motorizado para que retenga la tarjeta



Declaración: CaptureCard(ByVal ApId As Integer) As Byte




Ninguno


Descripción: Emite datos por el puerto serie del nodo

Aplica a: NdCan,NdCanMax,NdCanMaxH


Declaración: OutputPort(ByVal ApId As Integer, ByVal Data As String) As Byte

Argumentos: ApId: Dirección del nodo.Data: Cadena a emitir por el puerto serie.








Kima

2.3.31. LockTerminal

Valores de retorno: 0: Ok.1: No se ha abierto el puerto.2: No se ha establecido el nodo.3: El nodo no admite la instrucción.10: Llamada cancelada. Operación en curso.11: Data excede la longitud máxima (255 bytes)255: Otros errores.


AnsOutputPort (ApId As Integer)

Valores de retorno: ApId: Dirección del nodo que responde

Descripción: Bloquea el terminal KBio. Solamente admite comandos on-line

Aplica a: KBio


Declaración: LockTerminal(ByVal ApId As Integer, ByVal Mode as Boolean) As Byte

Argumentos: ApId: Dirección del nodo.Mode: True para bloquear, False para desbloquea

Valores de retorno: 0: Ok.1: No se ha abierto el puerto.2: No se ha establecido el nodo.3: El nodo no admite la instrucción.10: Llamada cancelada. Operación en curso.11: Data excede la longitud máxima (830 bytes)20: Data no se puede procesar de acuerdo a Ins. 255: Otros errores.


AnsLock(ApId As Integer, status As Byte)

Valores de retorno: ApId: Dirección del nodo que responde Status: 0x00: Terminal no bloqueado. 0xFF: Terminal Bloqueado.








Kima

2.3.32. OutputFP

2.4. Sucesos.

2.4.1. TCPClose

Descripción: Emite datos por el puerto serie del nodo

Aplica a: KBio


Declaración: OutputFP(ByVal ApId As Integer, ByVal Ins As String, ByVal Data As String) As Byte

Argumentos: ApId: Dirección del nodo.Ins: Instrucción de envío.Data: Cadena para procesar la emisión por el puerto serie.

Valores de retorno: 0: Ok.1: No se ha abierto el puerto.2: No se ha establecido el nodo.3: El nodo no admite la instrucción.10: Llamada cancelada. Operación en curso.11: Data excede la longitud máxima (830 bytes)20: Data no se puede procesar de acuerdo a Ins. 255: Otros errores.


AnsOutputFP (ApId As Integer,Status as byte)

Valores de retorno: ApId: Dirección del nodo que responde Status: 0: ok 1: Llamada cancelada. Recepción en curso. 2: Error de comunicaciones.

Descripción: Se ha perdido la comunicación TCP

Declaración: TCPClose()








Kima

2.4.2. OnFncKey

2.4.3. OnTrack

2.4.4. OnDigitalInput


Descripción: Se ha recibido un código de tecla

Declaración: OnFncKey (ApId As Integer, Key as string)

Valores de retorno: ApId: Dirección del nodo que responde Key: Código de la tecla pulsada.

Descripción: Se han recibido datos de una lectura

Declaración: OnTrack (ApId As Integer, Track as string)

Valores de retorno: ApId: Dirección del nodo que responde Track: Datos procedentes del lector

Descripción: Se ha recibido el estado de las entradas digitales

Declaración: OnDigitalInput (ApId As Integer, DigInput as byte)








Kima

2.4.5. AnsGetPortAnswer

2.4.6. AnsInputFP

2.4.7. AnsAutonomousIdentify

Valores de retorno: ApId: Dirección del nodo que responde DigInput: Valor Byte correspondiente al estado de las entradas digitales.

Descripción: Se ha recibido información como consecuencia de la emisión de un OutputPort

Declaración: AnsOutputPort (ApId As Integer, Answer: string)

Valores de retorno: ApId: Dirección del nodo que responde Answer: Respuesta del nodo.

Descripción: Se ha recibido información como consecuencia de la emisión de un OutputFP

Declaración: AnsInputFP(ApId As Integer, Ins As String, Data As String)

Valores de retorno: ApId: Dirección del nodo que responde Ins: Instrucción decodificadaData: Respuesta decodificada del nodo.

Descripción: Evento generado por un proceso de identificación autónomo de la KBio

Declaración: AnsAutonomousIdentify(Result As Byte, FPID As String)








Kima

2.4.8. AnsOpticBarrier

Generado por: KBio

Valores de retorno: Result: 0xE0: Identificación errónea 0xE1:Time-out 0x00: Identificación correctaFPID: En caso de identificación correcta. Cadena con el FPID del usuario identificado.

Nota: El orden en el que aparece el FPID es inverso al que se registra, primero la información de los dos dígitos más significa-tivos y en segundo lugar la de los dos dígitos menos significati-vos del FPID.

Descripción: Si el camino de la barrera óptica de la KBio se bloquea durante mucho rato o existen interferéncias por fuente luminosa externa, se nos comunica a través de este evento. Cuando la situación vuelve a la normalidad tamboén se genera el evento.

Declaración: AnsOpticBarrier(status As Byte)

Generado por: KBio

Valores de retorno: Status: 0x00: Estado Normal. 0xE0: Interferéncia.








Kima

2.5. Timeout.

2.5.1. CtrTimeOut

2.5.2. NodeTimeOut

Descripción: Se ha agotado el Timeout de comunicaciones con el concentra-dor entre una instrucción y la recepción de su respuesta.

Declaración: CtrTimeOut ()


Descripción: Se ha agotado el Timeout de comunicaciones con un nodo entre una instrucción y la recepción de su respuesta.

Declaración: NodeTimeOut (ApId As Integer)

Valores de retorno: ApId: Dirección del nodo que no responde.








Kima

3. Formato de trama.

Mediante el control ACTIVEX el software del PC se comunica con el concentrador a partir de unas tramas serie.Cada trama posee el siguiente formato:

<STX><APID><OPC><NA><ARG><CRC><ETX>

• <STX> Indica el inicio de la trama. Es el carácter ascii 0x02.• <APID> Para las tramas emitidas por el PC, este parámetro indica la dirección de

bus del nodo al que se dirige la trama. Para las tramas emitidas por un nodo, el parámetro indica la dirección de bus del nodo emisor. El concentrador se consid-era un nodo más del bus cuya dirección es cero.Si el concentrador está config-urado con Direccionamiento Estándar, el parámetro se expresará mediante dos caracteres con ascii comprendidos en el rango (de “0” a”9” y de ”A” a ”F”) rep-resentando un número hexadecimal de dos dígitos.Si se ha configurado el Direc-cionamiento Extendido, se usarán cuatro caracteres ascii para representar un valor hexadecimal de cuatro dígitos.

• <OPC>Este parámetro indica el significado de la trama y, permitirá interpretar los datos de la misma. Es un valor byte que se expresa mediante dos caracteres con ascii comprendido en el rango (de “0” a”9” y de ”A” a ”F”) representando un valor hexadecimal de dos dígitos.

• <NA>Este parámetro indica el número de bytes que se encuentran codificados en el campo datos. Es un valor byte que se expresa mediante dos caracteres con ascii comprendido en el rango (de “0” a”9” y de ”A” a ”F”) representando un valor hexadecimal de dos dígitos.

• <ARG> Contiene la información de la trama.Para las tramas con <OPC> igual a 0xCB este campo estará constituido por una cadena de caracteres cuya longitud será la indicada por <NA>.Para las tramas con <OPC> distinto de 0xCB, este campo estará constituido por <NA> pares de caracteres con ascii comprendido en el rango (de “0” a”9” y de ”A” a ”F”) representando en notación hexadecimal cada uno de los <NA> bytes de información.

• <CRC> Este campo contiene un valor byte resultado de sumar en módulo 255 todos los valores ascii de la trama a excepción de <STX>, <CRC> y <ETX>. Se expresa mediante dos caracteres con ascii comprendido en el rango (de “0” a”9” y de ”A” a ”F”).

• <ETX> Indica el fin de la trama. Es el carácter ascii 0x03.








Kima

4. Resolución de problemas.

Tanto el concentrador como las tarjetas de comunicaciones están provistos de un led de estado de las comunicaciones del bus. Este led se enciende al conectar la alimentación del equipo y se apaga después de inicializar correctamente el transmisor CAN. Luego se encenderá brevemente cada vez que el equipo emita o reciba información. Esta indicación facilita la localización de problemas. Para mayor ayuda sugerimos algunas indicaciones adicionales:

Al emitir el método TestCtrLink, no se dispara el evento AnsTestCtrLink.

Compruebe lo siguiente:

¿ Llega alimentación al concentrador ?¿El concentrador está correctamente conectado al PC mediante un cable serie pin a pin ?

¿Ha abierto el puerto adecuado en el método OpenPort ?¿Ha invocado al método Extended sólo si su concentrador usa el modo de direcciona-miento extendido?

¿Ha programado el evento AnsTestCtrLink para capturar el suceso emitido por el concentrador ?

Al emitir el método CloseRelay, no se cierra el contacto relé del nodo.


¿Está el bus alimentado?¿Tiene instaladas las resistencias de terminación?¿Llega alimentación al nodo?¿Ha conectado correctamente el bus?¿La dirección del nodo corresponde con la que se especifica en el método?








Kima

El PC no recibe datos del lector conectado al nodo.


¿Está activado el puerto del lector en la configuración del nodo?¿Si procede, se ha configurado el formato de recepción que corresponde al lector instalado?

¿Está seguro que no existe en el bus otro nodo con la misma dirección? ¿Ha programado el evento OnTrack para capturar el suceso emitido por el nodo ?








Kima

Anexo A. Soporte al protocolo del lector FIM01-HD y FDA01

En este apartado se presentan algunos de los comandos que pueden ser enviados al lector biométrico de huella dactilar FDA01 o FIM01-HD por el puerto serie de la BioMax o KBio. No se relacionan todos los comandos que admite la unidad, sino solamente los necesarios para poder utilizar el lector de huella en modo on-line tal como se explica a continuación.

En una aplicación típica de control de acceso, deberemos empezar por registrar el usuario al sistema. Para ello, pediremos al usuario que coloque su dedo en el lector al tiempo que emitimos el comando CMD_GET_MINUTIAE para obtener los datos característicos de su huella. Una vez recibidos, almacenaremos los datos en una base de datos local del PC; o en la base de datos interna que posee el lector biométrico situado en cada uno de los accesos a los que deseamos permitir la entrada de ese usuario. Usaremos para ello el comando CMD_FDA_DB_ADD_REC. Cuando ese usuario se presente en un punto de acceso, facilitará su código de usuario mediante teclado, tarjeta magnética, tarjeta de proximidad, etc. y situará su dedo en el lector de huella. Si la huella se ha almacenado en la base de datos del PC, se podrá verificar la huella presente en el lector con los datos que se mandan desde el PC a partir del comando CMD_INSTANT_VERIFY. En caso que las huellas estén almacenadas en la memoria del sensor el PC mandará el comando CMD_FP_VERIFY para que la unidad biométrica situada en el acceso contraste la huella presente con la registrada en su base de datos local correspondiente a ese usuario.Añadir que, la descripción que se hace de cada uno de los comandos es meramente orientativo. En ningún caso pretende sustituir el manual de la unidad FDA01 o FIM01-HD.








Kima

A.1. CMD_GET_VERSION

A.2. CMD_DEVICE_TEST

Descripción: Permite conocer la versión del firmware del lector FDA01 o FIM01-HD

Comando: Enviado mediante OutputFP

Ins “05”

Data: “”

Respuesta: Recibido mediante AnsInputFP

Ins: “05”

Data: [ErrCode: 2 dig.hex.];[Versión: 8 dig.hex.]ErrCode: ver manual del lector biométrico.Versión: valor de la versión del firmware.

Descripción: Permite comprobar el correcto funcionamiento del hardware.


Ins “10”

Data: Formato: [Device: 2 dig.hex.]Device: 0x00: para verificar todos los dispositivos del hardware. 0x01: para verificar el sensor de imagen. 0x02: para verificar la memoria flash. 0x03: para verificar el checksum del programa en flash.


Ins: “10”

Data: [ErrCode: 2 dig.hex.];ErrCode: ver manual del lector biométrico








Kima

A.3. CMD_EXP_AUTOTUNING

A.4. CMD_SET_EXP

Descripción: Permite calibrar automáticamente la exposición de la unidad óptica. El usuario debe mantener el dedo en el sensor durante el proceso de calibración.


Ins “16”

Data: “”


Ins: “16”

Data: [ErrCode: 2 dig.hex.];[Coarse: 4 dig.hex.][Fine: 2 dig.hex.]ErrCode: ver manual del lector biométrico

Descripción: Permite fijar la exposición que usará la unidad óptica.


Ins “22”

Data: Formato: [Coarse: 4 dig.hex.][Fine: 4 dig.hex.]Coarse: valor entre 0x0000 y 0x012EFine: valor entre 0x0000 y 0x0168


Ins: “22”









Kima

A.5. CMD_SET_GAIN

A.6. CMD_SET_TIME

Descripción: Permite fijar la ganancia que usará la unidad óptica.


Ins “23”

Data: Formato: [Gain: 2 dig.hex.]Gain: 0x01, 0x02, 0x04, 0x08


Ins: “23”


Descripción: Pone en hora el reloj de la unidad FDA01 o FIM01-HD


Ins “24”

Data: Formato: [Time: 14 dig.dec.]Time: DDMMAAAAhhmmss


Ins: “24”









Kima

A.7. CMD_SET_SECULEVEL

A.8. CMD_GET_MINUTIAE

Descripción: Establece el nivel de seguridad empleado en las operaciones de verificación y registro o identificación.


Ins “25”

Data: Formato: [verify: 2 dig.hex.][identify: 2 dig.hex.]Verify: entre 0x01 y 0x09Identify: entre 0x01 y 0x09


Ins: “25”


Descripción: Permite obtener datos sobre el dedo que se encuentra en la unidad óptica.


Ins “40”

Data: Formato: [Quality: 2 dig. hex.]Quality: entre 0x00 y 0x64


Ins: “40”

Data: [ErrCode: 2 dig.hex.];[Minutiae: 800 dig.hex.]ErrCode: ver manual del lector biométrico








Kima

A.9. CMD_GET_GAIN

A.10. CMD_GET_EXP

Descripción: Obtiene el valor de ganancia empleado por la unidad óptica


Ins “41”

Data: “”


Ins: “41”

Data: [ErrCode: 2 dig.hex.];[Gain: 2 dig.hex.]ErrCode: ver manual del lector biométrico

Descripción: Obtiene el valor de exposición empleado por la unidad óptica.


Ins “42”

Data: “”


Ins: “42”

Data: [ErrCode: 2 dig.hex.];[Coarse: 4 dig.hex.][Fine: 4 dig. hex.]ErrCode: ver manual del lector biométrico








Kima

A.11. CMD_GET_TIME

A.12. CMD_GET_SECULEVEL

Descripción: Obtiene la fecha/hora del reloj de la unidad FDA01 o FIM01-HD


Ins “44”

Data: “”


Ins: “44”

Data: [ErrCode: 2 dig.hex.];[Time: 14 dig.dec.]ErrCode: ver manual del lector biométricoTime: DDMMAAAAhhmmss

Descripción: Obtiene el nivel de seguridad empleado por la unidad BIOMÉTRICA


Ins “45”

Data: “”


Ins: “45”

Data: [ErrCode: 2 dig.hex.];[Verify: 2 dig.hex.][Identify: 2 dig.hex.]ErrCode: ver manual del lector biométrico








Kima

A.13. CMD_FP_VERIFY

A.14. CMD_DB_GET_RECCOUNT

Descripción: Permite verificar la huella del dedo presente el en lector con una minutiae residente en la base de datos.


Ins “55”

Data: Formato: [UserID: 4 dig.hex.]UserID: número del registro de la base de datos del que hay que tomar la minutiae para hacer la verificación.


Ins: “55”

Data: [ErrCode: 2 dig.hex.];[UserID: 4 dig.hex.]ErrCode: ver manual del lector biométrico

Descripción: Obtiene el número de registros de la base de datos.


Ins “70”

Data: “”


Ins: “70”

Data: [ErrCode: 2 dig.hex.];[Numrec: 4 dig.hex.]ErrCode: ver manual del lector biométrico








Kima

A.15. CMD_FDA_DB_ADD_REC

A.16. CMD_DB_DELETE_REC

Descripción: Añade/modifica un registro en la base de datos.


Ins “71”

Data: Formato: [Overwrite: 2 dig.hex.][UserID: 4 dig.hex.][Minutiae1: 800 dig.hex.][Minutiae2: 800 dig.hex.][Time: 14 dig.dec.]Overwrite: 0x00 no sobrescribe el registro si ya existe 0x01 sobrescribe el registro en caso de existir previamente.UserID: número del registro de la base de datos a crear/modifi-car.Minutiae1: datos de la huellaMinutiae2: datos de la misma huella distintos de los anteriores.Time: DDMMAAAAhhmmss de la grabación del registro.


Ins: “71”

Data: [ErrCode: 2 dig.hex.];[UserID: 4 dig.hex.]ErrCode: ver manual del lector biométrico

Descripción: Borra un registro de la base de datos.


Ins “72”

Data: Formato: [UserID: 4 dig.hex.]UserID: número del registro a borrar


Ins: “72”

Data: [ErrCode: 2 dig.hex.]; [UserID: 4 dig.hex.]ErrCode: ver manual del lector biométrico








Kima

A.17. CMD_DB_GET_REC

A.18. CMD_DB_GET_FIRSTREC

Descripción: Obtiene un registro de la base de datos


Ins “73”

Data: Formato: [UserID: 4 dig.hex.]UserID: número del registro a consultar


Ins: “73”

Data: [ErrCode: 2 dig.hex.];[UserID: 4 dig.hex.][Minutiae1: 800 dig.hex.][Minutiae2: 800 dig.hex.][Time: 14 dig.hex.]ErrCode: ver manual del lector biométricoTime: DDMMAAAAhhmmss

Descripción: Obtiene el primer registro de la base de datos


Ins “74”

Data: “”


Ins: “74”









Kima

A.19. CMD_DB_GET_NEXTREC

A.20. CMD_DB_DELETE_ALL

Descripción: Obtiene el siguiente registro de la base de datos


Ins “75”

Data: “”


Ins: “75”


Descripción: Borra todos los registros de la base de datos


Ins “76”

Data: “”


Ins: “76”









Kima

A.21. CMD_DB_GET_CURRENTREC

A.22. CMD_GET_RECCOUNT

Descripción: Obtiene el registro actualmente apuntado de la base de datos


Ins “77”

Data: “”


Ins: “77”


Descripción: Obtiene el númro de Logs guardados en el sistema. Los Logs son obtenidos mediante CMD_LOG_GET_REC.


Ins “80”

Data: “”


Ins: “80”

Data: [ErrCode: 2 dig.hex.];[LogRecCount: 4 dig.hex.]








Kima

A.23. CMD_LOG_REC

Descripción: Obtiene de uno en uno los Logs guardados en el sistema.


Ins “81”

Data: "[(LogRecCount-1)..0:4 dig.hex]"Para obtener un Log debemos mandar en el campo Data el número de Log que queremos recuperar, de (LogRecCount-1) a 0. Ver comando anterior.


Ins: “81”

Data: [ErrCode: 2 dig.hex.];[LogInfo: 16 dig.hex]

ErrCode: ver manual del lector biométrico

LogInfo: consta de 8 subcampos de 2 bytes cada uno ordena-dos de manera: LSByte MSByte y expresados en hexadecimal.Estos subcampos son: Año, Mes, Dia, Hora, minuto, segundo, ID, EventNum.El campo EventNum informa del tipo de Log que se ha produc-ido:0700 (Add User)0400 (Identify Ok)0500 (Identify Fail)0800 (Delete User)0900 (Delete All Users)

Ejemplo:D407 0100 0100 0000 0400 2900 0001 0700Informa de que el evento se ha producido en:Año: 2004Mes: Enero Dia: 1Hora: 00Minutos: 00Segundos: 41ID: 0100Resultado: Usuario añadido.








Kima

A.24. CMD_LOG_DELETE_ALL

A.25. CMD_INSTANT_VERIFY

Descripción: Borra todos los Logs guardados en el sistema.


Ins “82”

Data: “”


Ins: “82”

Data: [ErrCode: 2 dig.hex.];[LogRecCount: 4 dig.hex.]

Descripción: Permite verificar la huella del dedo presente el en lector con la minutiae que se envía como argumento.


Ins “D0”

Data: Formato: [Minutiae: 800 dig.hex.]Minutiae: datos de la huella a comparar con la huella del dedo presente en el sensor.


Ins: “D0”









Kima

A.26. Otros comandos de la unidad FDA01 o FIM01-HD

Descripción: Permite enviar un comando a la unidad FDA.


Ins “FF”

Data: Formato: [Channel: 2 dig.hex.][Command: 2 dig.hex.][Param1: 4 dig.hex.][Param2: 4 dig.hex.][Arg: hasta 816 dig.hex.]Ver manual del lector biométrico


Ins: “FF”

Data: [ErrCode: 2 dig.hex.];[Channel: 2 dig.hex.][Command: 2 dig.hex.][Param1: 4 dig.hex.][Param2: 4 dig.hex.][Arg: hasta 816 dig.hex.]Ver manual del lector biométrico







manual kimaldi biomax

Documents