Tedee Smart Lock Integration

Getting started

This Library lets you control any tedee lock from Loxone. We assume that you have already installed the Tedee Lock at your door and have used the tedee iOS or Android App to install both the Tedee Lock and Bridge. Here are some key points to get you started with the integration:

- Initial Setup: To get started, you'll need a Tedee Bridge connected to your local network. Importantly, the bridge must have internet access to obtain and periodically refresh an access certificate for paired devices. - Local Network: The API functions over your local network, allowing your integrations to communicate directly with the Tedee Bridge without requiring external internet access for the API calls. - Device Pairing: Make sure you have at least one Tedee Lock paired with the bridge to control it via the API.

Enabling Bridge API

Before you can use the API you must enable it on the Bridge using Tedee mobile application. Open the Tedee-App and select the Bridge which is connected to the Lock you would like to integrate -> Go to Settings -> Select API -> then toggle the switch button in order to turn on the API.

As we cannot handle the token encryption in Loxone we need to switch "Encrypted token" off. Please make sure the local network is secured!

From the API view we need the following two values:

- Token: This is the actual token that must be included in every API request for authentication, functioning similarly to a password, so keep it secure. - IP Address: Indicates the local network address of the Tedee Bridge where the API will be accessible.

The third value we need can be found in the Lock information. Select the Tedee-Lock which you would like to integrate (need to be paired with the Bridge from the prior step) -> Settings -> Information -> Device ID

- Device-ID: This is the ID of the lock we like to control.

Loxone Config

After the we enabled the Bridge-API we need to configure the Loxone Miniserver. Please follow the steps below:

1. Open the Loxone Config Software and connect to your Loxone Miniserver 2. Download the "Tedee Smart Lock Integration" template from the Loxone Library 3. Add the template to your Virtual Outputs 4. Add the template to your project after downloading and importing it 5. Replace the IP Address we obtained when activating the Bridge API with the <BRIDGEIPADDRESS> in the "Tedee Controls VO" Address Field 6. Replace the Device-ID we obtained from the lock with the <LOCKDEVICEID> for all three commands (lock, unlock & unlockAndPull) in the Command On Field as well as the Token from the Bridge API with the <APITOKEN>

The unlock command will only unlock the lock and will not pull the spring even if you have configured the lock to pull the spring with unlocking. The unlockAndPull command will always pull the spring regardless of the current state of the lock.

Now you can connect the Virtual Output Commands for example to your NFC Code Touch Air:

Lock States

We will use Webhooks to obtain the locks state. Webhooks allow information from the Tedee Bridge to arrive in the Loxone system instantly.

1. Create a Virtual Text Input in your project in Loxone Config 2. Give the Virtual Text Input a unique name - we will need this name later 3. Create a new user in your loxone project (is needed for the tedee bridge to trigger the Virtual Text Input) - and remember the username 4. Give the user you have just created a secure password and remember it - we will need it later 5. Grant the user you have just created "Web Interface/Apps" rights 6. Authorise the user you have just created for the Virtual Text Input you have just created 7. Remember to Save your project to the Miniserver otherwise the Bridge cannot send anything to Loxone 8. Generate a Basic Auth header from the username and password of the user you have created in your loxone project - you can for example use this website for it 9. Enter the IP-Address of your Tedee-Bridge in the browser (your computer must be in the same local network as the bridge) 10. Authorise yourself on the site with the API-Token from the tedee Bridge API 11. Prepare putting the webhook on the Tedee Bridge by clicking on PUT /callback and "Try it out" 12. Obtain the IP-Address of the Miniserver - it will be needed in the next step 13. Replace <IP_MINISERVER> with the IP-Address of your Miniserver, <VIRTUAL_INPUT_NAME> with the name of your Virtual Text Input and <BASIC_AUTHORIZATION> with the Basic Authorization Header we created earlier in the text below, put it in the request body and click "Execute"

[ { "id": 1, "url": "http://<IP_MINISERVER>/dev/sps/io/<VIRTUAL_INPUT_NAME>", "method": "GET+NO_PARAMS", "headers": [ { "Authorization": "<BASIC_AUTHORIZATION>" } ] } ]

If you manage multiple locks with one bridge you might need to enter "id": 1 for the first and "id": 2 for the second lock if you like to integrate both locks in Loxone.

You can read the lock´s state (open, closed, etc.) and battery level using a Command Recognition Block. You can simply copy both blocks from the tedee smart lock.Loxone file here, paste them into your project and connect them both with the virtual text input you have created.

If you rather create your own Command Recognition Blocks you can read out the locks state and battery level with the following text in the Block:

Lock-State:

\istate=\i\v

Battery Level:

\ibatteryLevel=\i\v

The different lock states are documented here: https://docs.tedee.com/bridge-api#tag/Webhook-events/Lock-status-changed