Suprema Documentation

website·Indexed 35 days ago

https://docs.supremainc.com

Comprehensive technical guides and API documentation for Suprema biometric access control solutions. Includes hardware manuals for BioEntry, BioStation, BioLite, and CoreStation series; platform documentation for BioStar Air and BioStar X; and developer resources for the BioStar X API and CLUe API.

Tokens
382.2K
Snippets
365
Records
2.7K
Agent score
62%

What's inside Suprema

  1. Overview of Extended Module-SC

    The Extended Module-SC provides additional RS-485 and RS-232C ports for compatible Suprema devices. It is compatible with BioStation 3 and BioStation 2a.

    Critical Requirement: The connection of the extended module is not supported by standard firmware; a separate custom firmware is required for operation.

  2. Overview of Secure I/O 2

    The Secure I/O 2 is a detachable controller designed for single external door relay control and I/O expansion. It enhances security by using encrypted communication with Suprema IP access control terminals and provides a solution optimized for various installation environments.
  3. Overview of Video Rules in BioStar X

    Video Rules combine events from cameras and access doors to send events and bookmarks to the VMS server. This enables:

    • Automatic Bookmark Generation: Automatically marks important footage when specific access events occur.
    • Efficient Monitoring: Real-time monitoring of cameras linked to doors.
    • Integrated Event Management: Linking access events with video for comprehensive security analysis.

    License Requirement: Video Rules require an Advanced license or higher with additional options.

  4. Overview of Suprema Device Manager

    Suprema Device Manager is a mobile application that uses BLE (Bluetooth Low Energy) communication to configure Suprema devices. It allows administrators to manage network, server, RS-485 communication, card formats, keypad settings, PINs, LEDs, and buzzers directly from a mobile device. It also supports device restarts, firmware upgrades, and setting resets. For XPass D2 devices, users can create configuration templates to apply settings to multiple devices quickly.
  5. Overview of the ViOnyx AI Camera API

    The ViOnyx AI Camera API (v1.0.0) provides a REST and WebRTC interface for managing live video, AI events, face authentication, and device configuration. The API uses JWT bearer authentication and exchanges data in JSON format, adhering to the OpenAPI 3.0.3 specification.
    Server URL: https://{{your-vionyx-ip}}/v1/api
  6. Overview of Advanced Access Control Settings

    BioStar X provides several advanced access control features to meet specific security and operational requirements:

    • Anti-Passback: Prevents unauthorized re-entry based on doors or devices.
    • Fire Alarm: Configures doors or elevators to open or lock during fire emergencies.
    • Scheduled Lock: Automatically locks doors at specific times.
    • Scheduled Unlock: Automatically opens doors at specific times.
    • Intrusion Alarm (Guard): Locks doors or triggers alarms upon detecting an intrusion.
    • Interlock: Enhances security by blocking access to one door if another door in the sequence is open.
    • Muster: Used for personnel accounting/evacuation monitoring.
  7. Overview of the Suprema Enclosure (ENCR-10)

    The Enclosure (ENCR-10) is a dedicated housing designed for the CoreStation. It provides a secure environment and includes the following integrated features:

    • Backup battery support
    • Tamper switch
    • 8-channel power distribution board
    • Power status LEDs
  8. Overview of CoreStation Setup Manager

    The CoreStation Setup Manager is a web server used to manage network settings and monitor the connection status of slave devices, input/output ports, and Wiegand ports. It allows technicians to verify network and wiring status on-site without needing to access the BioStar X server. Key capabilities include:

    • IP address configuration
    • Device information retrieval
    • Configuration backup and restoration
    • Administrator account management
    • Monitoring of slave devices, I/O, and Wiegand ports
    • Device initialization and factory resets.
  9. Overview of BioStation 3 Max

    The BioStation 3 Max is a flagship AI-based biometric terminal designed for identity-centric security in high-traffic areas like lobbies and secure access environments. It features a 7-inch touchscreen and supports multi-factor authentication and a wide range of credentials.
  10. Overview of BioStar X Mobile features

    The BioStar X Mobile app allows administrators to manage BioStar X access control systems from a mobile device. Key capabilities include:

    • User Management: Adding, deleting, and editing user information and credentials (PIN, Fingerprint, IR Face, Face, and Cards such as CSN, Wiegand, SCC, AoC).
    • Door Control: Remote locking, unlocking, opening, and releasing doors, as well as resetting Anti-Passback (APB) and door alarms.
    • Real-time Monitoring: Viewing live access event logs.
    • Alarm Management: Handling door, device, and advanced access control alarms with separate lists for new and acknowledged events.
    • Remote Notifications: Receiving alerts for door requests, forced opens, held-open doors, device tampering, reboots, RS485 disconnects, and zone alarms (e.g., fire or APB).
  11. Overview of Suprema Integration with Gallagher

    Suprema Integration with Gallagher is a middleware that enables communication between Gallagher Command Centre (version 8.8 or later) and Suprema Biometric devices. It allows administrators to register biometric face and fingerprint credentials for users directly from the Command Centre and manage connected device settings. Key features include:

    • Bulk user enrollment and management synced from Gallagher Command Centre to Suprema BioStar 2.
    • Biometric data registration (Face and Fingerprint) via Suprema devices.
    • Support for up to 1,000 biometric devices.
    • Integration of CSN and Wiegand detection for automatic data enrichment.
    • Support for various card types including TOC, QR, and custom configurations.
    • Tested compatible devices: X-Station 2, BioLite N2, BioStation 3, FaceStation F2, XPass 2, BioEntry W3, and BioEntry W2.