Join an Existing Installation

You can request access to an existing installation owned by someone else. This allows you to control products, view data, and interact with the system, depending on the permissions granted.

Installation Ownership

• Each installation has one owner
• Multiple users can have access to an installation
• In v01.00, access is automatically approved. Future versions will require owner approval.

Methods to Join an Installation

There are two ways to add an existing installation to your account:

Method 1: Scan a Device QR Code

This method is supported in v01.00.

Mobile App

You can scan the QR code on any device (typically the gateway) that belongs to an existing installation.

Steps:

1. Navigate to Installations

   • Go to Settings → Installations → Join Installation
   • Or tap Add Installation → Join Existing

2. Scan the QR Code

   • Tap Scan QR Code
   • Point your camera at the QR code on the device (usually found on the gateway)
   • The app will recognize the device

3. Request Access

   • You'll see a prompt asking if you want to request access to this installation
   • Tap Request Access or Join
   • In v01.00, access is automatically approved by the middleware

4. Access Granted

   • The installation is added to your account
   • You receive the same privileges as if you created the installation yourself
   • The installation automatically becomes your active installation

note

See Appendix: Scanning QR Codes for more details on how QR code scanning works.

Web Portal

Use your organization's access workflow (invitation or request):

Steps:

1. Navigate to Installations

   • Go to Installations → Requests/Invitations

2. Accept an Invitation or Submit a Request

   • If you've been invited, you'll see pending invitations
   • Click Accept to join
   • Alternatively, submit an access request to the owner/admin

3. Wait for Approval (in future versions)

   • The installation owner will receive a notification
   • Once approved, the installation appears in your list

Method 2: Scan a Shared QR Code

This method will be available in future versions.

The installation owner can generate a QR code specifically for sharing access:

1. Owner generates QR code

   • The owner creates a shareable QR code from their app
   • This QR code can be displayed on their phone or shared via email, WhatsApp, etc.

2. You scan the QR code

   • Scan the shared QR code using your TWIST app
   • Follow the same access request flow as Method 1

3. Access is granted

   • The installation is added to your account

What Happens After Joining

• The installation appears in your installation list
• You can switch to this installation and view all products
• You receive the same privileges as the owner (in v01.00)
• The installation automatically becomes your active installation

Future Versions

In future versions, TWIST will support different levels of access (read-only, control, admin, etc.). The owner will have granular control over what each user can do.

Expected Result

• The installation appears in your list
• You can switch to it and control products based on your permissions
• The installation owner and other users with access can see you in the user list

Troubleshooting

QR Code Won't Scan

• Ensure good lighting: QR codes scan best in well-lit conditions
• Hold camera steady: Keep your phone steady and at a reasonable distance from the QR code
• Check permissions: Ensure the app has camera access
• Clean the code: Make sure the QR code isn't damaged or obscured

Device Not Recognized

• Verify the device is registered: The device must already belong to an installation
• Check internet connection: The app needs to communicate with the middleware

Access Request Fails

• Contact the installation owner: In future versions, they may need to approve your request
• Verify device status: Ensure the device is online and properly configured

Appendix: Scanning QR Codes

QR codes on TWIST devices contain:

• A Deep Link to the app (installs the app if you don't have it)
• A Unique Device ID

When you scan a QR code, the app passes the device ID to the middleware, which responds with:

1. Device Type
2. State (online/offline)
3. Installation ID (if the device belongs to an installation)

Based on this information, the app prompts you with the appropriate action:

Scenario	App Behavior
Device not in any installation	App asks if you want to add it to your active installation
Device in your active installation	App navigates to the product page for this device
Device in another installation you own	App asks if you want to switch to that installation
Device in another user's installation	App asks if you want to request access to that installation