# Create from scratch

In the left menu, click on **Device Types**.

If no device type has been created within your organization yet, the **Device Types - Create your first device** **type** page will be displayed.

<figure><img src="/files/WQoI3JBTnDkri0Fba3wG" alt=""><figcaption></figcaption></figure>

Otherwise, the **Device Type** page will be displayed, showing the list of previously created device types.

<figure><img src="/files/t3aCTUE6O9bw1PR0gOEU" alt=""><figcaption></figcaption></figure>

## Adding a Device Type

In the Widgelix IoT cloud platform, you have the flexibility to add new devices individually through the **Create** option or import them using the **Load From Repository** option.

### Using Create Option

Click the **+Create Device Type** or **+Create** button, depending on the page you are on.

<figure><img src="/files/EXiIBTG56DdmMVVoZFwJ" alt=""><figcaption></figcaption></figure>

The **Device Type** page will be displayed, which consists of the following tabs: **About**, **Uplink Data**, **Downlink Data**, **Tags**, **Additional Parameters**, and **Widgets**.

#### About

The **About** tab allows you to provide basic information about your device type:

In the **Name** text box, enter the **name** of the device.

In the **Description** text box, enter a short **description** including what the device is intended for.

In the **Manufacturer** text box, enter the name of the **device manufacturer**.&#x20;

Click on the **picture box** to browse and upload an **image** of the device.&#x20;

<figure><img src="/files/c4QF7AezARb3tImiKhoL" alt=""><figcaption></figcaption></figure>

Click on the **+ Map Marke**r button and select a suitable icon for your device. You can also use the **Search box** to find the icon by typing its name, for example, 'temperature'.

<figure><img src="/files/NalBCsnqQtob49BvByue" alt="" width="266"><figcaption></figcaption></figure>

Click on the **Next** button.

You will be directed to the **Uplink Data** tab.

#### Uplink Data

The **Uplink Data** tab allows you to provide information about the uplink data that is being sent from your device.&#x20;

{% hint style="info" %}
This section is optional, and you may skip it without providing uplink information.
{% endhint %}

In the **Code** text area, type or paste the **uplink payload formatter** code, which is written in **JavaScript**.

{% hint style="info" %}
Ensure that the uplink payload formatter code has the`decode()`function.
{% endhint %}

Here is an example of an **uplink payload formatter** code:<br>

```javascript
function decode(payload, data) {
  for (var bytes = [], c = 0; c < payload.length; c += 2) {
    bytes.push(parseInt(payload.substr(c, 2), 16))
  }
  
  if (bytes.length === 24) {
    return {
      lastColorRed: bytes[16],
      lastColorBlue: bytes[17],
      lastColorGreen: bytes[18],
      lastColorOnTime: bytes[19],
      lastColorOffTime: bytes[20],
      messagesReceived: getValue(bytes, 8),
      messagesSent: getValue(bytes, 12),
      swRev: bytes[21],
      hwRev: bytes[22],
      adrState: bytes[23],
      rssi: getValue(bytes, 0),
      snr: getValue(bytes, 4),
    }
  } else { return {} }
}


function getValue(bytes, at) {
  return bytes[at] | (bytes[at+1] << 8) | (bytes[at+2] << 16) | (bytes[at+3] << 24);
}
```

To test the **uplink payload formatter**, enter the **binary payload** in **HEX** into the **Payload** text box and then click on the **Run** button.

{% hint style="info" %}
Here is an example of a **binary payload** in HEX that you can use with the above uplink payload formatter:

`D0FFFFFF2500000001000000020000007FFF00FF00240C01`
{% endhint %}

<figure><img src="/files/68v5rt826HHtk1mDKfGt" alt=""><figcaption></figcaption></figure>

If it is valid, the **decoded payload** will display in the **Output** text area and it will look something like this:

```json
{
    "lastColorRed": 127,
    "lastColorBlue": 255,
    "lastColorGreen": 0,
    "lastColorOnTime": 255,
    "lastColorOffTime": 0,
    "messagesReceived": 1,
    "messagesSent": 2,
    "swRev": 36,
    "hwRev": 12,
    "adrState": 1,
    "rssi": -48,
    "snr": 37
}
```

In the **Data Fields** section, you can add **keys** that allow you to extract data from the payload.&#x20;

In the **Name** text box, enter the **key** of the data field exactly as it appears in your **uplink payload formatter**. For example, according to the above uplink payload formatter code, the keys to be used are `lastColorRed`, `lastColorBlue`, `lastColorGreen`,`lastColorOnTime`, `lastColorOffTime`, `messagesReceived`, `messagesSent`, `swRev`, `hwRev`, `adrState`, `rssi` and `snr`.

Select the appropriate **unit** of measurement *(if applicable)* from the **Units** drop-down list.&#x20;

Type the **minimum** and **maximum** values *(if applicable)* for the measurement in the **Min** and **Max** text boxes, respectively.

<figure><img src="/files/lYUPDSUpo1Jbq0JmqPba" alt=""><figcaption></figcaption></figure>

Click on the **+** button to add more data fields.

Alternatively, you can load the data fields in bulk from the **decoded payload** in the format of **JSON object literal**:&#x20;

```json
{
    "lastColorOnTime": 255,
    "lastColorOffTime": 0,
    "messagesReceived": 1,
    "messagesSent": 2,
    "swRev": 36,
    "hwRev": 12,
    "adrState": 1,
    "rssi": -48,
    "snr": 37
}
```

Click on the **Load From Payload** button.

Type or paste your **JSON** object literal in the **Load Data Fields from Payload** modal.

<figure><img src="/files/egxS9FroQybqcFJNCnPO" alt=""><figcaption></figcaption></figure>

