Learn how to connect and control your ControlByWeb device with the Seam API.
Last updated
Was this helpful?
Was this helpful?
npm i seampip install seam
# For some development environments, use pip3 in this command instead of pip.bundle add seamcomposer require seamapi/seam$ export SEAM_API_KEY=seam_test2ZTo_0mEYQW2TvNDCxG5Atpj85Ffwfrom seam import Seam
seam = Seam()
webview = seam.connect_webviews.create(accepted_providers=["controlbyweb"])
assert webview.login_successful is False
# Send the webview URL to your user
print(webview.url)import { Seam } from 'seam'
const seam = new Seam()
const connectWebview = await seam.connectWebviews.create({
accepted_providers: ['controlbyweb'],
})
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: ["controlbyweb"]
)
puts webview.login_successful # false
# Send the webview URL to your user
puts webview.urlupdated_webview = seam.connect_webviews.get(connect_webview_id: webview.connect_webview_id)
assert updated_webview.login_successful # trueconst updatedWebview = await seam.connectWebviews.get(
connectWebview.connect_webview_id,
)
console.log(updatedWebview.login_successful) // trueupdated_webview = seam.connect_webviews.get(connect_webview_id: webview.connect_webview_id)
puts updated_webview.login_successful # true# Device(
# device_id='4a570d13-9704-46e0-b69c-9fea80d6a7aa',
# device_type='controlbyweb_device',
# location=None,
# properties={
# 'locked': True,
# 'online': True,
# 'manufacturer': 'controlbyweb',
# 'controlbyweb_metadata': {
# 'device_id': '9997',
# 'relay_name': 'firstRelay',
# 'device_name': 'Device 2'
# },
# 'name': 'Device 2',
# 'image_url': 'https://connect.getseam.com/assets/images/devices/unknown-lock.png',
# 'image_alt_text': 'Placeholder Lock Image'
# },
# capabilities_supported=['lock'],
# errors=[]
# )const allLocks = await seam.locks.list()
const someLock = allLocks[0]
console.log(someLock.properties.online) // true
console.log(someLock.properties.locked) // true
console.log(someLock)
/*
{
device_id: '4a570d13-9704-46e0-b69c-9fea80d6a7aa',
device_type: 'controlbyweb_device',
capabilities_supported: [ 'lock' ],
properties: {
locked: true,
online: true,
manufacturer: 'controlbyweb',
controlbyweb_metadata: {
device_id: '9997',
relay_name: 'firstRelay',
device_name: 'Device 2'
},
name: 'Device 2',
image_url: 'https://connect.getseam.com/assets/images/devices/unknown-lock.png',
image_alt_text: 'Placeholder Lock Image'
},
location: null,
connected_account_id: '5e0f49ac-3cb5-4e81-8c74-aba262218611',
workspace_id: '40a179ca-3553-4226-9483-21df4e12f5fe',
created_at: '2023-04-25T14:34:50.508Z',
errors: [],
warnings: []
}
*/some_lock = seam.locks.list.first
puts some_lock.properties.online # true
puts some_lock.properties.locked # true
puts some_lock.inspect # > # warnings=[] # errors=[] # created_at=2023-04-25 14:34:50 UTC # } # "image_alt_text"=>"Placeholder Lock Image" # "image_url"=>"https://connect.getseam.com/assets/images/devices/unknown-lock.png", # "name"=>"Device 2", # }, # "device_name"=>"Device 2" # "relay_name"=>"firstRelay", # "device_id"=>"9997", # "controlbyweb_metadata"=>{ # "manufacturer"=>"controlbyweb", # "online"=>true, # "locked"=>true, # properties={ # device_type="controlbyweb_device" # device_id="4a570d13-9704-46e0-b69c-9fea80d6a7aa" # <Seam::Device:0x00146639380# trigger the relay
seam.locks.unlock_door(some_lock)// trigger the relay
await seam.locks.unlockDoor(someLock.device_id)
ruby
# trigger the relay
seam.locks.unlock_door(device_id: some_lock.device_id)