YSpectralSensor (Yoctopuce Java EE API 2.0.64286-SNAPSHOT API)

java.lang.Object
- com.yoctopuce.YoctoAPI.YFunction
- - com.yoctopuce.YoctoAPI.YSpectralSensor

```
public class YSpectralSensor
extends YFunction
```
YSpectralSensor Class: spectral sensor control interface The YSpectralSensor class allows you to read and configure Yoctopuce spectral sensors. It inherits from YSensor class the core functions to read measurements, to register callback functions, and to access the autonomous datalogger.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`YSpectralSensor.TimedReportCallback` TimedReportCallback for SpectralSensor
`static interface`	`YSpectralSensor.UpdateCallback` Deprecated UpdateCallback for SpectralSensor

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`_estimatedHSL`
`protected String`	`_estimatedOkLab`
`protected int`	`_estimatedRGB`
`protected String`	`_estimatedXYZ`
`protected int`	`_estimationModel`
`protected int`	`_gain`
`protected int`	`_gainAtPowerOn`
`protected int`	`_integrationTime`
`protected int`	`_integrationTimeAtPowerOn`
`protected int`	`_ledCurrent`
`protected int`	`_ledCurrentAtPowerOn`
`protected String`	`_nearHTMLColor`
`protected String`	`_nearRAL1`
`protected String`	`_nearRAL2`
`protected String`	`_nearRAL3`
`protected String`	`_nearSimpleColor`
`protected double`	`_resolution`
`protected int`	`_saturation`
`protected YSpectralSensor.UpdateCallback`	`_valueCallbackSpectralSensor`
`static int`	`ESTIMATEDHSL_INVALID` invalid estimatedHSL value
`static String`	`ESTIMATEDOKLAB_INVALID` invalid estimatedOkLab value
`static int`	`ESTIMATEDRGB_INVALID` invalid estimatedRGB value
`static String`	`ESTIMATEDXYZ_INVALID` invalid estimatedXYZ value
`static int`	`ESTIMATIONMODEL_EMISSION`
`static int`	`ESTIMATIONMODEL_INVALID`
`static int`	`ESTIMATIONMODEL_REFLECTION` invalid estimationModel value
`static int`	`GAIN_INVALID` invalid gain value
`static int`	`GAINATPOWERON_INVALID` invalid gainAtPowerOn value
`static int`	`INTEGRATIONTIME_INVALID` invalid integrationTime value
`static int`	`INTEGRATIONTIMEATPOWERON_INVALID` invalid integrationTimeAtPowerOn value
`static int`	`LEDCURRENT_INVALID` invalid ledCurrent value
`static int`	`LEDCURRENTATPOWERON_INVALID` invalid ledCurrentAtPowerOn value
`static String`	`NEARHTMLCOLOR_INVALID` invalid nearHTMLColor value
`static String`	`NEARRAL1_INVALID` invalid nearRAL1 value
`static String`	`NEARRAL2_INVALID` invalid nearRAL2 value
`static String`	`NEARRAL3_INVALID` invalid nearRAL3 value
`static String`	`NEARSIMPLECOLOR_INVALID` invalid nearSimpleColor value
`static double`	`RESOLUTION_INVALID` invalid resolution value
`static int`	`SATURATION_INVALID` invalid saturation value

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction
_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, _yapi, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID

Constructor Summary

Constructors
Modifier Constructor and Description

protected YSpectralSensor(String func)

protected YSpectralSensor(YAPIContext ctx, String func)

