POPULAR · switch

Switch

A compact on/off endpoint.

1 capabilitiesREST + secure WebSocketProduction schema

OVERVIEW

Built from capabilities, not assumptions.

Switch is a canonical HomeAutoPro popular template. The same production capability schema drives validation, controls, reported state, telemetry, scenes and automations. Undeclared keys are rejected.

WRITABLE CAPABILITIES

Controls

ControlTypeRange / valuesDescription

PowerpowerbooleanON / OFFWritable through validated owner commands and automations.

DEVICE → HOMEAUTOPRO

Feedback / state

Every connected device also reports online state and last-seen time. Applied values remain distinct from requested values until the device acknowledges them.

Powerpower

boolean. Report the value actually applied after each command.

TIME-SERIES VALUES

Telemetry

This template declares no telemetry-only values. Report readable applied values as state.

CAPABILITY-AWARE WORKFLOWS

Automations

Triggers

State/telemetry changes for power, plus online and offline events.

Actions

Validated commands for power. Applied state is reported as ACK.

ACTUAL PRODUCTION PROTOCOL

Payloads and acknowledgement

Dashboard/API→HomeAutoPro→Device→Applied-state ACK

Authenticate

{"type":"auth","device_secret":"YOUR_DEVICE_SECRET"}

Command

{
  "event": "command",
  "state": {
    "power": true
  }
}

State ACK

{
  "state": {
    "power": true
  },
  "type": "state"
}

CAPABILITY-GENERATED EXAMPLES

Sample code

Choose one platform. All examples use the production protocol and placeholders; no stored secret is retrieved.

#include <ESP8266WiFi.h>
#include <ArduinoJson.h>
#include <WebSocketsClient.h>

const char* DEVICE_CODE = "YOUR_DEVICE_ID";
const char* DEVICE_SECRET = "YOUR_DEVICE_SECRET";
WebSocketsClient socket;

// Handle only: power
// Connect: socket.beginSSL("api.homeautopro.in", 443, path);
// First message: {"type":"auth","device_secret":DEVICE_SECRET}
// After a command, publish {"type":"state","state":applied}.

#include <WiFi.h>
#include <ArduinoJson.h>
#include <WebSocketsClient.h>

const char* DEVICE_CODE = "YOUR_DEVICE_ID";
const char* DEVICE_SECRET = "YOUR_DEVICE_SECRET";
// Use TLS port 443 and the same authenticated command/state ACK lifecycle.
// Generate handlers only for: power

import requests

url = "https://homeautopro.in/api/device-ingest/DEVICE_CODE/state"
headers = {"X-Device-Secret": "YOUR_DEVICE_SECRET"}
payload = {"state": {"power": true}}
response = requests.post(url, headers=headers, json=payload, timeout=10)
response.raise_for_status()

const response = await fetch(
  "https://homeautopro.in/api/device-ingest/DEVICE_CODE/state",
  { method: "POST", headers: { "X-Device-Secret": "YOUR_DEVICE_SECRET", "Content-Type": "application/json" },
    body: JSON.stringify({"state": {"power": true}}) }
);
if (!response.ok) throw new Error(`HomeAutoPro ${response.status}`);

curl --fail-with-body -X POST \
  -H "X-Device-Secret: YOUR_DEVICE_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"state": {"power": true}}' \
  https://homeautopro.in/api/device-ingest/DEVICE_CODE/state

SAFE DIAGNOSTICS

Troubleshooting

401 authentication

Use the current Device Secret locally. Rotate it in Device Details if it was lost.

422 validation

Compare every key, type and range with the capability schema above.

No command ACK

Publish the value actually applied after handling event=command.