> For the complete documentation index, see [llms.txt](https://inklay.gitbook.io/inklay-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://inklay.gitbook.io/inklay-docs/trmnl.md).

# TRMNL

Connect your Inklay with your TRMNL account and get access to over 1000 apps.

<div data-with-frame="true"><figure><img src="https://2873613899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfDz2dNIYKtA9Qw6PB28G%2Fuploads%2FN6ek21HJ3PyVAVDehL8g%2Fdevices-cdfef813-bf64-4df7-8f72-0f0533d9dd61-image-5.png?alt=media&amp;token=1400a41e-019d-4cf5-b74d-d3f15d5d0a13" alt=""><figcaption><p>Configure the Weather app, or choose from the many other apps available through the TRMNL App.</p></figcaption></figure></div>

{% stepper %}
{% step %}

### Create a TRMNL Account

Go to <https://trmnl.com/signup> and create a TRMNL account.
{% endstep %}

{% step %}

### Get a TRMNL BYOD License

Go to <https://shop.trmnl.com/products/byod> and buy a BYOD license. You will receive an email containing your order number and further instructions.
{% endstep %}

{% step %}

### Claim your Device

Go to <https://trmnl.com/claim-a-device> and claim your device by entering your order number, name, and email address. You will then receive a device ID.
{% endstep %}

{% step %}

### Add a new Device to your TRMNL Account

Go to <https://trmnl.com/devices/new> and enter the device ID in the Friendly Device ID field.
{% endstep %}

{% step %}

### Change Device Model

Open your device settings and set the device model to

&#x20;`Kobo Aura One - 1872x1404`.
{% endstep %}

{% step %}

### Change Device Color Palette

Go to Device Settings > Presentation > Color Palette and select

&#x20;`16 greys (4-bit)`
{% endstep %}

{% step %}

### Get your TRMNL Device Mac Address

Go to Device Settings > Developer Perks and note your device’s MAC address. You will need it later in the Inklay app.
{% endstep %}

{% step %}

### Add a TRMNL App

Go to the Plugins section and configure a plugin of your choice. The plugin should then appear on your dashboard.
{% endstep %}

{% step %}

### Add the TRMNL App

Go to your Inklay’s device view and select a button slot. Press and hold the button slot to open the app menu, then select the TRMNL app.
{% endstep %}

{% step %}

### Connect Inklay with TRMNL

Enter your TRMNL device’s MAC address to establish the connection. Once the connection is successful, the Inklay app will fetch and display a preview image.

<div align="left"><figure><img src="https://2873613899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfDz2dNIYKtA9Qw6PB28G%2Fuploads%2F3x4unXPb8bZ4JKmEWV1W%2Fapp-trmnl-1.png?alt=media&amp;token=da0b3c3d-5c51-4938-981f-577d5f7b5be2" alt="" width="188"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}

### Configure TRMNL App

You can configure the following options:

<div align="left"><figure><img src="https://2873613899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfDz2dNIYKtA9Qw6PB28G%2Fuploads%2FQGBFmHHcSsuuNOeLjbX4%2Fapp-trmnl-2.png?alt=media&amp;token=edeefdac-815e-410a-a5fe-42b69c0be114" alt="" width="188"><figcaption></figcaption></figure></div>

| Wake up every | <p>15min<br>30min<br>1h<br>6h (no Night Sleep)<br>12h (no Night Sleep)<br>24h (no Night Sleep)</p> |
| ------------- | -------------------------------------------------------------------------------------------------- |
| {% endstep %} |                                                                                                    |

{% step %}

### Set Active (Optional)

Set this app as the active app. The active app will update according to the configured wake up settings.
{% endstep %}
{% endstepper %}

More infos: <https://trmnl.com>