Testing Your App Against Device Disconnection and Removal

When developing an app to control IoT devices—before moving to production—it is imperative to test your app against events like device disconnection and removal. However, it can be difficult to orchestrate these events in your quality assurance (QA) environment using real devices. To help you test your app more easily and effectively, Seam provides the following suite of simulate endpoints that you can use in a sandbox workspace:

/devices/simulate/disconnect
/devices/simulate/connect
/devices/simulate/remove

Currently, Seam supports these endpoints for August and Yale sandbox devices.

Simulation Capability Flags

The Seam API provides the following sandbox-only capability flags that show you which simulate endpoints you can currently use on a device:

device.can_simulate_disconnection
device.can_simulate_connection
device.can_simulate_removal

Simulate Disconnecting a Device

To simulate a device disconnection: Code:

// Get the device.
const device = await seam.devices.get({
  device_id: '11111111-1111-1111-1111-444444444444',
})

// Confirm that Seam supports simulated disconnection for the device.
if (device.can_simulate_disconnection) {
  // Perform the simulated disconnection.
  await seam.devices.simulate.disconnect({
    device_id: device.device_id,
  })
}

# Get the device.
device=$(
  # Use GET or POST.
  curl -X 'GET' \
    'https://connect.getseam.com/devices/get' \
    -H 'accept: application/json' \
    -H "Authorization: Bearer ${SEAM_API_KEY}" \
    -H 'Content-Type: application/json' \
    -d '{
      "device_id": "11111111-1111-1111-1111-444444444444"
  }')

# Confirm that Seam supports simulated disconnection for the device.
if  $(jq -r '.device.can_simulate_disconnection' <<< ${device}); then \
  # Perform the simulated disconnection.
  curl -X 'POST' \
    'https://connect.getseam.com/devices/simulate/disconnect' \
    -H 'accept: application/json' \
    -H "Authorization: Bearer ${SEAM_API_KEY}" \
    -H 'Content-Type: application/json' \
    -d "{
      \"device_id\": \"$(jq -r '.device.device_id' <<< ${device})\"
  }";
fi

# Get the device.
device = seam.devices.get(
  device_id="11111111-1111-1111-1111-444444444444"
)

# Confirm that Seam supports simulated disconnection for the device.
if device.can_simulate_disconnection:
  # Perform the simulated disconnection.
  seam.devices.simulate.disconnect(device_id=device.device_id)

# Get the device.
device = client.devices.get(device_id: "11111111-1111-1111-1111-444444444444")

# Confirm that Seam supports simulated disconnection for the device.
if (device.can_simulate_disconnection)
  # Perform the simulated disconnection.
  client.devices.simulate.disconnect(device_id: device.device_id)
end

// Get the device.
$device = $seam->devices->get(device_id: "11111111-1111-1111-1111-444444444444");

// Confirm that Seam supports simulated disconnection for the device.
if ($device->can_simulate_disconnection) {
  // Perform the simulated disconnection.
  $seam->devices->simulate->disconnect(device_id: $device->device_id);
}

// Get the device.
Device device = seam.Devices.Get(deviceId: "11111111-1111-1111-1111-444444444444");

// Confirm that Seam supports simulated disconnection for the device.
if (device.CanSimulateDisconnection == true) {
  // Perform the simulated disconnection.
  seam.Devices.Simulate.Disconnect(deviceId: device.DeviceId);
}

Output:

void

{
  "ok": true
}

None

nil

void

void

Simulate Connecting a Device

To simulate a device connection: Code:

// Get the device.
const device = await seam.devices.get({
  device_id: '11111111-1111-1111-1111-444444444444',
})

// Confirm that Seam supports simulated connection for the device.
if (device.can_simulate_connection) {
  // Perform the simulated connection.
  await seam.devices.simulate.connect({
    device_id: device.device_id,
  })
}

# Get the device.
device=$(
  # Use GET or POST.
  curl -X 'GET' \
    'https://connect.getseam.com/devices/get' \
    -H 'accept: application/json' \
    -H "Authorization: Bearer ${SEAM_API_KEY}" \
    -H 'Content-Type: application/json' \
    -d '{
      "device_id": "11111111-1111-1111-1111-444444444444"
  }')

# Confirm that Seam supports simulated connection for the device.
if  $(jq -r '.device.can_simulate_connection' <<< ${device}); then \
  # Perform the simulated connection.
  curl -X 'POST' \
    'https://connect.getseam.com/devices/simulate/connect' \
    -H 'accept: application/json' \
    -H "Authorization: Bearer ${SEAM_API_KEY}" \
    -H 'Content-Type: application/json' \
    -d "{
      \"device_id\": \"$(jq -r '.device.device_id' <<< ${device})\"
  }";
fi

# Get the device.
device = seam.devices.get(
  device_id="11111111-1111-1111-1111-444444444444"
)

# Confirm that Seam supports simulated connection for the device.
if device.can_simulate_connection:
  # Perform the simulated connection.
  seam.devices.simulate.connect(device_id=device.device_id)

# Get the device.
device = client.devices.get(device_id: "11111111-1111-1111-1111-444444444444")