Click on the **Load** button.

The **field names** (keys) will be automatically filled in from the JSON object literal. Then, you can manually set **units**, **min**, and **max** values.

**Widgelix** also supports extracting the **device id** and **device position** *(only applicable if the device has GPS support)* from the payload:&#x20;

**Take device id from payload**: First, turn on the '**Take device id from payload**' slider button. In the **Field name for device ID**, type the **key** exactly as it appears in your **uplink payload formatter**.

**Take position from payload**: First, turn on the '**Take position from payload**' slider button. In the **Latitude field name** and **Longitude field name**, type the **keys** exactly as they appear in your **uplink payload formatter**.

<figure><img src="/files/BnD48oF6hEigyCoJKvuj" alt=""><figcaption></figcaption></figure>

Click on the **Next** button.&#x20;

You will be directed to the **Downlink Data** tab.

#### Downlink Data

The **Downlink Data** tab allows you to provide information about the downlink data that is being received by your device.

{% hint style="info" %}
This section is optional, and you may skip it without providing downlink information.
{% endhint %}

In the **Code** text area, type or paste the **downlink payload formatter** code, which is written in **JavaScript**.

{% hint style="info" %}
Ensure that the downlink payload formatter code has the`decode()`function.
{% endhint %}

Here is an example of a downlink payload formatter code:

```javascript
function decode(payload, params) {
    const red = ('00' + payload.red.toString(16)).slice(-2)
    const green = ('00' + payload.green.toString(16)).slice(-2)
    const blue = ('00' + payload.blue.toString(16)).slice(-2)
    const on = ('00' + payload.on.toString(16)).slice(-2)
    const off = ('00' + payload.off.toString(16)).slice(-2)
    return `${red}${blue}${green}${on}${off}`
}
```

<figure><img src="/files/6tXl0XsWGJLqODti0IkU" alt=""><figcaption></figcaption></figure>

To test the downlink payload formatter, type or paste its JSON payload (JSON object literal) into the **Payload** text box and then click on the **Run** button.&#x20;

Here is a sample **JSON payload** you can use to test the downlink payload formatter code listed above:

```json
{
  "red": 255,
  "green": 0,
  "blue": 0,
  "on": 255,
  "off": 0
}
```

<figure><img src="/files/Nk2d9I7Xlc4Zf6bGXd5E" alt=""><figcaption></figcaption></figure>

If it is valid, the encoded binary payload in HEX will display in the **Output** text box and it will look something like this:

```
"ff0000ff00"
```

Click on the **Next** button.&#x20;

You will be directed to the **Tags** tab.

#### Tags

The **Tags** tab allows you to add tags for your device type.

Tags are useful for easily finding and organizing your device types later on.

{% hint style="info" %}
This section is optional, and you may skip it without adding any tags.
{% endhint %}

To add a tag to a device type, simply type the tag and press `ENTER`. You can add any number of tags that are related to your device type. For example, if the device type is a beacon, you can use tags like `busy indicator`, `status light`, and `class C`.

<figure><img src="/files/M6UGL3x1T3vI4Y8Kt8Z2" alt=""><figcaption></figcaption></figure>

Click on the **Next** button.

You will be directed to the **Additional Parameters** tab.

#### Additional Parameters

The **Additional Parameters** tab allows you to provide additional parameters for your device type.

{% hint style="info" %}
This section is optional, and you may skip it without providing additional parameters.
{% endhint %}

In the Additional Parameters tab, you can enable extracting **radio** parameters and **battery** parameters from the uplink payload.&#x20;

**Radio**: Enabling the **Radio** option decodes RSSI and SNR from the payload.

* Turn on the **Take radio parameters from payload** slider button.&#x20;
* In the **Field name for RSSI** and **Field name for SNR** text boxes, type the keys exactly as they appear in your uplink payload formatter.

**Battery**: Enabling the **Battery** option decodes battery voltage from the payload.

* Turn on the **Take battery parameters from payload** slider button.&#x20;
* In the **Field name for battery value** text box, type the **key** exactly as it appears in your uplink payload formatter.&#x20;
* In the **Power consumption per cycle, mAh** text box, enter the **power consumption** of your device per transmission in **mAh**.
* Select the **battery type/chemistry** from the **Battery type** drop-down list.&#x20;
* In the **Capacity** text box, enter the **battery capacity** in **mAh**.

<figure><img src="/files/Shz8ZrY9QOLXKaOPuNIx" alt=""><figcaption></figcaption></figure>

Click on the **Next** button.&#x20;

You will be directed to the **Widgets** tab.

#### Widgets

The **Widgets** tab allows you to select the widgets that you want to use for data visualization in order to gain a better understanding of the data.

In the **Widgets** tab, click on the **+Add** **Widget** button.

<figure><img src="/files/wksCts1CdUjBAJ5JcpCi" alt=""><figcaption></figcaption></figure>

In the Select **Widget** modal, click on the **widget type** that you want to add, for example, **Chart**.

<figure><img src="/files/BIgGXioLlv9b8RCh6BVl" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
The complete instructions on how to configure each widget type can be found on the [Widgets](/get-started/widgets.md) page.
{% endhint %}

After adding the necessary widgets, click on the **Save** button to add the device type to your organization.

<figure><img src="/files/JfaRriCL8RIUgBo80hCh" alt=""><figcaption></figcaption></figure>

The new device type is listed on the **Device Type** page.

<figure><img src="/files/1A47MH3R84voveP4Bthp" alt=""><figcaption></figcaption></figure>

### Load From Repository


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.widgelix.com/get-started/device-types/create-from-scratch.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.