Guides

Create New Model

Suggest Edits

To create a new Model, navigate to the "Product" -> "Models" view and click on "Add Model"

Model fields

  • Icon - Select an icon to be displayed for all devices of this type.
  • SKU - Optional text field - displayed when the device is sold as HaaS product.
  • Authentication Method - Defines how devices register with the server and how End Customers identify the device when claiming - [https://dev.xyte.io/reference/set-authentication-method]
  • Communication protocol - HTTPS or MQTT communication method.
  • Device Type - See below
  • XYTE API Version - https://dev.xyte.io/docs/device-model-versions
  • Offline detection threshold - Define if and after how many minutes of no communication from the device, the system should automatically mark the device as offline.
  • Enabled tabs in device view - Set which tabs should be shown to End Customers in the Device View.
  • Suggested commands - Automatically generate selected commands (can be later manually added).

Device API Version

Periodically, Xyte makes subtle modifications and enhancements to the Device APIs it supports. These alterations can vary in their impact on device communication. Some changes have no direct effect, while others may introduce new APIs, substitute older API methods, or modify the data transmission and reception processes.

To ensure comprehensive backward compatibility for existing device and firmware code, the Device Model incorporates a crucial element—the "Device API Version" field. This field's value dictates the server's response to devices connected to the respective Device Model. By employing this versioning mechanism, the platform can seamlessly accommodate changes in the API while maintaining support for legacy device functionalities.

When initiating the creation of a new Device Model, the user will be presented with a creation dialog showcasing the available "Device API Version." This list invariably incorporates the latest version, recommended for use. Additionally, it encompasses any versions associated with other pre-existing Device Models. For instance, if a Firmware (FW) version 1.0.3 is associated with another Device Model, and the latest version is 1.0.5, both options will be presented in the available list.

To change the "Device API Version" of an existing Device Model, please contact [email protected]

For staying informed about future upgrades and reviewing historical changes,
we recommend following the Change Log

Updated about 2 hours ago

What’s Next