Search
Preparing search index...
@signalk/schema-types
MetaSchema
Interface MetaSchema
Provides meta data to enable alarm and display configuration.
interface
MetaSchema
{
description
:
string
;
alarmMethod
?:
AlarmMethod
;
alertMethod
?:
AlertMethod
;
displayName
?:
string
;
displayScale
?:
ScaleToDisplay
;
emergencyMethod
?:
EmergencyMethod
;
enum
?:
PermissibleValues
;
gaugeType
?:
string
;
longName
?:
string
;
properties
?:
PropertiesForObjectValuedProperties
;
shortName
?:
string
;
timeout
?:
number
;
units
?:
string
;
warnMethod
?:
WarnMethod
;
zones
?:
ZonesSchema
;
[
k
:
string
]:
unknown
;
}
Indexable
[
k
:
string
]:
unknown
Index
Properties
description
alarm
Method?
alert
Method?
display
Name?
display
Scale?
emergency
Method?
enum?
gauge
Type?
long
Name?
properties?
short
Name?
timeout?
units?
warn
Method?
zones?
Properties
description
description
:
string
Optional
alarm
Method
alarmMethod
?:
AlarmMethod
Optional
alert
Method
alertMethod
?:
AlertMethod
Optional
display
Name
displayName
?:
string
Optional
display
Scale
displayScale
?:
ScaleToDisplay
Optional
emergency
Method
emergencyMethod
?:
EmergencyMethod
Optional
enum
enum
?:
PermissibleValues
Optional
gauge
Type
gaugeType
?:
string
Optional
long
Name
longName
?:
string
Optional
properties
properties
?:
PropertiesForObjectValuedProperties
Optional
short
Name
shortName
?:
string
Optional
timeout
timeout
?:
number
Optional
units
units
?:
string
Optional
warn
Method
warnMethod
?:
WarnMethod
Optional
zones
zones
?:
ZonesSchema
On This Page
Properties
description
alarm
Method
alert
Method
display
Name
display
Scale
emergency
Method
enum
gauge
Type
long
Name
properties
short
Name
timeout
units
warn
Method
zones
Signal K
Loading...
Provides meta data to enable alarm and display configuration.