Constructors
Modifier	Constructor and Description
`protected`	`YSpectralSensor(String func)`
`protected`	`YSpectralSensor(YAPIContext ctx, String func)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`_invokeValueCallback(String value)`
`protected void`	`_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)`
`static YSpectralSensor`	`FindSpectralSensor(String func)` Retrieves a spectral sensor for a given identifier.
`static YSpectralSensor`	`FindSpectralSensorInContext(YAPIContext yctx, String func)` Retrieves a spectral sensor for a given identifier in a YAPI context.
`static YSpectralSensor`	`FirstSpectralSensor()` Starts the enumeration of spectral sensors currently accessible.
`static YSpectralSensor`	`FirstSpectralSensorInContext(YAPIContext yctx)` Starts the enumeration of spectral sensors currently accessible.
`int`	`get_estimatedHSL()` Returns the estimated color in HSL (Hue, Saturation, Lightness) format.
`String`	`get_estimatedOkLab()` Returns the estimated color in OkLab format.
`int`	`get_estimatedRGB()` Returns the estimated color in RGB format (0xRRGGBB).
`String`	`get_estimatedXYZ()` Returns the estimated color in XYZ format.
`int`	`get_estimationModel()` Returns the model for color estimation.
`int`	`get_gain()` Retrieves the current gain.
`int`	`get_gainAtPowerOn()`
`int`	`get_integrationTime()` Returns the current integration time.
`int`	`get_integrationTimeAtPowerOn()`
`int`	`get_ledCurrent()` Returns the current value of the LED.
`int`	`get_ledCurrentAtPowerOn()`
`String`	`get_nearHTMLColor()`
`String`	`get_nearRAL1()`
`String`	`get_nearRAL2()`
`String`	`get_nearRAL3()`
`String`	`get_nearSimpleColor()` Returns the estimated color.
`double`	`get_resolution()` Returns the resolution of the measured values.
`int`	`get_saturation()` Returns the current saturation of the sensor.
`int`	`getEstimatedHSL()` Returns the estimated color in HSL (Hue, Saturation, Lightness) format.
`String`	`getEstimatedOkLab()` Returns the estimated color in OkLab format.
`int`	`getEstimatedRGB()` Returns the estimated color in RGB format (0xRRGGBB).
`String`	`getEstimatedXYZ()` Returns the estimated color in XYZ format.
`int`	`getEstimationModel()` Returns the model for color estimation.
`int`	`getGain()` Retrieves the current gain.
`int`	`getIntegrationTime()` Returns the current integration time.
`int`	`getLedCurrent()` Returns the current value of the LED.
`String`	`getNearSimpleColor()` Returns the estimated color.
`double`	`getResolution()` Returns the resolution of the measured values.
`int`	`getSaturation()` Returns the current saturation of the sensor.
`YSpectralSensor`	`nextSpectralSensor()` Continues the enumeration of spectral sensors started using yFirstSpectralSensor().
`int`	`registerValueCallback(YSpectralSensor.UpdateCallback callback)` Registers the callback function that is invoked on every change of advertised value.
`int`	`set_estimationModel(int newval)` Changes the model for color estimation.
`int`	`set_gain(int newval)` Sets the gain for signal processing.
`int`	`set_gainAtPowerOn(int newval)` Sets the gain at power-on.
`int`	`set_integrationTime(int newval)` Sets the integration time for data processing.
`int`	`set_integrationTimeAtPowerOn(int newval)` Sets the integration time at power-on.
`int`	`set_ledCurrent(int newval)` Changes the luminosity of the module leds.
`int`	`set_ledCurrentAtPowerOn(int newval)` Sets the LED current at power-on.
`int`	`set_resolution(double newval)` Changes the resolution of the measured physical values.
`int`	`setEstimationModel(int newval)` Changes the model for color estimation.
`int`	`setGain(int newval)` Sets the gain for signal processing.
`int`	`setGainAtPowerOn(int newval)` Sets the gain at power-on.
`int`	`setIntegrationTime(int newval)` Sets the integration time for data processing.
`int`	`setIntegrationTimeAtPowerOn(int newval)` Sets the integration time at power-on.
`int`	`setLedCurrent(int newval)` Changes the luminosity of the module leds.
`int`	`setLedCurrentAtPowerOn(int newval)` Sets the LED current at power-on.
`int`	`setResolution(double newval)` Changes the resolution of the measured physical values.

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction
_AddToCache, _clearDataStreamCache, _decode_json_int, _decode_json_string, _download, _escapeAttr, _FindFromCache, _FindFromCacheInContext, _get_json_path_struct, _get_json_path, _json_get_array, _json_get_key, _json_get_string, _parse, _parserHelper, _setAttr, _throw, _UpdateTimedReportCallbackList, _UpdateValueCallbackList, _upload, _upload, _uploadEx, clearCache, describe, errMessage, errorMessage, errorType, errType, FindFunction, FindFunctionInContext, FirstFunction, FirstFunctionInContext, functionDescriptor, get_advertisedValue, get_errorMessage, get_errorType, get_friendlyName, get_functionDescriptor, get_functionId, get_hardwareId, get_logicalName, get_module, get_serialNumber, get_userData, getAdvertisedValue, getErrorMessage, getErrorType, getFriendlyName, getFunctionDescriptor, getFunctionId, getHardwareId, getLogicalName, getModule, getUserData, isOnline, isReadOnly, load, loadAttribute, module, muteValueCallbacks, nextFunction, registerValueCallback, set_advertisedValue, set_logicalName, set_userData, setLogicalName, setUserData, toString, unmuteValueCallbacks, userData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LEDCURRENT_INVALID
```
public static final int LEDCURRENT_INVALID
```
    invalid ledCurrent value
    
    See Also:
    
    Constant Field Values
  - RESOLUTION_INVALID
```
public static final double RESOLUTION_INVALID
```
    invalid resolution value
    
    See Also:
    
    Constant Field Values
  - INTEGRATIONTIME_INVALID
```
public static final int INTEGRATIONTIME_INVALID
```
    invalid integrationTime value
    
    See Also:
    
    Constant Field Values
  - GAIN_INVALID
```
public static final int GAIN_INVALID
```
    invalid gain value
    
    See Also:
    
    Constant Field Values
  - ESTIMATIONMODEL_REFLECTION
```
public static final int ESTIMATIONMODEL_REFLECTION
```
    invalid estimationModel value
    
    See Also:
    
    Constant Field Values
  - ESTIMATIONMODEL_EMISSION
```
public static final int ESTIMATIONMODEL_EMISSION
```
    See Also:
    
    Constant Field Values
  - ESTIMATIONMODEL_INVALID
```
public static final int ESTIMATIONMODEL_INVALID
```
    See Also:
    
    Constant Field Values
  - SATURATION_INVALID
```
public static final int SATURATION_INVALID
```
    invalid saturation value
    
    See Also:
    
    Constant Field Values
  - ESTIMATEDRGB_INVALID
```
public static final int ESTIMATEDRGB_INVALID
```
    invalid estimatedRGB value
    
    See Also:
    
    Constant Field Values
  - ESTIMATEDHSL_INVALID
```
public static final int ESTIMATEDHSL_INVALID
```
    invalid estimatedHSL value
    
    See Also:
    
    Constant Field Values
  - ESTIMATEDXYZ_INVALID
```
public static final String ESTIMATEDXYZ_INVALID
```
    invalid estimatedXYZ value
    
    See Also:
    
    Constant Field Values
  - ESTIMATEDOKLAB_INVALID
```
public static final String ESTIMATEDOKLAB_INVALID
```
    invalid estimatedOkLab value
    
    See Also:
    
    Constant Field Values
  - NEARRAL1_INVALID
```
public static final String NEARRAL1_INVALID
```
    invalid nearRAL1 value
    
    See Also:
    
    Constant Field Values
  - NEARRAL2_INVALID
```
public static final String NEARRAL2_INVALID
```
    invalid nearRAL2 value
    
    See Also:
    
    Constant Field Values
  - NEARRAL3_INVALID
```
public static final String NEARRAL3_INVALID
```
    invalid nearRAL3 value
    
    See Also:
    
    Constant Field Values
  - NEARHTMLCOLOR_INVALID
```
public static final String NEARHTMLCOLOR_INVALID
```
    invalid nearHTMLColor value
    
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLOR_INVALID
```
public static final String NEARSIMPLECOLOR_INVALID
```
    invalid nearSimpleColor value
    
    See Also:
    
    Constant Field Values
  - LEDCURRENTATPOWERON_INVALID
```
public static final int LEDCURRENTATPOWERON_INVALID
```
    invalid ledCurrentAtPowerOn value
    
    See Also:
    
    Constant Field Values
  - INTEGRATIONTIMEATPOWERON_INVALID
```
public static final int INTEGRATIONTIMEATPOWERON_INVALID
```
    invalid integrationTimeAtPowerOn value
    
    See Also:
    
    Constant Field Values
  - GAINATPOWERON_INVALID
```
public static final int GAINATPOWERON_INVALID
```
    invalid gainAtPowerOn value
    
    See Also:
    
    Constant Field Values
  - _ledCurrent
```
protected int _ledCurrent
```
  - _resolution
```
protected double _resolution
```
  - _integrationTime
```
protected int _integrationTime
```
  - _gain
```
protected int _gain
```
  - _estimationModel
```
protected int _estimationModel
```
  - _saturation
```
protected int _saturation
```
  - _estimatedRGB
```
protected int _estimatedRGB
```
  - _estimatedHSL
```
protected int _estimatedHSL
```
  - _estimatedXYZ
```
protected String _estimatedXYZ
```
  - _estimatedOkLab
```
protected String _estimatedOkLab
```
  - _nearRAL1
```
protected String _nearRAL1
```
  - _nearRAL2
```
protected String _nearRAL2
```
  - _nearRAL3
```
protected String _nearRAL3
```
  - _nearHTMLColor
```
protected String _nearHTMLColor
```
  - _nearSimpleColor
```
protected String _nearSimpleColor
```
  - _ledCurrentAtPowerOn
```
protected int _ledCurrentAtPowerOn
```
  - _integrationTimeAtPowerOn
```
protected int _integrationTimeAtPowerOn
```
  - _gainAtPowerOn
```
protected int _gainAtPowerOn
```
  - _valueCallbackSpectralSensor
```
protected YSpectralSensor.UpdateCallback _valueCallbackSpectralSensor
```
- Constructor Detail
  - YSpectralSensor
```
protected YSpectralSensor(YAPIContext ctx,
                          String func)
