inputs
object, contains the values of the specified variablesstate
object, contains the user defined rule statetype
string, indicates how the rule was invoked (either timer
or uplink
)dataSources
object, see data source propertiesdevice
object, see device propertiesproperties
object, contains the user defined properties of the custom logic blocktype
has the value of timer
certain properties will behave differently:inputs
object will be nulldataSources
will be an empty objectdevice
will be undefineddevice.
is always required in order to access sub properties.name
the device namedescription
the device descriptionintegrationId
the integrationId of the device (only for LoRaWAN devices)workspaceId
the workspaceId of the devicedataFlowId
the data flow id of the deviceconnectivity
the connectivity of the deviceid
the akenza device iddeviceId
the unique device iddataSources.X
where X
is the number of the data source as specified in the rule (starting at 1).correlationId
or the device
) if e.g. the rule was triggered by a timer event or the data source is set to access the last sample.dataSources.X.
is always required in order to access sub properties.correlationId
the correlation id of the data source (only available if the data source was triggering the flow)device
the complete device object. See Device Properties for sub propertiesdeviceId
the unique device idakenzaDeviceId
the akenza device idtopic
the topic of the sampletimestamp
the timestamp of the sampledata.*
access any values of the sample.meta.*
access any values of the meta objectuplinkMeta
the complete uplink meta objecttrigger
boolean, indicates whether the data source has triggered the uplinkdeviceInput
boolean, indicates if the data source is a devicetagInput
boolean, indicates if the data source is a tagcorrelationId
, topic
, timestamp
, data
, meta
and uplinkMeta
) are resolved based on which data source triggered the rule evalution. If the data source is triggering (trigger = true
) the rule, the values will be the one from the triggering uplink. Otherwise the values will correlate the most recent stored sample.uplinkMeta.
is always required in order to access sub properties.dataReceived
the ISO-8601 timestamp when the data was recievedbytesReceived
the number of bytes received in the uplink requestprocessingStart
the ISO-8601 timestamp when the processing was startedscriptRunUplinkStart
the ISO-8601 timestamp when script run was startedscriptRunUplinkEnd
the ISO-8601 timestamp when script run endedprocessingEnd
the ISO-8601 timestamp when the processing endedoutputProduced
the ISO-8601 timestamp when all output were produceduplinkDuration
the ISO-8601 duration of the whole uplink flowprocessingDuration
the IOS-8601 duration of the processingscriptRunningDuration
the ISO-8601 duration of the script run