# Device INIT-Phase When starting SPAD.neXt will send an INIT Request to the device and expects a response within 5 seconds, else the device will be marked as offline/unavailable. Request from SPAD.neXt:\ `0,INIT,,,` `Parameters`
| \ |

Version of the serial protocol supported
2 means SPAD.neXt supports version 1 and version 2
The current version is 2

| | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \ | SPAD.neXt version (e.g. 0.9.12.0 ) | | \ | A unique ID identifying the SPAD.neXt instance used as authentication tag in AuthenticationCipher (See [http://rweather.github.io/arduinolibs/classAuthenticatedCipher.html](http://rweather.github.io/arduinolibs/classAuthenticatedCipher.html#details) for details) | Reply from device:\ `0,SPAD,,,,[,,...,;` | `` | Unique Identifier identifying the device. It should follow the GUID-Registryformat e.g. "{A8AA15C5-7BB6-4AC6-A558-A88CAFB78729}". To create a GUID you can use this site: (enable braces and hyphens) | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \ | the human readable name of the device. This will be used throughout the SPAD.neXt UI for everything related to that device | | \ | Serialversion the device is supporting (Current Version is 2) | | \ | Version of the device (Major.Minor\[.Build.Patch]) | | \,...,\ | optional device option Key=Value pairs (see [OPTIONS](/extending-and-apis/serial-connection/device-communication-flow/device-config-phase/device-options.md)) | ## INIT-Options available only in INIT Command.\ (all additional [options](/extending-and-apis/serial-connection/device-communication-flow/device-config-phase/device-options.md) can be added as well) | Key | Value | | | ---------- | ------------------ | --------------------------------------------------------------------- | | AUTHOR | \ | | | ALLOWLOCAL | 0\|1\|2 | where SPAD.neXt will look for device configuration files (default: 0) | | PID | string | A unique **short** product id for the device. | | SERIAL | string | optional serial number of device | {% hint style="warning" %} If PID option is provided, the AUTHOR option must be provided as well {% endhint %} ### AUTHOR To receive your unique authorkey, issue the command "!deviceinfo" on the SPAD.neXt discord.\ This key will identify the device author and enable author-only functions like e.g. editing the device UI or device configuration database, if the current SPAD.neXt user is the device author. {% hint style="warning" %} The authorkey is case-sensitive! {% endhint %} ### ALLOWLOCAL The ALLOWLOCAL option controls where SPAD.neXt will search for device configuration files/images etc. before checking the database.\ \&#xNAN;*Documents* refers to the Documents-Directory from SPAD.neXt configuration. Default: "Documents/SPAD.neXt"-Folder of Windows user SPAD.neXt will search for files/images in the following order
Value = 0 (default) SPAD.neXt will not search for any local files and will always use 1. Internal database 2. Device provided data Value = 1 1. *Documents*/devices/local/\/\/ 2. Internal database 3. Device provided data Value = 2 **if the current SPAD.neXt user is the author of the device, else it will behave like 0** 1. *Documents*/devices/\/\/\/ 2. *Documents*/devices/local/\/\/ 3. Internal database 4. Device provided data {% hint style="info" %} if no local configuration exists (or is not allowed), the device sent-configuration will be used always.\ if a local configuration exists (and is allowed) it will always overwrite any device sent configuration! {% endhint %} ### VID The VID (or Vendor ID) defines the **author** of a device uniquely in a similar manor to USB devices. The VID cannot be chosen freely, but has to be requested by opening a ticket, to prevent duplicates. The VID is provided and set automatically by SPAD.neXt once it has been assigned. ### PID The PID (or Product ID) defines a **device** uniquely in a similar manor to USB devices. The PID can be choosen freely and should be unique per device(type) as it will be also used to find the corresponding device profile within a SPAD.neXt profile. {% hint style="warning" %} The PID will be used in SPAD.neXt all over the place (e.g. Variable names), so **keep it short and simpl**e. The only allowed characters for the PID are A-Z,0-9 (no spaces, no special chars) {% endhint %} ### SERIAL If provided the serial number of the device (unique per device connected!) to identify device variables (ADD Command). If not provided or a duplicate is found, SPAD.neXt will use an internal unique identifier ## **Device variables** if PID is defined for a device, all its inputs will be available as LOCAL variables within SPAD.neXt as\ `LOCAL:__[suffix]`\ \[suffix] will only be present if more than one identical device is connected #### Examples `LOCAL:SHAKEPRINT_ECHO_BUTTON1`\ `LOCAL:C0NNEX_FCU_I_AP1`\ `LOCAL:C0NNEX_FCU_I_AP1_2` (second FCU device) ## **INIT Examples** Request from SPAD.neXt:\ `0,INIT,2,0.9.10.0,73993732632;`\ Reply from device:\ `0,SPAD,{A8AA15C5-7BB6-4AC6-A558-A88CAFB78729},Altimeter Display,2,1.0;`\ (No one will be able to locally modify the device configuration) Request from SPAD.neXt:\ `0,INIT,2,0.9.10.0,73993732632;`\ Reply from device:\ `0,SPAD,{A8AA15C5-7BB6-4AC6-A558-A88CAFB78729},Demo,2,1.0,AUTHOR=a3dhfc4323dca,PID=Echo`\ The user associated with authorkey a3dhfc4323dca will be able to edit the device configuration. SPAD.neXT will frist search in `Documents/SPAD.neXt/devices/a3dhfc4323dca/shakeprint/echo` for local configurations --- # 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.spadnext.com/extending-and-apis/serial-connection/device-communication-flow/device-init-phase.md?ask= ``` 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.