```
    Parameters:
    
    func - : functionid
  - YSpectralSensor
```
protected YSpectralSensor(String func)
```
    Parameters:
    
    func - : functionid
- Method Detail
  - _parseAttr
```
protected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
                   throws Exception
```
    Overrides:
    
    _parseAttr in class YFunction
    
    Throws:
    
    Exception
  - get_ledCurrent
```
public int get_ledCurrent()
                   throws YAPI_Exception
```
    Returns the current value of the LED. This method retrieves the current flowing through the LED and returns it as an integer or an object.
    
    Returns:
    
    an integer corresponding to the current value of the LED
    
    Throws:
    
    YAPI_Exception - on error
  - getLedCurrent
```
public int getLedCurrent()
                  throws YAPI_Exception
```
    Returns the current value of the LED. This method retrieves the current flowing through the LED and returns it as an integer or an object.
    
    Returns:
    
    an integer corresponding to the current value of the LED
    
    Throws:
    
    YAPI_Exception - on error
  - set_ledCurrent
```
public int set_ledCurrent(int newval)
                   throws YAPI_Exception
```
    Changes the luminosity of the module leds. The parameter is a value between 0 and 254.
    
    Parameters:
    
    newval - : an integer corresponding to the luminosity of the module leds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setLedCurrent
```
public int setLedCurrent(int newval)
                  throws YAPI_Exception
