YColorSensor (Yoctopuce Java API 2.1.11632-SNAPSHOT API)

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

```
public class YColorSensor
extends YFunction
```
YColorSensor Class: color sensor control interface The YColorSensor class allows you to read and configure Yoctopuce color sensors.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`YColorSensor.TimedReportCallback` TimedReportCallback for ColorSensor
`static interface`	`YColorSensor.UpdateCallback` Deprecated UpdateCallback for ColorSensor

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`_autoGain`
`protected int`	`_estimatedHSL`
`protected String`	`_estimatedOkLab`
`protected int`	`_estimatedRGB`
`protected String`	`_estimatedXYZ`
`protected int`	`_estimationModel`
`protected int`	`_gain`
`protected int`	`_integrationTime`
`protected int`	`_ledCalibration`
`protected int`	`_ledCurrent`
`protected String`	`_nearHTMLColor`
`protected String`	`_nearRAL1`
`protected String`	`_nearRAL2`
`protected String`	`_nearRAL3`
`protected String`	`_nearSimpleColor`
`protected int`	`_nearSimpleColorIndex`
`protected int`	`_saturation`
`protected YColorSensor.UpdateCallback`	`_valueCallbackColorSensor`
`protected int`	`_workingMode`
`static String`	`AUTOGAIN_INVALID` invalid autoGain value
`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`	`INTEGRATIONTIME_INVALID` invalid integrationTime value
`static int`	`LEDCALIBRATION_INVALID` invalid ledCalibration value
`static int`	`LEDCURRENT_INVALID` invalid ledCurrent 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 int`	`NEARSIMPLECOLORINDEX_BLACK`
`static int`	`NEARSIMPLECOLORINDEX_BLUE`
`static int`	`NEARSIMPLECOLORINDEX_BROWN` invalid nearSimpleColorIndex value
`static int`	`NEARSIMPLECOLORINDEX_GRAY`
`static int`	`NEARSIMPLECOLORINDEX_GREEN`
`static int`	`NEARSIMPLECOLORINDEX_INVALID`
`static int`	`NEARSIMPLECOLORINDEX_ORANGE`
`static int`	`NEARSIMPLECOLORINDEX_PINK`
`static int`	`NEARSIMPLECOLORINDEX_PURPLE`
`static int`	`NEARSIMPLECOLORINDEX_RED`
`static int`	`NEARSIMPLECOLORINDEX_WHITE`
`static int`	`NEARSIMPLECOLORINDEX_YELLOW`
`static int`	`SATURATION_INVALID` invalid saturation value
`static int`	`WORKINGMODE_AUTO` invalid workingMode value
`static int`	`WORKINGMODE_AUTOGAIN`
`static int`	`WORKINGMODE_EXPERT`
`static int`	`WORKINGMODE_INVALID`

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 YColorSensor(String func)

protected YColorSensor(YAPIContext ctx, String func)

Constructors
Modifier	Constructor and Description
`protected`	`YColorSensor(String func)`
`protected`	`YColorSensor(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)`
`int`	`configureAutoGain(String channel, int minRaw, int maxRaw, boolean noSatur)` Changes the sensor automatic gain control settings.
`static YColorSensor`	`FindColorSensor(String func)` Retrieves a color sensor for a given identifier.
`static YColorSensor`	`FindColorSensorInContext(YAPIContext yctx, String func)` Retrieves a color sensor for a given identifier in a YAPI context.
`static YColorSensor`	`FirstColorSensor()` Starts the enumeration of color sensors currently accessible.
`static YColorSensor`	`FirstColorSensorInContext(YAPIContext yctx)` Starts the enumeration of color sensors currently accessible.
`String`	`get_autoGain()` Returns the current autogain parameters of the sensor as a character string.
`int`	`get_estimatedHSL()` Returns the estimated color in HSL color model (0xHHSSLL).
`String`	`get_estimatedOkLab()` Returns the estimated color according to the OkLab color model.
`int`	`get_estimatedRGB()` Returns the estimated color in RGB color model (0xRRGGBB).
`String`	`get_estimatedXYZ()` Returns the estimated color according to the CIE XYZ color model.
`int`	`get_estimationModel()` Returns the predictive model used for color estimation (reflective or emissive).
`int`	`get_gain()` Returns the current spectral channel detector gain exponent.
`int`	`get_integrationTime()` Returns the current integration time for spectral measure, in milliseconds.
`int`	`get_ledCalibration()` Returns the current sent to the illumination LEDs during the latest calibration.
`int`	`get_ledCurrent()` Returns the amount of current sent to the illumination LEDs, for reflection measures.
`String`	`get_nearHTMLColor()` Returns the name of the HTML color closest to the estimated color.
`String`	`get_nearRAL1()` Returns the RAL Classic color closest to the estimated color, with a similarity ratio.
`String`	`get_nearRAL2()` Returns the second closest RAL Classic color to the estimated color, with a similarity ratio.
`String`	`get_nearRAL3()` Returns the third closest RAL Classic color to the estimated color, with a similarity ratio.
`String`	`get_nearSimpleColor()` Returns the name of the basic color typically used to refer to the estimated color.
`int`	`get_nearSimpleColorIndex()` Returns the index of the basic color typically used to refer to the estimated color (enumerated value).
`int`	`get_saturation()` Returns the current saturation state of the sensor, as an integer.
`int`	`get_workingMode()` Returns the sensor working mode.
`String`	`getAutoGain()` Returns the current autogain parameters of the sensor as a character string.
`int`	`getEstimatedHSL()` Returns the estimated color in HSL color model (0xHHSSLL).
`String`	`getEstimatedOkLab()` Returns the estimated color according to the OkLab color model.
`int`	`getEstimatedRGB()` Returns the estimated color in RGB color model (0xRRGGBB).
`String`	`getEstimatedXYZ()` Returns the estimated color according to the CIE XYZ color model.
`int`	`getEstimationModel()` Returns the predictive model used for color estimation (reflective or emissive).
`int`	`getGain()` Returns the current spectral channel detector gain exponent.
`int`	`getIntegrationTime()` Returns the current integration time for spectral measure, in milliseconds.
`int`	`getLedCalibration()` Returns the current sent to the illumination LEDs during the latest calibration.
`int`	`getLedCurrent()` Returns the amount of current sent to the illumination LEDs, for reflection measures.
`String`	`getNearHTMLColor()` Returns the name of the HTML color closest to the estimated color.
`String`	`getNearRAL1()` Returns the RAL Classic color closest to the estimated color, with a similarity ratio.
`String`	`getNearRAL2()` Returns the second closest RAL Classic color to the estimated color, with a similarity ratio.
`String`	`getNearRAL3()` Returns the third closest RAL Classic color to the estimated color, with a similarity ratio.
`String`	`getNearSimpleColor()` Returns the name of the basic color typically used to refer to the estimated color.
`int`	`getNearSimpleColorIndex()` Returns the index of the basic color typically used to refer to the estimated color (enumerated value).
`int`	`getSaturation()` Returns the current saturation state of the sensor, as an integer.
`int`	`getWorkingMode()` Returns the sensor working mode.
`YColorSensor`	`nextColorSensor()` Continues the enumeration of color sensors started using yFirstColorSensor().
`int`	`registerValueCallback(YColorSensor.UpdateCallback callback)` Registers the callback function that is invoked on every change of advertised value.
`int`	`set_autoGain(String newval)` Remember to call the saveToFlash() method of the module if the modification must be kept.
`int`	`set_estimationModel(int newval)` Changes the predictive model to be used for color estimation (reflective or emissive).
`int`	`set_gain(int newval)` Changes the spectral channel detector gain exponent.
`int`	`set_integrationTime(int newval)` Changes the integration time for spectral measure, in milliseconds.
`int`	`set_ledCalibration(int newval)` Remember the LED current sent to the illumination LEDs during a calibration.
`int`	`set_ledCurrent(int newval)` Changes the amount of current sent to the illumination LEDs, for reflection measures.
`int`	`set_workingMode(int newval)` Changes the sensor working mode.
`int`	`setAutoGain(String newval)` Remember to call the saveToFlash() method of the module if the modification must be kept.
`int`	`setEstimationModel(int newval)` Changes the predictive model to be used for color estimation (reflective or emissive).
`int`	`setGain(int newval)` Changes the spectral channel detector gain exponent.
`int`	`setIntegrationTime(int newval)` Changes the integration time for spectral measure, in milliseconds.
`int`	`setLedCalibration(int newval)` Remember the LED current sent to the illumination LEDs during a calibration.
`int`	`setLedCurrent(int newval)` Changes the amount of current sent to the illumination LEDs, for reflection measures.
`int`	`setWorkingMode(int newval)` Changes the sensor working mode.
`int`	`turnLedOff()` Turns off the built-in illumination LEDs.
`int`	`turnLedOn()` Turns on the built-in illumination LEDs using the same current as used during the latest calibration.

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, _is_valid_pass, _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
  - 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
  - WORKINGMODE_AUTO
```
public static final int WORKINGMODE_AUTO
```
    invalid workingMode value
    
    See Also:
    
    Constant Field Values
  - WORKINGMODE_EXPERT
```
public static final int WORKINGMODE_EXPERT
```
    See Also:
    
    Constant Field Values
  - WORKINGMODE_AUTOGAIN
```
public static final int WORKINGMODE_AUTOGAIN
```
    See Also:
    
    Constant Field Values
  - WORKINGMODE_INVALID
```
public static final int WORKINGMODE_INVALID
```
    See Also:
    
    Constant Field Values
  - LEDCURRENT_INVALID
```
public static final int LEDCURRENT_INVALID
```
    invalid ledCurrent value
    
    See Also:
    
    Constant Field Values
  - LEDCALIBRATION_INVALID
```
public static final int LEDCALIBRATION_INVALID
```
    invalid ledCalibration 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
  - AUTOGAIN_INVALID
```
public static final String AUTOGAIN_INVALID
```
    invalid autoGain value
    
    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
  - NEARSIMPLECOLORINDEX_BROWN
```
public static final int NEARSIMPLECOLORINDEX_BROWN
```
    invalid nearSimpleColorIndex value
    
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLORINDEX_RED
```
public static final int NEARSIMPLECOLORINDEX_RED
```
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLORINDEX_ORANGE
```
public static final int NEARSIMPLECOLORINDEX_ORANGE
```
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLORINDEX_YELLOW
```
public static final int NEARSIMPLECOLORINDEX_YELLOW
```
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLORINDEX_WHITE
```
public static final int NEARSIMPLECOLORINDEX_WHITE
```
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLORINDEX_GRAY
```
public static final int NEARSIMPLECOLORINDEX_GRAY
```
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLORINDEX_BLACK
```
public static final int NEARSIMPLECOLORINDEX_BLACK
```
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLORINDEX_GREEN
```
public static final int NEARSIMPLECOLORINDEX_GREEN
```
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLORINDEX_BLUE
```
public static final int NEARSIMPLECOLORINDEX_BLUE
```
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLORINDEX_PURPLE
```
public static final int NEARSIMPLECOLORINDEX_PURPLE
```
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLORINDEX_PINK
```
public static final int NEARSIMPLECOLORINDEX_PINK
```
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLORINDEX_INVALID
```
public static final int NEARSIMPLECOLORINDEX_INVALID
```
    See Also:
    
    Constant Field Values
  - NEARSIMPLECOLOR_INVALID
```
public static final String NEARSIMPLECOLOR_INVALID
```
    invalid nearSimpleColor value
    
    See Also:
    
    Constant Field Values
  - _estimationModel
```
protected int _estimationModel
```
  - _workingMode
```
protected int _workingMode
```
  - _ledCurrent
```
protected int _ledCurrent
```
  - _ledCalibration
```
protected int _ledCalibration
```
  - _integrationTime
```
protected int _integrationTime
```
  - _gain
```
protected int _gain
```
  - _autoGain
```
protected String _autoGain
```
  - _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
```
  - _nearSimpleColorIndex
