A datapoint reference a time-series tag stored on DB.
Attributes
| Name | Type | Description |
|---|---|---|
| datapoint_id | uuid.UUID | Unique datapoint identifier (technical id). |
| hardware_id | str | The unique datapoint logical hardware id corresponding to time-series tag name. |
| business_type | BusinessType | Business type of a datapoint defining usage. |
| name | str | Display name used in the user interface. |
| twin_id | uuid.UUID | Set parent twin id on which datapoint is attached. |
| unit_id | uuid.UUID | Unit on which the time-series is expressed (e.g. Celsius Degree). |
| category_id | uuid.UUID | Defines the Unit category (e.g Temperature). |
| description | str | Additional information to help user understand the datapoint. |
| min_value | float | Set manufacturer specification for hardware logical minimum values. |
| max_value | float | Set manufacturer specification for hardware logical maximum values. |
| frequency | int | Set frequency in milliseconds at which this data point should theoretically emit data. |
| input_mode | InputModeType | Set if time-series can or not be manually/automatically written in Wizata. |
| extra_properties | dict | Add any custom properties to your datapoints as a key/value pair dictionary. |
Methods
api_id()
formatted id of the datapoint (datapoint_id)
return: string formatted UUID of the DataPoint.
endpoint()
endpoint name used to manipulate datapoint on backend.
return: endpoint name.
from_json()
load the datapoint entity from a dictionary.
| Name | Type | Default | Description |
|---|---|---|---|
| obj | dict version of the datapoint. |
set_id()
specify the id_value neutrally
| Name | Type | Default | Description |
|---|---|---|---|
| id_value |
return:
to_json()
convert the datapoint to a dictionary compatible with JSON format.
| Name | Type | Default | Description |
|---|---|---|---|
| target | str | None |
return: dictionary representation of the datapoint object.