```
    Changes the luminosity of the module leds. The parameter is a value between 0 and 254.
    
    Parameters:
    
    newval - : an integer corresponding to the luminosity of the module leds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - set_resolution
```
public int set_resolution(double newval)
                   throws YAPI_Exception
```
    Changes the resolution of the measured physical values. The resolution corresponds to the numerical precision when displaying value. It does not change the precision of the measure itself. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a floating point number corresponding to the resolution of the measured physical values
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setResolution
```
public int setResolution(double newval)
                  throws YAPI_Exception
```
    Changes the resolution of the measured physical values. The resolution corresponds to the numerical precision when displaying value. It does not change the precision of the measure itself. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a floating point number corresponding to the resolution of the measured physical values
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_resolution
```
public double get_resolution()
                      throws YAPI_Exception
```
    Returns the resolution of the measured values. The resolution corresponds to the numerical precision of the measures, which is not always the same as the actual precision of the sensor.
    
    Returns:
    
    a floating point number corresponding to the resolution of the measured values
    
    Throws:
    
    YAPI_Exception - on error
  - getResolution
```
public double getResolution()
                     throws YAPI_Exception
```
    Returns the resolution of the measured values. The resolution corresponds to the numerical precision of the measures, which is not always the same as the actual precision of the sensor.
    
    Returns:
    
    a floating point number corresponding to the resolution of the measured values
    
    Throws:
    
    YAPI_Exception - on error
  - get_integrationTime
```
public int get_integrationTime()
                        throws YAPI_Exception
