Class: VirtualDevice

This VirtualDevice API is specific to the device client. This implements the alerts defined in the device model and can be used for raising alerts to be sent to the server for the device. Also it has action handlers for actions that come as requests from the server side.

A device model can be obtained by it's afferent urn with the DirectlyConnectedDevice if it is registered on the cloud.

The VirtualDevice has the attributes, actions and alerts of the device model as properties and it provides functionality to the device model in the following ways:

Get the value of an attribute:
let value = device.temperature.value;

Get the last known value of an attribute:
let lastValue = device.temperature.lastKnownValue;

Set the value of an attribute (with update on cloud and error callback handling):
device.temperature.onError = function (errorTuple);
device.temperature.value = 27;
where errorTuple is an object of the form {attribute: ... , newValue: ... , tryValue: ... , errorResponse: ...}. The library will throw an error in the value to update is invalid according to the device model.

Monitor a specific attribute for any value change (that comes from the cloud):
device.maxThreshold.onChange = function (changeTuple);
where changeTuple is an object of the form {attribute: ... , newValue: ... , oldValue: ...}. To tell the cloud that the attribute update has failed an error must be thrown in the onChange function, otherwise the library will send an OK response message to the cloud.

Monitor a specific action that was requested from the server:
device.reset.onAction = function (value);
where value is an optional parameter given if the action has parameters defined in the device model. To tell the cloud that an action has failed an error must be thrown in the onAction function, otherwise the library will send an OK response message to the cloud.

Monitor all attributes for any value change (that comes from the cloud):
device.onChange = function (changeTuple);
where changeTuple is an object with array type properties of the form [{attribute: ... , newValue: ... , oldValue: ...}]. To tell the cloud that the attribute update has failed an error must be thrown in the onChange function, otherwise the library will send an OK response message to the cloud.

Monitor all update errors:
device.onError = function (errorTuple);
where errorTuple is an object with array type properties (besides errorResponse) of the form {attributes: ... , newValues: ... , tryValues: ... , errorResponse: ...}.

Raising alerts:
let alert = device.createAlert('urn:com:oracle:iot:device:temperature_sensor:too_hot');
alert.fields.temp = 100;
alert.fields.maxThreshold = 90;
alert.raise();
If an alert was not sent the error is handled by the device.onError handler where errorTuple has the following structure:
{attributes: ... , errorResponse: ...}
where attributes are the alerts that failed with fields already set, so the alert can be retried only by raising them.

Sending custom data fields:
let data = device.createData('urn:com:oracle:iot:device:motion_sensor:rfid_detected');
data.fields.detecting_motion = true;
data.submit();
If the custom data fields were not sent, the error is handled by the device.onError handler where errorTuple has the following structure:
{attributes: ... , errorResponse: ...}
where attributes are the Data objects that failed to be sent with fields already set, so the Data objects can be retried only by sending them.

A VirtualDevice can also be created with the appropriate parameters from the DirectlyConnectedDevice.