```
protected int _nearSimpleColorIndex
```
  - _nearSimpleColor
```
protected String _nearSimpleColor
```
  - _valueCallbackColorSensor
```
protected YColorSensor.UpdateCallback _valueCallbackColorSensor
```
- Constructor Detail
  - YColorSensor
```
protected YColorSensor(YAPIContext ctx,
                       String func)
```
    Parameters:
    
    func - : functionid
  - YColorSensor
```
protected YColorSensor(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_estimationModel
```
public int get_estimationModel()
                        throws YAPI_Exception
```
    Returns the predictive model used for color estimation (reflective or emissive).
    
    Returns:
    
    either YColorSensor.ESTIMATIONMODEL_REFLECTION or YColorSensor.ESTIMATIONMODEL_EMISSION, according to the predictive model used for color estimation (reflective or emissive)
    
    Throws:
    
    YAPI_Exception - on error
  - getEstimationModel
```
public int getEstimationModel()
                       throws YAPI_Exception
```
    Returns the predictive model used for color estimation (reflective or emissive).
    
    Returns:
    
    either YColorSensor.ESTIMATIONMODEL_REFLECTION or YColorSensor.ESTIMATIONMODEL_EMISSION, according to the predictive model used for color estimation (reflective or emissive)
    
    Throws:
    
    YAPI_Exception - on error
  - set_estimationModel
```
public int set_estimationModel(int newval)
                        throws YAPI_Exception
