Skip to content
HALOWERK

Iotwerk

register mapped field decode

Return scaled engineering values from explicitly declared fields in a supplied binary register buffer. Supplied bytes only; no device connection or command.

POST https://iot.halowerk.com/v1/register-mapped-field-decode

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
hexstringYes
fieldsarrayYes
Show full input schema
{
  "type": "object",
  "properties": {
    "hex": {
      "type": "string",
      "pattern": "^(?:[0-9a-fA-F]{2}){1,4096}$"
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1
          },
          "offset": {
            "type": "integer",
            "minimum": 0,
            "maximum": 4095
          },
          "bytes": {
            "enum": [
              1,
              2,
              4
            ]
          },
          "endian": {
            "enum": [
              "be",
              "le"
            ]
          },
          "signed": {
            "type": "boolean"
          },
          "scale": {
            "type": "number",
            "minimum": -10,
            "maximum": 10
          },
          "bias": {
            "type": "number",
            "minimum": -1000000000,
            "maximum": 1000000000
          }
        },
        "required": [
          "name",
          "offset",
          "bytes",
          "endian",
          "signed",
          "scale",
          "bias"
        ],
        "additionalProperties": false
      },
      "maxItems": 30,
      "minItems": 1
    }
  },
  "required": [
    "hex",
    "fields"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "hex": "0064fff6",
  "fields": [
    {
      "name": "temperature_c",
      "offset": 0,
      "bytes": 2,
      "endian": "be",
      "signed": false,
      "scale": 0.1,
      "bias": 0
    },
    {
      "name": "offset_c",
      "offset": 2,
      "bytes": 2,
      "endian": "be",
      "signed": true,
      "scale": 1,
      "bias": 0
    }
  ]
}

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 โ†’