```
    Returns the current integration time. This method retrieves the integration time value used for data processing and returns it as an integer or an object.
    
    Returns:
    
    an integer corresponding to the current integration time
    
    Throws:
    
    YAPI_Exception - on error
  - getIntegrationTime
```
public int getIntegrationTime()
                       throws YAPI_Exception
```
    Returns the current integration time. This method retrieves the integration time value used for data processing and returns it as an integer or an object.
    
    Returns:
    
    an integer corresponding to the current integration time
    
    Throws:
    
    YAPI_Exception - on error
  - set_integrationTime
```
public int set_integrationTime(int newval)
                        throws YAPI_Exception
```
    Sets the integration time for data processing. This method takes a parameter `val` and assigns it as the new integration time. This affects the duration for which data is integrated before being processed.
    
    Parameters:
    
    newval - : an integer
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setIntegrationTime
```
public int setIntegrationTime(int newval)
                       throws YAPI_Exception
```
    Sets the integration time for data processing. This method takes a parameter `val` and assigns it as the new integration time. This affects the duration for which data is integrated before being processed.
    
    Parameters:
    
    newval - : an integer
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_gain
```
public int get_gain()
             throws YAPI_Exception
```
    Retrieves the current gain. This method updates the gain value.
    
    Returns:
    
    an integer
    
    Throws:
    
    YAPI_Exception - on error
  - getGain
```
public int getGain()
            throws YAPI_Exception
```
    Retrieves the current gain. This method updates the gain value.
    
    Returns:
    
    an integer
    
    Throws:
    
    YAPI_Exception - on error
  - set_gain
```
public int set_gain(int newval)
             throws YAPI_Exception
```
    Sets the gain for signal processing. This method takes a parameter `val` and assigns it as the new gain. This affects the sensitivity and intensity of the processed signal.
    
    Parameters:
    
    newval - : an integer
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setGain
```
public int setGain(int newval)
            throws YAPI_Exception
```
    Sets the gain for signal processing. This method takes a parameter `val` and assigns it as the new gain. This affects the sensitivity and intensity of the processed signal.
    
    Parameters:
    
    newval - : an integer
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_estimationModel
```
public int get_estimationModel()
                        throws YAPI_Exception
```
    Returns the model for color estimation.
    
    Returns:
    
    either YSpectralSensor.ESTIMATIONMODEL_REFLECTION or YSpectralSensor.ESTIMATIONMODEL_EMISSION, according to the model for color estimation
    
    Throws:
    
    YAPI_Exception - on error
  - getEstimationModel
```
public int getEstimationModel()
                       throws YAPI_Exception
```
    Returns the model for color estimation.
    
    Returns:
    
    either YSpectralSensor.ESTIMATIONMODEL_REFLECTION or YSpectralSensor.ESTIMATIONMODEL_EMISSION, according to the model for color estimation
    
    Throws:
    
    YAPI_Exception - on error
  - set_estimationModel
```
public int set_estimationModel(int newval)
                        throws YAPI_Exception
```
    Changes the model for color estimation. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : either YSpectralSensor.ESTIMATIONMODEL_REFLECTION or YSpectralSensor.ESTIMATIONMODEL_EMISSION, according to the model for color estimation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setEstimationModel
```
public int setEstimationModel(int newval)
                       throws YAPI_Exception
