Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Added updates according with #5432 #5433

Merged
merged 2 commits into from
Oct 14, 2024
Merged

docs: Added updates according with #5432 #5433

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27a7a62
Added updates according with #5432
salvatore-coppola Oct 11, 2024
27ac0ba
added a note on long size.
salvatore-coppola Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/connect-field-devices/asset-implemetation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,16 @@ Once defined the Channels in an Asset, a simple Java application that leverages
- **enabled**: each channel can be separately enabled using this flag.
- **name**: unique user-friendly name for a channel
- **type**: represents the type of operation supported. Possible values are: _READ_, _WRITE_, _READ/WRITE_
- **value.type**: represents the data type that will be used when creating the Wire Envelope for the connected components.

- **value.type**: represents the data type that will be used when creating the Wire Envelope for the connected components and the output value for _READ_ channel.
- **scale**: an optional scaling factor to be applied only to the numeric values retrieved from the field. It is parsed as a double. See below for more details.
- **offset**: an optional offset value that will be added only to the numeric values retrieved from the field. It is parsed as a double. See below for more details.
- **scaleoffset.type**: Allows to customise the way scale and offset is applied. See below for more details.
- **unit**: an optional string value that will be added to the asset channel read to represent the unit of measure associated to that specific channel.
- **listen**: if supported by the associated driver, allows to receive notifications by the driver on events. This flag currently has effect only inside Kura Wires.

For the _READ_ and _READ/WRITE_ channels, the Asset typically asks the driver to provide a value based on the **value.type**.
If the **scaleoffset.type** is _LONG_ or _DOUBLE_, the type requested will be one of these and the final value (after the scale and offset operation) will be transformed into the data type expected by **value.type**.
salvatore-coppola marked this conversation as resolved.
Show resolved Hide resolved

### Arithmetic with scale and offset
The Asset supports applying a scale and offset to the values obtained by the attached Driver during read operations and to the values received in listen mode.

Expand All @@ -64,7 +66,7 @@ The values of the **scale** and **offset** parameters are parsed from channel co

The **mode** can be selected in the following way:

- If the **scaleoffset.type** is set to `DOUBLE` the corrisponding **mode** will be used.
- If the **scaleoffset.type** is set to `DOUBLE` or `LONG` the corrisponding **mode** will be used. The largest representable `LONG` is 2^53
- If the **scaleoffset.type** value is `DEFINED_BY_VALUE_TYPE` the operation **mode** is determinated by **value.type**.

Example of `DOUBLE` **mode**:
Expand Down
Loading