com.yoctopuce.YoctoAPI

Class YSoundSpectrum

java.lang.Object

com.yoctopuce.YoctoAPI.YFunction

com.yoctopuce.YoctoAPI.YSoundSpectrum

public class YSoundSpectrum
extends YFunction

YSoundSpectrum Class: sound spectrum analyzer control interface The YSoundSpectrum class allows you to read and configure Yoctopuce sound spectrum analyzers. 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	YSoundSpectrum.TimedReportCallback TimedReportCallback for SoundSpectrum
static interface	YSoundSpectrum.UpdateCallback Deprecated UpdateCallback for SoundSpectrum

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_integrationTime
protected String	_spectrumData
protected YSoundSpectrum.UpdateCallback	_valueCallbackSoundSpectrum
static int	INTEGRATIONTIME_INVALID invalid integrationTime value
static String	SPECTRUMDATA_INVALID invalid spectrumData 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	YSoundSpectrum(String func)
protected	YSoundSpectrum(YAPIContext ctx, String func)

Method Summary

Modifier and Type	Method and Description
int	_invokeValueCallback(String value)
protected void	_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
static YSoundSpectrum	FindSoundSpectrum(String func) Retrieves a sound spectrum analyzer for a given identifier.
static YSoundSpectrum	FindSoundSpectrumInContext(YAPIContext yctx, String func) Retrieves a sound spectrum analyzer for a given identifier in a YAPI context.
static YSoundSpectrum	FirstSoundSpectrum() comment from .yc definition
static YSoundSpectrum	FirstSoundSpectrumInContext(YAPIContext yctx) comment from .yc definition
int	get_integrationTime() Returns the integration time in milliseconds for calculating time weighted spectrum data.
String	get_spectrumData()
int	getIntegrationTime() Returns the integration time in milliseconds for calculating time weighted spectrum data.
YSoundSpectrum	nextSoundSpectrum() comment from .yc definition
int	registerValueCallback(YSoundSpectrum.UpdateCallback callback) Registers the callback function that is invoked on every change of advertised value.
int	set_integrationTime(int newval) Changes the integration time in milliseconds for computing time weighted spectrum data.
int	setIntegrationTime(int newval) Changes the integration time in milliseconds for computing time weighted spectrum data.

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

INTEGRATIONTIME_INVALID

public static final int INTEGRATIONTIME_INVALID

invalid integrationTime value

See Also:

Constant Field Values

SPECTRUMDATA_INVALID

public static final String SPECTRUMDATA_INVALID

invalid spectrumData value

See Also:

Constant Field Values

_integrationTime

protected int _integrationTime

_spectrumData

protected String _spectrumData

_valueCallbackSoundSpectrum

protected YSoundSpectrum.UpdateCallback _valueCallbackSoundSpectrum

Constructor Detail

YSoundSpectrum

protected YSoundSpectrum(YAPIContext ctx,
                         String func)

Parameters:

func - : functionid

YSoundSpectrum

protected YSoundSpectrum(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_integrationTime

public int get_integrationTime()
                        throws YAPI_Exception

Returns the integration time in milliseconds for calculating time weighted spectrum data.

Returns:

an integer corresponding to the integration time in milliseconds for calculating time weighted spectrum data

Throws:

YAPI_Exception - on error

getIntegrationTime

public int getIntegrationTime()
                       throws YAPI_Exception

Returns the integration time in milliseconds for calculating time weighted spectrum data.

Returns:

an integer corresponding to the integration time in milliseconds for calculating time weighted spectrum data

Throws:

YAPI_Exception - on error

set_integrationTime

public int set_integrationTime(int newval)
                        throws YAPI_Exception

Changes the integration time in milliseconds for computing time weighted spectrum data. Be aware that on some devices, changing the integration time for time-weighted spectrum data may also affect the integration period for one or more sound pressure level measurements. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : an integer corresponding to the integration time in milliseconds for computing time weighted spectrum data

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 in milliseconds for computing time weighted spectrum data. Be aware that on some devices, changing the integration time for time-weighted spectrum data may also affect the integration period for one or more sound pressure level measurements. Remember to call the saveToFlash() method of the module if the modification must be kept.

Parameters:

newval - : an integer corresponding to the integration time in milliseconds for computing time weighted spectrum data

Returns:

YAPI.SUCCESS if the call succeeds.

Throws:

YAPI_Exception - on error

get_spectrumData

public String get_spectrumData()
                        throws YAPI_Exception

Throws:

YAPI_Exception

FindSoundSpectrum

public static YSoundSpectrum FindSoundSpectrum(String func)

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

Returns:

a YSoundSpectrum object allowing you to drive the sound spectrum analyzer.

FindSoundSpectrumInContext

public static YSoundSpectrum FindSoundSpectrumInContext(YAPIContext yctx,
                                                        String func)

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

Returns:

a YSoundSpectrum object allowing you to drive the sound spectrum analyzer.

registerValueCallback

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

nextSoundSpectrum

public YSoundSpectrum nextSoundSpectrum()

comment from .yc definition

FirstSoundSpectrum

public static YSoundSpectrum FirstSoundSpectrum()

comment from .yc definition

FirstSoundSpectrumInContext

public static YSoundSpectrum FirstSoundSpectrumInContext(YAPIContext yctx)

comment from .yc definition