Seam provides a universal API to connect and control many brands of devices such as smart locks, thermostats, and sensors. This guide provides a rapid introduction to connecting and controlling your devices (called "activity zones" by NoiseAware) using the Seam API. To learn more about other brands of devices supported by Seam, head over to our .
To simplify the examples below, we'll use the following modules and utility variables:
1. Install Seam SDK
npm i seam
pip install seam
# For some development environments, use pip3 in this command instead of pip.
This guide uses a Sandbox Workspace. Only virtual activity zones can be connected. If you need to connect a real Noiseaware device, use a non-sandbox workspace and API key.
2. Link NoiseAware Account with Seam
Create a Connect Webview
from seam import Seam
seam = Seam()
webview = seam.connect_webviews.create(accepted_providers=["noiseaware"])
assert webview.login_successful is False
# Send this webview url to your user!
print(webview.url)
import { Seam } from 'seam'
const seam = new Seam()
const connectWebview = await seam.connectWebviews.create({
accepted_providers: ["noiseaware"],
})
console.log(connectWebview.login_successful) // false
// Send the webview URL to your user
console.log(connectWebview.url)
require "seam"
seam = Seam.new(api_key: "MY_API_KEY")
webview = seam.connect_webviews.create(
accepted_providers: ["noiseaware"]
)
puts webview.login_successful # false
# Send the webview URL to your user
puts webview.url
use Seam\SeamClient;
$seam = new SeamClient("YOUR_API_KEY");
$webview = $seam->connect_webviews->create(
accepted_providers: ["noiseaware"]
);
echo json_encode($webview)
/*
{"connect_webview_id":"70c4df9e-1070-441f-92f8-fd6524062cec","workspace_id":"d7418ff3-a476-4f48-9a4b-211d1d21a03d","url":"https:\/\/connect.getseam.com\/connect_webviews\/view?connect_webview_id=70c4df9e-1070-441f-92f8-fd6524062cec&auth_token=9HJbwWKbD5aJLifZcozU9WWZXxropn9Bg","connected_account_id":null,"status":"pending","custom_redirect_url":null,"custom_redirect_failure_url":null,"created_at":"2023-02-09T02:14:06.147745+00:00","error":null}
*/
NoiseAware users can define noise thresholds at which noise alerts are sent.
NoiseAware has three distinct noise alerts: newNoise, continuedNoise, and resolvedNoise. It is essential to keep in mind that Seam will solely trigger the noise_threshold.noise_threshold_triggered event for newNoise.
Now that you've completed this guide, you can try to connect a real NoiseAware device. To do so, make sure to switch to a non-sandbox workspace and API key as real devices cannot be connected to sandbox workspaces.
If you have any questions or want to report an issue, email us at support@seam.co
Seam provides client libraries for many languages, such as JavaScript, Python, Ruby, PHP, and others, as well as a Postman collection and spec.
JavaScript / TypeScript (, )
Python (, )
Ruby Gem (, )
PHP (, )
Java ()
C# (, )
Go ()
Install using .
Once installed, to get your API key, and export it as an environment variable:
To control your NoiseAware device via the Seam API, you must first authorize your Seam workspace against your NoiseAware account. To do so, Seam provides: pre-built UX flows that walk you through authorizing your application to control your NoiseAware device.
Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the NoiseAware credentials below:
After you complete the login above, you'll get an event for if you set up a . Otherwise you can just poll for the webview until it's status changes, as shown below:
You'll get an event for noise_threshold.noise_threshold_triggered when you set up a . You can also .