# Confirm that Seam supports simulated connection for the device.
if (device.can_simulate_connection)
  # Perform the simulated connection.
  client.devices.simulate.connect(device_id: device.device_id)
end

// Get the device.
$device = $seam->devices->get(device_id: "11111111-1111-1111-1111-444444444444");

// Confirm that Seam supports simulated connection for the device.
if ($device->can_simulate_connection) {
  // Perform the simulated connection.
  $seam->devices->simulate->connect(device_id: $device->device_id);
}

// Get the device.
Device device = seam.Devices.Get(deviceId: "11111111-1111-1111-1111-444444444444");

// Confirm that Seam supports simulated connection for the device.
if (device.CanSimulateConnection == true) {
  // Perform the simulated connection.
  seam.Devices.Simulate.Connect(deviceId: device.DeviceId);
}

Output:

void

{
  "ok": true
}

None

nil

void

void

Simulate Removing a Device

To simulate a device removal: Code:

// Get the device.
const device = await seam.devices.get({
  device_id: '11111111-1111-1111-1111-444444444444',
})

// Confirm that Seam supports simulated removal for the device.
if (device.can_simulate_removal) {
  // Perform the simulated removal.
  await seam.devices.simulate.remove({
    device_id: device.device_id,
  })
}

# Get the device.
device=$(
  # Use GET or POST.
  curl -X 'GET' \
    'https://connect.getseam.com/devices/get' \
    -H 'accept: application/json' \
    -H "Authorization: Bearer ${SEAM_API_KEY}" \
    -H 'Content-Type: application/json' \
    -d '{
      "device_id": "11111111-1111-1111-1111-444444444444"
  }')

# Confirm that Seam supports simulated removal for the device.
if  $(jq -r '.device.can_simulate_removal' <<< ${device}); then \
  # Perform the simulated removal.
  curl -X 'POST' \
    'https://connect.getseam.com/devices/simulate/remove' \
    -H 'accept: application/json' \
    -H "Authorization: Bearer ${SEAM_API_KEY}" \
    -H 'Content-Type: application/json' \
    -d "{
      \"device_id\": \"$(jq -r '.device.device_id' <<< ${device})\"
  }";
fi

# Get the device.
device = seam.devices.get(
  device_id="11111111-1111-1111-1111-444444444444"
)

# Confirm that Seam supports simulated removal for the device.
if device.can_simulate_removal:
  # Perform the simulated removal.
  seam.devices.simulate.remove(device_id=device.device_id)

# Get the device.
device = client.devices.get(device_id: "11111111-1111-1111-1111-444444444444")

# Confirm that Seam supports simulated removal for the device.
if (device.can_simulate_removal)
  # Perform the simulated removal.
  client.devices.simulate.remove(device_id: device.device_id)
end

// Get the device.
$device = $seam->devices->get(device_id: "11111111-1111-1111-1111-444444444444");

// Confirm that Seam supports simulated removal for the device.
if ($device->can_simulate_removal) {
  // Perform the simulated removal.
  $seam->devices->simulate->remove(device_id: $device->device_id);
}

// Get the device.
Device device = seam.Devices.Get(deviceId: "11111111-1111-1111-1111-444444444444");

// Confirm that Seam supports simulated removal for the device.
if (device.CanSimulateRemoval == true) {
  // Perform the simulated removal.
  seam.Devices.Simulate.Remove(deviceId: device.DeviceId);
}

Output:

void

{
  "ok": true
}

None

nil

void

void

Simulate Device Disconnection, Connection, and Removal in the Seam Console

You can also use the Seam Console to simulate disconnecting, connecting, and removing a device.

Currently, Seam supports these actions for August and Yale sandbox devices.

In the upper-right corner of the Seam Console, click the down arrow to display the workspace list and select a sandbox workspace.
In the left navigation pane of the Seam Console, click Connected Accounts.
Click the account that contains the device that you want to simulate disconnecting, connecting, or removing.
At the right of the row for the desired device, click … and select Simulate Removal, Simulate Connection, or Simulate Disconnection.
The Seam Console only displays the actions that you can perform based on the current state of the device. For example, if the device is already disconnected, you cannot simulate disconnection.
Click Simulate Removal, Simulate Connection, or Simulate Disconnection to confirm the action.

Getting Started

Use Cases

Core Concepts

Capability Guides

UI Components

Developer Tools

Industry Guides

Device Manufacturer Guidance

Low-Level APIs

Testing Your App Against Device Disconnection and Removal

Simulation Capability Flags

Simulate Disconnecting a Device

Simulate Connecting a Device

Simulate Removing a Device

Simulate Device Disconnection, Connection, and Removal in the Seam Console

​Simulation Capability Flags

​Simulate Disconnecting a Device

​Simulate Connecting a Device

​Simulate Removing a Device

​Simulate Device Disconnection, Connection, and Removal in the Seam Console

Simulation Capability Flags

Simulate Disconnecting a Device

Simulate Connecting a Device

Simulate Removing a Device

Simulate Device Disconnection, Connection, and Removal in the Seam Console