Yale Smart Lock Integration

Included functionalities

Integrating the Yale Smart Lock into your Loxone system provides a range of features that make managing your keyless access more efficient and convenient. These functionalities offer both automation and real-time control, ensuring a secure and connected environment. Key features include:

- Lock/Unlock command: With a simple tap in the Loxone app or an automated scene, you can lock or unlock your door remotely, no matter where you are. This feature uses the Yale API to ensure seamless communication between the lock and your smart home system. Whether you're welcoming a guest or securing your home while away: this function gives you the opportunity to exercise full control and enjoy peace of mind.

- Monitor the status of your door: The Loxone app allows you to check the current status of your Smart Lock at any time. Simply open your app to check if your door is locked or unlocked. This real-time feedback provides peace of mind, especially when you are away from home.

- Auto Unlock/ Auto Lock command: Integrating with Loxone’s presence detection, the Yale Smart Lock can automatically lock or unlock your door based on your proximity to the house. As you approach, the door unlocks for you, and when you leave, it locks behind you—no interaction needed.

- Notifications: Get immediate alerts whenever someone locks or unlocks the door. Whether it’s your kids coming home from school or a guest arriving, you’ll receive real-time push notifications that keep you in the loop.

- Battery monitoring: Loxone integration allows you to monitor the battery status of your Yale Smart Lock in real time. When the battery is running low, you’ll receive an alert so you have enough time to replace them.

Integration with Loxone

Requirements:

- Yale Linus Smart Lock - Seam Account - Loxone Miniserver (with Loxone Config 12.x or later)

Communication method

Seam Web API

Installation Guide To integrate your Yale Smart Lock with the Loxone Miniserver via the Seam Web API, follow these simple steps:

Step 1: Set up the Yale Smart Lock and Seam Web

- Install the Lock: Physically install your Yale Smart Lock following the manufacturer's instructions. - Configure via Yale Access App: Open the app, sign in or create an account, and follow the prompts to add and configure your lock. - Enable Remote Access: If required, set up the Yale Connect Wi-Fi Bridge to allow remote control of your lock.

Step 2: Create a Seam Account and Link Your Yale Lock

- Sign Up: Go to Seam Console and create an account. - Create a Workspace and Uncheck the Sandbox mode. - Link Yale Account: In the Seam Console, initiate the Connect Webview flow to link your Yale account. - Generate API Key: Navigate to developer section then the API Keys section in the Seam Console and generate a new API key and copy it before saving Because it disappears after saving. - Retrieve Device ID: Once your Yale account is linked, locate your lock in the Devices section to find its device_id.

Step 3: Configure Loxone Miniserver

1. Access Loxone Config: Open Loxone Config software on your computer and connect your Loxone Miniserver. 2. Download the template from the Loxone Library 3. Add the template to the Virtual Outputs 4. Add the template to your project after downloading and importing. 5. Prepare Loxone for integration

- Adjust the properties (Virtual Outputs) - Adress: https://connect.getseam.com - Adjust the properties (Virtual Output Command)

Replace Placeholders: <YourAPIToken> with the Seam API Key which was created in the seam interface before. <Your Device Id> with the your Yale id which was extracted from the seam interface before.

Important: Be careful when editing the template. Removing or misplacing hidden characters may cause malfunction. Only keep curly brackets ({}) in the HTTP body for the "ON" commands.

Step 4: Configure Functions in Loxone

1. Basic functions 2. The template includes three essential functions: Lock, Unlock and Getdata 3. Each action sends an HTTP request to the Seam Web API, allowing you to control your Yale Smart Lock remotely.

Step 5: Configure Virtual HTTP Input

To be able to monitor the Status of the Smart Lock, you need a user on the miniserver. A separate user should be created for security reasons. This user only needs the permission for Web Interface/Apps.

1. Create a user with the permission for Web Interface/Apps 2. Download the Virtual Input Template (Yale States) from the Download section 3. Add the template to the Virtual Inputs 4. Adjust the properties (Virtual Inputs)

Replace Placeholders:

- <username> with the name of the user you have created - <userpassword> with the password of the user - <ip-address> with the ip-address of the Miniserver

Basic States functions

- The template includes three essential functions: Battery level, Connection, and Lock States - Battery: returns the state of charge of the battery in % - Connection: returns the status of the smart lock, whether it is online or offline. - Lock States: returns the status of the smart lock - 0 = unlock - 1 = locked

Step 6: Test the integration

1. Test functions 2. After importing the template and configuring the settings, test the Lock, Unlock commands from the Loxone app to ensure proper functionality. 3. Ensure the lock status is reflected correctly in the Loxone system for accurate monitoring.