```
    Changes the predictive model to be used for color estimation (reflective or emissive). Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : either YColorSensor.ESTIMATIONMODEL_REFLECTION or YColorSensor.ESTIMATIONMODEL_EMISSION, according to the predictive model to be used for color estimation (reflective or emissive)
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setEstimationModel
```
public int setEstimationModel(int newval)
                       throws YAPI_Exception
```
    Changes the predictive model to be used for color estimation (reflective or emissive). Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : either YColorSensor.ESTIMATIONMODEL_REFLECTION or YColorSensor.ESTIMATIONMODEL_EMISSION, according to the predictive model to be used for color estimation (reflective or emissive)
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_workingMode
```
public int get_workingMode()
                    throws YAPI_Exception
```
    Returns the sensor working mode. In Auto mode, sensor parameters are automatically set based on the selected estimation model. In Expert mode, sensor parameters such as gain and integration time are configured manually.
    
    Returns:
    
    a value among YColorSensor.WORKINGMODE_AUTO, YColorSensor.WORKINGMODE_EXPERT and YColorSensor.WORKINGMODE_AUTOGAIN corresponding to the sensor working mode
    
    Throws:
    
    YAPI_Exception - on error
  - getWorkingMode
```
public int getWorkingMode()
                   throws YAPI_Exception