```
    Changes the model for color estimation. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : either YSpectralSensor.ESTIMATIONMODEL_REFLECTION or YSpectralSensor.ESTIMATIONMODEL_EMISSION, according to the model for color estimation
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_saturation
```
public int get_saturation()
                   throws YAPI_Exception
```
    Returns the current saturation of the sensor. This function updates the sensor's saturation value.
    
    Returns:
    
    an integer corresponding to the current saturation of the sensor
    
    Throws:
    
    YAPI_Exception - on error
  - getSaturation
```
public int getSaturation()
                  throws YAPI_Exception
```
    Returns the current saturation of the sensor. This function updates the sensor's saturation value.
    
    Returns:
    
    an integer corresponding to the current saturation of the sensor
    
    Throws:
    
    YAPI_Exception - on error
  - get_estimatedRGB
```
public int get_estimatedRGB()
                     throws YAPI_Exception
```
    Returns the estimated color in RGB format (0xRRGGBB). This method retrieves the estimated color values and returns them as an RGB object or structure.
    
    Returns:
    
    an integer corresponding to the estimated color in RGB format (0xRRGGBB)
    
    Throws:
    
    YAPI_Exception - on error
  - getEstimatedRGB
```
public int getEstimatedRGB()
                    throws YAPI_Exception
```
    Returns the estimated color in RGB format (0xRRGGBB). This method retrieves the estimated color values and returns them as an RGB object or structure.
    
    Returns:
    
    an integer corresponding to the estimated color in RGB format (0xRRGGBB)
    
    Throws:
    
    YAPI_Exception - on error
  - get_estimatedHSL
```
public int get_estimatedHSL()
                     throws YAPI_Exception
```
    Returns the estimated color in HSL (Hue, Saturation, Lightness) format. This method retrieves the estimated color values and returns them as an HSL object or structure.
    
    Returns:
    
    an integer corresponding to the estimated color in HSL (Hue, Saturation, Lightness) format
    
    Throws:
    
    YAPI_Exception - on error
  - getEstimatedHSL
```
public int getEstimatedHSL()
                    throws YAPI_Exception
```
    Returns the estimated color in HSL (Hue, Saturation, Lightness) format. This method retrieves the estimated color values and returns them as an HSL object or structure.
    
    Returns:
    
    an integer corresponding to the estimated color in HSL (Hue, Saturation, Lightness) format
    
    Throws:
    
    YAPI_Exception - on error
  - get_estimatedXYZ
```
public String get_estimatedXYZ()
                        throws YAPI_Exception
```
    Returns the estimated color in XYZ format. This method retrieves the estimated color values and returns them as an XYZ object or structure.
    
    Returns:
    
    a string corresponding to the estimated color in XYZ format
    
    Throws:
    
    YAPI_Exception - on error
  - getEstimatedXYZ
```
public String getEstimatedXYZ()
                       throws YAPI_Exception
```
    Returns the estimated color in XYZ format. This method retrieves the estimated color values and returns them as an XYZ object or structure.
    
    Returns:
    
    a string corresponding to the estimated color in XYZ format
    
    Throws:
    
    YAPI_Exception - on error
  - get_estimatedOkLab
```
public String get_estimatedOkLab()
                          throws YAPI_Exception
```
    Returns the estimated color in OkLab format. This method retrieves the estimated color values and returns them as an OkLab object or structure.
    
    Returns:
    
    a string corresponding to the estimated color in OkLab format
    
    Throws:
    
    YAPI_Exception - on error
  - getEstimatedOkLab
```
public String getEstimatedOkLab()
                         throws YAPI_Exception
```
    Returns the estimated color in OkLab format. This method retrieves the estimated color values and returns them as an OkLab object or structure.
    
    Returns:
    
    a string corresponding to the estimated color in OkLab format
    
    Throws:
    
    YAPI_Exception - on error
  - get_nearRAL1
```
public String get_nearRAL1()
                    throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - get_nearRAL2
```
public String get_nearRAL2()
                    throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - get_nearRAL3
```
public String get_nearRAL3()
                    throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - get_nearHTMLColor
