value.ospp

Value property

type	object
properties
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
isTemplateGeneratedByOspComposer	If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.
	type	boolean
name	The name of the value used for logging
	type	string
description
type	The type of the value
	type	string
	enum	BOOLEAN, INTEGER, DECIMAL, TEXT
preTransform	The transformation to apply to the value. This is applied before the smooth, pulse, and delay. If the transform map multiple data to one, it will not generate a value for each change of the source. The reset value of a pulse will not be transformed. The “PULSE_ON_READ”, “PULSE_ON_CHANGE” and “ignoreReset” will be applied to the transformed value.
	TransformConfigurationEntity
delay	Delay to wait before forwarding the value when it changes
	DurationConfigurationEntity
pulse	Pulse of the value (i.e. the duration for holding the value before resetting it)
	PulseConfigurationEntity(Object)
smooth	Delay after which the value is considered stable and produced
	DurationConfigurationEntity
postTransform	The transformation to apply to the value. This is applied after the smooth, pulse, and delay. If the transform map multiple data to one, it will generate a value for each change of the source. The reset value of a pulse will be transformed. The “PULSE_ON_READ”, “PULSE_ON_CHANGE” and “ignoreReset” will be applied to the original data.
	TransformConfigurationEntity
retention	Retention of the value content (i.e. STEADY for states, FIRE_AND_FORGET for events)
	type	string
	enum	STEADY, FIRE_AND_FORGET
	default	STEADY
markdownDescription
additionalProperties	False

TransformConfigurationEntity

type	object
properties
transform	The transformation to apply to the value
	type	string
transformType	The new type of the value after the transformation
	type	string
	enum	BOOLEAN, INTEGER, DECIMAL, TEXT
additionalProperties	False

DurationConfigurationEntity

type	object
properties
value	The amount of time expressed with the unit
	type	integer
unit	The unit of time expressed with the value
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
additionalProperties	False

PulseConfigurationEntity(Object)

type	object
properties
duration	Duration of the pulse (i.e. duration for holding the value before resetting it)
	DurationConfigurationEntity
reset	The reset value after the pulse delay is expired
type	The type of the value (i.e. pulse when value changes or every time the value is updated)
	type	string
	enum	PULSE_ON_READ, PULSE_ON_CHANGE
	default	PULSE_ON_CHANGE
ignoreReset	If the pulse should ignore its reset value (i.e. if the pulse should wait for its duration before resetting when the value changes to its reset value)
	type	boolean
	default	False
additionalProperties	False