FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kAnalogOut_SetCalibration ( kAnalogOut  analog,
kArray2  calibration 
)

Sets (or clears) calibration information.

The calibration table provides a mapping between nominal current and calibrated current. The table should have the following properties:

  • kArray2<k64f>
  • First column represents nominal current.
  • Second column represents calibrated current.
  • At least two rows with unique nominal/calibrated current values.

Calibration is optional and can be cleared by calling this function with a null calibration object. If calibration is not provided, output will governed by the nominal device calibration model (e.g., 0 - 22 mA, mapped directly to DAC codes).

Calibration is transient (will not be saved to storage). Reapply calibration as needed after reset.

This method will automatically apply any outstanding configuration changes before sending calibration data to the node.

Parameters
analogAnalog output object.
calibrationCalibration table (kArray2<k64f>), or null to clear calibration.
Returns
Operation status.