```
    Returns the sensor working mode. In Auto mode, sensor parameters are automatically set based on the selected estimation model. In Expert mode, sensor parameters such as gain and integration time are configured manually.
    
    Returns:
    
    a value among YColorSensor.WORKINGMODE_AUTO, YColorSensor.WORKINGMODE_EXPERT and YColorSensor.WORKINGMODE_AUTOGAIN corresponding to the sensor working mode
    
    Throws:
    
    YAPI_Exception - on error
  - set_workingMode
```
public int set_workingMode(int newval)
                    throws YAPI_Exception
```
    Changes the sensor working mode. In Auto mode, sensor parameters are automatically set based on the selected estimation model. In Expert mode, sensor parameters such as gain and integration time are configured manually. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a value among YColorSensor.WORKINGMODE_AUTO, YColorSensor.WORKINGMODE_EXPERT and YColorSensor.WORKINGMODE_AUTOGAIN corresponding to the sensor working mode
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setWorkingMode
```
public int setWorkingMode(int newval)
                   throws YAPI_Exception
```
    Changes the sensor working mode. In Auto mode, sensor parameters are automatically set based on the selected estimation model. In Expert mode, sensor parameters such as gain and integration time are configured manually. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a value among YColorSensor.WORKINGMODE_AUTO, YColorSensor.WORKINGMODE_EXPERT and YColorSensor.WORKINGMODE_AUTOGAIN corresponding to the sensor working mode
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_ledCurrent
```
public int get_ledCurrent()
                   throws YAPI_Exception
