Content Comparison

Attributes are where you define the characteristics of your device. This allows you to define items such as how quickly the device appears Offline in the app, the image shown to the user when adding the device, fields shown for customizing units and more.

...

Since there are a number of Attributes that can be used, the documentation is broken out into sections with additional details on attribute fields you can define. When you start a new template, the Attributes section will be empty but you will want to add at least a few from the Recommended/Required section at a minimum.

Recommended/Required

• device_type: Required for all devices. Describes the type of device defined by the template. Can be anything you want (but see notes below). Used by the application UI to key off of when setting up alerts, displaying appropriate units, etc. This also gets returned in API calls and displayed in various places within the app.💡 Note: The app has several built in values which, if used, will fallback to certain hardcoded display behavior. If you are creating a new template and want to avoid any such instances, be sure to use something here which is not one of the reserved names (see below). E.g. “Laird RSXX1” instead of the generic “Temperature/Humidity”.Reserved (Old) device types: Open/Close, Temperature/Humidity, Motion, Level Sensor, CO, CO2, Push Button, AC Current Meter, Light, Water Meter, Occupancy, Smoke

• instructions: Single sentence shown to the user during the Device Setup process, meant to help the user in setting up the hardware for the first time.Example: Pull activation tab, then wait until green light flashes.

• image_url: Link to image of the hardware which gets displayed to the user during the Device Setup process.💡 Note: Use a shared image service so that the image is always available. Do not direct link to a manufacturer’s image since it could change if they update the model or worse, they could remove the image.Example: https://res.cloudinary.com/dctlrnwuz/image/upload/v1557784791/agoraopinion_is7f61.png

...