Skip to content

Commit 9381d2e

Browse files
DebbieAtSeamgitbook-bot
authored andcommitted
GITBOOK-567: Update Seam Bridge docs
1 parent 66004c5 commit 9381d2e

20 files changed

Lines changed: 87 additions & 88 deletions

File tree

130 KB
Loading
83.4 KB
Loading
25.6 KB
Loading
61.2 KB
Loading
175 KB
Loading

docs/SUMMARY.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@
344344
* [Step 5: Set up Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md)
345345
* [Step 6: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md)
346346
* [Step 7: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md)
347-
* [Step 8: Connect Your Visionline Development Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md)
347+
* [Step 8: Connect Your Visionline Development Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md)
348348
* [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md)
349349
* [Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md)
350350
* [Step 1: Create a Sandbox Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md)
@@ -355,7 +355,7 @@
355355
* [Step 2: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md)
356356
* [Step 3: Purchase and Import the Callback Option from ASSA ABLOY](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md)
357357
* [Step 4: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md)
358-
* [Step 5: Connect Your Visionline Production Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md)
358+
* [Step 5: Connect Your Visionline Production Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md)
359359
* [Developing and Launching Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md)
360360
* [Developing Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md)
361361
* [Step 1: Complete the ASSA ABLOY Mobile Development Course](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md)
@@ -367,7 +367,7 @@
367367
* [Step 7: Set up Door Locks with BLE Profiles](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md)
368368
* [Step 8: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md)
369369
* [Step 9: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md)
370-
* [Step 10: Connect Your Visionline Development Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md)
370+
* [Step 10: Connect Your Visionline Development Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md)
371371
* [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md)
372372
* [Launching Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md)
373373
* [Step 1: Obtain ASSA ABLOY Certification for Your Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md)
@@ -378,7 +378,7 @@
378378
* [Step 6: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md)
379379
* [Step 7: Purchase and Import the Callback and Mobile Service Options from ASSA ABLOY](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md)
380380
* [Step 8: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md)
381-
* [Step 9: Connect Your Visionline Production Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md)
381+
* [Step 9: Connect Your Visionline Production Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md)
382382
* [Configuring Visionline Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/README.md)
383383
* [Issuing Various Types of Guest Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/issuing-various-types-of-guest-mobile-credentials.md)
384384
* [Issuing Various Types of Guest Joiner Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/issuing-various-types-of-guest-joiner-mobile-credentials.md)
Lines changed: 42 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,80 @@
11
---
2-
description: Use Seam Bridge to connect on-premises systems to Seam.
2+
description: Use Seam Bridge to connect on-premises access systems to Seam.
33
---
44

55
# 📡 Seam Bridge
66

77
## Overview
88

9-
Seam Bridge enables you to connect on-premises software systems to the Seam platform. Consisting of an executable file (that is, an application), Seam Bridge is easy to install on an on-premises computer. Once installed, Seam Bridge creates a Seam network and functions as a secure intermediary, facilitating network requests between Seam and the on-premises network. This setup aims to enable smooth communication between cloud-based services and existing local systems, while prioritizing data security and network integrity.
9+
Seam Bridge is a lightweight app that brings your on-premises access system online—without exposing any ports to the public internet.
10+
11+
Install it on a computer in the same local network as your access system. Seam Bridge creates a secure tunnel between your on-premises system and Seam Cloud, handling all the encryption and authentication for you.
12+
13+
With Seam Bridge, you get the reliability of a local system, plus the flexibility of the cloud.
1014

1115
{% hint style="info" %}
12-
Seam Bridge is a software-only component that Seam provides at no extra cost.
16+
It is important to understand the difference between Seam Bridge and smart lock Wi-Fi bridges. Seam Bridge is specifically designed to connect on-premises access systems to the Seam platform. On the other hand, Smart lock Wi-Fi bridges enable remote management of smart lock devices that do not have integrated Wi-Fi connectivity. That is, a smart lock Wi-Fi bridge uses a short-range communication protocol, such as Bluetooth, to connect one or more locks to the internet through a property's local Wi-Fi network.
1317
{% endhint %}
1418