```
    Returns the amount of current sent to the illumination LEDs, for reflection measures. The value is an integer ranging from 0 (LEDs off) to 254 (LEDs at maximum intensity).
    
    Returns:
    
    an integer corresponding to the amount of current sent to the illumination LEDs, for reflection measures
    
    Throws:
    
    YAPI_Exception - on error
  - getLedCurrent
```
public int getLedCurrent()
                  throws YAPI_Exception
```
    Returns the amount of current sent to the illumination LEDs, for reflection measures. The value is an integer ranging from 0 (LEDs off) to 254 (LEDs at maximum intensity).
    
    Returns:
    
    an integer corresponding to the amount of current sent to the illumination LEDs, for reflection measures
    
    Throws:
    
    YAPI_Exception - on error
  - set_ledCurrent
```
public int set_ledCurrent(int newval)
                   throws YAPI_Exception
```
    Changes the amount of current sent to the illumination LEDs, for reflection measures. The value is an integer ranging from 0 (LEDs off) to 254 (LEDs at maximum intensity).
    
    Parameters:
    
    newval - : an integer corresponding to the amount of current sent to the illumination LEDs, for reflection measures
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setLedCurrent
```
public int setLedCurrent(int newval)
                  throws YAPI_Exception
```
    Changes the amount of current sent to the illumination LEDs, for reflection measures. The value is an integer ranging from 0 (LEDs off) to 254 (LEDs at maximum intensity).
    
    Parameters:
    
    newval - : an integer corresponding to the amount of current sent to the illumination LEDs, for reflection measures
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_ledCalibration
```
public int get_ledCalibration()
                       throws YAPI_Exception
```
    Returns the current sent to the illumination LEDs during the latest calibration.
    
    Returns:
    
    an integer corresponding to the current sent to the illumination LEDs during the latest calibration
    
    Throws:
    
    YAPI_Exception - on error
  - getLedCalibration
```
public int getLedCalibration()
                      throws YAPI_Exception
```
    Returns the current sent to the illumination LEDs during the latest calibration.
    
    Returns:
    
    an integer corresponding to the current sent to the illumination LEDs during the latest calibration
    
    Throws:
    
    YAPI_Exception - on error
  - set_ledCalibration
```
public int set_ledCalibration(int newval)
                       throws YAPI_Exception
```
    Remember the LED current sent to the illumination LEDs during a calibration. Thanks to this, the device is able to use the same current when taking measures. 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
  - setLedCalibration
```
public int setLedCalibration(int newval)
                      throws YAPI_Exception
```
    Remember the LED current sent to the illumination LEDs during a calibration. Thanks to this, the device is able to use the same current when taking measures. 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_integrationTime
```
public int get_integrationTime()
                        throws YAPI_Exception
```
    Returns the current integration time for spectral measure, in milliseconds. A longer integration time increase the sensitivity for low light conditions, but reduces the measure taking rate and may lead to saturation for lighter colors.
    
    Returns:
    
    an integer corresponding to the current integration time for spectral measure, in milliseconds
    
    Throws:
    
    YAPI_Exception - on error
  - getIntegrationTime
```
public int getIntegrationTime()
                       throws YAPI_Exception
