Skip to main content

Welcome to TWIST

Welcome to the official TWIST documentation portal. Whether you're an end-user looking to control your smart home, a manufacturer integrating TWIST into your products, or a developer building on the TWIST platform, you'll find comprehensive guides and resources here.

What is TWIST?​

TWIST is a comprehensive IoT platform designed for smart control of outdoor and indoor products. It consists of:

  • TWIST Devices: Hardware nodes that communicate via mesh network
  • Gateway: Wi-Fi/Ethernet or Cellular gateway connecting to cloud infrastructure
  • Mobile App & Web Portal: Control interfaces for end-users
  • Cloud Infrastructure: MQTT-based communication and REST API
  • Middleware: Backend services managing device communication and automation

TWIST enables seamless control and automation of products including pergolas, awnings, screens, shutters, lights, heaters, and more.

Who is This Documentation For?​

🏠 End-Users​

Installation owners and authorized users who want to:

  • Set up and manage TWIST installations
  • Add and control products
  • Create scenes and automations
  • Monitor and configure their smart home

Start here: End-User Guide →

🏭 Manufacturers​

Product manufacturers integrating TWIST technology who need to:

  • Understand TWIST hardware and integration options
  • Configure and provision TWIST-enabled products
  • Access manufacturing tools and resources
  • Understand product templates and device models

Start here: Manufacturer Guide →

👨‍💻 Developers​

Software developers building on the TWIST platform who need:

  • API documentation and specifications
  • Integration guides and SDKs
  • Technical architecture details
  • Development best practices

Start here: Developer Guide →

Platform Overview​

Architecture​

TWIST uses a distributed architecture:

┌─────────────┐
│  Mobile App │ ◄─────┐
└─────────────┘       │
                      │
┌─────────────┐       │    ┌──────────────┐
│ Web Portal  │ ◄─────┼───►│  Middleware  │
└─────────────┘       │    │  (REST API)  │
                      │    └──────────────┘
┌─────────────┐       │            │
│  Devices    │       │            │
│  (Mesh)     │ ◄─────┘            │
└─────────────┘                    │
      ▲                             │
      │                             │
      └─────────────────────────────┘
            Gateway (MQTT)

Key Components​

  • Mesh Network: Devices communicate directly with each other
  • Gateway: Bridges mesh network to cloud via MQTT
  • Middleware: Manages device states, automations, and user interactions
  • REST API & SignalR: Real-time communication between apps and middleware
  • Cloud Services: Weather data, authentication, firmware updates

Key Features​

🎮 Real-Time Control​

Control all your TWIST-enabled products from anywhere using the mobile app or web portal.

🤖 Intelligent Automation​

Create routines that trigger based on:

  • Time: Specific times or sunrise/sunset
  • Weather: Temperature, wind, rain, or weather conditions
  • Sensors: Thresholds and real-time sensor data
  • Buttons: Physical button presses

⚡ Scenes (Shortcuts)​

Save your favorite product configurations as scenes for instant one-tap activation.

🔗 Product Linking​

Connect products that interact with each other:

  • Remote controls operating shutters
  • Sensors automatically controlling awnings
  • Weather data triggering protective actions

🌤️ Weather Integration​

Virtual weather sensors provide real-time data from online services:

  • Temperature
  • Wind speed
  • Rain detection
  • Weather conditions

👥 Multi-User Access​

Share access to installations with family, guests, or service providers.

📱 Dual Interfaces​

  • Mobile App: Daily control, notifications, QR code scanning
  • Web Portal: Advanced configuration, larger views, detailed analytics

Supported Products​

TWIST supports a wide range of products:

Product TypeFunctions/Models
PergolaLouvres, Lights (RGB/Monochrome/TW), Screens (1-4), Heaters, Sensors, Buttons
AwningMotor, Lights (RGB/Monochrome/TW)
Roller ShutterMotor
ZIP ScreenMotor, Lights (RGB/Monochrome/TW)
Garage DoorMotor
GateMotor
Remote ControlButtons (4-16)
GatewayWeather Models (Temperature, Wind, Rain, Weather)
Sensor PlatformTemperature, Rain, Wind, Weather

Quick Start by Role​

End-Users​

  1. Create an account
  2. Set up an installation
  3. Add products
  4. Start controlling

Manufacturers​

  1. Understand TWIST integration
  2. Configure product templates
  3. Provision devices
  4. Access manufacturing tools

Developers​

  1. Review API documentation
  2. Set up development environment
  3. Explore integration options
  4. Build and test

Platform Versions​

Current Version: v01.00​

Features:

  • ✅ Account management (create, sign in, password recovery)
  • ✅ Installation management (create, join, switch)
  • ✅ Product support (all major product types)
  • ✅ Offline pre-provisioning (QR code scanning)
  • ✅ Online discovery and configuration
  • ✅ Product control (Dashboard, Products, Settings)
  • ✅ Product linking (remote controls, sensors, weather)
  • ✅ Scenes (shortcuts)
  • ✅ Routines (time, weather, sensor-based automations)
  • ✅ Weather data (virtual sensors)
  • ✅ Push notifications

Coming in Future Versions:

  • 🔄 Owner approval for access requests
  • 🔄 Multiple access levels (read-only, control, admin)
  • 🔄 Advanced analytics and activity logs
  • 🔄 Shared QR codes for installation access
  • 🔄 Enhanced routine filters and conditions
  • 🔄 Cellular gateway support

Documentation Structure​

End-User Guide​

Complete guide for installation owners and users covering setup, control, scenes, routines, and troubleshooting.

Manufacturer Guide​

Resources for product manufacturers integrating TWIST technology into their products.

Developer Guide​

Technical documentation for developers building on the TWIST platform, including API specifications and integration guides.

Need Help?​

Documentation Resources​

Support Channels​

  • In-App Help: Settings → Help → Contact Support
  • Technical Support: Contact TWIST support team
  • Community Forum: Connect with other users (if available)

API & Technical Resources​

  • API Documentation: Swagger documentation for REST API
  • Developer Portal: Access to SDKs and development tools
  • Technical Specifications: Detailed architecture and protocol documentation

Contributing to Documentation​

Found an error or want to improve the documentation? Contributions are welcome!

  • Report issues or suggest improvements
  • Submit documentation updates
  • Share use cases and examples

Let's Get Started!​

Choose your path:

Welcome to the TWIST ecosystem! 🎉