quickstart

Getting Started

From unboxing a Twinise node to live values in the portal, Unreal and your AI assistant.

Getting Started

This guide takes a new deployment from the box to live data. Each step is marked Live (use it from your own account) or Pilot (works, delivered to you by arrangement). Steps you cannot do yet are listed at the end.

1. What is in the box (Pilot)

  • Your sensor nodes, each with a QR label. Tell us whether your batch is an engineering sample with an enclosure or a bare board.
  • A USB-C cable and supply for each node, if your proposal includes them. Nodes run from USB-C 5 V.
  • Mounting material and a quick-start guide.

There is no hardware gateway. Nodes publish straight to the cloud over Wi-Fi, so you need a 2.4 GHz Wi-Fi network with WPA2 and outbound access on ports 8883 (TLS) and 443.

2. Create your organisation (Live)

Sign up at https://twinise.spark-tech.io/app. Signing up creates your organisation. Then create a Site, and Zones inside it.

The portal Sites page for one site, with its zones and a card for each device showing its latest readings

3. Install the Twinise phone app (Pilot)

The phone app is an Android build we send you; allow installs from that source. There is no iOS app yet. Sign in by scanning the QR code shown in the portal under Devices > Add device. The code lasts two minutes and works once, and the phone never asks for a password.

The Twinise phone app sign-in screen with Scan QR code and Sign in with email

4. Set up a node (Pilot)

  1. Plug the node in over USB-C. It advertises itself over Bluetooth as Twinise-<serial>.
  2. In the app, scan the node's QR label. A node that is already registered is refused.
  3. Pick a saved 2.4 GHz network or enter a new one, including its password.
  4. Wait for the device to show Online in the portal, normally within a minute of the scan.
The phone app scanning a node's QR label, with the prompt Point me at the device labelThe phone app Wi-Fi step, Pick a 2.4 GHz network, with the network name hiddenThe phone app confirming that the device is live

If a node was set up before, hold the BOOT button for 5 seconds to reopen provisioning, or choose Set it up again in the device list. If setup is interrupted, the device is kept as a draft you can resume.

5. See it in the portal (Live)

Open the device page.

A device selected on the portal Sites page, with its live readings in the side panel
  • Readings are shown live. History keeps one stored reading per device per minute.
  • Control sends commands: identify, light, outputs, settings and restart, as far as the board supports each.
  • Calibrate records the rest state; alarm rules can then follow it.
  • Build a dashboard, set alarm rules, and watch the alert bell.
A portal dashboard with temperature charts, an alerts list, an Identify button and device readings
  • Settings > Usage shows this month's stored data points against your plan and the date it resets.

The phone app lists your devices and opens a per-device menu with Identify, Calibrate and Settings (the options shown depend on the board). It does not show live readings; use the portal for those.

The phone app device list, showing 9 of 9 devices with the time each was last seenThe phone app control screen for a presence device, with Identify and Light offThe phone app device menu with Calibrate selected

See What the Platform Does Today.

6. Link your Unreal project (Pilot)

  1. Get the plugin from us. It needs a C++ project on Unreal Engine 5.5 or 5.8.
  2. Sign in from the plugin panel with your Twinise email and password.
  3. In the portal choose Find twin, then Link code, and redeem the code in the plugin panel. Your devices appear.
  4. Place a BP_TwiniseDevice actor, or add a Twinise Device Tag with a known device ID to an actor, and show one metric.

Dashboards, alerts and commands sync between the portal and the plugin. Details: Unreal Engine Integration.

7. Link your Revit model (Pilot, pre-release)

Run the installer we send you. It is not code-signed yet, so Windows warns that the publisher could not be verified, and Revit asks you to choose Always Load. Open the Twinise tab and use Link, then place devices into the model. Revit 2025 and 2026.

8. Connect your AI assistant (Live)

Create an API key under Settings > API keys, or add the Twinise connector by URL in your assistant and approve its access on the consent page. Revoke access any time under Connected apps.

9. Firmware updates

Twinise updates firmware by USB. Over-the-air updates are not available.

Not available yet

One-scan kit provisioning, a hardware gateway, an iOS app, over-the-air updates, push notifications and the simulation sandbox.

Before production

  • Naming convention for device IDs finalized
  • Required metrics documented per zone
  • Alarm rules defined, including rules that follow the rest state
  • Fallback behaviour for missing data implemented

Next