com.yoctopuce.YoctoAPI

Class YVoltage

java.lang.Object

com.yoctopuce.YoctoAPI.YFunction

com.yoctopuce.YoctoAPI.YSensor

com.yoctopuce.YoctoAPI.YVoltage

public class YVoltage
extends YSensor

YVoltage Class: voltage sensor control interface, available for instance in the Yocto-Motor-DC, the Yocto-Volt or the Yocto-Watt The YVoltage class allows you to read and configure Yoctopuce voltage 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	YVoltage.TimedReportCallback TimedReportCallback for Voltage
static interface	YVoltage.UpdateCallback Deprecated UpdateCallback for Voltage

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_enabled
protected double	_signalBias
protected YVoltage.TimedReportCallback	_timedReportCallbackVoltage
protected YVoltage.UpdateCallback	_valueCallbackVoltage
static int	ENABLED_FALSE invalid enabled value
static int	ENABLED_INVALID
static int	ENABLED_TRUE
static double	SIGNALBIAS_INVALID invalid signalBias value

Fields inherited from class com.yoctopuce.YoctoAPI.YSensor

_advMode, _cal, _calibrationParam, _currentRawValue, _currentValue, _highestValue, _iresol, _logFrequency, _lowestValue, _prevTR, _reportFrequency, _resolution, _sensorState, _timedReportCallbackSensor, _unit, _valueCallbackSensor, ADVMODE_IMMEDIATE, ADVMODE_INVALID, ADVMODE_PERIOD_AVG, ADVMODE_PERIOD_MAX, ADVMODE_PERIOD_MIN, CALIBRATIONPARAM_INVALID, CURRENTRAWVALUE_INVALID, CURRENTVALUE_INVALID, HIGHESTVALUE_INVALID, LOGFREQUENCY_INVALID, LOWESTVALUE_INVALID, REPORTFREQUENCY_INVALID, RESOLUTION_INVALID, SENSORSTATE_INVALID, UNIT_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	YVoltage(String func)
protected	YVoltage(YAPIContext ctx, String func)

Method Summary

Modifier and Type	Method and Description
int	_invokeTimedReportCallback(YMeasure value)
int	_invokeValueCallback(String value)
protected void	_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
static YVoltage	FindVoltage(String func) Retrieves a voltage sensor for a given identifier.
static YVoltage	FindVoltageInContext(YAPIContext yctx, String func) Retrieves a voltage sensor for a given identifier in a YAPI context.
static YVoltage	FirstVoltage() Starts the enumeration of voltage sensors currently accessible.
static YVoltage	FirstVoltageInContext(YAPIContext yctx) Starts the enumeration of voltage sensors currently accessible.
int	get_enabled() Returns the activation state of this input.
double	get_signalBias() Returns the DC bias configured for zero shift adjustment.
int	getEnabled() Returns the activation state of this input.
double	getSignalBias() Returns the DC bias configured for zero shift adjustment.
YVoltage	nextVoltage() Continues the enumeration of voltage sensors started using yFirstVoltage().
int	registerTimedReportCallback(YVoltage.TimedReportCallback callback) Registers the callback function that is invoked on every periodic timed notification.
int	registerValueCallback(YVoltage.UpdateCallback callback) Registers the callback function that is invoked on every change of advertised value.
int	set_enabled(int newval) Changes the activation state of this voltage input.
int	set_signalBias(double newval) Changes the DC bias configured for zero shift adjustment.
int	setEnabled(int newval) Changes the activation state of this voltage input.
int	setSignalBias(double newval) Changes the DC bias configured for zero shift adjustment.
int	zeroAdjust() Calibrate the device by adjusting signalBias so that the current input voltage is precisely seen as zero.

Methods inherited from class com.yoctopuce.YoctoAPI.YSensor

_applyCalibration, _decodeAvg, _decodeTimedReport, _decodeVal, _encodeCalibrationPoints, _parseCalibStr, _parserHelper, calibrateFromPoints, FindSensor, FindSensorInContext, FirstSensor, FirstSensorInContext, get_advMode, get_calibrationParam, get_currentRawValue, get_currentValue, get_dataLogger, get_highestValue, get_logFrequency, get_lowestValue, get_recordedData, get_reportFrequency, get_resolution, get_sensorState, get_unit, getAdvMode, getCurrentRawValue, getCurrentValue, getHighestValue, getLogFrequency, getLowestValue, getReportFrequency, getResolution, getSensorState, getUnit, isSensorReady, loadCalibrationPoints, nextSensor, registerTimedReportCallback, registerValueCallback, set_advMode, set_calibrationParam, set_highestValue, set_logFrequency, set_lowestValue, set_reportFrequency, set_resolution, setAdvMode, setHighestValue, setLogFrequency, setLowestValue, setReportFrequency, setResolution, startDataLogger, stopDataLogger

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, _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

ENABLED_FALSE

public static final int ENABLED_FALSE

invalid enabled value

See Also:

Constant Field Values

ENABLED_TRUE

public static final int ENABLED_TRUE

See Also:

Constant Field Values

ENABLED_INVALID

public static final int ENABLED_INVALID

See Also:

Constant Field Values

SIGNALBIAS_INVALID

public static final double SIGNALBIAS_INVALID

invalid signalBias value

See Also:

Constant Field Values

_enabled

protected int _enabled

_signalBias

protected double _signalBias

_valueCallbackVoltage

protected YVoltage.UpdateCallback _valueCallbackVoltage

_timedReportCallbackVoltage

protected YVoltage.TimedReportCallback _timedReportCallbackVoltage

Constructor Detail

YVoltage

protected YVoltage(YAPIContext ctx,
                   String func)

