Device Configuration File

The device configuration file is used when adding a device to the Atym Hub. This document outlines the required and optional fields in the device configuration file.

---

Overview

The device configuration file is a YAML file that contains information about a device that will be added to the Atym Hub. When using the atym add device command with the -f flag, you can specify a device configuration file to add a new device. The format of the command is:

atym add device -f device.yaml

Note

The device file can be named anything as long as it is a YAML file with valid YAML content.

---

Example

Here's an example of a valid device configuration file:

---
deviceName: Mydevice 
description: "My test device" 
serialNumber: '1234567890'
target: armv8m.main
cpu: cortex-m33 
enabled: true
aotEnabled: true 
targetAbi: undefined
xip: false 

This configuration will add a device with the name Mydevice, which is an STMicroelectronics B-U585I-IOT02A development board with a Cortex-M33 processor running the ARMv8-M architecture that has AOT enabled.

---

Required Fields

The following fields are required in the device configuration file:

Field	Type	Description	Accepted Values
cpu	string	The CPU variant of your device	See available CPU types
deviceName	string	A human-readable name for the device	-
target	string	The device architecture type	See available Target types
serialNumber	string	The serial number of the device	-

---

Optional Fields

The following fields are optional in the device configuration file:

Field	Type	Description	Default	Accepted Values
aotEnabled	boolean	Enable Ahead-of-Time compilation for the device (See AOT Compilation for details)	false	true/false
description	string	A description of the device	None	-
enabled	boolean	A boolean flag indicating whether the device is enabled	true	true/false
targetAbi	string	The Application Binary Interface for the target platform (required when AOT is enabled)	None	See available TargetAbi types
xip	boolean	Enable Execute-in-Place for the device	false	true/false

---

See Also

• Ahead-of-Time (AOT) Compilation - Detailed guide on AOT compilation, configuration, and usage