Displaying Device Health

You can display the health status of your end users' devices in your app.

To display the healthβ€”that is, the online/offline statusβ€”of your end users' devices in your app, you can use the following Seam mechanisms:

Get Device Status Using Device Properties

Seam polls connected devices and accounts every ten minutes and updates the Boolean device.properties.online property accordingly. Use a Get Device request to retrieve the current online/offline status of a device. Then, display the device status in your app.

You can also use the prebuilt device details Seam Component, which includes a device status display.

Request:

device = seam.devices.get("36cf1a96-196d-41b0-9804-88154387f1f9")
pprint("Online: " + str(device.properties.online))

Response:

'Online: True'

When a device connection or disconnection occurs, Seam generates a device.connected or device.disconnected event, respectively. You can retrieve these events using a List Events request or through webhooks and then display the corresponding status in your app.

When issuing a List Events request to retrieve device.connected or device.disconnected events for a specific device, include the following parameters:

ParameterTypeDescription

device_id

String (UUID)

ID of the device for which you want to retrieve device.connected or device.disconnected events

event_type

String

Event type that you want to retrieve, that is, device.connected or device.disconnected

since

String

Desired starting event generation date and time You must include since or between.

between

Set of two strings

Desired starting and ending event generation dates and times For example: ["2024-01-01T00:00:00Z", "2024-02-01T00:00:00Z"] You must include between or since.

The following example uses the List Events request to retrieve all device.connected events for a specific device since January 1, 2024:

Request:

device_connected_events = seam.events.list(
    device_id = "36cf1a96-196d-41b0-9804-88154387f1f9",
    event_type = "device.connected",
    since = "2024-01-01T00:00:00Z"
)
pprint(device_connected_events)

Response:

[{'connected_account_id': 'c1413928-f527-4e12-abf9-d5e18d92dd33',
  'created_at': '2024-02-04T21:55:09.681Z',
  'device_id': '36cf1a96-196d-41b0-9804-88154387f1f9',
  'event_id': 'ca3114b2-088d-43f9-bb5e-ded5d19ad053',
  'event_type': 'device.connected',
  'occurred_at': '2024-02-04T21:55:09.681Z',
  'workspace_id': '398d80b7-3f96-47c2-b85a-6f8ba21d07be'},
 {'connected_account_id': 'c1413928-f527-4e12-abf9-d5e18d92dd33',
  'created_at': '2024-02-03T04:54:39.744Z',
  'device_id': '36cf1a96-196d-41b0-9804-88154387f1f9',
  'event_id': '39fcb512-82a4-431d-969f-3935eeba8929',
  'event_type': 'device.connected',
  'occurred_at': '2024-02-03T04:54:39.744Z',
  'workspace_id': '398d80b7-3f96-47c2-b85a-6f8ba21d07be'}]

You can set up webhook endpoints to receive device.connected and device.disconnected events. Then, you can use the receipt of these events to display the corresponding device status in your app. For more information about configuring webhooks, see Webhooks.

Last updated

Logo

Β© Seam Labs, Inc. All rights reserved.