Skip to main content

Add Products

Once you have an installation, you can start adding products. Products contain one or more devices, and each device supports one or more models (functions like lights, motors, buttons, sensors).

Before You Begin
  • Ensure you have selected the correct active installation
  • Have your devices ready (check if they need to be powered on, depending on the mode)
  • For online mode, ensure your gateway is connected to the internet

Understanding Devices, Products, and Models​

Before adding products, it's helpful to understand these terms:

  • Device: The physical hardware unit sold by LEDsGO for integration
  • Model: A function provided by a device (e.g., button, light, motor, sensor)
  • Product: The complete unit sold by the manufacturer, containing one or more devices

For example:

  • A simple product like a remote control contains one device with button models
  • A complex product like a pergola contains multiple devices with motors, lights, sensors, and buttons

Adding Modes: Online vs. Offline​

TWIST supports two modes for adding products:

Offline Mode (Pre-Provisioning)​

Use this mode when:

  • Devices are not yet powered
  • Devices are not within range of a connected gateway
  • You want to pre-configure products before installation
  • You're adding a gateway to the installation

How it works:

  • You scan QR codes on devices one by one
  • Configuration is saved but not sent to devices yet
  • When devices come online, the configuration is automatically applied

Online Mode (Discovery)​

Use this mode when:

  • A gateway is connected and online
  • Devices are powered and within range of the gateway
  • You want immediate configuration and testing

How it works:

  • The gateway discovers nearby devices
  • Configuration is sent to devices immediately
  • You can use "identify" functions to verify device mapping

Step-by-Step: Adding Products​

Offline Mode (Pre-Provisioning)​

  1. Ensure the correct installation is active

    • Check the installation switcher to confirm you're in the right installation

  2. Navigate to Add Product

    • Tap Products → Add Product
    • Or tap + Add from the Dashboard

  3. Choose Offline Mode

    • Select Scan QR Code or Offline Mode

  4. Scan Device QR Codes

    • Point your camera at the QR code on each device
    • Scan all devices that belong to the product (e.g., gateway, control units, sensors)
    • The app records each device without requiring power or network

  5. Review Detected Products

    • After scanning all devices, tap Done or Next
    • The middleware suggests possible products based on the scanned devices

  6. Configure Products

    • Some products can be added automatically (e.g., gateway, simple remote)
    • Others require configuration (e.g., pergola, awning)
    • For products requiring configuration, follow the prompts to map models to the product template

  7. Configuration Applied Later

    • The configuration is saved but not sent to devices yet
    • When devices come online, the configuration is automatically programmed

Online Mode (Discovery)​

  1. Ensure Prerequisites

    • The gateway must be powered and connected to the internet
    • Devices must be powered and within range of the gateway

  2. Navigate to Add Product

    • Tap Products → Add Product
    • Or tap + Add from the Dashboard

  3. Choose Online Mode

    • Select Discover Devices or Online Mode

  4. Start Discovery

    • Tap Start Discovery
    • The gateway searches for nearby devices

  5. Monitor Discovery

    • The app displays devices as they're found
    • You can stop discovery manually or wait for the timeout

  6. Review Suggested Products

    • The middleware provides a list of possible products based on discovered devices
    • Some products can be added immediately
    • Others require configuration

  7. Configure Products (if needed)

    • For products requiring configuration, you'll map models to the product template
    • Use the Identify function to verify which model is which:
      • Output models (e.g., lights, motors): The device will blink, move, or activate
      • Input models (e.g., buttons, sensors): The app shows real-time data when you press/trigger them

  8. Configuration Applied Immediately

    • The configuration is sent to devices right away
    • Products are ready for use

After Adding a Product​

Regardless of mode, after adding a product:

  1. Complete Prerequisites (if required)

    • Some products require setup steps (e.g., connecting gateway to Wi-Fi, calibrating motors)
    • Follow the guided flows (see Product Prerequisites)

  2. Set Mandatory Parameters (if required)

    • Enter any required settings (e.g., text fields, dropdowns, toggles)
    • You cannot skip this step (see Mandatory Parameters)

  3. Link Products (optional)

    • The app checks if this product can interact with other products in the installation
    • If linking is possible, you'll be prompted to configure it
    • You can skip and link products later (see Linking Products)

Product Configuration Details​

Some products need configuration during the add process. This typically involves:

Mapping Models to the Product Template​

For products with multiple devices/models (e.g., pergola with motors and lights):

  • The middleware provides a product template
  • You assign each discovered model to a slot in the template
  • Use the Identify function to verify mappings

Identify Function​

  • Output Models (lights, motors, heaters):

    • The app sends an identify command
    • The device performs a visible action (blink, move, etc.)
    • Only available in Online Mode

  • Input Models (buttons, sensors):

    • The middleware monitors for input
    • The app displays which model is active when you press/trigger it
    • Only available in Online Mode

Expected Result​

After successfully adding a product:

  • The product appears in your Products list
  • The product is visible and controllable on the Dashboard (if it has output models)
  • You can open the product to view and control its models

Troubleshooting​

Discovery Fails or No Devices Found​

  • Verify gateway connectivity: Ensure the gateway is online (check Dashboard)
  • Check device power: Ensure devices are powered on
  • Check range: Devices must be within range of the gateway
  • Pairing mode: Some devices may need to be in pairing mode (refer to manufacturer instructions)
  • Retry discovery: Stop and restart the discovery process

Devices Found but Configuration Fails​

  • Check internet connection: The app needs to communicate with the middleware
  • Review device compatibility: Ensure devices are compatible with the TWIST system
  • Restart devices: Power cycle devices and try again

Offline Mode: Configuration Not Applied​

  • Wait for devices to come online: Configuration is applied automatically when devices connect
  • Check gateway connectivity: Ensure the gateway is online and can reach the devices
  • Review device status: Check in Settings → Products → Select Product → Devices

Product Not Showing on Dashboard​

  • Check for output models: Products with only input models or "non-visible" models don't appear on the Dashboard
  • View in Products screen: All products appear in the Products list, even if not on the Dashboard

Next Steps​

After adding a product:

  1. Product Prerequisites – Complete required setup steps
  2. Mandatory Parameters – Set required configuration
  3. Linking Products – Connect products that interact with each other
  4. Control Products – Start controlling your products