```
    Returns the current integration time for spectral measure, in milliseconds. A longer integration time increase the sensitivity for low light conditions, but reduces the measure taking rate and may lead to saturation for lighter colors.
    
    Returns:
    
    an integer corresponding to the current integration time for spectral measure, in milliseconds
    
    Throws:
    
    YAPI_Exception - on error
  - set_integrationTime
```
public int set_integrationTime(int newval)
                        throws YAPI_Exception
```
    Changes the integration time for spectral measure, in milliseconds. A longer integration time increase the sensitivity for low light conditions, but reduces the measure taking rate and may lead to saturation for lighter colors. This method can only be used when the sensor is configured in expert mode; when running in auto mode, the change is ignored. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the integration time for spectral measure, in milliseconds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setIntegrationTime
```
public int setIntegrationTime(int newval)
                       throws YAPI_Exception
```
    Changes the integration time for spectral measure, in milliseconds. A longer integration time increase the sensitivity for low light conditions, but reduces the measure taking rate and may lead to saturation for lighter colors. This method can only be used when the sensor is configured in expert mode; when running in auto mode, the change is ignored. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the integration time for spectral measure, in milliseconds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_gain
```
public int get_gain()
             throws YAPI_Exception
```
    Returns the current spectral channel detector gain exponent. For a value n ranging from 0 to 12, the applied gain is 2^(n-1). 0 corresponds to a gain of 0.5, and 12 corresponds to a gain of 2048.
    
    Returns:
    
    an integer corresponding to the current spectral channel detector gain exponent
    
    Throws:
    
    YAPI_Exception - on error
  - getGain
```
public int getGain()
            throws YAPI_Exception
```
    Returns the current spectral channel detector gain exponent. For a value n ranging from 0 to 12, the applied gain is 2^(n-1). 0 corresponds to a gain of 0.5, and 12 corresponds to a gain of 2048.
    
    Returns:
    
    an integer corresponding to the current spectral channel detector gain exponent
    
    Throws:
    
    YAPI_Exception - on error
  - set_gain
```
public int set_gain(int newval)
             throws YAPI_Exception
```
    Changes the spectral channel detector gain exponent. For a value n ranging from 0 to 12, the applied gain is 2^(n-1). 0 corresponds to a gain of 0.5, and 12 corresponds to a gain of 2048. This method can only be used when the sensor is configured in expert mode; when running in auto mode, the change is ignored. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the spectral channel detector gain exponent
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setGain
```
public int setGain(int newval)
            throws YAPI_Exception
```
    Changes the spectral channel detector gain exponent. For a value n ranging from 0 to 12, the applied gain is 2^(n-1). 0 corresponds to a gain of 0.5, and 12 corresponds to a gain of 2048. This method can only be used when the sensor is configured in expert mode; when running in auto mode, the change is ignored. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the spectral channel detector gain exponent
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_autoGain
```
public String get_autoGain()
                    throws YAPI_Exception
```
    Returns the current autogain parameters of the sensor as a character string. The returned parameter format is: "Min < Channel < Max:Saturation".
    
    Returns:
    
    a string corresponding to the current autogain parameters of the sensor as a character string
    
    Throws:
    
    YAPI_Exception - on error
  - getAutoGain
```
public String getAutoGain()
                   throws YAPI_Exception
```
    Returns the current autogain parameters of the sensor as a character string. The returned parameter format is: "Min < Channel < Max:Saturation".
    
    Returns:
    
    a string corresponding to the current autogain parameters of the sensor as a character string
    
    Throws:
    
    YAPI_Exception - on error
  - set_autoGain
```
public int set_autoGain(String newval)
                 throws YAPI_Exception