```
public String get_nearHTMLColor()
                         throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - get_nearSimpleColor
```
public String get_nearSimpleColor()
                           throws YAPI_Exception
```
    Returns the estimated color. This method retrieves the estimated color values and returns them as the color name.
    
    Returns:
    
    a string corresponding to the estimated color
    
    Throws:
    
    YAPI_Exception - on error
  - getNearSimpleColor
```
public String getNearSimpleColor()
                          throws YAPI_Exception
```
    Returns the estimated color. This method retrieves the estimated color values and returns them as the color name.
    
    Returns:
    
    a string corresponding to the estimated color
    
    Throws:
    
    YAPI_Exception - on error
  - get_ledCurrentAtPowerOn
```
public int get_ledCurrentAtPowerOn()
                            throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - set_ledCurrentAtPowerOn
```
public int set_ledCurrentAtPowerOn(int newval)
                            throws YAPI_Exception
```
    Sets the LED current at power-on. This method takes a parameter `val` and assigns it to startupLumin, representing the LED current defined at startup. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setLedCurrentAtPowerOn
```
public int setLedCurrentAtPowerOn(int newval)
                           throws YAPI_Exception
```
    Sets the LED current at power-on. This method takes a parameter `val` and assigns it to startupLumin, representing the LED current defined at startup. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_integrationTimeAtPowerOn
```
public int get_integrationTimeAtPowerOn()
                                 throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - set_integrationTimeAtPowerOn
```
public int set_integrationTimeAtPowerOn(int newval)
                                 throws YAPI_Exception
```
    Sets the integration time at power-on. This method takes a parameter `val` and assigns it to startupIntegTime, representing the integration time defined at startup. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setIntegrationTimeAtPowerOn
```
public int setIntegrationTimeAtPowerOn(int newval)
                                throws YAPI_Exception
```
    Sets the integration time at power-on. This method takes a parameter `val` and assigns it to startupIntegTime, representing the integration time defined at startup. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_gainAtPowerOn
```
public int get_gainAtPowerOn()
                      throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - set_gainAtPowerOn
```
public int set_gainAtPowerOn(int newval)
                      throws YAPI_Exception
```
    Sets the gain at power-on. This method takes a parameter `val` and assigns it to startupGain, representing the gain defined at startup. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setGainAtPowerOn
```
public int setGainAtPowerOn(int newval)
                     throws YAPI_Exception
```
    Sets the gain at power-on. This method takes a parameter `val` and assigns it to startupGain, representing the gain defined at startup. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - FindSpectralSensor
```
public static YSpectralSensor FindSpectralSensor(String func)
```
    Retrieves a spectral sensor for a given identifier. The identifier can be specified using several formats:
    - FunctionLogicalName
    - ModuleSerialNumber.FunctionIdentifier
    - ModuleSerialNumber.FunctionLogicalName
    - ModuleLogicalName.FunctionIdentifier
    - ModuleLogicalName.FunctionLogicalName
    This function does not require that the spectral sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YSpectralSensor.isOnline() to test if the spectral sensor is indeed online at a given time. In case of ambiguity when looking for a spectral sensor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name. If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
    Parameters:
    
    func - : a string that uniquely characterizes the spectral sensor, for instance MyDevice.spectralSensor.
    
    Returns:
    
    a YSpectralSensor object allowing you to drive the spectral sensor.
  - FindSpectralSensorInContext
```
public static YSpectralSensor FindSpectralSensorInContext(YAPIContext yctx,
                                                          String func)
```
    Retrieves a spectral sensor for a given identifier in a YAPI context. The identifier can be specified using several formats:
    - FunctionLogicalName
    - ModuleSerialNumber.FunctionIdentifier
    - ModuleSerialNumber.FunctionLogicalName
    - ModuleLogicalName.FunctionIdentifier
    - ModuleLogicalName.FunctionLogicalName
    This function does not require that the spectral sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YSpectralSensor.isOnline() to test if the spectral sensor is indeed online at a given time. In case of ambiguity when looking for a spectral sensor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
    Parameters:
    
    yctx - : a YAPI context
    
    func - : a string that uniquely characterizes the spectral sensor, for instance MyDevice.spectralSensor.
    
    Returns:
    
    a YSpectralSensor object allowing you to drive the spectral sensor.
  - registerValueCallback
