Skip to content
Pi

Identification Packet

Added on v1.0.0
TCP
HTTP

Defines the identification packet for the Layrz Protocol, designed to be the first packet to be send by the client to the server (After authentication if is TCP mode). This packet contains information about the firmware version, device model, and other metadata that helps the server to identify the client.

Example Usage

<Pi>IMEI;FIRMWARE_ID;FIRMWARE_BUILD;DEVICE_ID;HARDWARE_ID;MODEL_ID;FIRMWARE_BRANCH;FOTA_ENABLED;CRC16</Pi>
ParameterTypeDescriptionExample
IMEIstringUnique identifier of the device.123456789012345
FIRMWARE_IDstringFirmware identifier of the device.com.layrz.hubone20
FIRMWARE_BUILDintegerFirmware build number.3
DEVICE_IDintegerInternal ID of the device.1
HARDWARE_IDintegerInternal Hardware ID.1
MODEL_IDintegerHardware version of the device. Send 0 if you don't know this value.1
FIRMWARE_BRANCHintegerBranch of the firmware. Use 0 to stable and 1 to development.0
FOTA_ENABLEDintegerRefers to the FOTA (Firmware Over The Air) feature. Use 1 to enabled and 0 to disabled.1
CRC16integerCyclic Redundancy Check for error checking.1234