Variable MetaValueSchemaConst
MetaValueSchema: TObject<
{
description: TOptional<TString>;
displayName: TOptional<TString>;
displayScale: TOptional<TObject<{ lower: TNumber; upper: TNumber }>>;
displayUnits: TOptional<
TUnion<
[
TObject<
{
category: TString;
displayFormat: TOptional<TString>;
targetUnit: TOptional<TString>;
},
>,
TObject<
{
category: TString;
displayFormat: TOptional<TString>;
formula: TString;
inverseFormula: TString;
symbol: TString;
targetUnit: TString;
},
>,
],
>,
>;
example: TOptional<TString>;
supportsPut: TOptional<TBoolean>;
timeout: TOptional<TUnion<[TNumber, TLiteral<"auto">]>>;
units: TOptional<TString>;
updateContract: TOptional<
TUnion<[TLiteral<"periodic">, TLiteral<"event">]>,
>;
zones: TOptional<
TArray<
TObject<
{
lower: TOptional<TNumber>;
message: TString;
state: TUnion<
[
TLiteral<"nominal">,
TLiteral<"normal">,
TLiteral<"alert">,
TLiteral<"warn">,
TLiteral<"alarm">,
TLiteral<"emergency">,
],
>;
upper: TOptional<TNumber>;
},
>,
>,
>;
},
> = ...
Metadata payload for a Signal K path. Contains display hints, units, timeout, and alarm zones.