```
public int registerValueCallback(YSpectralSensor.UpdateCallback callback)
```
    Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a null pointer as argument.
    
    Parameters:
    
    callback - : the callback function to call, or a null pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value.
  - _invokeValueCallback
```
public int _invokeValueCallback(String value)
```
    Overrides:
    
    _invokeValueCallback in class YFunction
  - nextSpectralSensor
```
public YSpectralSensor nextSpectralSensor()
```
    Continues the enumeration of spectral sensors started using yFirstSpectralSensor(). Caution: You can't make any assumption about the returned spectral sensors order. If you want to find a specific a spectral sensor, use SpectralSensor.findSpectralSensor() and a hardwareID or a logical name.
    
    Returns:
    
    a pointer to a YSpectralSensor object, corresponding to a spectral sensor currently online, or a null pointer if there are no more spectral sensors to enumerate.
  - FirstSpectralSensor
```
public static YSpectralSensor FirstSpectralSensor()
```
    Starts the enumeration of spectral sensors currently accessible. Use the method YSpectralSensor.nextSpectralSensor() to iterate on next spectral sensors.
    
    Returns:
    
    a pointer to a YSpectralSensor object, corresponding to the first spectral sensor currently online, or a null pointer if there are none.
  - FirstSpectralSensorInContext
```
public static YSpectralSensor FirstSpectralSensorInContext(YAPIContext yctx)
```
    Starts the enumeration of spectral sensors currently accessible. Use the method YSpectralSensor.nextSpectralSensor() to iterate on next spectral sensors.
    
    Parameters:
    
    yctx - : a YAPI context.
    
    Returns:
    
    a pointer to a YSpectralSensor object, corresponding to the first spectral sensor currently online, or a null pointer if there are none.

Class YSpectralSensor

Nested Class Summary

Field Summary

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction

Constructor Summary

Method Summary

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction

Methods inherited from class java.lang.Object

Field Detail

LEDCURRENT_INVALID

RESOLUTION_INVALID

INTEGRATIONTIME_INVALID

GAIN_INVALID

ESTIMATIONMODEL_REFLECTION

ESTIMATIONMODEL_EMISSION

ESTIMATIONMODEL_INVALID

SATURATION_INVALID

ESTIMATEDRGB_INVALID

ESTIMATEDHSL_INVALID

ESTIMATEDXYZ_INVALID

ESTIMATEDOKLAB_INVALID

NEARRAL1_INVALID

NEARRAL2_INVALID

NEARRAL3_INVALID

NEARHTMLCOLOR_INVALID

NEARSIMPLECOLOR_INVALID

LEDCURRENTATPOWERON_INVALID

INTEGRATIONTIMEATPOWERON_INVALID

GAINATPOWERON_INVALID

_ledCurrent

_resolution

_integrationTime

_gain

_estimationModel

_saturation

_estimatedRGB

_estimatedHSL

_estimatedXYZ

_estimatedOkLab

_nearRAL1

_nearRAL2

_nearRAL3

_nearHTMLColor

_nearSimpleColor

_ledCurrentAtPowerOn

_integrationTimeAtPowerOn

_gainAtPowerOn

_valueCallbackSpectralSensor

Constructor Detail

YSpectralSensor

YSpectralSensor

Method Detail

_parseAttr

get_ledCurrent

getLedCurrent

set_ledCurrent

setLedCurrent

set_resolution

setResolution

get_resolution

getResolution

get_integrationTime

getIntegrationTime

set_integrationTime

setIntegrationTime

get_gain

getGain

set_gain

setGain

get_estimationModel

getEstimationModel

set_estimationModel

setEstimationModel

get_saturation

getSaturation

get_estimatedRGB

getEstimatedRGB

get_estimatedHSL

getEstimatedHSL

get_estimatedXYZ