public class YBridgeControl extends YFunction
Modifier and Type | Class and Description |
---|---|
static interface |
YBridgeControl.TimedReportCallback
TimedReportCallback for BridgeControl
|
static interface |
YBridgeControl.UpdateCallback
Deprecated UpdateCallback for BridgeControl
|
Modifier and Type | Field and Description |
---|---|
protected int |
_adGain |
protected int |
_adValue |
protected int |
_bridgeLatency |
protected int |
_excitationMode |
protected YBridgeControl.UpdateCallback |
_valueCallbackBridgeControl |
static int |
ADGAIN_INVALID
invalid adGain value
|
static int |
ADVALUE_INVALID
invalid adValue value
|
static int |
BRIDGELATENCY_INVALID
invalid bridgeLatency value
|
static int |
EXCITATIONMODE_EXTERNAL_DC |
static int |
EXCITATIONMODE_INTERNAL_AC
invalid excitationMode value
|
static int |
EXCITATIONMODE_INTERNAL_DC |
static int |
EXCITATIONMODE_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 |
YBridgeControl(String func) |
protected |
YBridgeControl(YAPIContext ctx,
String func) |
Modifier and Type | Method and Description |
---|---|
int |
_invokeValueCallback(String value) |
protected void |
_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val) |
static YBridgeControl |
FindBridgeControl(String func)
Retrieves a Wheatstone bridge controller for a given identifier.
|
static YBridgeControl |
FindBridgeControlInContext(YAPIContext yctx,
String func)
Retrieves a Wheatstone bridge controller for a given identifier in a YAPI context.
|
static YBridgeControl |
FirstBridgeControl()
Starts the enumeration of Wheatstone bridge controllers currently accessible.
|
static YBridgeControl |
FirstBridgeControlInContext(YAPIContext yctx)
Starts the enumeration of Wheatstone bridge controllers currently accessible.
|
int |
get_adGain()
Returns the current ratiometric A/D converter gain.
|
int |
get_adValue()
Returns the raw value returned by the ratiometric A/D converter
during last read.
|
int |
get_bridgeLatency()
Returns the current Wheatstone bridge excitation method.
|
int |
get_excitationMode()
Returns the current Wheatstone bridge excitation method.
|
int |
getAdGain()
Returns the current ratiometric A/D converter gain.
|
int |
getAdValue()
Returns the raw value returned by the ratiometric A/D converter
during last read.
|
int |
getBridgeLatency()
Returns the current Wheatstone bridge excitation method.
|
int |
getExcitationMode()
Returns the current Wheatstone bridge excitation method.
|
YBridgeControl |
nextBridgeControl()
Continues the enumeration of Wheatstone bridge controllers started using yFirstBridgeControl().
|
int |
registerValueCallback(YBridgeControl.UpdateCallback callback)
Registers the callback function that is invoked on every change of advertised value.
|
int |
set_bridgeLatency(int newval)
Changes the current Wheatstone bridge excitation method.
|
int |
set_excitationMode(int newval)
Changes the current Wheatstone bridge excitation method.
|
int |
setBridgeLatency(int newval)
Changes the current Wheatstone bridge excitation method.
|
int |
setExcitationMode(int newval)
Changes the current Wheatstone bridge excitation method.
|
_AddToCache, _clearDataStreamCache, _devRequest, _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, 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_userData, getAdvertisedValue, getErrorMessage, getErrorType, getFriendlyName, getFunctionDescriptor, getFunctionId, getHardwareId, getLogicalName, getModule, getUserData, isOnline, load, loadAttribute, module, muteValueCallbacks, nextFunction, registerValueCallback, set_advertisedValue, set_logicalName, set_userData, setLogicalName, setUserData, toString, unmuteValueCallbacks, userData
public static final int EXCITATIONMODE_INTERNAL_AC
public static final int EXCITATIONMODE_INTERNAL_DC
public static final int EXCITATIONMODE_EXTERNAL_DC
public static final int EXCITATIONMODE_INVALID
public static final int BRIDGELATENCY_INVALID
public static final int ADVALUE_INVALID
public static final int ADGAIN_INVALID
protected int _excitationMode
protected int _bridgeLatency
protected int _adValue
protected int _adGain
protected YBridgeControl.UpdateCallback _valueCallbackBridgeControl
protected YBridgeControl(YAPIContext ctx, String func)
func
- : functionidprotected YBridgeControl(String func)
func
- : functionidprotected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val) throws Exception
_parseAttr
in class YFunction
Exception
public int get_excitationMode() throws YAPI_Exception
YAPI_Exception
- on errorpublic int getExcitationMode() throws YAPI_Exception
YAPI_Exception
- on errorpublic int set_excitationMode(int newval) throws YAPI_Exception
newval
- : a value among YBridgeControl.EXCITATIONMODE_INTERNAL_AC,
YBridgeControl.EXCITATIONMODE_INTERNAL_DC and YBridgeControl.EXCITATIONMODE_EXTERNAL_DC
corresponding to the current Wheatstone bridge excitation methodYAPI_Exception
- on errorpublic int setExcitationMode(int newval) throws YAPI_Exception
newval
- : a value among Y_EXCITATIONMODE_INTERNAL_AC, Y_EXCITATIONMODE_INTERNAL_DC and
Y_EXCITATIONMODE_EXTERNAL_DC corresponding to the current Wheatstone bridge excitation methodYAPI_Exception
- on errorpublic int get_bridgeLatency() throws YAPI_Exception
YAPI_Exception
- on errorpublic int getBridgeLatency() throws YAPI_Exception
YAPI_Exception
- on errorpublic int set_bridgeLatency(int newval) throws YAPI_Exception
newval
- : an integer corresponding to the current Wheatstone bridge excitation methodYAPI_Exception
- on errorpublic int setBridgeLatency(int newval) throws YAPI_Exception
newval
- : an integer corresponding to the current Wheatstone bridge excitation methodYAPI_Exception
- on errorpublic int get_adValue() throws YAPI_Exception
YAPI_Exception
- on errorpublic int getAdValue() throws YAPI_Exception
YAPI_Exception
- on errorpublic int get_adGain() throws YAPI_Exception
YAPI_Exception
- on errorpublic int getAdGain() throws YAPI_Exception
YAPI_Exception
- on errorpublic static YBridgeControl FindBridgeControl(String func)
func
- : a string that uniquely characterizes the Wheatstone bridge controllerpublic static YBridgeControl FindBridgeControlInContext(YAPIContext yctx, String func)
yctx
- : a YAPI contextfunc
- : a string that uniquely characterizes the Wheatstone bridge controllerpublic int registerValueCallback(YBridgeControl.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 YFunction
public YBridgeControl nextBridgeControl()
public static YBridgeControl FirstBridgeControl()
public static YBridgeControl FirstBridgeControlInContext(YAPIContext yctx)
yctx
- : a YAPI context.Copyright © 2017. All rights reserved.