> For the complete documentation index, see [llms.txt](https://manual.simhubdash.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manual.simhubdash.com/device-definition-authoring/getting-started-device-definition-authoring.md).

# Getting started - Device definition authoring

### Introduction

A **device definition** describes how a hardware device behaves and appears inside SimHub.

It defines:

* The **hardware interface** (HID, Serial, Named Protocol, etc.)
* The **available features** (LEDs, screens, encoders, buttons, etc.)
* Default parameters such as:
  * LED mappings and colors
  * Brightness profiles
  * Screen layout
  * Default telemetry bindings

A definition transforms a raw hardware device into a ready-to-use SimHub device with proper names, visuals, and defaults, once installed the end user can instantiate it as any other device.

***

### Creating a New Definition

1. Open **Descriptor Builder**\
   → *Devices → Utilities → Device definition authoring tools -> New*<br>

   <figure><img src="/files/xA1JFIPRt4Rkawr9kuk6" alt=""><figcaption></figcaption></figure>
2. Fill the **device description**:
   * Brand and product name
   * Thumbnail image
3. Choose the **hardware interface**:
   * Serial, HID, or custom named protocol (see [Device communication protocols](/device-definition-authoring/device-communication-protocols.md))
4. Add **features**:
   * LEDs, screens, encoders, buttons, etc.
5. Define **logical → physical mappings** for LEDs or buttons.

***

### Distribution Formats

| Format                 | Extension | Purpose                               |
| ---------------------- | --------- | ------------------------------------- |
| **Project**            | `.shdd`   | Editable, for collaboration or backup |
| **Installable device** | `.shdp`   | Read-only, for end-user distribution  |

***

### Exporting Your Definition

To share your work:

1. Open the authoring tool&#x20;
2. Select the device and click on **Export installable definition**'&#x20;

   It will create a `.shdp` file which can be installed by any user wuing "installed devices" menu.

### Managing Installed Definitions

Installed definitions can be viewed or removed from:

> **Devices → Installed Devices**

This view is intentionally simple — it only lists user-installed third-party definitions.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://manual.simhubdash.com/device-definition-authoring/getting-started-device-definition-authoring.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.