Device
Class describing the supported properties and methods for a Nix device.
Properties
Current battery level for this device (0 - 100), or null if not available. The value is valid only after a connection has successfully been opened.
External power connection state for this device. The value is valid only after a connection has successfully been opened.
Flag to indicate if in-field calibration is recommended for this device at this time (if supported). This value is only valid after opening a connection and is a function of both time and ambient temperature. This value also updates each time a measurement is completed.
Flag to indicate if in-field calibration results are applied (true) or bypassed (false) when evaluating the final calibrated measurement result. Value is true by default if supported by the device. It is recommended to leave this set to true if supported.
Maximum Delta E threshold used when performing in-field calibration (if supported), or NaN if the device does not support this operation. It is recommended to leave this set to its default value, which can vary by device type. If a difference from the reference greater than this value is detected during runFieldCalibration, the command will fail with status CommandStatus.ERROR_SCAN_DELTA.
Firmware version of this device. The value is valid only after a connection has successfully been opened.
Flag to indicate if device haptic feedback is enabled.
Hardware version of this device. The value is valid only after a connection has successfully been opened.
Helper function to describe if any on-device options are available. Value is true if any one of supportsFieldCalibration, supportsTemperatureCompensation, supportsHapticFeedback, or supportsRgbFeedback is true.
Interface / connection type for this device
Flag set to true if sufficient power is available to complete a measurement, or false if a measurement will be aborted (function of external power connection and battery level).
Flag indicating if this device is capable of providing absolute density values in its IMeasurementData results. This value only indicates the hardware capability; the LicenseFeature.DENSITY_DATA feature must also be be enabled by the active license. See also LicenseManager.Shared.isFeatureEnabled.
Flag indicating if this device is capable of providing spectral values in its IMeasurementData results. This value only indicates the hardware capability; the LicenseFeature.SPECTRAL_DATA feature must also be be enabled by the active license. See also LicenseManager.Shared.isFeatureEnabled.
Date that the last in-field normalization was last performed, or null if this device does not support this feature.
Baseline temperature for this device. Corresponds to in-field normalization temperature for DeviceType.SPECTRO2 and DeviceType.MINI3, or factory temperature for others. Value is null if the device does not support this feature.
Flag to indicate if device RGB feedback is enabled.
Last known temperature of the device, corresponding to the most recently completed scan since the device was connected. Value is null if the device does not support this feature. This value is only valid if the device is connected and a measurement has completed.
Build ID for this Nix SDK binary
Serial number for this device. The value is valid only after a connection has successfully been opened.
Software version of this device. The value is valid only after a connection has successfully been opened.
Current state of this device
List of scan modes that are supported by this device. The list is valid only after a connection has successfully been opened.
List of supported reference white points for the colorimetry data available from the IMeasurementData results provided by this device.
Flag to indicate if this device supports in-field calibration using the provided reference tile.
Flag to indicate if the device supports built-in haptic feedback.
Flag to indicate if the device supports built-in RGB feedback.
Flag to indicate if this device supports automatic temperature compensation to correct for small changes in ambient temperature.
Flag to indicate if ambient temperature compensation / correction is applied (true) or bypassed (false) when evaluating the final calibrated measurement. Value is true by default if supported by the device. It is recommended to leave this set to true if supported.
Type for this device.
Functions
Compares this device instance to another (via signal strength / RSSI)
Open a connection to this Nix device. This operation is asynchronous and this method returns immediately. Status of this operation is updated via the provided OnDeviceStateChangeListener callback.
Disconnect from this Nix device, or cancel a connection attempt currently in progress.
Current battery level for this device (0 - 100), or null if not available. The value is valid only after a connection has successfully been opened.
External power connection state for this device. The value is valid only after a connection has successfully been opened.
Flag to indicate if in-field calibration is recommended for this device at this time (if supported). This value is only valid after opening a connection and is a function of both time and ambient temperature. This value also updates each time a measurement is completed.
Flag to indicate if in-field calibration results are applied (true) or bypassed (false) when evaluating the final calibrated measurement result. Value is true by default if supported by the device. It is recommended to leave this set to true if supported.
Maximum Delta E threshold used when performing in-field calibration (if supported), or NaN if the device does not support this operation. It is recommended to leave this set to its default value, which can vary by device type. If a difference from the reference greater than this value is detected during runFieldCalibration, the command will fail with status CommandStatus.ERROR_SCAN_DELTA.
Firmware version of this device. The value is valid only after a connection has successfully been opened.
Flag to indicate if device haptic feedback is enabled.
Hardware version of this device. The value is valid only after a connection has successfully been opened.
Flag set to true if sufficient power is available to complete a measurement, or false if a measurement will be aborted (function of external power connection and battery level).
Date that the last in-field normalization was last performed, or null if this device does not support this feature.
Baseline temperature for this device. Corresponds to in-field normalization temperature for DeviceType.SPECTRO2 and DeviceType.MINI3, or factory temperature for others. Value is null if the device does not support this feature.
Flag to indicate if device RGB feedback is enabled.
Lifetime scan count for this device, or null if this device does not support this feature.
Last known temperature of the device, corresponding to the most recently completed scan since the device was connected. Value is null if the device does not support this feature. This value is only valid if the device is connected and a measurement has completed.
Serial number for this device. The value is valid only after a connection has successfully been opened.
Software version of this device. The value is valid only after a connection has successfully been opened.
Current state of this device
List of scan modes that are supported by this device. The list is valid only after a connection has successfully been opened.
List of supported reference white points for the colorimetry data available from the IMeasurementData results provided by this device.
Flag to indicate if this device supports in-field calibration using the provided reference tile.
Flag to indicate if the device supports built-in haptic feedback.
Flag to indicate if the device supports built-in RGB feedback.
Flag to indicate if this device supports automatic temperature compensation to correct for small changes in ambient temperature.
Flag to indicate if ambient temperature compensation / correction is applied (true) or bypassed (false) when evaluating the final calibrated measurement. Value is true by default if supported by the device. It is recommended to leave this set to true if supported.
Type for this device.
Invalidates current field calibration date, so that fieldCalibrationDue is reported as true, if supported by the device.
Helper to check if a particular LicenseFeature is supported by this device.
Helper to check if a particular scan mode is supported by this device (i.e. - checks if the mode is present in the supportedModes list). This value is valid only after a connection has successfully been opened.
Used to check if a decoded string from the reference tile is valid. Returns null if the string is not in the expected format, false if the string is in a valid format but does not match this particular device, true if the string is valid.
Manually run a LED test routine. On devices featuring RGB feedback, this will use the RGB LEDs. On other devices, this will flash the white LEDs. This method is asynchronous and will return immediately. Status of this operation is updated via the provided OnDeviceResultListener callback.
Run a measurement for the specified scan modes, or all supported scan modes if none are specified. If unsupported modes are selected, the measurement will fail with status code CommandStatus.ERROR_NOT_SUPPORTED. This method is asynchronous and will return immediately. Status of this operation is provided by the OnDeviceResultListener callback
Helper to check if a particular reference white point is supported by the colorimetry data from this device (i.e - checks if the reference is present in the supportedReferences list`).
Start field calibration using provided reference tile, if supported. Upon executing this command, the scan of the reference tile will begin immediately. The user MUST be prompted to place the device onto the reference tile BEFORE this method is executed. This method is asynchronous and will return immediately. This command requires data from the reference tile QR code. As the format varies between different device types, the string data should be provided exactly as decoded from the QR code.
Set the value for fieldCalibrationEnabled. This method is asynchronous and will return immediately.
Maximum Delta E threshold used when performing in-field calibration (if supported), or NaN if the device does not support this operation. It is recommended to leave this set to its default value, which can vary by device type. If a difference from the reference greater than this value is detected during runFieldCalibration, the command will fail with status CommandStatus.ERROR_SCAN_DELTA.
Set the value for hapticFeedbackEnabled. This method is asynchronous and will return immediately.
Set the value for rgbFeedbackEnabled. This method is asynchronous and will return immediately.
Set the value for temperatureCompensationEnabled. This method is asynchronous and will return immediately.