@tecnologicodemonterrey/hid-capacitor-mitec

Plugin de Capacitor que implementa el SDK Origo (HID) para llaves móviles y control de acceso en aplicaciones iOS y Android. Desarrollado para el Tecnológico de Monterrey.

Instalación

npm install @tecnologicodemonterrey/hid-capacitor-mitec
npx cap sync

Requisitos

• Capacitor 5.x
• iOS: Xcode y CocoaPods
• Android: Android Studio, SDK y NDK según requisitos del SDK nativo

Uso

Registra el plugin e importa la API en tu app:

import { HidSDK } from '@tecnologicodemonterrey/hid-capacitor-mitec';

// Ejemplo: inicializar SDK
await HidSDK.inicio();

// Obtener información de llaves
const datos = await HidSDK.getKeyInfo();

Widget "Abrir puerta" (Android)

Para usar el widget en la pantalla de inicio que abre la puerta más cercana sin abrir la app, y cómo integrarlo en la app principal, ver Implementación del widget en la app principal.

API

• echo(...)
• registro_a(...)
• inicio_a()
• getKeyInfo_a()
• validar_a()
• scanear_a()
• scanear_stop()
• openDoorFromBackground()
• isStartSDK_a()
• isActiveSDK_ios()
• registro(...)
• inicio()
• getKeyInfo()
• validar()
• getValidar()
• scanear()
• start()
• scanear()
• healthCheck()
• getKeyInfo()
• validar()
• startBLE()
• stopBLE()
• turnOnBLE()
• startSetupEndpoint()
• deliverMobileID()
• typeOpening(...)
• Interfaces

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

| Param | Type | | ------------- | ------------------------------- | | options | { value: string; } |

Returns: Promise<{ value: string; }>

registro_a(...)

registro_a(options: { value: string; }) => Promise<{ value: string; }>

| Param | Type | | ------------- | ------------------------------- | | options | { value: string; } |

Returns: Promise<{ value: string; }>

inicio_a()

inicio_a() => Promise<void>

getKeyInfo_a()

getKeyInfo_a() => Promise<Datos>

Returns: Promise<Datos>

validar_a()

validar_a() => Promise<{ validar?: any; }>

Returns: Promise<{ validar?: any; }>

scanear_a()

scanear_a() => Promise<void>

scanear_stop()

scanear_stop() => Promise<void>

openDoorFromBackground()

openDoorFromBackground() => Promise<{ started: boolean; }>

Returns: Promise<{ started: boolean; }>

isStartSDK_a()

isStartSDK_a() => Promise<void>

isActiveSDK_ios()

isActiveSDK_ios() => Promise<void>

registro(...)

registro(options: { value: string; }) => Promise<{ value: number; alreadySetup?: boolean; }>

| Param | Type | | ------------- | ------------------------------- | | options | { value: string; } |

Returns: Promise<{ value: number; alreadySetup?: boolean; }>

inicio()

inicio() => Promise<void>

getKeyInfo()

getKeyInfo() => Promise<Datos>

Returns: Promise<Datos>

validar()

validar() => Promise<{ validar?: any; }>

Returns: Promise<{ validar?: any; }>

getValidar()

getValidar() => Promise<{ getValidar?: any; }>

Returns: Promise<{ getValidar?: any; }>

scanear()

scanear() => Promise<void>

start()

start() => Promise<void>

scanear()

scanear() => Promise<void>

healthCheck()

healthCheck() => Promise<Objpermisos>

Returns: Promise<Objpermisos>

getKeyInfo()

getKeyInfo() => Promise<Datos>

Returns: Promise<Datos>

validar()

validar() => Promise<{ validar?: any; }>

Returns: Promise<{ validar?: any; }>

startBLE()

startBLE() => Promise<void>

stopBLE()

stopBLE() => Promise<void>

turnOnBLE()

turnOnBLE() => Promise<void>

startSetupEndpoint()

startSetupEndpoint() => Promise<void>

deliverMobileID()

deliverMobileID() => Promise<void>

typeOpening(...)

typeOpening(options: { value: boolean; }) => Promise<void>

| Param | Type | | ------------- | -------------------------------- | | options | { value: boolean; } |

Interfaces

Datos

| Prop | Type | | ---------- | ------------------- | | info | Info[] |

Info

| Prop | Type | | ---------------- | ------------------- | | name | string | | cardNumber | string | | nombrecard | string | | typo | string |

Objpermisos

| Prop | Type | | ----------------- | ---------------------------- | | objpermisos | Datospermisos[] |

Datospermisos

| Prop | Type | | ---------- | ------------------- | | name | string |

Licencia

MIT

Repositorio y soporte

• Repositorio: github.com/ti-tecnologico-de-monterrey-oficial/hid-capacitor-mitec
• Incidencias: Issues