The Data API provides a set of functions for creating, setting and monitoring data values, searching data lists and creating and setting data control values.
Data Values
Data values are numeric integers that you can register with the Data framework so that users can monitor them in the data panel and in the Dashboard. The steps for registering a new data value are as follows:
- Register a data provider with DataRegisterDataProviderV1 or DataRegisterDataProviderV2
- Implement the appropriate DataProviderInterfaceV1 or DataProviderInterfaceV2 interface
- Register a watchable data value with DataRegisterWatchableValue
When the framework needs to perform an operation on your registered data value it will call your DataProviderInterface.
Watching Values
Due to the large number of possible registered data values, they are not watched automatically by the framework when they are registered. The user needs to enable monitoring of the value manually.
When a user wants to watch one of your registered data values, the framework will call your provider interface DataProviderWatchValue function. From that point on when your data value changes you need to call DataSetValue to inform the framework of the change.
When the user stops watching your value the framework will call DataProviderUnwatchValue at which point you should stop sending updates to the framework.
Data Lists
The Data API provides a data list lookup function, DataDoesListContain
Control Values
Control values can only hold values within a specified range and are typically used to control/display the behaviour of components via Dashboard switches/indicators. See DataRegisterControl for more information.
To register a control value:
- Register a data provider with DataRegisterDataProviderV1 or DataRegisterDataProviderV2
- Implement the appropriate DataProviderInterfaceV1 or DataProviderInterfaceV2 interface to respond to the DataProviderSetControlValue function
- Register a control value with DataRegisterControl
The framework will call the DataSetControlValue function of your registered DataProviderInterfaceV1 or DataProviderInterfaceV2 interface when the value changes.