HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Insight

An insight defines how display live data on control panel tiles.

Attributes

NameTypeDescription
insight_iduuid.UUIDtechnical id of the insight.
namestrName of the insight displayed on the tile.
display_precisionintnumber of decimal digits to display.
component_iduuid.UUIDtechnical id of the SolutionComponent associated.
twin_iduuid.UUIDtechnical id of the twin associated.
datapoint_iduuid.UUIDtechnical id of the datapoint associated.

Methods

add_condition()

add a condition to the conditions.

NameTypeDefaultDescription
condition
return:

clear_conditions()

remove all conditions from the insight.

remove_condition()

remove a condition at a specific index.

NameTypeDefaultDescription
indexintindex of the condition to remove.

update_condition()

update a condition at a specific index.

NameTypeDefaultDescription
indexintindex of the condition to update.
conditionnew condition value.

api_id()

return current object id on Web API format.

endpoint()

return endpoint name used to contact backend.

from_json()

load the object from a dict originating of a JSON format.

NameTypeDefaultDescription
objobject to load information from.

set_id()

specify the id_value neutrally

NameTypeDefaultDescription
id_value
return:

to_json()

transform current object into a dict that could be JSONIFY.

NameTypeDefaultDescription
targetstrNone
return: dumpable dict.