Introduction

To facilitate device creation, the Gear Studio platform allows creating device models. Device models are primarily used to automatically describe each device's structure, its endpoints, basic properties, serial number validation rules, among many other things. Once a device model has been created, as many devices as needed can be created using that same model. Gear Studio supports two types of device models:

Models built into Gear Studio (built-in). These are native models or drivers, certified on the platform, that are supported without any integration. For these device models, you generally only need to configure each device to report to the platform, and the platform will then automatically receive and process the information. When creating a device corresponding to a natively supported model, all necessary endpoints will also be created automatically.
User-defined models (custom). These models are managed from the device models page, as described here. User-defined models are used to create devices that the platform does not natively support. Optionally, custom device models can contain scripts that help the platform process received data, as described in the scripting section.

Creating a New Device Model

Device Model Management

To create a user-defined device model, use the Manager. Select the Device Models option within the Devices section.

This screen contains the list of all previously created custom device models, with the ability to edit their configuration, delete them, etc. To create a new model, select the "Add" option.

To create a new model, certain information must be completed:

Description: this field contains the descriptive name for the new model.
Model code: this field cannot be modified after creation and is used to internally identify the device model. It is recommended to always use a consistent pattern for device model codes.

Additionally, you can define the offline timeout. This field allows associating a maximum inactivity time, so that any device of this model is considered offline after this period elapses without receiving information from the device. When using this option, if a device remains disconnected from the platform for longer than the specified time, the platform will automatically generate a device offline alarm. The alarm will automatically close when the device transmits any data to the platform.

Once a device has been created, it can be edited or deleted using the "Edit" and "Delete" options.

When editing a device model, you can also edit and test the model's configuration script and the data conversion script.

For more information about configuration and data conversion scripts, see the scripting section.

Introduction

Models built into Gear Studio (built-in). These are native models or drivers, certified on the platform, that are supported without any integration. For these device models, you generally only need to configure each device to report to the platform, and the platform will then automatically receive and process the information. When creating a device corresponding to a natively supported model, all necessary endpoints will also be created automatically.
User-defined models (custom). These models are managed from the device models page, as described here. User-defined models are used to create devices that the platform does not natively support. Optionally, custom device models can contain scripts that help the platform process received data, as described in the scripting section.

Creating a New Device Model

Device Model Management

To create a user-defined device model, use the Manager. Select the Device Models option within the Devices section.

This screen contains the list of all previously created custom device models, with the ability to edit their configuration, delete them, etc. To create a new model, select the "Add" option.

To create a new model, certain information must be completed:

Description: this field contains the descriptive name for the new model.
Model code: this field cannot be modified after creation and is used to internally identify the device model. It is recommended to always use a consistent pattern for device model codes.

Once a device has been created, it can be edited or deleted using the "Edit" and "Delete" options.

When editing a device model, you can also edit and test the model's configuration script and the data conversion script.

For more information about configuration and data conversion scripts, see the scripting section.

Device Models

Introduction

Creating a New Device Model

Device Model Management

On this page

Device Models

Introduction

Creating a New Device Model

Device Model Management

On this page