public class YTilt extends YSensor
Modifier and Type | Class and Description |
---|---|
static interface |
YTilt.TimedReportCallback
TimedReportCallback for Tilt
|
static interface |
YTilt.UpdateCallback
Deprecated UpdateCallback for Tilt
|
Modifier and Type | Field and Description |
---|---|
protected int |
_axis |
protected int |
_bandwidth |
protected YTilt.TimedReportCallback |
_timedReportCallbackTilt |
protected YTilt.UpdateCallback |
_valueCallbackTilt |
static int |
AXIS_INVALID |
static int |
AXIS_X
invalid axis value
|
static int |
AXIS_Y |
static int |
AXIS_Z |
static int |
BANDWIDTH_INVALID
invalid bandwidth value
|
_advMode, _calhdl, _calibrationParam, _calpar, _calraw, _calref, _caltyp, _currentRawValue, _currentValue, _decexp, _highestValue, _iresol, _logFrequency, _lowestValue, _offset, _prevTimedReport, _reportFrequency, _resolution, _scale, _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
_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, _yapi, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID
Modifier | Constructor and Description |
---|---|
protected |
YTilt(String func) |
protected |
YTilt(YAPIContext ctx,
String func) |
Modifier and Type | Method and Description |
---|---|
int |
_invokeTimedReportCallback(YMeasure value) |
int |
_invokeValueCallback(String value) |
protected void |
_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val) |
int |
calibrateToZero()
Performs a zero calibration for the tilt measurement (Yocto-Inclinometer only).
|
static YTilt |
FindTilt(String func)
Retrieves a tilt sensor for a given identifier.
|
static YTilt |
FindTiltInContext(YAPIContext yctx,
String func)
Retrieves a tilt sensor for a given identifier in a YAPI context.
|
static YTilt |
FirstTilt()
Starts the enumeration of tilt sensors currently accessible.
|
static YTilt |
FirstTiltInContext(YAPIContext yctx)
Starts the enumeration of tilt sensors currently accessible.
|
int |
get_axis() |
int |
get_bandwidth()
Returns the measure update frequency, measured in Hz.
|
int |
getBandwidth()
Returns the measure update frequency, measured in Hz.
|
YTilt |
nextTilt()
Continues the enumeration of tilt sensors started using yFirstTilt().
|
int |
registerTimedReportCallback(YTilt.TimedReportCallback callback)
Registers the callback function that is invoked on every periodic timed notification.
|
int |
registerValueCallback(YTilt.UpdateCallback callback)
Registers the callback function that is invoked on every change of advertised value.
|
int |
restoreZeroCalibration()
Cancels any previous zero calibration for the tilt measurement (Yocto-Inclinometer only).
|
int |
set_bandwidth(int newval)
Changes the measure update frequency, measured in Hz.
|
int |
setBandwidth(int newval)
Changes the measure update frequency, measured in Hz.
|
_applyCalibration, _decodeAvg, _decodeTimedReport, _decodeVal, _encodeCalibrationPoints, _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
_AddToCache, _clearDataStreamCache, _download, _escapeAttr, _FindFromCache, _FindFromCacheInContext, _get_json_path_struct, _get_json_path, _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
public static final int BANDWIDTH_INVALID
public static final int AXIS_X
public static final int AXIS_Y
public static final int AXIS_Z
public static final int AXIS_INVALID
protected int _bandwidth
protected int _axis
protected YTilt.UpdateCallback _valueCallbackTilt
protected YTilt.TimedReportCallback _timedReportCallbackTilt
protected YTilt(YAPIContext ctx, String func)
func
- : functionidprotected YTilt(String func)
func
- : functionidprotected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val) throws Exception
_parseAttr
in class YSensor
Exception
public int get_bandwidth() throws YAPI_Exception
YAPI_Exception
- on errorpublic int getBandwidth() throws YAPI_Exception
YAPI_Exception
- on errorpublic int set_bandwidth(int newval) throws YAPI_Exception
newval
- : an integer corresponding to the measure update frequency, measured in HzYAPI_Exception
- on errorpublic int setBandwidth(int newval) throws YAPI_Exception
newval
- : an integer corresponding to the measure update frequency, measured in HzYAPI_Exception
- on errorpublic int get_axis() throws YAPI_Exception
YAPI_Exception
public static YTilt FindTilt(String func)
func
- : a string that uniquely characterizes the tilt sensor, for instance
Y3DMK002.tilt1.public static YTilt FindTiltInContext(YAPIContext yctx, String func)
yctx
- : a YAPI contextfunc
- : a string that uniquely characterizes the tilt sensor, for instance
Y3DMK002.tilt1.public int registerValueCallback(YTilt.UpdateCallback callback)
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.public int _invokeValueCallback(String value)
_invokeValueCallback
in class YSensor
public int registerTimedReportCallback(YTilt.TimedReportCallback callback)
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.public int _invokeTimedReportCallback(YMeasure value)
_invokeTimedReportCallback
in class YSensor
public int calibrateToZero() throws YAPI_Exception
YAPI_Exception
- on errorpublic int restoreZeroCalibration() throws YAPI_Exception
YAPI_Exception
- on errorpublic YTilt nextTilt()
public static YTilt FirstTilt()
public static YTilt FirstTiltInContext(YAPIContext yctx)
yctx
- : a YAPI context.Copyright © 2020. All rights reserved.