1519
***
1620

17-
## System Requirements
21+
## Getting Started
1822

19-
* **Operating System:** Window 7 or later versions
20-
* **Memory:** At least 1 GB of RAM
21-
* **Network:** LAN connection required
23+
Download the Seam Bridge application onto an on-premises computer. Then, pair Seam Bridge with your Seam [workspace](../core-concepts/workspaces/) and connect the on-premises access system to Seam. You install and pair Seam Bridge while you are connecting your on-premises access system to Seam. That is, the [Connect Webview](../core-concepts/connect-webviews/) that you use to connect your on-premises access system to Seam walks you through the process of downloading and pairing Seam Bridge.
2224

23-
***
25+
For detailed information, see the setup instructions within the [system integration guide](../device-and-system-integration-guides/overview.md#access-control-systems) for your on-premises access system. 
2426

25-
## Installation Instructions
27+
***
2628

27-
To install Seam Bridge, first install the Seam Bridge application on an on-premises computer. Then, pair Seam Bridge with your Seam [workspace](../core-concepts/workspaces/).
29+
## **Download Seam Bridge**
2830

29-
### **Install the Seam Bridge Application on the On-Premises Computer**
31+
In a web browser, go to [the Seam Bridge repo](https://www.seam.co/seam-bridge/releases/latest) and download the latest version of the Seam Bridge application for the appropriate operating system.
3032

31-
1. In a web browser, go to [the Seam Bridge releases page](https://www.seam.co/seam-bridge/releases/latest) and download the latest version of the Seam Bridge executable.
32-
2. Run the downloaded executable file.
33+
<figure><img src="../.gitbook/assets/seam-bridge-download-area.png" alt="Download the Seam Bridge application for your operating system."><figcaption><p>Download the Seam Bridge application for your operating system.</p></figcaption></figure>
3334

34-
This application opens a webpage containing the Seam Bridge settings.
35-
3. Click **Create Pairing Code**.\
35+
### System Requirements
3636

37+
* **Operating System:** Window 7 or later, macOS, or Linux
38+
* **Memory:** At least 1 GB of RAM
39+
* **Network:** LAN connection required
3740

38-
<figure><img src="../.gitbook/assets/seam-bridge-create-pairing-code.png" alt=""><figcaption></figcaption></figure>
39-
4. Copy the pairing code that the webpage displays.
41+
***
4042

41-
The installer uses this code to pair Seam Bridge to the workspace, using a Connect Webview.\
43+
## Run Seam Bridge
4244

45+
1. Open the downloaded executable file.
46+
2. If you are using a Windows computer running Microsoft Defender, you may need to allow Windows to run the Seam Bridge app.
47+
1. In the **Windows protected your PC** dialog, click **More info**.
48+
2. Click **Run anyway**.
49+
3. If you are using a Windows computer, you may need to allow public networks to access the Seam Bridge app.
4350

44-
<figure><img src="../.gitbook/assets/seam-bridge-already-connected-error.png" alt=""><figcaption></figcaption></figure>
51+
1. In the **Do you want to allow public and private networks to access this app?** dialog, click **Show more**.
52+
2. Make sure that the **Public networks** and **Private networks** checkboxes are selected.
53+
3. Click **Allow**.
4554

46-
### Pairing Seam Bridge with Your Workspace
55+
The Seam Bridge app displays the **Welcome to Seam Bridge** window.
4756

48-
Seam provides two options for connecting Seam Bridge to your workspace. If you are a developer who wants to connect your own device, see [Pair using Seam Console](seam-bridge.md#pair-using-the-seam-console). Alternately, if you are coordinating with an external party to set up Seam Bridge, see [Pair Using a Connect Webview](seam-bridge.md#pair-using-a-connect-webview).
57+
<figure><img src="../.gitbook/assets/seam-bridge-welcome.png" alt="Welcome to Seam Bridge window" width="375"><figcaption><p><strong>Welcome to Seam Bridge</strong> window</p></figcaption></figure>
58+
4. In the **Welcome to Seam Bridge** window, type a name for the site that you are connecting using Seam Bridge—for example, `My Site`—and then click **Start pairing**.
4959

50-
{% hint style="info" %}
51-
Alternately, you can connect Seam Bridge to your workspace while you are connecting your access control system to Seam.
52-
{% endhint %}
60+
The Seam Bridge app displays a pairing code that you can use to pair Seam Bridge with your workspace.
5361

54-
#### **Pair Using Seam Console**
62+
<figure><img src="../.gitbook/assets/seam-bridge-pairing-code.png" alt="Use the pairing code to pair Seam Bridge with your workspace." width="375"><figcaption><p>Use the pairing code to pair Seam Bridge with your workspace.</p></figcaption></figure>
5563

56-
1. Log in to your account in [Seam Console](https://console.getseam.com).
57-
2. Click **Devices** to view the **Devices** page.
58-
3. In the upper-right corner of the **Devices** page, click **+ Add Devices**.
59-
4. Select **Seam Bridge**.
60-
5. In the **Pairing Code** field, type the invitation code that you copied during the [Seam Bridge application installation](seam-bridge.md#install-the-seam-bridge-application-on-the-on-premises-computer).
61-
6. In the **Bridge Name** field, type a unique name.
62-
7. Make sure to remember the Seam Bridge name for future reference.\
63-
You must use this Seam Bridge name when connecting the on-premises access control system in a Connect Webview.
64+
***
6465

65-
#### **Pair Using a Connect Webview**
66+
## Next Steps
6667

67-
The developer creates a Connect Webview using `seam_bridge` as the `accepted_providers` key. Then, the person who installed Seam Bridge performs the following steps:
68+
Go to the setup instructions within the [system integration guide](../device-and-system-integration-guides/overview.md#access-control-systems) for your on-premises access system. These instructions describe how to pair Seam Bridge with your workspace and then connect your on-premises access system to Seam through Seam Bridge.
6869

69-
1. In the Connect Webview, choose **Seam Bridge** from the list of brands, if available.
70-
2. In the **Pairing Code** field, type the invitation code obtained during the [Seam Bridge application installation](seam-bridge.md#install-the-seam-bridge-application-on-the-on-premises-computer).
71-
3. In the **Bridge Name** field, type a unique name.
70+
***
7271

73-
<figure><img src="../.gitbook/assets/connect-webview-seam-bridge-info.png" alt="Type a unique Seam Bridge name and the pairing code from the Seam Bridge application installation." width="245"><figcaption><p>Type a unique Seam Bridge name and the pairing code from the Seam Bridge application installation.</p></figcaption></figure>
72+
## Troubleshooting Seam Bridge
7473

75-
4. Remember the Seam Bridge name for future reference.\
76-
You must use this Seam Bridge name when connecting the on-premises access control system in a Connect Webview.
74+
If issues affect the connections between Seam Bridge, your on-premises access system, and the Seam platform, the Seam Bridge app displays status, error, and other information to help you understand and troubleshoot these issues.
7775

78-
***
76+
The **Connected Systems** area displays the status of each connection. A green checkmark indicates a healthy connection.
7977

80-
## Connecting the On-Premises Software System
78+
The Seam Bridge app also displays communication errors at the top of the window.
8179

82-
After installing the Seam Bridge application and connecting Seam Bridge to your workspace, connect your on-premises software system to Seam using a Connect Webview. For detailed instructions on how to connect your system, see the setup instructions in the appropriate brand-specific [system integration guide](../device-and-system-integration-guides/overview.md#access-control-systems).
80+
<figure><img src="../.gitbook/assets/seam-bridge-connected-systems-info.png" alt="Seam Bridge displays information about the connections to on-premises access systems." width="375"><figcaption><p>Seam Bridge displays information about the connections to on-premises access systems.</p></figcaption></figure>

0 commit comments

Comments
 (0)