Skip to main content

Device Presentations

A Device Presentation is used by the SmartThings platform to determine how the Capability Presentations of a Device are grouped and displayed in the SmartThings app. Using the SmartThings API, you can generate a custom Device Presentation based on your Device Configuration using the createDeviceConfiguration API call.

When you create a Device Presentation using the createDeviceConfiguration API POST call, the SmartThings API will return the vid and mnmn of your newly created Device Presentation - you will use these properties to associate your Device Presentation with your Device Profile.

tip

For Edge Drivers, Device Presentations are automatcally generated based on the Device Profile. Custom Device Presentations can still be used, but are not required for Edge Drivers.

note

What's the difference between a Device Presentation and a Capability Presentation?

A Device Presentation determines which Capabilities are displayed and how they are arranged when presented; a Capability Presentation determines how the Capability's attributes and commands are displayed within the Device Presentation.

Using a Device Presentation​

To use your Device Presentation, add your Device Presentations's vid and mnmn to your Device Profile's metadata.

You can update your Device Profile using the SmartThings API. After adding the appropriate metadata to your Device Profile, the SmartThings platform will begin using the Device Presentation associated with the Device Profile. Below is an example Device Profile using a Device Presentation's vid and mnmn of ST_98314275-0bc0-466f-940b-07b6487cb945 and 0AJJ respectively:

{
    "id": "ed3e53a1-ef5e-4d7f-86fa-cd30da196025",
    "name": "ThermostatProfile",
    "metadata": {
        "vid": "ST_98314275-0bc0-466f-940b-07b6487cb945",
        "deviceType": "Thermostat",
        "mnmn": "0AJJ"
    },
    "status": "DEVELOPMENT",
    "components": [
        {
            "label": "main",
            "id": "main",
            "capabilities": [
                {
                    "id": "temperatureMeasurement",
                    "version": 1,
                    "ephemeral": false
                },
                {
                    "id": "thermostatMode",
                    "version": 1,
                    "ephemeral": false
                },
                {
                    "id": "refresh",
                    "version": 1,
                    "ephemeral": false
                }
            ],
            "categories": []
        }
    ]
}

Using Device Presentations with SmartThings Edge Drivers

To associate a SmartThings Edge Driver with a Device Presentation, edit your Driver Profile to include your Device Presentations's vid - no mnmn is required.

Verifying Your Presentation Is In Use​

To ensure the correct Device Presentation is in use with your device, use the List Devices API call. Analyze the API response, making sure your device's presentationId and manufacturerName match the vid and mnmn respectively of your Device Presentation.