Skip to main content

CompiledCustomField

A validated field spec with every default resolved.

Kind: Interface
Package: @ovok/native

Import​

import { CompiledCustomField } from '@ovok/native/bt-management';

TypeScript shape​

interface CompiledCustomField {
    name: string;
    byteIndexes: number[];
    encoding: CustomFieldEncoding;
    scale: number;
    offset: number;
    decimals?: number;
    unit: string;
    min: number;
    max: number;
}

This is a type-level export; it has no call parameters.

Public members​

MemberTypeDetails
namestring—
byteIndexesnumber[]Already reordered for the declared byte order.
encodingCustomFieldEncoding—
scalenumber—
offsetnumber—
decimalsnumberOptional. —
unitstring—
minnumberHard accepted range. A decoded value outside it is an error, never a reading.
maxnumber—

Learn the workflow​

Continue with Bluetooth for the workflow context and examples.

Source​

View the declaration in the SDK source.