Get custom profile field metadata

GET

http://os-992244000006.local/api/v1/sensor/custom_profile/fields

GET

/api/v1/sensor/custom_profile/fields

curl http://os-992244000006.local/api/v1/sensor/custom_profile/fields

{
  "n_fields": 1,
  "max_words": 1,
  "word_width": 32,
  "max_fields_per_word": 1,
  "fields": [
    {
      "name": "string",
      "width": 1,
      "index": 1,
      "slot": 1
    }
  ],
  "data_views": [
    {
      "view_id": "string",
      "display_id": "string",
      "display_description": "string",
      "sdk_ids": [
        "string"
      ],
      "array_length": 1,
      "variants": [
        {
          "variant_id": "string",
          "display_id": "string",
          "units": "string",
          "multiplier": 1.1,
          "field_indices": [
            1
          ],
          "field_names": [
            "string"
          ],
          "widths": [
            1
          ],
          "returns": [
            {
              "name": "string",
              "hardware_field": "string",
              "index": 1,
              "width": 1,
              "slot": 1,
              "sdk_id": "string"
            }
          ],
          "computed_note": "string"
        }
      ]
    }
  ]
}

Returns pixel assembler field metadata generated from pixel_assembler_fields.json for building custom UDP lidar profiles (udp_profile_lidar: CUSTOM). Use this endpoint to discover available data views, variants, bit widths, and slot assignments.

Recommended workflow

GET /sensor/custom_profile/fields — load field metadata
GET /sensor/custom_profile/templates — list built-in UDP lidar profile names
GET /sensor/custom_profile/template/{udp_profile_lidar} — load factory field layout for a built-in profile
GET /sensor/custom_profile?source=staged — read staged custom profile
POST /sensor/custom_profile/validation — validate before staging
POST /sensor/config with target=staged — stage { udp_profile_lidar: "CUSTOM", udp_profile_lidar_custom: <cfg> }
POST /sensor/config?target=active — apply staged config and reinitialize

Returns pixel assembler field metadata generated from `pixel_assembler_fields.json` for building custom UDP lidar profiles (`udp_profile_lidar: CUSTOM`). Use this endpoint to discover available data views, variants, bit widths, and slot assignments. ### Recommended workflow 1. `GET /sensor/custom_profile/fields` — load field metadata 2. `GET /sensor/custom_profile/templates` — list built-in UDP lidar profile names 3. `GET /sensor/custom_profile/template/{udp_profile_lidar}` — load factory field layout for a built-in profile 4. `GET /sensor/custom_profile?source=staged` — read staged custom profile 5. `POST /sensor/custom_profile/validation` — validate before staging 6. `POST /sensor/config` with `target=staged` — stage `{ udp_profile_lidar: "CUSTOM", udp_profile_lidar_custom: <cfg> }` 7. `POST /sensor/config?target=active` — apply staged config and reinitialize

Response

Pixel assembler field metadata

n_fieldsinteger

max_wordsinteger

word_widthinteger

max_fields_per_wordinteger

fieldslist of objects

data_viewslist of objects

Errors

500

Internal Server Error