# Crestron driver & integration for notification API

**URL:** <https://developer.ekey.net/t/crestron-driver-integration-for-notification-api/75>\
**Category:** Crestron\
**Created:** [November 3, 2026, 2:45pm UTC](https://developer.ekey.net/t/crestron-driver-integration-for-notification-api/75 "2026-11-03T14:45:59Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![christoph.deimel](https://dub1.discourse-cdn.com/flex017/user_avatar/developer.ekey.net/christoph.deimel/32/123_2.png) [@christoph.deimel](https://developer.ekey.net/u/christoph.deimel)\
**Post date:** [November 3, 2026, 2:45pm UTC](https://developer.ekey.net/t/crestron-driver-integration-for-notification-api/75/1 "2026-11-03T14:45:59Z")

</div>

This post explains how ekey bionyx fingerprint scanners are integrated into Crestron. It covers the drivers, the licensing, the setup steps and the events available for programming. A recording of the integration webinar is available here: [LINK: Webinar video]

# What does this integration do?

The integration is based on the ekey bionyx Notification API. With every scan, the ekey bionyx system sends an HTTPS notification directly to the Crestron controller in the local network. No cloud connection and no additional gateway hardware are required.

- ekey identifies the user and makes the access decision. The access security stays completely in the ekey system.
- Crestron receives the event, including the user and the finger that was used.
- Based on rules, Crestron triggers house functions (e.g. Alarm Off, Welcome Scene) and door functions (e.g. Lights, Climate, Curtains).

# Crestron drivers

The integration is available for both Crestron platforms. Each platform uses two driver types: one central driver per project and one driver per additional door.

| Platform | Central driver (1 per project) | Door driver (1 per additional scanner) |
| --- | --- | --- |
| Crestron Home | bionyx gateway | bionyx addon |
| Crestron 4-Series (SIMPL Windows) | BionyxEngine | BionyxScanner |

**Central driver (bionyx gateway / BionyxEngine)** – receives the notifications from the ekey bionyx system, holds the license and the user list, manages the rules and triggers the house functions. It also counts failed scans.

**Door driver (bionyx addon / BionyxScanner)** – represents one fingerprint scanner (one door). It is identified by the scanner’s serial number and triggers the door functions and scan events for this door.

**Licensing** – a license is required per Crestron controller. The 16-character license code is bound to the MAC address of the controller. Licenses are available in the ekey online shop: [LINK: License shop]. Without a license, the driver runs for 2 hours after each program load or compilation, for development and testing purposes.

**Requirements** – ekey bionyx with firmware v5.2 or higher, Crestron Home or Crestron 4-Series controller, ekey and Crestron in the same local network.

# How does it work technically?

1. **Activate the Notification API in the ekey bionyx app**
  - Open User settings → Smart home connections and switch on the Notification API.
  - Open Configuration and enter the Notification Webhook: https:///cws/ekeyX (example: [https://192.168.76.33/cws/ekeyX](https://192.168.76.33/cws/ekeyX)). Keep all other routings as displayed.
  - Set Level of security to **TlsAllowSelfSigned**.
  - Set the Access token to a secret value. The same value is entered as Token ID in the Crestron driver.

2. **Add the drivers**
  - Crestron Home: In Crestron Home Setup, open Pair Devices, search for “ekey bionyx” and add the bionyx gateway to a room. Add one bionyx addon for each additional door.
  - Crestron 4-Series: Add one BionyxEngine module and one BionyxScanner module per door to the SIMPL Windows program. Use the same EngineId in all modules. A demo touch panel app with Smart Objects is included.

3. **Configure the drivers (installer settings)**
  - Token ID (same as the access token in the ekey bionyx app) and the 16-character license.
  - Door name and 16-digit serial number of each scanner.
  - Names of the house functions and door functions, e.g. “Alarm Off, Silent Alarm On, Welcome Scene, Cleaning Scene” or “Welcome, Lights, Climate, Curtains”.
  - Max Scan Fail Number: number of consecutive failed scans that triggers the multiple-fail event (default: 5).

4. **Program the actions**
  - Crestron Home: In Actions & Events, link each event to the desired actions and scenes.
  - Crestron 4-Series: Connect the digital and analog outputs of the modules to your logic.

5. **Define the rules (installer or end user)**
  - Users are added automatically with their first successful scan. Afterwards, their name can be corrected.
  - For each house or door function, select which users (or all users) and which fingers trigger it.
  - In Crestron Home, the rules are managed directly in the Crestron Home app. The end user can add users and change rules without any reprogramming.

# Events

| Event | Description | Crestron Home | Crestron 4-Series (SIMPL) |
| --- | --- | --- | --- |
| Scan OK | Successful scan on a door | ScanOK | ScanOK\_os |
| Scan failed | Finger was not recognized | ScanFail | ScanFail\_os |
| Multiple failed scans | Consecutive failed scans reached the defined limit | ScanFailMulti | ScanFailMulti\_os |
| House function | Function for the whole house, triggered by a matching rule | HouseF01, HouseF02 … | Scene\_os, Scene001–100\_os (BionyxEngine) |
| Door function | Function for one door, triggered by a matching rule | DoorF01, DoorF02 … | Scene\_os, Scene001–100\_os (BionyxScanner) |
| Scanner status | Scanner is online or offline | Is Online, Is Offline | – |
| Last scan details | User name, user ID and finger of the last successful scan | – | LastUserName, LastUserId, LastFingerIx |

# Rules: users and fingers

Instead of fixed user groups, the integration works with rules. Each rule defines which user – or all users – and which fingers trigger a function. This allows very individual automation, for example:

- Any finger of any user opens the front door and switches off the alarm.
- The right index finger of a specific user starts that user’s personal welcome scene.
- The cleaning staff’s finger opens the side entry and starts the cleaning scene.

# Silent alarm (duress finger)

A dedicated finger can be defined as a duress finger. Create a house function such as “Silent Alarm On” and assign it only to this finger. If a user is forced to open the door, they use this finger: the door opens as usual, and Crestron triggers a silent alarm in the background.

# Resources & documentation

- ekey bionyx Notification API: [[Notification API]](https://developer.ekey.net/c/notification-api/10)
- Crestron driver documentation (BionyxEngine, BionyxScanner): [LINK: [BionyxEngine.pdf](https://ekey.net/wp-content/dokumente/BionyxEngine.pdf); [BionyxScanner.pdf](https://ekey.net/wp-content/dokumente/BionyxScanner.pdf)]
- Crestron 4-Series modules and demo app: [[LINK: SIMPL module download]](https://www.ekey.net/wp-content/dokumente/ekeyBionyxDemo_V1.2.zip)
- Integration webinar: [LINK: [Webinar Video](https://youtu.be/aRNiGJDpmaI)]