Skip to content
HALOWERK

Iotwerk

register frame length contract

Return declared-versus-actual frame length and trailing or missing byte counts for a supplied layout. Supplied bytes only; no device connection or command.

POST https://iot.halowerk.com/v1/register-frame-length-contract

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
hexstringYes
header_bytesintegerYes
length_offsetintegerYes
length_bytesSee schemaYes
endianSee schemaYes
length_includes_headerbooleanYes
Show full input schema
{
  "type": "object",
  "properties": {
    "hex": {
      "type": "string",
      "pattern": "^(?:[0-9a-fA-F]{2}){1,4096}$"
    },
    "header_bytes": {
      "type": "integer",
      "minimum": 1,
      "maximum": 4096
    },
    "length_offset": {
      "type": "integer",
      "minimum": 0,
      "maximum": 4095
    },
    "length_bytes": {
      "enum": [
        1,
        2,
        4
      ]
    },
    "endian": {
      "enum": [
        "be",
        "le"
      ]
    },
    "length_includes_header": {
      "type": "boolean"
    }
  },
  "required": [
    "hex",
    "header_bytes",
    "length_offset",
    "length_bytes",
    "endian",
    "length_includes_header"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "hex": "000400010203",
  "header_bytes": 2,
  "length_offset": 0,
  "length_bytes": 2,
  "endian": "be",
  "length_includes_header": false
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-18 UTC.

More endpoints in this hub

All endpoints in this hub โ†’