# TL DeviceSDK

TL DeviceSDK is a toolkit that allows different pieces of Thorlabs equipment to communicate with your computer.

Canonical page: https://ourlocalhost.com/app/6520/tl-devicesdk

## Description

TL DeviceSDK is a toolkit that allows different pieces of Thorlabs equipment to communicate with your computer. It acts as a bridge, enabling you to build custom software to control and coordinate your laboratory devices through a single, unified interface.

## Platform availability

Available on 0 of 10 platforms.

## Health score

53/100 (Fair), based on 3 of 4 factors.
- Maintained: 91 (last commit 97 days ago)
- Popular: 16 (5 GitHub stars)
- Easy to install: 25 (0 install platforms, install notes, Docker image)

## Links

- Official website: https://www.thorlabs.com/software-pages/SC30
- GitHub: https://github.com/device-sdk/devicesdk

## Common questions

### How do I start the DeviceSDK server locally?

Use Docker Compose to run one container that exposes port 8080 for the API, WebSockets, and dashboard. The first registered account becomes the admin.

### Where does DeviceSDK store its data, and what should I back up?

All persistent state lives in the data directory, default /data, including the SQLite database, device scripts, and firmware images. In Docker Compose, mount a host directory such as ./data to /data.

### How do I stop new users from registering after setup?

Set the ALLOW_REGISTRATION environment variable to false. This closes sign-ups once your account already exists.

### What environment variable must I set for an HTTPS reverse proxy?

Set SECURE_COOKIES to true when the server is served behind an HTTPS reverse proxy.

### How can I run several DeviceSDK servers on the same LAN?

Give each server a different MDNS_HOSTNAME. Set MDNS_ENABLED to false if you do not want mDNS advertisement.

### Do updates force breaking changes?

Releases are intended to be infrequent, and you can skip an update if you do not need it. Opt-in compatibility flags are used when behavior must evolve so you can migrate on your own schedule.

---
Source: Our Local Host (https://ourlocalhost.com/app/6520/tl-devicesdk), the self-hosted and open-source app directory.