Parameters:

func - : functionid

YVoltage

protected YVoltage(String func)

Parameters:

func - : functionid

Method Detail

_parseAttr

protected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
                   throws Exception

Overrides:

_parseAttr in class YSensor

Throws:

Exception

get_enabled

public int get_enabled()
                throws YAPI_Exception

Returns the activation state of this input.

Returns:

either YVoltage.ENABLED_FALSE or YVoltage.ENABLED_TRUE, according to the activation state of this input

Throws:

YAPI_Exception - on error

getEnabled

public int getEnabled()
               throws YAPI_Exception

Returns the activation state of this input.

Returns:

either YVoltage.ENABLED_FALSE or YVoltage.ENABLED_TRUE, according to the activation state of this input

Throws:

YAPI_Exception - on error

set_enabled

public int set_enabled(int newval)
                throws YAPI_Exception

Changes the activation state of this voltage input. When AC measurements are disabled, the device will always assume a DC signal, and vice-versa. When both AC and DC measurements are active, the device switches between AC and DC mode based on the relative amplitude of variations compared to the average value. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : either YVoltage.ENABLED_FALSE or YVoltage.ENABLED_TRUE, according to the activation state of this voltage input

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

setEnabled

public int setEnabled(int newval)
               throws YAPI_Exception

Changes the activation state of this voltage input. When AC measurements are disabled, the device will always assume a DC signal, and vice-versa. When both AC and DC measurements are active, the device switches between AC and DC mode based on the relative amplitude of variations compared to the average value. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : either YVoltage.ENABLED_FALSE or YVoltage.ENABLED_TRUE, according to the activation state of this voltage input

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

set_signalBias

public int set_signalBias(double newval)
                   throws YAPI_Exception

Changes the DC bias configured for zero shift adjustment. If your DC current reads positive when it should be zero, set up a positive signalBias of the same value to fix the zero shift. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : a floating point number corresponding to the DC bias configured for zero shift adjustment

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

setSignalBias

public int setSignalBias(double newval)
                  throws YAPI_Exception

Changes the DC bias configured for zero shift adjustment. If your DC current reads positive when it should be zero, set up a positive signalBias of the same value to fix the zero shift. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : a floating point number corresponding to the DC bias configured for zero shift adjustment

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

get_signalBias

public double get_signalBias()
                      throws YAPI_Exception

Returns the DC bias configured for zero shift adjustment. A positive bias value is used to correct a positive DC bias, while a negative bias value is used to correct a negative DC bias.

Returns:

a floating point number corresponding to the DC bias configured for zero shift adjustment

Throws:

YAPI_Exception - on error

getSignalBias

public double getSignalBias()
                     throws YAPI_Exception

Returns the DC bias configured for zero shift adjustment. A positive bias value is used to correct a positive DC bias, while a negative bias value is used to correct a negative DC bias.

Returns:

a floating point number corresponding to the DC bias configured for zero shift adjustment

Throws:

YAPI_Exception - on error

FindVoltage

public static YVoltage FindVoltage(String func)

Retrieves a voltage 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 voltage sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YVoltage.isOnline() to test if the voltage sensor is indeed online at a given time. In case of ambiguity when looking for a voltage 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 voltage sensor, for instance MOTORCTL.voltage.

Returns:

a YVoltage object allowing you to drive the voltage sensor.

FindVoltageInContext

public static YVoltage FindVoltageInContext(YAPIContext yctx,
                                            String func)

Retrieves a voltage 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 voltage sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YVoltage.isOnline() to test if the voltage sensor is indeed online at a given time. In case of ambiguity when looking for a voltage 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 voltage sensor, for instance MOTORCTL.voltage.

Returns:

a YVoltage object allowing you to drive the voltage sensor.

registerValueCallback

public int registerValueCallback(YVoltage.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 YSensor

registerTimedReportCallback

public int registerTimedReportCallback(YVoltage.TimedReportCallback callback)

Registers the callback function that is invoked on every periodic timed notification. 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 an YMeasure object describing the new advertised value.

_invokeTimedReportCallback

public int _invokeTimedReportCallback(YMeasure value)

Overrides:

_invokeTimedReportCallback in class YSensor

zeroAdjust

public int zeroAdjust()
               throws YAPI_Exception

Calibrate the device by adjusting signalBias so that the current input voltage is precisely seen as zero. Before calling this method, make sure to short the power source inputs as close as possible to the connector, and to disconnect the load to ensure the wires don't capture radiated noise. Remember to call the saveToFlash() method of the module if the modification must be kept.

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

nextVoltage

public YVoltage nextVoltage()

Continues the enumeration of voltage sensors started using yFirstVoltage(). Caution: You can't make any assumption about the returned voltage sensors order. If you want to find a specific a voltage sensor, use Voltage.findVoltage() and a hardwareID or a logical name.

Returns:

a pointer to a YVoltage object, corresponding to a voltage sensor currently online, or a null pointer if there are no more voltage sensors to enumerate.

FirstVoltage

public static YVoltage FirstVoltage()

Starts the enumeration of voltage sensors currently accessible. Use the method YVoltage.nextVoltage() to iterate on next voltage sensors.

Returns:

a pointer to a YVoltage object, corresponding to the first voltage sensor currently online, or a null pointer if there are none.

FirstVoltageInContext

public static YVoltage FirstVoltageInContext(YAPIContext yctx)

Starts the enumeration of voltage sensors currently accessible. Use the method YVoltage.nextVoltage() to iterate on next voltage sensors.

Parameters:

yctx - : a YAPI context.

Returns:

a pointer to a YVoltage object, corresponding to the first voltage sensor currently online, or a null pointer if there are none.