What Is the TS Smart Home SDK?

The SDK is a pre-built C++ firmware library for the ESP32 microcontroller. It handles all the complex cloud connectivity, authentication, and real-time communication that a smart home device requires. Instead of building this infrastructure from scratch, you write a small amount of device-specific code and the SDK handles the rest.

When you flash an ESP32 with SDK-based firmware, your device automatically gains:

• Wi-Fi provisioning via the TS Smart Home mobile app.
• Cloud registration and device identity management.
• Real-time relay control through the app and API.
• Automatic OTA firmware updates pushed from the platform.
• Schedule execution — schedules set in the app run on the device itself.
• Status reporting — online/offline state, relay status, error conditions.

Who Is the SDK For?

The SDK is designed for a wide range of builders:

• Hardware startups building consumer smart home products who need a cloud and app without the months of backend development.
• Electronics hobbyists who want their DIY ESP32 projects to work with a polished mobile app.
• System integrators adding smart control to industrial or commercial equipment.
• Educators and researchers studying IoT connectivity and home automation.

Getting Your Developer Token

To use the SDK, register as a developer on the TS Smart Home platform and obtain a Developer SDK Token. This token is embedded in your firmware and identifies which developer account your devices belong to.

1. Download and install the TS Smart Home app.
2. Navigate to Account > Developer Portal.
3. Fill in the developer registration form with your project details.
4. Upon approval, your SDK token appears in the Developer Portal section of the app.

Treat your SDK token like a private API key. Do not commit it to public repositories — it authenticates all devices you produce, so compromising it would affect every deployed unit.

SDK Architecture and Basic Usage

The SDK follows a straightforward initialization pattern:

#include "TSSmartHome.h"
TSSmartHome device("YOUR_SDK_TOKEN", "DEVICE_MODEL_ID");

void setup() {
  device.begin();
  device.onRelayCommand([](bool state) {
    digitalWrite(RELAY_PIN, state ? HIGH : LOW);
  });
}

void loop() {
  device.loop();
}

The SDK manages Wi-Fi connection recovery, MQTT/WebSocket communication with the cloud, command parsing, OTA update handling, and heartbeat reporting — all automatically.

Key SDK Features

Relay Control Callbacks

Register callback functions that fire when the app or a schedule sends a Turn On or Turn Off command. Your callback receives a boolean and you decide how to control your hardware output.

OTA Firmware Updates

The SDK monitors a firmware update endpoint. When you publish a new firmware version for your device model, it is automatically downloaded and applied to every deployed unit in the field — no user action required.

Custom Device Metadata

Attach a device model ID and firmware version to your device registration. This allows the platform to manage OTA updates correctly — different device models receive different firmware builds.

What You Can Build

The SDK supports any device category that relies on relay control or state reporting:

• Smart plugs and power strips
• Smart light switches (single, double, triple gang)
• Smart irrigation controllers
• Relay-based appliance controllers
• Industrial equipment on/off control