```
    Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setAutoGain
```
public int setAutoGain(String newval)
                throws YAPI_Exception
```
    Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string
    
    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 state of the sensor, as an integer. Bit 0 indicates saturation of the analog sensor, which can only be corrected by reducing the gain parameters or the luminosity. Bit 1 indicates saturation of the digital interface, which can be corrected by reducing the integration time or the gain.
    
    Returns:
    
    an integer corresponding to the current saturation state of the sensor, as an integer
    
    Throws:
    
    YAPI_Exception - on error
  - getSaturation
```
public int getSaturation()
                  throws YAPI_Exception
```
    Returns the current saturation state of the sensor, as an integer. Bit 0 indicates saturation of the analog sensor, which can only be corrected by reducing the gain parameters or the luminosity. Bit 1 indicates saturation of the digital interface, which can be corrected by reducing the integration time or the gain.
    
    Returns:
    
    an integer corresponding to the current saturation state of the sensor, as an integer
    
    Throws:
    
    YAPI_Exception - on error
  - get_estimatedRGB
```
public int get_estimatedRGB()
                     throws YAPI_Exception
```
    Returns the estimated color in RGB color model (0xRRGGBB). The RGB color model describes each color using a combination of 3 components:
    - Red (R): the intensity of red, in the 0...255 range
    - Green (G): the intensity of green, in the 0...255 range
    - Blue (B): the intensity of blue, in the 0...255 range
    Returns:
    
    an integer corresponding to the estimated color in RGB color model (0xRRGGBB)
    
    Throws:
    
    YAPI_Exception - on error
  - getEstimatedRGB
```
public int getEstimatedRGB()
                    throws YAPI_Exception
```
    Returns the estimated color in RGB color model (0xRRGGBB). The RGB color model describes each color using a combination of 3 components:
    - Red (R): the intensity of red, in the 0...255 range
    - Green (G): the intensity of green, in the 0...255 range
    - Blue (B): the intensity of blue, in the 0...255 range
    Returns:
    
    an integer corresponding to the estimated color in RGB color model (0xRRGGBB)
    
    Throws:
    
    YAPI_Exception - on error
  - get_estimatedHSL
```
public int get_estimatedHSL()
                     throws YAPI_Exception
```
    Returns the estimated color in HSL color model (0xHHSSLL). The HSL color model describes each color using a combination of 3 components:
    - Hue (H): the angle on the color wheel (0-360 degrees), mapped to 0...255
    - Saturation (S): the intensity of the color (0-100%), mapped to 0...255
    - Lightness (L): the brightness of the color (0-100%), mapped to 0...255
    Returns:
    
    an integer corresponding to the estimated color in HSL color model (0xHHSSLL)
    
    Throws:
    
    YAPI_Exception - on error
  - getEstimatedHSL
```
public int getEstimatedHSL()
                    throws YAPI_Exception
```
    Returns the estimated color in HSL color model (0xHHSSLL). The HSL color model describes each color using a combination of 3 components:
    - Hue (H): the angle on the color wheel (0-360 degrees), mapped to 0...255
    - Saturation (S): the intensity of the color (0-100%), mapped to 0...255
    - Lightness (L): the brightness of the color (0-100%), mapped to 0...255
    Returns:
    
    an integer corresponding to the estimated color in HSL color model (0xHHSSLL)
    
    Throws:
    
    YAPI_Exception - on error
  - get_estimatedXYZ
```
public String get_estimatedXYZ()
                        throws YAPI_Exception
```
    Returns the estimated color according to the CIE XYZ color model. This color model is based on human vision and light perception, with three components represented by real numbers between 0 and 1:
    - X: corresponds to a component mixing sensitivity to red and green
    - Y: represents luminance (perceived brightness)
    - Z: corresponds to sensitivity to blue
    Returns:
    
    a string corresponding to the estimated color according to the CIE XYZ color model
    
    Throws:
    
    YAPI_Exception - on error
  - getEstimatedXYZ
```
public String getEstimatedXYZ()
                       throws YAPI_Exception
```
    Returns the estimated color according to the CIE XYZ color model. This color model is based on human vision and light perception, with three components represented by real numbers between 0 and 1:
    - X: corresponds to a component mixing sensitivity to red and green
    - Y: represents luminance (perceived brightness)
    - Z: corresponds to sensitivity to blue
    Returns:
    
    a string corresponding to the estimated color according to the CIE XYZ color model
    
    Throws:
    
    YAPI_Exception - on error
  - get_estimatedOkLab
```
public String get_estimatedOkLab()
                          throws YAPI_Exception
```
    Returns the estimated color according to the OkLab color model. OkLab is a perceptual color model that aims to align human color perception with numerical values, so that colors that are visually near are also numerically near. Colors are represented using three components:
  - L: lightness, a real number between 0 and 1
  - a: color variations between green and red, between -0.5 and 0.5
  - b: color variations between blue and yellow, between -0.5 and 0.5.

Returns:: a string corresponding to the estimated color according to the OkLab color model
Throws:: YAPI_Exception - on error

getEstimatedOkLab
```
public String getEstimatedOkLab()
                         throws YAPI_Exception
```
Returns the estimated color according to the OkLab color model. OkLab is a perceptual color model that aims to align human color perception with numerical values, so that colors that are visually near are also numerically near. Colors are represented using three components:
L: lightness, a real number between 0 and 1
a: color variations between green and red, between -0.5 and 0.5
b: color variations between blue and yellow, between -0.5 and 0.5.

Class YColorSensor

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

ESTIMATIONMODEL_REFLECTION

ESTIMATIONMODEL_EMISSION

ESTIMATIONMODEL_INVALID

WORKINGMODE_AUTO

WORKINGMODE_EXPERT

WORKINGMODE_AUTOGAIN

WORKINGMODE_INVALID

LEDCURRENT_INVALID

LEDCALIBRATION_INVALID

INTEGRATIONTIME_INVALID

GAIN_INVALID

AUTOGAIN_INVALID

SATURATION_INVALID

ESTIMATEDRGB_INVALID

ESTIMATEDHSL_INVALID

ESTIMATEDXYZ_INVALID

ESTIMATEDOKLAB_INVALID

NEARRAL1_INVALID

NEARRAL2_INVALID

NEARRAL3_INVALID

NEARHTMLCOLOR_INVALID

NEARSIMPLECOLORINDEX_BROWN

NEARSIMPLECOLORINDEX_RED

NEARSIMPLECOLORINDEX_ORANGE

NEARSIMPLECOLORINDEX_YELLOW

NEARSIMPLECOLORINDEX_WHITE

NEARSIMPLECOLORINDEX_GRAY

NEARSIMPLECOLORINDEX_BLACK

NEARSIMPLECOLORINDEX_GREEN

NEARSIMPLECOLORINDEX_BLUE

NEARSIMPLECOLORINDEX_PURPLE

NEARSIMPLECOLORINDEX_PINK

NEARSIMPLECOLORINDEX_INVALID

NEARSIMPLECOLOR_INVALID

_estimationModel

_workingMode

_ledCurrent

_ledCalibration

_integrationTime

_gain

_autoGain

_saturation

_estimatedRGB

_estimatedHSL

_estimatedXYZ

_estimatedOkLab

_nearRAL1

_nearRAL2

_nearRAL3

_nearHTMLColor

_nearSimpleColorIndex

_nearSimpleColor

_valueCallbackColorSensor

Constructor Detail

YColorSensor

YColorSensor

Method Detail

_parseAttr

get_estimationModel

getEstimationModel

set_estimationModel

setEstimationModel

get_workingMode

getWorkingMode

set_workingMode

setWorkingMode

get_ledCurrent

getLedCurrent

set_ledCurrent

setLedCurrent

get_ledCalibration