Modifier and Type | Method and Description |
---|---|
String |
YCellular._AT(String cmd)
Sends an AT command to the GSM module and returns the command output.
|
protected com.yoctopuce.YoctoAPI.YJSONObject |
YFunction._devRequest(String extra) |
protected byte[] |
YFunction._download(String url) |
String |
YSensor._encodeCalibrationPoints(ArrayList<Double> rawValues,
ArrayList<Double> refValues) |
protected String |
YFunction._escapeAttr(String newval) |
byte[] |
YModule._flattenJsonStruct(byte[] jsoncomplex) |
protected com.yoctopuce.YoctoAPI.YDevice |
YModule._getDev() |
int |
YGyro._invokeGyroCallbacks(int qtIndex,
double qtValue) |
protected ArrayList<String> |
YFunction._json_get_array(byte[] json) |
protected String |
YFunction._json_get_key(byte[] json,
String key) |
protected String |
YFunction._json_get_string(byte[] json) |
int |
YGyro._loadAngles() |
int |
YGyro._loadQuaternion() |
protected int |
YDataSet._parse(String json_str) |
protected void |
YFunction._parse(com.yoctopuce.YoctoAPI.YJSONObject json,
long msValidity) |
int |
YDataStream._parseStream(byte[] sdata) |
protected int |
YFunction._setAttr(String attr,
String newval) |
void |
YModule._startStopDevLog_internal(String serial,
boolean start) |
void |
YModule._startStopDevLog(String serial,
boolean start) |
protected void |
YFunction._throw(int error,
String message) |
protected int |
YFunction._upload(String path,
byte[] content) |
protected int |
YFunction._upload(String pathname,
String content) |
int |
YMultiAxisController.abortAndBrake()
Stops the motor smoothly as soon as possible, without waiting for ongoing move completion.
|
int |
YStepperMotor.abortAndBrake()
Stops the motor smoothly as soon as possible, without waiting for ongoing move completion.
|
int |
YMultiAxisController.abortAndHiZ()
Turn the controller into Hi-Z mode immediately, without waiting for ongoing move completion.
|
int |
YStepperMotor.abortAndHiZ()
Turn the controller into Hi-Z mode immediately, without waiting for ongoing move completion.
|
int |
YBuzzer.addFreqMoveToPlaySeq(int freq,
int msDelay)
Adds a new frequency transition to the playing sequence.
|
int |
YColorLed.addHslMoveToBlinkSeq(int HSLcolor,
int msDelay)
Add a new transition to the blinking sequence, the move will
be performed in the HSL space.
|
int |
YColorLedCluster.addHslMoveToBlinkSeq(int seqIndex,
int hslValue,
int delay)
Adds an HSL transition to a sequence.
|
int |
YColorLedCluster.addJumpToBlinkSeq(int seqIndex,
int linkSeqIndex)
Adds to a sequence a jump to another sequence.
|
int |
YColorLedCluster.addMirrorToBlinkSeq(int seqIndex)
Adds a mirror ending to a sequence.
|
int |
YBuzzer.addNotesToPlaySeq(String notes)
Adds notes to the playing sequence.
|
int |
YBuzzer.addPulseToPlaySeq(int freq,
int msDuration)
Adds a pulse to the playing sequence.
|
int |
YColorLed.addRgbMoveToBlinkSeq(int RGBcolor,
int msDelay)
Adds a new transition to the blinking sequence, the move is
performed in the RGB space.
|
int |
YColorLedCluster.addRgbMoveToBlinkSeq(int seqIndex,
int rgbValue,
int delay)
Adds an RGB transition to a sequence.
|
int |
YColorLedCluster.addUnlinkToBlinkSeq(int seqIndex)
Adds a to a sequence a hard stop code.
|
int |
YBuzzer.addVolMoveToPlaySeq(int volume,
int msDuration)
Adds a new volume transition to the playing sequence.
|
int |
YWireless.adhocNetwork(String ssid,
String securityKey)
Changes the configuration of the wireless lan interface to create an ad-hoc
wireless network, without using an access point.
|
int |
YStepperMotor.alertStepDir(int dir)
Move one single step in the selected direction without regards to end switches.
|
int |
YStepperMotor.alertStepOut()
Move one step in the direction opposite the direction set when the most recent alert was raised.
|
int |
YMotor.brakingForceMove(double targetPower,
int delay)
Changes progressively the braking force applied to the motor for a specific duration.
|
int |
YLightSensor.calibrate(double calibratedVal)
Changes the sensor-specific calibration parameter so that the current value
matches a desired target (linear scaling).
|
int |
YSensor.calibrateFromPoints(ArrayList<Double> rawValues,
ArrayList<Double> refValues)
Configures error correction data points, in particular to compensate for
a possible perturbation of the measure caused by an enclosure.
|
int |
YNetwork.callbackLogin(String username,
String password)
Connects to the notification callback and saves the credentials required to
log into it.
|
int |
YRefFrame.cancel3DCalibration()
Aborts the sensors tridimensional calibration process et restores normal settings.
|
int |
YRangeFinder.cancelCoverGlassCalibrations()
Cancels the effect of previous hardware calibration procedures to compensate
for cover glass, and restores factory settings.
|
int |
YStepperMotor.changeSpeed(double speed)
Starts the motor at a given speed.
|
static void |
YJniWrapper.Check() |
String |
YModule.checkFirmware(String path,
boolean onlynew)
Tests whether the byn file is valid for this module.
|
int |
YMessageBox.checkNewMessages() |
int |
YDisplayLayer.clear()
Erases the whole content of the layer (makes it fully transparent).
|
int |
YDisplayLayer.clearConsole()
Blanks the console area within console margins, and resets the console pointer
to the upper left corner of the console.
|
int |
YCellular.clearDataCounters()
Clear the transmitted data counters.
|
int |
YMessageBox.clearPduCounters()
Clear the SMS units counters.
|
int |
YMessageBox.clearSIMSlot(int slot) |
int |
YBluetoothLink.connect()
Attempt to connect to the previously selected remote device.
|
void |
WSHandlerInterface.connect(com.yoctopuce.YoctoAPI.YHTTPHub hub,
boolean first_notification_connection,
int mstimeout,
int notifAbsPos) |
void |
WSHandlerJEE.connect(com.yoctopuce.YoctoAPI.YHTTPHub hub,
boolean first_notification_connection,
int mstimeout,
int notifAbsPos) |
int |
YDisplayLayer.consoleOut(String text)
Outputs a message in the console area, and advances the console pointer accordingly.
|
int |
YDisplay.copyLayerContent(int srcLayerId,
int dstLayerId)
Copies the whole content of a layer to another layer.
|
int |
YCurrentLoopOutput.currentMove(double mA_target,
int ms_duration)
Performs a smooth transition of current flowing in the loop.
|
int |
YWatchdog.delayedPulse(int ms_delay,
int ms_duration)
Schedules a pulse.
|
int |
YRelay.delayedPulse(int ms_delay,
int ms_duration)
Schedules a pulse.
|
int |
YDigitalIO.delayedPulse(int bitno,
int ms_delay,
int ms_duration)
Schedules a pulse on a single bit for a specified duration.
|
int |
YSms.deleteFromSIM() |
int |
YBluetoothLink.disconnect()
Disconnect from the previously selected remote device.
|
byte[] |
YFiles.download(String pathname)
Downloads the requested file and returns a binary buffer with its content.
|
byte[] |
YModule.download(String pathname)
Downloads the specified built-in file and returns a binary buffer with its content.
|
int |
YDisplayLayer.drawBar(int x1,
int y1,
int x2,
int y2)
Draws a filled rectangular bar at a specified position.
|
int |
YDisplayLayer.drawBitmap(int x,
int y,
int w,
byte[] bitmap,
int bgcol)
Draws a bitmap at the specified position.
|
int |
YDisplayLayer.drawCircle(int x,
int y,
int r)
Draws an empty circle at a specified position.
|
int |
YDisplayLayer.drawDisc(int x,
int y,
int r)
Draws a filled disc at a given position.
|
int |
YDisplayLayer.drawImage(int x,
int y,
String imagename)
Draws a GIF image at the specified position.
|
int |
YDisplayLayer.drawPixel(int x,
int y)
Draws a single pixel at the specified position.
|
int |
YDisplayLayer.drawRect(int x1,
int y1,
int x2,
int y2)
Draws an empty rectangle at a specified position.
|
int |
YDisplayLayer.drawText(int x,
int y,
YDisplayLayer.ALIGN anchor,
String text)
Draws a text string at the specified position.
|
int |
YMotor.drivingForceMove(double targetPower,
int delay)
Changes progressively the power sent to the motor for a specific duration.
|
int |
YPwmOutput.dutyCycleMove(double target,
int ms_duration)
Performs a smooth change of the duty cycle toward a given value.
|
int |
YMultiAxisController.emergencyStop()
Stops the motor with an emergency alert, without taking any additional precaution.
|
int |
YStepperMotor.emergencyStop()
Stops the motor with an emergency alert, without taking any additional precaution.
|
void |
YAPIContext.EnableUSBHost(Object osContext)
This function is used only on Android.
|
static void |
YAPI.EnableUSBHost(Object osContext)
This function is used only on Android.
|
int |
YDisplay.fade(int brightness,
int duration)
Smoothly changes the brightness of the screen to produce a fade-in or fade-out
effect.
|
YSms |
YMessageBox.fetchPdu(int slot) |
boolean |
YFiles.fileExist(String filename)
Test if a file exist on the filesystem of the module.
|
int |
YMultiAxisController.findHomePosition(ArrayList<Double> speed)
Starts all motors backward at the specified speeds, to search for the motor home position.
|
int |
YStepperMotor.findHomePosition(double speed)
Starts the motor backward at the specified speed, to search for the motor home position.
|
int |
YDisplayLayer.flush_now() |
int |
YDisplay.flushLayers() |
int |
YDataLogger.forgetAllDataStreams()
Clears the data logger memory and discards all recorded data streams.
|
int |
YFiles.format_fs()
Reinitialize the filesystem to its clean, unfragmented, empty state.
|
int |
YBuzzer.freqMove(int frequency,
int duration)
Makes the buzzer frequency change over a period of time.
|
int |
YPwmOutput.frequencyMove(double target,
int ms_duration)
Performs a smooth frequency change toward a given value.
|
String |
YModule.functionBaseType(int functionIndex)
Retrieves the base type of the nth function on the module.
|
int |
YModule.functionCount()
Returns the number of functions (beside the "module" interface) available on the module.
|
String |
YModule.functionId(int functionIndex)
Retrieves the hardware identifier of the nth function on the module.
|
String |
YModule.functionName(int functionIndex)
Retrieves the logical name of the nth function on the module.
|
String |
YModule.functionType(int functionIndex)
Retrieves the type of the nth function on the module.
|
String |
YModule.functionValue(int functionIndex)
Retrieves the advertised value of the nth function on the module.
|
int |
YCarbonDioxide.get_abcPeriod()
Returns the Automatic Baseline Calibration period, in hours.
|
double |
YHumidity.get_absHum()
Returns the current absolute humidity, in grams per cubic meter of air.
|
int |
YColorLedCluster.get_activeLedCount()
Returns the number of LEDs currently handled by the device.
|
String |
YNetwork.get_adminPassword()
Returns a hash string if a password has been set for user "admin",
or an empty string otherwise.
|
String |
YFunction.get_advertisedValue()
Returns a short string representing the current state of the function.
|
int |
YSensor.get_advMode()
Returns the measuring mode used for the advertised value pushed to the parent hub.
|
int |
YCellular.get_airplaneMode()
Returns true if the airplane mode is active (radio turned off).
|
String |
YStepperMotor.get_alertMode() |
byte[] |
YModule.get_allSettings()
Returns all the settings and uploaded files of the module.
|
double |
YGps.get_altitude()
Returns the current altitude.
|
int |
YAnButton.get_analogCalibration()
Tells if a calibration process is currently ongoing.
|
String |
YCellular.get_apn()
Returns the Access Point Name (APN) to be used, if needed.
|
String |
YCellular.get_apnSecret()
Returns an opaque string if APN authentication parameters have been configured
in the device, or an empty string otherwise.
|
int |
YWatchdog.get_autoStart()
Returns the watchdog running state at module power on.
|
int |
YDataLogger.get_autoStart()
Returns the default activation state of the data logger on power up.
|
String |
YStepperMotor.get_auxMode() |
int |
YStepperMotor.get_auxSignal()
Returns the current value of the signal generated on the auxiliary output.
|
ArrayList<String> |
YCellular.get_availableOperators()
Returns the list detected cell operators in the neighborhood.
|
double |
YDataStream.get_averageValue()
Returns the average of all measures observed within this stream.
|
int |
YTilt.get_axis() |
int |
YCompass.get_axis() |
int |
YTilt.get_bandwidth()
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YCompass.get_bandwidth()
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YGyro.get_bandwidth()
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YAccelerometer.get_bandwidth()
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YMagnetometer.get_bandwidth()
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YHubPort.get_baudRate()
Returns the current baud rate used by this Yocto-hub port, in kbps.
|
int |
YModule.get_beacon()
Returns the state of the localization beacon.
|
int |
YDataLogger.get_beaconDriven()
Returns true if the data logger is synchronised with the localization beacon.
|
double |
YRefFrame.get_bearing()
Returns the reference bearing used by the compass.
|
int |
YDigitalIO.get_bitDirection(int bitno)
Returns the direction of a single bit (i.e.
|
int |
YDigitalIO.get_bitOpenDrain(int bitno)
Returns the type of electrical interface of a single bit from the I/O port.
|
int |
YDigitalIO.get_bitPolarity(int bitno)
Returns the polarity of a single bit from the I/O port (0 means the I/O works in regular mode, 1
means the I/O works in reverse mode).
|
int |
YDigitalIO.get_bitState(int bitno)
Returns the state of a single bit (i.e.
|
int |
YLed.get_blinking()
Returns the current LED signaling mode.
|
int |
YColorLedCluster.get_blinkSeqMaxCount()
Returns the maximum number of sequences that the device can handle.
|
int |
YColorLedCluster.get_blinkSeqMaxSize()
Returns the maximum length of sequences.
|
int |
YColorLed.get_blinkSeqMaxSize()
Returns the maximum length of the blinking sequence.
|
int |
YColorLed.get_blinkSeqSignature()
Return the blinking sequence signature.
|
ArrayList<Integer> |
YColorLedCluster.get_blinkSeqSignatures(int seqIndex,
int count)
Returns a list on 32 bit signatures for specified blinking sequences.
|
int |
YColorLed.get_blinkSeqSize()
Returns the current length of the blinking sequence.
|
ArrayList<Integer> |
YColorLedCluster.get_blinkSeqState(int seqIndex,
int count)
Returns a list of integers with the started state for specified blinking sequences.
|
ArrayList<Integer> |
YColorLedCluster.get_blinkSeqStateAtPowerOn(int seqIndex,
int count)
Returns a list of integers with the "auto-start at power on" flag state for specified blinking sequences.
|
ArrayList<Integer> |
YColorLedCluster.get_blinkSeqStateSpeed(int seqIndex,
int count)
Returns a list of integers with the current speed for specified blinking sequences.
|
double |
YMotor.get_brakingForce()
Returns the braking force applied to the motor, as a percentage.
|
int |
YDisplay.get_brightness()
Returns the luminosity of the module informative LEDs (from 0 to 100).
|
int |
YAnButton.get_calibratedValue()
Returns the current calibrated input value (between 0 and 1000, included).
|
int |
YAnButton.get_calibrationMax()
Returns the maximal value measured during the calibration (between 0 and 4095, included).
|
int |
YAnButton.get_calibrationMin()
Returns the minimal value measured during the calibration (between 0 and 4095, included).
|
String |
YRefFrame.get_calibrationParam() |
String |
YSensor.get_calibrationParam() |
int |
YRefFrame.get_calibrationState()
Returns the 3D sensor calibration state (Yocto-3D-V2 only).
|
String |
YNetwork.get_callbackCredentials()
Returns a hashed version of the notification callback credentials if set,
or an empty string otherwise.
|
int |
YNetwork.get_callbackEncoding()
Returns the encoding standard to use for representing notification values.
|
int |
YNetwork.get_callbackInitialDelay()
Returns the initial waiting time before first callback notifications, in seconds.
|
int |
YNetwork.get_callbackMaxDelay()
Returns the waiting time between two HTTP callbacks when there is nothing new.
|
int |
YNetwork.get_callbackMethod()
Returns the HTTP method used to notify callbacks for significant state changes.
|
int |
YNetwork.get_callbackMinDelay()
Returns the minimum waiting time between two HTTP callbacks, in seconds.
|
String |
YNetwork.get_callbackSchedule()
Returns the HTTP callback schedule strategy, as a text string.
|
String |
YNetwork.get_callbackUrl()
Returns the callback URL to notify of significant state changes.
|
int |
YMultiCellWeighScale.get_cellCount()
Returns the number of load cells in use.
|
String |
YCellular.get_cellIdentifier()
Returns the unique identifier of the cellular antenna in use: MCC, MNC, LAC and Cell ID.
|
String |
YCellular.get_cellOperator()
Returns the name of the cell operator currently in use.
|
int |
YCellular.get_cellType()
Active cellular connection type.
|
int |
YWireless.get_channel()
Returns the 802.11 channel currently used, or 0 when the selected network has not been found.
|
int |
YDaisyChain.get_childCount()
Returns the number of child nodes currently detected.
|
int |
YDataLogger.get_clearHistory() |
int |
YDataStream.get_columnCount()
Returns the number of data columns present in this stream.
|
ArrayList<String> |
YDataStream.get_columnNames()
Returns the title (or meaning) of each data column present in this stream.
|
String |
YColorLedCluster.get_command() |
String |
YCarbonDioxide.get_command() |
String |
YSerialPort.get_command() |
String |
YMessageBox.get_command() |
String |
YBluetoothLink.get_command() |
String |
YTemperature.get_command() |
String |
YDigitalIO.get_command() |
String |
YMultiSensController.get_command() |
String |
YRangeFinder.get_command() |
String |
YColorLed.get_command() |
String |
YGps.get_command() |
String |
YMultiAxisController.get_command() |
String |
YCellular.get_command() |
String |
YWeighScale.get_command() |
String |
YPowerSupply.get_command() |
String |
YStepperMotor.get_command() |
String |
YSpiPort.get_command() |
String |
YDisplay.get_command() |
String |
YBuzzer.get_command() |
String |
YMotor.get_command() |
String |
YMultiCellWeighScale.get_command() |
double |
YWeighScale.get_compensation()
Returns the current current thermal compensation value.
|
double |
YMultiCellWeighScale.get_compensation()
Returns the current current thermal compensation value.
|
double |
YWeighScale.get_compTempAvg()
Returns the current averaged temperature, used for thermal compensation.
|
double |
YMultiCellWeighScale.get_compTempAvg()
Returns the current averaged temperature, used for thermal compensation.
|
double |
YWeighScale.get_compTempChg()
Returns the current temperature variation, used for thermal compensation.
|
double |
YMultiCellWeighScale.get_compTempChg()
Returns the current temperature variation, used for thermal compensation.
|
int |
YGps.get_coordSystem()
Returns the representation system used for positioning data.
|
double |
YPower.get_cosPhi()
Returns the power factor (the ratio between the real power consumed,
measured in W, and the apparent power provided, measured in VA).
|
long |
YWatchdog.get_countdown()
Returns the number of milliseconds remaining before a pulse (delayedPulse() call)
When there is no scheduled pulse, returns zero.
|
long |
YRelay.get_countdown()
Returns the number of milliseconds remaining before a pulse (delayedPulse() call)
When there is no scheduled pulse, returns zero.
|
int |
YSerialPort.get_CTS()
Reads the level of the CTS line.
|
double |
YCurrentLoopOutput.get_current()
Returns the loop current set point in mA.
|
double |
YPowerSupply.get_currentAtStartUp()
Returns the selected current limit at device startup, in mA.
|
double |
YCurrentLoopOutput.get_currentAtStartUp()
Returns the current in the loop at device startup, in mA.
|
String |
YSerialPort.get_currentJob()
Returns the name of the job file currently in use.
|
String |
YSpiPort.get_currentJob()
Returns the name of the job file currently in use.
|
double |
YPowerSupply.get_currentLimit()
Returns the current limit, in mA.
|
double |
YSensor.get_currentRawValue()
Returns the uncalibrated, unrounded raw value returned by the sensor, in the specified unit, as a
floating point number.
|
int |
YDataLogger.get_currentRunIndex()
Returns the current run number, corresponding to the number of times the module was
powered on with the dataLogger enabled at some point.
|
double |
YRangeFinder.get_currentTemperature()
Returns the current sensor temperature, as a floating point number.
|
String |
YCurrentLoopOutput.get_currentTransition() |
double |
YSensor.get_currentValue()
Returns the current value of the measure, in the specified unit, as a floating point number.
|
double |
YVoltageOutput.get_currentVoltage()
Returns the output voltage set point, in V.
|
double |
YMotor.get_cutOffVoltage()
Returns the threshold voltage under which the controller automatically switches to error state
and prevents further current draw.
|
int |
YDaisyChain.get_daisyState()
Returns the state of the daisy-link between modules.
|
double |
YDataStream.get_data(int row,
int col)
Returns a single measure from the data stream, specified by its
row and column index.
|
YDataLogger |
YSensor.get_dataLogger()
Returns the YDatalogger object of the device hosting the sensor.
|
int |
YCellular.get_dataReceived()
Returns the number of bytes received so far.
|
ArrayList<ArrayList<Double>> |
YDataStream.get_dataRows()
Returns the whole data set contained in the stream, as a bidimensional
table of numbers.
|
int |
YCellular.get_dataSent()
Returns the number of bytes sent so far.
|
ArrayList<YDataSet> |
YDataLogger.get_dataSets()
Returns a list of YDataSet objects that can be used to retrieve
all measures stored by the data logger.
|
String |
YGps.get_dateTime()
Returns the current time in the form "YYYY/MM/DD hh:mm:ss".
|
String |
YRealTimeClock.get_dateTime()
Returns the current time in the form "YYYY/MM/DD hh:mm:ss".
|
int |
YPwmInput.get_debouncePeriod()
Returns the shortest expected pulse duration, in ms.
|
int |
YQuadratureDecoder.get_decoding()
Returns the current activation state of the quadrature decoder.
|
String |
YNetwork.get_defaultPage()
Returns the HTML page to serve for the URL "/"" of the hub.
|
YWatchdog.YDelayedPulse |
YWatchdog.get_delayedPulseTimer() |
YRelay.YDelayedPulse |
YRelay.get_delayedPulseTimer() |
ArrayList<YWlanRecord> |
YWireless.get_detectedWlans()
Returns a list of YWlanRecord objects that describe detected Wireless networks.
|
int |
YProximity.get_detectionHysteresis()
Returns the hysteresis used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
|
int |
YProximity.get_detectionThreshold()
Returns the threshold used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
|
int |
YStepperMotor.get_diags()
Returns the stepper motor controller diagnostics, as a bitmap.
|
double |
YGps.get_dilution()
Returns the current horizontal dilution of precision,
the smaller that number is, the better .
|
double |
YGps.get_direction()
Returns the current move bearing in degrees, zero
is the true (geographic) north.
|
int |
YNetwork.get_discoverable()
Returns the activation state of the multicast announce protocols to allow easy
discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
|
String |
YSegmentedDisplay.get_displayedText()
Returns the text currently displayed on the screen.
|
int |
YDisplayLayer.get_displayHeight()
Returns the display height, in pixels.
|
int |
YDisplay.get_displayHeight()
Returns the display height, in pixels.
|
YDisplayLayer |
YDisplay.get_displayLayer(int layerId)
Returns a YDisplayLayer object that can be used to draw on the specified
layer.
|
int |
YSegmentedDisplay.get_displayMode() |
int |
YDisplay.get_displayType()
Returns the display type: monochrome, gray levels or full color.
|
int |
YDisplayLayer.get_displayWidth()
Returns the display width, in pixels.
|
int |
YDisplay.get_displayWidth()
Returns the display width, in pixels.
|
double |
YMotor.get_drivingForce()
Returns the power sent to the motor, as a percentage between -100% and +100%.
|
double |
YPwmOutput.get_dutyCycle()
Returns the PWM duty cycle, in per cents.
|
double |
YPwmInput.get_dutyCycle()
Returns the PWM duty cycle, in per cents.
|
double |
YPwmOutput.get_dutyCycleAtPowerOn()
Returns the PWMs duty cycle at device power on as a floating point number between 0 and 100.
|
int |
YCurrent.get_enabled()
Returns the activation state of this input.
|
int |
YPwmOutput.get_enabled()
Returns the state of the PWMs.
|
int |
YDisplay.get_enabled()
Returns true if the screen is powered, false otherwise.
|
int |
YServo.get_enabled()
Returns the state of the servos.
|
int |
YHubPort.get_enabled()
Returns true if the Yocto-hub port is powered, false otherwise.
|
int |
YGenericSensor.get_enabled()
Returns the activation state of this input.
|
int |
YVoltage.get_enabled()
Returns the activation state of this input.
|
int |
YCellular.get_enableData()
Returns the condition for enabling IP data services (GPRS).
|
int |
YPwmOutput.get_enabledAtPowerOn()
Returns the state of the PWM at device power on.
|
int |
YServo.get_enabledAtPowerOn()
Returns the servo signal generator state at power up.
|
int |
YSerialPort.get_errCount()
Returns the total number of communication errors detected since last reset.
|
int |
YSpiPort.get_errCount()
Returns the total number of communication errors detected since last reset.
|
int |
YWeighScale.get_excitation()
Returns the current load cell bridge excitation method.
|
int |
YMultiCellWeighScale.get_excitation()
Returns the current load cell bridge excitation method.
|
int |
YDualPower.get_extVoltage()
Returns the measured voltage on the external power source, in millivolts.
|
int |
YMotor.get_failSafeTimeout()
Returns the delay in milliseconds allowed for the controller to run autonomously without
receiving any instruction from the control process.
|
int |
YFiles.get_filesCount()
Returns the number of files currently loaded in the filesystem.
|
String |
YModule.get_firmwareRelease()
Returns the version of the firmware embedded in the module.
|
int |
YFiles.get_freeSpace()
Returns the free space for uploading new files to the filesystem, in bytes.
|
double |
YPwmOutput.get_frequency()
Returns the PWM frequency in Hz.
|
double |
YBuzzer.get_frequency()
Returns the frequency of the signal sent to the buzzer/speaker.
|
double |
YMotor.get_frequency()
Returns the PWM frequency used to control the motor.
|
double |
YPwmInput.get_frequency()
Returns the PWM frequency in Hz.
|
String |
YFunction.get_friendlyName()
Returns a global identifier of the function in the format MODULE_NAME.FUNCTION_NAME.
|
String |
YFunction.get_functionId()
Returns the hardware identifier of the function, without reference to the module.
|
ArrayList<String> |
YModule.get_functionIds(String funType)
Retrieve all hardware identifier that match the type passed in argument.
|
int |
YRefFrame.get_fusionMode() |
int |
YMultiAxisController.get_globalState()
Returns the stepper motor set overall state.
|
int |
YAccelerometer.get_gravityCancellation() |
double |
YGps.get_groundSpeed()
Returns the current ground speed in Km/h.
|
String |
YRangeFinder.get_hardwareCalibration() |
double |
YRangeFinder.get_hardwareCalibrationTemperature()
Returns the temperature at the time when the latest calibration was performed.
|
String |
YFunction.get_hardwareId()
Returns the unique hardware identifier of the function in the form SERIAL.FUNCTIONID.
|
String |
YModule.get_hardwareId()
Returns the unique hardware identifier of the module.
|
String |
YDataSet.get_hardwareId()
Returns the unique hardware identifier of the function who performed the measures,
in the form SERIAL.FUNCTIONID.
|
double |
YGyro.get_heading()
Returns the estimated heading angle, based on the integration of
gyroscopic measures combined with acceleration and
magnetic field measurements.
|
double |
YSensor.get_highestValue()
Returns the maximal value observed for the measure since the device was started.
|
int |
YWakeUpSchedule.get_hours()
Returns the hours scheduled for wake up.
|
int |
YColorLed.get_hslColor()
Returns the current HSL color of the LED.
|
YColorLed.YMove |
YColorLed.get_hslMove() |
int |
YNetwork.get_httpPort()
Returns the HTML page to serve for the URL "/"" of the hub.
|
byte[] |
YModule.get_icon2d()
Returns the icon of the module.
|
String |
YCellular.get_imsi()
Returns an opaque string if a PIN code has been configured in the device to access
the SIM card, or an empty string if none has been configured or if the code provided
was rejected by the SIM card.
|
double |
YPowerSupply.get_inputVoltage()
Returns the measured input voltage, in V.
|
String |
YNetwork.get_ipAddress()
Returns the IP address currently in use by the device.
|
String |
YNetwork.get_ipConfig()
Returns the IP configuration of the network interface.
|
int |
YGps.get_isFixed()
Returns TRUE if the receiver has found enough satellites to work.
|
int |
YProximity.get_isPresent()
Returns true if the input (considered as binary) is active (detection value is smaller than the
specified threshold), and false otherwise.
|
int |
YAnButton.get_isPressed()
Returns true if the input (considered as binary) is active (closed contact), and false otherwise.
|
String |
YModule.get_lastLogs()
Returns a string with last logs of the module.
|
String |
YSerialPort.get_lastMsg()
Returns the latest message fully received (for Line, Frame and Modbus protocols).
|
String |
YSpiPort.get_lastMsg()
Returns the latest message fully received (for Line and Frame protocols).
|
long |
YProximity.get_lastTimeApproached()
Returns the number of elapsed milliseconds between the module power on and the last observed
detection (the input contact transitioned from absent to present).
|
long |
YAnButton.get_lastTimePressed()
Returns the number of elapsed milliseconds between the module power on and the last time
the input button was pressed (the input contact transitioned from open to closed).
|
long |
YAnButton.get_lastTimeReleased()
Returns the number of elapsed milliseconds between the module power on and the last time
the input button was released (the input contact transitioned from closed to open).
|
long |
YProximity.get_lastTimeRemoved()
Returns the number of elapsed milliseconds between the module power on and the last observed
detection (the input contact transitioned from present to absent).
|
String |
YGps.get_latitude()
Returns the current latitude.
|
int |
YDisplay.get_layerCount()
Returns the number of available layers to draw on.
|
int |
YDisplayLayer.get_layerHeight()
Returns the height of the layers to draw on, in pixels.
|
int |
YDisplay.get_layerHeight()
Returns the height of the layers to draw on, in pixels.
|
int |
YDisplayLayer.get_layerWidth()
Returns the width of the layers to draw on, in pixels.
|
int |
YDisplay.get_layerWidth()
Returns the width of the layers to draw on, in pixels.
|
double |
YPowerSupply.get_ldoTemperature()
Returns the LDO temperature, in Celsius.
|
int |
YColorLedCluster.get_ledType()
Returns the RGB LED type currently handled by the device.
|
ArrayList<Integer> |
YColorLedCluster.get_linkedSeqArray(int ledIndex,
int count)
Returns a list on sequence index for each RGB LED.
|
int |
YWireless.get_linkQuality()
Returns the link quality, expressed in percent.
|
int |
YBluetoothLink.get_linkQuality()
Returns the bluetooth receiver signal strength, in pourcents, or 0 if no connection is established.
|
int |
YCellular.get_linkQuality()
Returns the link quality, expressed in percent.
|
int |
YBluetoothLink.get_linkState()
Returns the bluetooth link state.
|
ArrayList<YFileRecord> |
YFiles.get_list(String pattern)
Returns a list of YFileRecord objects that describe files currently loaded
in the filesystem.
|
String |
YCellular.get_lockedOperator()
Returns the name of the only cell operator to use if automatic choice is disabled,
or an empty string if the SIM card will automatically choose among available
cell operators.
|
String |
YSensor.get_logFrequency()
Returns the datalogger recording frequency for this function, or "OFF"
when measures are not stored in the data logger flash memory.
|
String |
YFunction.get_logicalName()
Returns the logical name of the function.
|
String |
YGps.get_longitude()
Returns the current longitude.
|
int |
YCurrentLoopOutput.get_loopPower()
Returns the loop powerstate.
|
double |
YSensor.get_lowestValue()
Returns the minimal value observed for the measure since the device was started.
|
int |
YLed.get_luminosity()
Returns the current LED intensity (in per cent).
|
int |
YModule.get_luminosity()
Returns the luminosity of the module informative LEDs (from 0 to 100).
|
String |
YNetwork.get_macAddress()
Returns the MAC address of the network interface.
|
double |
YCompass.get_magneticHeading()
Returns the magnetic heading, regardless of the configured bearing.
|
int |
YMultiSensController.get_maintenanceMode()
Returns true when the device is in maintenance mode.
|
double |
YStepperMotor.get_maxAccel()
Returns the maximal motor acceleration, measured in steps per second^2.
|
int |
YColorLedCluster.get_maxLedCount()
Returns the maximum number of LEDs that the device can handle.
|
int |
YMultiSensController.get_maxSensors()
Returns the maximum configurable sensor count allowed on this device.
|
double |
YStepperMotor.get_maxSpeed()
Returns the maximal motor speed, measured in steps per second.
|
long |
YWatchdog.get_maxTimeOnStateA()
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
|
long |
YRelay.get_maxTimeOnStateA()
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
|
long |
YWatchdog.get_maxTimeOnStateB()
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
|
long |
YRelay.get_maxTimeOnStateB()
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
|
double |
YDataStream.get_maxValue()
Returns the largest measure observed within this stream.
|
double |
YPowerSupply.get_measuredCurrent()
Returns the measured output current, in mA.
|
double |
YPowerSupply.get_measuredVoltage()
Returns the measured output voltage, in V.
|
int |
YRefFrame.get_measureQuality()
Returns estimated quality of the orientation (Yocto-3D-V2 only).
|
ArrayList<YMeasure> |
YDataSet.get_measures()
Returns all measured values currently available for this DataSet,
as a list of YMeasure objects.
|
ArrayList<YMeasure> |
YDataSet.get_measuresAt(YMeasure measure)
Returns the detailed set of measures for the time interval corresponding
to a given condensed measures previously returned by get_preview().
|
int |
YLightSensor.get_measureType()
Returns the type of light measure.
|
String |
YWireless.get_message()
Returns the latest status message from the wireless interface.
|
String |
YCellular.get_message()
Returns the latest status message from the wireless interface.
|
ArrayList<YSms> |
YMessageBox.get_messages()
Returns the list of messages received and not deleted.
|
double |
YPower.get_meter()
Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time.
|
int |
YPower.get_meterTimer()
Returns the elapsed time since last energy counter reset, in seconds.
|
long |
YWakeUpSchedule.get_minutes()
Returns all the minutes of each hour that are scheduled for wake up.
|
int |
YWakeUpSchedule.get_minutesA()
Returns the minutes in the 00-29 interval of each hour scheduled for wake up.
|
int |
YWakeUpSchedule.get_minutesB()
Returns the minutes in the 30-59 interval of each hour scheduled for wake up.
|
double |
YDataStream.get_minValue()
Returns the smallest measure observed within this stream.
|
int |
YWakeUpSchedule.get_monthDays()
Returns the days of the month scheduled for wake up.
|
int |
YWakeUpSchedule.get_months()
Returns the months scheduled for wake up.
|
int |
YStepperMotor.get_motorState()
Returns the motor working state.
|
int |
YMotor.get_motorStatus()
Return the controller state.
|
YRefFrame.MOUNTORIENTATION |
YRefFrame.get_mountOrientation()
Returns the installation orientation of the device, as configured
in order to define the reference frame for the compass and the
pitch/roll tilt sensors.
|
int |
YRefFrame.get_mountPos() |
YRefFrame.MOUNTPOSITION |
YRefFrame.get_mountPosition()
Returns the installation position of the device, as configured
in order to define the reference frame for the compass and the
pitch/roll tilt sensors.
|
YServo.YMove |
YServo.get_move() |
int |
YAudioIn.get_mute()
Returns the state of the mute function.
|
int |
YBluetoothLink.get_mute()
Returns the state of the mute function.
|
int |
YAudioOut.get_mute()
Returns the state of the mute function.
|
int |
YMultiAxisController.get_nAxis()
Returns the number of synchronized controllers.
|
int |
YServo.get_neutral()
Returns the duration in microseconds of a neutral pulse for the servo.
|
long |
YWakeUpSchedule.get_nextOccurence()
Returns the date/time (seconds) of the next wake up occurrence.
|
long |
YWakeUpMonitor.get_nextWakeUp()
Returns the next scheduled wake up date/time (UNIX format).
|
int |
YAudioIn.get_noSignalFor()
Returns the number of seconds elapsed without detecting a signal.
|
int |
YAudioOut.get_noSignalFor()
Returns the number of seconds elapsed without detecting a signal.
|
int |
YMultiSensController.get_nSensors()
Returns the number of sensors to poll.
|
String |
YNetwork.get_ntpServer()
Returns the IP address of the NTP server to be used by the device.
|
int |
YDisplay.get_orientation()
Returns the currently selected display orientation.
|
int |
YWatchdog.get_output()
Returns the output state of the watchdog, when used as a simple switch (single throw).
|
int |
YRelay.get_output()
Returns the output state of the relays, when used as a simple switch (single throw).
|
int |
YDigitalIO.get_outputVoltage()
Returns the voltage source used to drive output bits.
|
int |
YStepperMotor.get_overcurrent()
Returns the overcurrent alert and emergency stop threshold, measured in mA.
|
int |
YMotor.get_overCurrentLimit()
Returns the current threshold (in mA) above which the controller automatically
switches to error state.
|
String |
YBluetoothLink.get_ownAddress()
Returns the MAC-48 address of the bluetooth interface, which is unique on the bluetooth network.
|
String |
YBluetoothLink.get_pairingPin()
Returns an opaque string if a PIN code has been configured in the device to access
the SIM card, or an empty string if none has been configured or if the code provided
was rejected by the SIM card.
|
String |
YModule.get_parentHub()
Returns the serial number of the YoctoHub on which this module is connected.
|
int |
YMessageBox.get_pduReceived()
Returns the number of SMS units received so far.
|
ArrayList<YSms> |
YMessageBox.get_pdus() |
int |
YMessageBox.get_pduSent()
Returns the number of SMS units sent so far.
|
double |
YPwmOutput.get_period()
Returns the PWM period in milliseconds.
|
double |
YPwmInput.get_period()
Returns the PWM period in milliseconds.
|
int |
YModule.get_persistentSettings()
Returns the current state of persistent module settings.
|
String |
YCellular.get_pin()
Returns an opaque string if a PIN code has been configured in the device to access
the SIM card, or an empty string if none has been configured or if the code provided
was rejected by the SIM card.
|
int |
YCellular.get_pingInterval()
Returns the automated connectivity check interval, in seconds.
|
double |
YGyro.get_pitch()
Returns the estimated pitch angle, based on the integration of
gyroscopic measures combined with acceleration and
magnetic field measurements.
|
int |
YBuzzer.get_playSeqMaxSize()
Returns the maximum length of the playing sequence.
|
int |
YBuzzer.get_playSeqSignature()
Returns the playing sequence signature.
|
int |
YBuzzer.get_playSeqSize()
Returns the current length of the playing sequence.
|
int |
YNetwork.get_poeCurrent()
Returns the current consumed by the module from Power-over-Ethernet (PoE), in milliamps.
|
int |
YDigitalIO.get_portDiags()
Returns the port state diagnostics (Yocto-IO and Yocto-MaxiIO-V2 only).
|
int |
YDigitalIO.get_portDirection()
Returns the IO direction of all bits (i.e.
|
int |
YDigitalIO.get_portOpenDrain()
Returns the electrical interface for each bit of the port.
|
int |
YDigitalIO.get_portPolarity()
Returns the polarity of all the bits of the port.
|
int |
YDigitalIO.get_portSize()
Returns the number of bits (i.e.
|
int |
YDigitalIO.get_portState()
Returns the digital IO port state as an integer with each bit
representing a channel
value 0 = 0b00000000 -> all channels are OFF
value 1 = 0b00000001 -> channel #0 is ON
value 2 = 0b00000010 -> channel #1 is ON
value 3 = 0b00000011 -> channels #0 and #1 are ON
value 4 = 0b00000100 -> channel #2 is ON
and so on...
|
int |
YHubPort.get_portState()
Returns the current state of the Yocto-hub port.
|
int |
YServo.get_position()
Returns the current servo position.
|
int |
YServo.get_positionAtPowerOn()
Returns the servo position at device power up.
|
int |
YLed.get_power()
Returns the current LED state.
|
int |
YDualPower.get_powerControl()
Returns the selected power source for module functions that require lots of current.
|
int |
YWakeUpMonitor.get_powerDuration()
Returns the maximal wake up time (in seconds) before automatically going to sleep.
|
int |
YPwmPowerSource.get_powerMode()
Returns the selected power source for the PWM on the same device.
|
int |
YPowerSupply.get_powerOutput()
Returns the power supply output switch state.
|
int |
YDualPower.get_powerState()
Returns the current power source for module functions that require lots of current.
|
int |
YBluetoothLink.get_preAmplifier()
Returns the audio pre-amplifier volume, in per cents.
|
int |
YProximity.get_presenceMinTime()
Returns the minimal detection duration before signalling a presence event.
|
ArrayList<YMeasure> |
YDataSet.get_preview()
Returns a condensed version of the measures that can
retrieved in this YDataSet, as a list of YMeasure
objects.
|
String |
YNetwork.get_primaryDNS()
Returns the IP address of the primary name server to be used by the module.
|
int |
YModule.get_productId()
Returns the USB device identifier of the module.
|
String |
YModule.get_productName()
Returns the commercial name of the module, as set by the factory.
|
int |
YModule.get_productRelease()
Returns the hardware release version of the module.
|
String |
YSerialPort.get_protocol()
Returns the type of protocol used over the serial line, as a string.
|
String |
YSpiPort.get_protocol()
Returns the type of protocol used over the serial line, as a string.
|
int |
YProximity.get_proximityReportMode()
Returns the parameter (sensor value, presence or pulse count) returned by the get_currentValue
function and callbacks.
|
double |
YStepperMotor.get_pullinSpeed()
Returns the motor speed immediately reachable from stop state, measured in steps per second.
|
long |
YProximity.get_pulseCounter()
Returns the pulse counter value.
|
long |
YAnButton.get_pulseCounter()
Returns the pulse counter value.
|
long |
YPwmInput.get_pulseCounter()
Returns the pulse counter value.
|
double |
YPwmOutput.get_pulseDuration()
Returns the PWM pulse length in milliseconds, as a floating point number.
|
double |
YPwmInput.get_pulseDuration()
Returns the PWM pulse length in milliseconds, as a floating point number.
|
long |
YWatchdog.get_pulseTimer()
Returns the number of milliseconds remaining before the watchdog is returned to idle position
(state A), during a measured pulse generation.
|
long |
YProximity.get_pulseTimer()
Returns the timer of the pulse counter (ms).
|
long |
YRelay.get_pulseTimer()
Returns the number of milliseconds remaining before the relays is returned to idle position
(state A), during a measured pulse generation.
|
long |
YAnButton.get_pulseTimer()
Returns the timer of the pulses counter (ms).
|
long |
YPwmInput.get_pulseTimer()
Returns the timer of the pulses counter (ms).
|
int |
YPwmInput.get_pwmReportMode()
Returns the parameter (frequency/duty cycle, pulse width, edges count) returned by the
get_currentValue function and callbacks.
|
String |
YPwmOutput.get_pwmTransition() |
double |
YAltitude.get_qnh()
Returns the barometric pressure adjusted to sea level used to compute
the altitude (QNH).
|
int |
YRangeFinder.get_quality()
Returns a measure quality estimate, based on measured dispersion.
|
double |
YGyro.get_quaternionW()
Returns the w component (real part) of the quaternion
describing the device estimated orientation, based on the
integration of gyroscopic measures combined with acceleration and
magnetic field measurements.
|
double |
YGyro.get_quaternionX()
Returns the x component of the quaternion
describing the device estimated orientation, based on the
integration of gyroscopic measures combined with acceleration and
magnetic field measurements.
|
double |
YGyro.get_quaternionY()
Returns the y component of the quaternion
describing the device estimated orientation, based on the
integration of gyroscopic measures combined with acceleration and
magnetic field measurements.
|
double |
YGyro.get_quaternionZ()
Returns the x component of the quaternion
describing the device estimated orientation, based on the
integration of gyroscopic measures combined with acceleration and
magnetic field measurements.
|
int |
YServo.get_range()
Returns the current range of use of the servo.
|
int |
YRangeFinder.get_rangeFinderMode()
Returns the range finder running mode.
|
int |
YAnButton.get_rawValue()
Returns the current measured input value as-is (between 0 and 4095, included).
|
int |
YNetwork.get_readiness()
Returns the current established working mode of the network interface.
|
int |
YModule.get_rebootCountdown()
Returns the remaining number of seconds before the module restarts, or zero when no
reboot has been scheduled.
|
YDataSet |
YSensor.get_recordedData(double startTime,
double endTime)
Retrieves a DataSet object holding historical data for this
sensor, for a specified time interval.
|
int |
YDataLogger.get_recording()
Returns the current activation state of the data logger.
|
double |
YHumidity.get_relHum()
Returns the current relative humidity, in per cents.
|
String |
YBluetoothLink.get_remoteAddress()
Returns the MAC-48 address of the remote device to connect to.
|
String |
YBluetoothLink.get_remoteName()
Returns the bluetooth name the remote device, if found on the bluetooth network.
|
int |
YProximity.get_removalMinTime()
Returns the minimal detection duration before signalling a removal event.
|
String |
YSensor.get_reportFrequency()
Returns the timed value notification frequency, or "OFF" if timed
value notifications are disabled for this function.
|
int |
YDaisyChain.get_requiredChildCount()
Returns the number of child nodes expected in normal conditions.
|
double |
YSensor.get_resolution()
Returns the resolution of the measured values.
|
int |
YColorLed.get_rgbColor()
Returns the current RGB color of the LED.
|
ArrayList<Integer> |
YColorLedCluster.get_rgbColorArray(int ledIndex,
int count)
Returns a list on 24bit RGB color values with the current colors displayed on
the RGB LEDs.
|
ArrayList<Integer> |
YColorLedCluster.get_rgbColorArrayAtPowerOn(int ledIndex,
int count)
Returns a list on 24bit RGB color values with the RGB LEDs startup colors.
|
int |
YColorLed.get_rgbColorAtPowerOn()
Returns the configured color to be displayed when the module is turned on.
|
byte[] |
YColorLedCluster.get_rgbColorBuffer(int ledIndex,
int count)
Returns a binary buffer with content from the LED RGB buffer, as is.
|
YColorLed.YMove |
YColorLed.get_rgbMove() |
double |
YGyro.get_roll()
Returns the estimated roll angle, based on the integration of
gyroscopic measures combined with acceleration and
magnetic field measurements.
|
String |
YNetwork.get_router()
Returns the IP address of the router on the device subnet (default gateway).
|
int |
YDataStream.get_rowCount()
Returns the number of data rows present in this stream.
|
long |
YWakeUpMonitor.get_rtcTime() |
int |
YWatchdog.get_running()
Returns the watchdog running state.
|
int |
YSerialPort.get_rxCount()
Returns the total number of bytes received since last reset.
|
int |
YSpiPort.get_rxCount()
Returns the total number of bytes received since last reset.
|
int |
YSerialPort.get_rxMsgCount()
Returns the total number of messages received since last reset.
|
int |
YSpiPort.get_rxMsgCount()
Returns the total number of messages received since last reset.
|
long |
YGps.get_satCount()
Returns the count of visible satellites.
|
String |
YNetwork.get_secondaryDNS()
Returns the IP address of the secondary name server to be used by the module.
|
int |
YWireless.get_security()
Returns the security algorithm used by the selected wireless network.
|
int |
YAnButton.get_sensitivity()
Returns the sensibility for the input (between 1 and 1000) for triggering user callbacks.
|
int |
YSensor.get_sensorState()
Returns the sensor health state code, which is zero when there is an up-to-date measure
available or a positive code if the sensor is not able to provide a measure right now.
|
int |
YTemperature.get_sensorType()
Returns the temperature sensor type.
|
String |
YSerialPort.get_serialMode()
Returns the serial port communication parameters, as a string such as
"9600,8N1".
|
String |
YFunction.get_serialNumber()
Returns the serial number of the module, as set by the factory.
|
String |
YModule.get_serialNumber()
Returns the serial number of the module, as set by the factory.
|
int |
YSpiPort.get_shiftSampling()
Returns true when the SDI line phase is shifted with regards to the SDO line.
|
int |
YOsControl.get_shutdownCountdown()
Returns the remaining number of seconds before the OS shutdown, or zero when no
shutdown has been scheduled.
|
int |
YAudioIn.get_signal()
Returns the detected input signal level.
|
int |
YAudioOut.get_signal()
Returns the detected output current level.
|
double |
YGenericSensor.get_signalBias()
Returns the electric signal bias for zero shift adjustment.
|
String |
YGenericSensor.get_signalRange()
Returns the electric signal range used by the sensor.
|
int |
YGenericSensor.get_signalSampling()
Returns the electric signal sampling method to use.
|
String |
YTemperature.get_signalUnit()
Returns the measuring unit of the electrical signal used by the sensor.
|
String |
YGenericSensor.get_signalUnit()
Returns the measuring unit of the electrical signal used by the sensor.
|
double |
YProximity.get_signalValue()
Returns the current value of signal measured by the proximity sensor.
|
double |
YTemperature.get_signalValue()
Returns the current value of the electrical signal measured by the sensor.
|
double |
YGenericSensor.get_signalValue()
Returns the current value of the electrical signal measured by the sensor.
|
int |
YWakeUpMonitor.get_sleepCountdown()
Returns the delay before the next sleep period.
|
String |
YMessageBox.get_slotsBitmap() |
int |
YMessageBox.get_slotsCount()
Returns the total number of message storage slots on the SIM card.
|
int |
YMessageBox.get_slotsInUse()
Returns the number of message storage slots currently in use.
|
double |
YStepperMotor.get_speed()
Returns current motor speed, measured in steps per second.
|
double |
YQuadratureDecoder.get_speed()
Returns the increments frequency, in Hz.
|
String |
YSpiPort.get_spiMode()
Returns the SPI port communication parameters, as a string such as
"125000,0,msb".
|
String |
YWireless.get_ssid()
Returns the wireless network name (SSID).
|
int |
YSpiPort.get_ssPolarity()
Returns the SS line polarity.
|
int |
YMotor.get_starterTime()
Returns the duration (in ms) during which the motor is driven at low frequency to help
it start up.
|
String |
YSerialPort.get_startupJob()
Returns the job file to use when the device is powered on.
|
String |
YSpiPort.get_startupJob()
Returns the job file to use when the device is powered on.
|
String |
YDisplay.get_startupSeq()
Returns the name of the sequence to play when the displayed is powered on.
|
int |
YWatchdog.get_state()
Returns the state of the watchdog (A for the idle position, B for the active position).
|
int |
YRelay.get_state()
Returns the state of the relays (A for the idle position, B for the active position).
|
int |
YWatchdog.get_stateAtPowerOn()
Returns the state of the watchdog at device startup (A for the idle position, B for the active
position, UNCHANGED for no change).
|
int |
YRelay.get_stateAtPowerOn()
Returns the state of the relays at device startup (A for the idle position, B for the active
position, UNCHANGED for no change).
|
int |
YStepperMotor.get_stepping()
Returns the stepping mode used to drive the motor.
|
double |
YStepperMotor.get_stepPos()
Returns the current logical motor position, measured in steps.
|
ArrayList<String> |
YModule.get_subDevices()
Returns a list of all the modules that are plugged into the current module.
|
String |
YNetwork.get_subnetMask()
Returns the subnet mask currently used by the device.
|
int |
YStepperMotor.get_tCurrRun()
Returns the torque regulation current when the motor is running, measured in mA.
|
int |
YStepperMotor.get_tCurrStop()
Returns the torque regulation current when the motor is stopped, measured in mA.
|
String |
YAltitude.get_technology()
Returns the technology used by the sesnor to compute
altitude.
|
double |
YWeighScale.get_tempAvgAdaptRatio()
Returns the averaged temperature update rate, in per mille.
|
double |
YMultiCellWeighScale.get_tempAvgAdaptRatio()
Returns the averaged temperature update rate, in per mille.
|
double |
YWeighScale.get_tempChgAdaptRatio()
Returns the temperature change update rate, in per mille.
|
double |
YMultiCellWeighScale.get_tempChgAdaptRatio()
Returns the temperature change update rate, in per mille.
|
long |
YRangeFinder.get_timeFrame()
Returns the time frame used to measure the distance and estimate the measure
reliability.
|
int |
YRealTimeClock.get_timeSet()
Returns true if the clock has been set, and false otherwise.
|
long |
YDataLogger.get_timeUTC()
Returns the Unix timestamp for current UTC time, if known.
|
long |
YWatchdog.get_triggerDelay()
Returns the waiting duration before a reset is automatically triggered by the watchdog, in milliseconds.
|
long |
YWatchdog.get_triggerDuration()
Returns the duration of resets caused by the watchdog, in milliseconds.
|
int |
YSerialPort.get_txCount()
Returns the total number of bytes transmitted since last reset.
|
int |
YSpiPort.get_txCount()
Returns the total number of bytes transmitted since last reset.
|
int |
YSerialPort.get_txMsgCount()
Returns the total number of messages send since last reset.
|
int |
YSpiPort.get_txMsgCount()
Returns the total number of messages send since last reset.
|
String |
YSensor.get_unit()
Returns the measuring unit for the measure.
|
String |
YDataSet.get_unit()
Returns the measuring unit for the measured value.
|
long |
YGps.get_unixTime()
Returns the current time in Unix format (number of
seconds elapsed since Jan 1st, 1970).
|
long |
YRealTimeClock.get_unixTime()
Returns the current time in Unix format (number of elapsed seconds since Jan 1st, 1970).
|
long |
YModule.get_upTime()
Returns the number of milliseconds spent since the module was powered on.
|
String |
YModule.get_url()
Returns the URL used to access the module.
|
int |
YDataLogger.get_usage()
Returns the percentage of datalogger memory in use.
|
int |
YModule.get_usbCurrent()
Returns the current consumed by the module on the USB bus, in milli-amps.
|
String |
YNetwork.get_userPassword()
Returns a hash string if a password has been set for "user" user,
or an empty string otherwise.
|
int |
YModule.get_userVar()
Returns the value previously stored in this attribute.
|
int |
YGps.get_utcOffset()
Returns the number of seconds between current time and UTC time (time zone).
|
int |
YRealTimeClock.get_utcOffset()
Returns the number of seconds between current time and UTC time (time zone).
|
String |
YGenericSensor.get_valueRange()
Returns the physical value range measured by the sensor.
|
double |
YPowerSupply.get_vInt()
Returns the internal voltage, in V.
|
int |
YPowerOutput.get_voltage()
Returns the voltage on the power output featured by the module.
|
double |
YVoltageOutput.get_voltageAtStartUp()
Returns the selected voltage output at device startup, in V.
|
double |
YPowerSupply.get_voltageAtStartUp()
Returns the selected voltage set point at device startup, in V.
|
int |
YSerialPort.get_voltageLevel()
Returns the voltage level used on the serial line.
|
int |
YSpiPort.get_voltageLevel()
Returns the voltage level used on the serial line.
|
int |
YPowerSupply.get_voltageSense()
Returns the output voltage control point.
|
double |
YPowerSupply.get_voltageSetPoint()
Returns the voltage set point, in V.
|
String |
YVoltageOutput.get_voltageTransition() |
String |
YPowerSupply.get_voltageTransition() |
int |
YAudioIn.get_volume()
Returns audio input gain, in per cents.
|
int |
YBluetoothLink.get_volume()
Returns the connected headset volume, in per cents.
|
int |
YAudioOut.get_volume()
Returns audio output volume, in per cents.
|
int |
YBuzzer.get_volume()
Returns the volume of the signal sent to the buzzer/speaker.
|
String |
YAudioIn.get_volumeRange()
Returns the supported volume range.
|
String |
YAudioOut.get_volumeRange()
Returns the supported volume range.
|
int |
YWakeUpMonitor.get_wakeUpReason()
Returns the latest wake up reason.
|
int |
YWakeUpMonitor.get_wakeUpState()
Returns the current state of the monitor.
|
int |
YWakeUpSchedule.get_weekDays()
Returns the days of the week scheduled for wake up.
|
String |
YWireless.get_wlanConfig() |
int |
YWireless.get_wlanState()
Returns the current state of the wireless interface.
|
int |
YNetwork.get_wwwWatchdogDelay()
Returns the allowed downtime of the WWW link (in seconds) before triggering an automated
reboot to try to recover Internet connectivity.
|
double |
YGyro.get_xValue()
Returns the angular velocity around the X axis of the device, as a floating point number.
|
double |
YAccelerometer.get_xValue()
Returns the X component of the acceleration, as a floating point number.
|
double |
YMagnetometer.get_xValue()
Returns the X component of the magnetic field, as a floating point number.
|
double |
YGyro.get_yValue()
Returns the angular velocity around the Y axis of the device, as a floating point number.
|
double |
YAccelerometer.get_yValue()
Returns the Y component of the acceleration, as a floating point number.
|
double |
YMagnetometer.get_yValue()
Returns the Y component of the magnetic field, as a floating point number.
|
double |
YWeighScale.get_zeroTracking()
Returns the zero tracking threshold value.
|
double |
YMultiCellWeighScale.get_zeroTracking()
Returns the zero tracking threshold value.
|
double |
YGyro.get_zValue()
Returns the angular velocity around the Z axis of the device, as a floating point number.
|
double |
YAccelerometer.get_zValue()
Returns the Z component of the acceleration, as a floating point number.
|
double |
YMagnetometer.get_zValue()
Returns the Z component of the magnetic field, as a floating point number.
|
int |
YCarbonDioxide.getAbcPeriod()
Returns the Automatic Baseline Calibration period, in hours.
|
double |
YHumidity.getAbsHum()
Returns the current absolute humidity, in grams per cubic meter of air.
|
int |
YColorLedCluster.getActiveLedCount()
Returns the number of LEDs currently handled by the device.
|
String |
YNetwork.getAdminPassword()
Returns a hash string if a password has been set for user "admin",
or an empty string otherwise.
|
String |
YFunction.getAdvertisedValue()
Returns a short string representing the current state of the function.
|
int |
YSensor.getAdvMode()
Returns the measuring mode used for the advertised value pushed to the parent hub.
|
int |
YCellular.getAirplaneMode()
Returns true if the airplane mode is active (radio turned off).
|
double |
YGps.getAltitude()
Returns the current altitude.
|
int |
YAnButton.getAnalogCalibration()
Tells if a calibration process is currently ongoing.
|
String |
YCellular.getApn()
Returns the Access Point Name (APN) to be used, if needed.
|
String |
YCellular.getApnSecret()
Returns an opaque string if APN authentication parameters have been configured
in the device, or an empty string otherwise.
|
int |
YWatchdog.getAutoStart()
Returns the watchdog running state at module power on.
|
int |
YDataLogger.getAutoStart()
Returns the default activation state of the data logger on power up.
|
int |
YStepperMotor.getAuxSignal()
Returns the current value of the signal generated on the auxiliary output.
|
int |
YTilt.getBandwidth()
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YCompass.getBandwidth()
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YGyro.getBandwidth()
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YAccelerometer.getBandwidth()
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YMagnetometer.getBandwidth()
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YHubPort.getBaudRate()
Returns the current baud rate used by this Yocto-hub port, in kbps.
|
int |
YModule.getBeacon()
Returns the state of the localization beacon.
|
int |
YDataLogger.getBeaconDriven()
Returns true if the data logger is synchronised with the localization beacon.
|
double |
YRefFrame.getBearing()
Returns the reference bearing used by the compass.
|
int |
YLed.getBlinking()
Returns the current LED signaling mode.
|
int |
YColorLedCluster.getBlinkSeqMaxCount()
Returns the maximum number of sequences that the device can handle.
|
int |
YColorLedCluster.getBlinkSeqMaxSize()
Returns the maximum length of sequences.
|
int |
YColorLed.getBlinkSeqMaxSize()
Returns the maximum length of the blinking sequence.
|
int |
YColorLed.getBlinkSeqSignature()
Return the blinking sequence signature.
|
int |
YColorLed.getBlinkSeqSize()
Returns the current length of the blinking sequence.
|
double |
YMotor.getBrakingForce()
Returns the braking force applied to the motor, as a percentage.
|
int |
YDisplay.getBrightness()
Returns the luminosity of the module informative LEDs (from 0 to 100).
|
int |
YAnButton.getCalibratedValue()
Returns the current calibrated input value (between 0 and 1000, included).
|
int |
YAnButton.getCalibrationMax()
Returns the maximal value measured during the calibration (between 0 and 4095, included).
|
int |
YAnButton.getCalibrationMin()
Returns the minimal value measured during the calibration (between 0 and 4095, included).
|
String |
YNetwork.getCallbackCredentials()
Returns a hashed version of the notification callback credentials if set,
or an empty string otherwise.
|
int |
YNetwork.getCallbackEncoding()
Returns the encoding standard to use for representing notification values.
|
int |
YNetwork.getCallbackInitialDelay()
Returns the initial waiting time before first callback notifications, in seconds.
|
int |
YNetwork.getCallbackMaxDelay()
Returns the waiting time between two HTTP callbacks when there is nothing new.
|
int |
YNetwork.getCallbackMethod()
Returns the HTTP method used to notify callbacks for significant state changes.
|
int |
YNetwork.getCallbackMinDelay()
Returns the minimum waiting time between two HTTP callbacks, in seconds.
|
String |
YNetwork.getCallbackSchedule()
Returns the HTTP callback schedule strategy, as a text string.
|
String |
YNetwork.getCallbackUrl()
Returns the callback URL to notify of significant state changes.
|
int |
YMultiCellWeighScale.getCellCount()
Returns the number of load cells in use.
|
String |
YCellular.getCellIdentifier()
Returns the unique identifier of the cellular antenna in use: MCC, MNC, LAC and Cell ID.
|
String |
YCellular.getCellOperator()
Returns the name of the cell operator currently in use.
|
int |
YCellular.getCellType()
Active cellular connection type.
|
int |
YWireless.getChannel()
Returns the 802.11 channel currently used, or 0 when the selected network has not been found.
|
int |
YDaisyChain.getChildCount()
Returns the number of child nodes currently detected.
|
double |
YWeighScale.getCompensation()
Returns the current current thermal compensation value.
|
double |
YMultiCellWeighScale.getCompensation()
Returns the current current thermal compensation value.
|
double |
YWeighScale.getCompTempAvg()
Returns the current averaged temperature, used for thermal compensation.
|
double |
YMultiCellWeighScale.getCompTempAvg()
Returns the current averaged temperature, used for thermal compensation.
|
double |
YWeighScale.getCompTempChg()
Returns the current temperature variation, used for thermal compensation.
|
double |
YMultiCellWeighScale.getCompTempChg()
Returns the current temperature variation, used for thermal compensation.
|
int |
YGps.getCoordSystem()
Returns the representation system used for positioning data.
|
double |
YPower.getCosPhi()
Returns the power factor (the ratio between the real power consumed,
measured in W, and the apparent power provided, measured in VA).
|
long |
YWatchdog.getCountdown()
Returns the number of milliseconds remaining before a pulse (delayedPulse() call)
When there is no scheduled pulse, returns zero.
|
long |
YRelay.getCountdown()
Returns the number of milliseconds remaining before a pulse (delayedPulse() call)
When there is no scheduled pulse, returns zero.
|
double |
YCurrentLoopOutput.getCurrent()
Returns the loop current set point in mA.
|
double |
YPowerSupply.getCurrentAtStartUp()
Returns the selected current limit at device startup, in mA.
|
double |
YCurrentLoopOutput.getCurrentAtStartUp()
Returns the current in the loop at device startup, in mA.
|
String |
YSerialPort.getCurrentJob()
Returns the name of the job file currently in use.
|
String |
YSpiPort.getCurrentJob()
Returns the name of the job file currently in use.
|
double |
YPowerSupply.getCurrentLimit()
Returns the current limit, in mA.
|
double |
YSensor.getCurrentRawValue()
Returns the uncalibrated, unrounded raw value returned by the sensor, in the specified unit, as a
floating point number.
|
int |
YDataLogger.getCurrentRunIndex()
Returns the current run number, corresponding to the number of times the module was
powered on with the dataLogger enabled at some point.
|
double |
YRangeFinder.getCurrentTemperature()
Returns the current sensor temperature, as a floating point number.
|
double |
YSensor.getCurrentValue()
Returns the current value of the measure, in the specified unit, as a floating point number.
|
double |
YVoltageOutput.getCurrentVoltage()
Returns the output voltage set point, in V.
|
double |
YMotor.getCutOffVoltage()
Returns the threshold voltage under which the controller automatically switches to error state
and prevents further current draw.
|
int |
YDaisyChain.getDaisyState()
Returns the state of the daisy-link between modules.
|
String |
YDataLogger.getData(Integer runIdx,
Integer timeIdx)
Internal function to retrieve datalogger memory
|
int |
YCellular.getDataReceived()
Returns the number of bytes received so far.
|
int |
YCellular.getDataSent()
Returns the number of bytes sent so far.
|
String |
YGps.getDateTime()
Returns the current time in the form "YYYY/MM/DD hh:mm:ss".
|
String |
YRealTimeClock.getDateTime()
Returns the current time in the form "YYYY/MM/DD hh:mm:ss".
|
int |
YPwmInput.getDebouncePeriod()
Returns the shortest expected pulse duration, in ms.
|
int |
YQuadratureDecoder.getDecoding()
Returns the current activation state of the quadrature decoder.
|
String |
YNetwork.getDefaultPage()
Returns the HTML page to serve for the URL "/"" of the hub.
|
int |
YProximity.getDetectionHysteresis()
Returns the hysteresis used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
|
int |
YProximity.getDetectionThreshold()
Returns the threshold used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
|
int |
YStepperMotor.getDiags()
Returns the stepper motor controller diagnostics, as a bitmap.
|
double |
YGps.getDilution()
Returns the current horizontal dilution of precision,
the smaller that number is, the better .
|
double |
YGps.getDirection()
Returns the current move bearing in degrees, zero
is the true (geographic) north.
|
int |
YNetwork.getDiscoverable()
Returns the activation state of the multicast announce protocols to allow easy
discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
|
String |
YSegmentedDisplay.getDisplayedText()
Returns the text currently displayed on the screen.
|
int |
YDisplay.getDisplayHeight()
Returns the display height, in pixels.
|
int |
YDisplay.getDisplayType()
Returns the display type: monochrome, gray levels or full color.
|
int |
YDisplay.getDisplayWidth()
Returns the display width, in pixels.
|
double |
YMotor.getDrivingForce()
Returns the power sent to the motor, as a percentage between -100% and +100%.
|
double |
YPwmOutput.getDutyCycle()
Returns the PWM duty cycle, in per cents.
|
double |
YPwmInput.getDutyCycle()
Returns the PWM duty cycle, in per cents.
|
double |
YPwmOutput.getDutyCycleAtPowerOn()
Returns the PWMs duty cycle at device power on as a floating point number between 0 and 100.
|
int |
YCurrent.getEnabled()
Returns the activation state of this input.
|
int |
YPwmOutput.getEnabled()
Returns the state of the PWMs.
|
int |
YDisplay.getEnabled()
Returns true if the screen is powered, false otherwise.
|
int |
YServo.getEnabled()
Returns the state of the servos.
|
int |
YHubPort.getEnabled()
Returns true if the Yocto-hub port is powered, false otherwise.
|
int |
YGenericSensor.getEnabled()
Returns the activation state of this input.
|
int |
YVoltage.getEnabled()
Returns the activation state of this input.
|
int |
YCellular.getEnableData()
Returns the condition for enabling IP data services (GPRS).
|
int |
YPwmOutput.getEnabledAtPowerOn()
Returns the state of the PWM at device power on.
|
int |
YServo.getEnabledAtPowerOn()
Returns the servo signal generator state at power up.
|
int |
YSerialPort.getErrCount()
Returns the total number of communication errors detected since last reset.
|
int |
YSpiPort.getErrCount()
Returns the total number of communication errors detected since last reset.
|
int |
YWeighScale.getExcitation()
Returns the current load cell bridge excitation method.
|
int |
YMultiCellWeighScale.getExcitation()
Returns the current load cell bridge excitation method.
|
int |
YDualPower.getExtVoltage()
Returns the measured voltage on the external power source, in millivolts.
|
int |
YMotor.getFailSafeTimeout()
Returns the delay in milliseconds allowed for the controller to run autonomously without
receiving any instruction from the control process.
|
int |
YFiles.getFilesCount()
Returns the number of files currently loaded in the filesystem.
|
String |
YModule.getFirmwareRelease()
Returns the version of the firmware embedded in the module.
|
int |
YFiles.getFreeSpace()
Returns the free space for uploading new files to the filesystem, in bytes.
|
double |
YPwmOutput.getFrequency()
Returns the PWM frequency in Hz.
|
double |
YBuzzer.getFrequency()
Returns the frequency of the signal sent to the buzzer/speaker.
|
double |
YMotor.getFrequency()
Returns the PWM frequency used to control the motor.
|
double |
YPwmInput.getFrequency()
Returns the PWM frequency in Hz.
|
String |
YFunction.getFriendlyName() |
String |
YFunction.getFunctionId() |
int |
YMultiAxisController.getGlobalState()
Returns the stepper motor set overall state.
|
double |
YGps.getGroundSpeed()
Returns the current ground speed in Km/h.
|
String |
YFunction.getHardwareId() |
double |
YSensor.getHighestValue()
Returns the maximal value observed for the measure since the device was started.
|
int |
YWakeUpSchedule.getHours()
Returns the hours scheduled for wake up.
|
int |
YColorLed.getHslColor()
Returns the current HSL color of the LED.
|
int |
YNetwork.getHttpPort()
Returns the HTML page to serve for the URL "/"" of the hub.
|
String |
YCellular.getImsi()
Returns an opaque string if a PIN code has been configured in the device to access
the SIM card, or an empty string if none has been configured or if the code provided
was rejected by the SIM card.
|
double |
YPowerSupply.getInputVoltage()
Returns the measured input voltage, in V.
|
String |
YNetwork.getIpAddress()
Returns the IP address currently in use by the device.
|
String |
YNetwork.getIpConfig()
Returns the IP configuration of the network interface.
|
int |
YGps.getIsFixed()
Returns TRUE if the receiver has found enough satellites to work.
|
int |
YProximity.getIsPresent()
Returns true if the input (considered as binary) is active (detection value is smaller than the
specified threshold), and false otherwise.
|
int |
YAnButton.getIsPressed()
Returns true if the input (considered as binary) is active (closed contact), and false otherwise.
|
String |
YSerialPort.getLastMsg()
Returns the latest message fully received (for Line, Frame and Modbus protocols).
|
String |
YSpiPort.getLastMsg()
Returns the latest message fully received (for Line and Frame protocols).
|
long |
YProximity.getLastTimeApproached()
Returns the number of elapsed milliseconds between the module power on and the last observed
detection (the input contact transitioned from absent to present).
|
long |
YAnButton.getLastTimePressed()
Returns the number of elapsed milliseconds between the module power on and the last time
the input button was pressed (the input contact transitioned from open to closed).
|
long |
YAnButton.getLastTimeReleased()
Returns the number of elapsed milliseconds between the module power on and the last time
the input button was released (the input contact transitioned from closed to open).
|
long |
YProximity.getLastTimeRemoved()
Returns the number of elapsed milliseconds between the module power on and the last observed
detection (the input contact transitioned from present to absent).
|
String |
YGps.getLatitude()
Returns the current latitude.
|
int |
YDisplay.getLayerCount()
Returns the number of available layers to draw on.
|
int |
YDisplay.getLayerHeight()
Returns the height of the layers to draw on, in pixels.
|
int |
YDisplay.getLayerWidth()
Returns the width of the layers to draw on, in pixels.
|
double |
YPowerSupply.getLdoTemperature()
Returns the LDO temperature, in Celsius.
|
int |
YColorLedCluster.getLedType()
Returns the RGB LED type currently handled by the device.
|
int |
YWireless.getLinkQuality()
Returns the link quality, expressed in percent.
|
int |
YBluetoothLink.getLinkQuality()
Returns the bluetooth receiver signal strength, in pourcents, or 0 if no connection is established.
|
int |
YCellular.getLinkQuality()
Returns the link quality, expressed in percent.
|
int |
YBluetoothLink.getLinkState()
Returns the bluetooth link state.
|
String |
YCellular.getLockedOperator()
Returns the name of the only cell operator to use if automatic choice is disabled,
or an empty string if the SIM card will automatically choose among available
cell operators.
|
String |
YSensor.getLogFrequency()
Returns the datalogger recording frequency for this function, or "OFF"
when measures are not stored in the data logger flash memory.
|
String |
YFunction.getLogicalName()
Returns the logical name of the function.
|
String |
YGps.getLongitude()
Returns the current longitude.
|
int |
YCurrentLoopOutput.getLoopPower()
Returns the loop powerstate.
|
double |
YSensor.getLowestValue()
Returns the minimal value observed for the measure since the device was started.
|
int |
YLed.getLuminosity()
Returns the current LED intensity (in per cent).
|
int |
YModule.getLuminosity()
Returns the luminosity of the module informative LEDs (from 0 to 100).
|
String |
YNetwork.getMacAddress()
Returns the MAC address of the network interface.
|
double |
YCompass.getMagneticHeading()
Returns the magnetic heading, regardless of the configured bearing.
|
int |
YMultiSensController.getMaintenanceMode()
Returns true when the device is in maintenance mode.
|
double |
YStepperMotor.getMaxAccel()
Returns the maximal motor acceleration, measured in steps per second^2.
|
int |
YColorLedCluster.getMaxLedCount()
Returns the maximum number of LEDs that the device can handle.
|
int |
YMultiSensController.getMaxSensors()
Returns the maximum configurable sensor count allowed on this device.
|
double |
YStepperMotor.getMaxSpeed()
Returns the maximal motor speed, measured in steps per second.
|
long |
YWatchdog.getMaxTimeOnStateA()
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
|
long |
YRelay.getMaxTimeOnStateA()
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
|
long |
YWatchdog.getMaxTimeOnStateB()
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
|
long |
YRelay.getMaxTimeOnStateB()
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
|
double |
YPowerSupply.getMeasuredCurrent()
Returns the measured output current, in mA.
|
double |
YPowerSupply.getMeasuredVoltage()
Returns the measured output voltage, in V.
|
int |
YLightSensor.getMeasureType()
Returns the type of light measure.
|
String |
YWireless.getMessage()
Returns the latest status message from the wireless interface.
|
String |
YCellular.getMessage()
Returns the latest status message from the wireless interface.
|
double |
YPower.getMeter()
Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time.
|
int |
YPower.getMeterTimer()
Returns the elapsed time since last energy counter reset, in seconds.
|
int |
YWakeUpSchedule.getMinutesA()
Returns the minutes in the 00-29 interval of each hour scheduled for wake up.
|
int |
YWakeUpSchedule.getMinutesB()
Returns the minutes in the 30-59 interval of each hour scheduled for wake up.
|
int |
YWakeUpSchedule.getMonthDays()
Returns the days of the month scheduled for wake up.
|
int |
YWakeUpSchedule.getMonths()
Returns the months scheduled for wake up.
|
int |
YStepperMotor.getMotorState()
Returns the motor working state.
|
int |
YMotor.getMotorStatus()
Return the controller state.
|
int |
YAudioIn.getMute()
Returns the state of the mute function.
|
int |
YBluetoothLink.getMute()
Returns the state of the mute function.
|
int |
YAudioOut.getMute()
Returns the state of the mute function.
|
int |
YMultiAxisController.getNAxis()
Returns the number of synchronized controllers.
|
int |
YServo.getNeutral()
Returns the duration in microseconds of a neutral pulse for the servo.
|
long |
YWakeUpSchedule.getNextOccurence()
Returns the date/time (seconds) of the next wake up occurrence.
|
long |
YWakeUpMonitor.getNextWakeUp()
Returns the next scheduled wake up date/time (UNIX format).
|
int |
YAudioIn.getNoSignalFor()
Returns the number of seconds elapsed without detecting a signal.
|
int |
YAudioOut.getNoSignalFor()
Returns the number of seconds elapsed without detecting a signal.
|
int |
YMultiSensController.getNSensors()
Returns the number of sensors to poll.
|
String |
YNetwork.getNtpServer()
Returns the IP address of the NTP server to be used by the device.
|
int |
YDisplay.getOrientation()
Returns the currently selected display orientation.
|
int |
YWatchdog.getOutput()
Returns the output state of the watchdog, when used as a simple switch (single throw).
|
int |
YRelay.getOutput()
Returns the output state of the relays, when used as a simple switch (single throw).
|
int |
YDigitalIO.getOutputVoltage()
Returns the voltage source used to drive output bits.
|
int |
YStepperMotor.getOvercurrent()
Returns the overcurrent alert and emergency stop threshold, measured in mA.
|
int |
YMotor.getOverCurrentLimit()
Returns the current threshold (in mA) above which the controller automatically
switches to error state.
|
String |
YBluetoothLink.getOwnAddress()
Returns the MAC-48 address of the bluetooth interface, which is unique on the bluetooth network.
|
String |
YBluetoothLink.getPairingPin()
Returns an opaque string if a PIN code has been configured in the device to access
the SIM card, or an empty string if none has been configured or if the code provided
was rejected by the SIM card.
|
int |
YMessageBox.getPduReceived()
Returns the number of SMS units received so far.
|
int |
YMessageBox.getPduSent()
Returns the number of SMS units sent so far.
|
double |
YPwmOutput.getPeriod()
Returns the PWM period in milliseconds.
|
double |
YPwmInput.getPeriod()
Returns the PWM period in milliseconds.
|
int |
YModule.getPersistentSettings()
Returns the current state of persistent module settings.
|
String |
YCellular.getPin()
Returns an opaque string if a PIN code has been configured in the device to access
the SIM card, or an empty string if none has been configured or if the code provided
was rejected by the SIM card.
|
int |
YCellular.getPingInterval()
Returns the automated connectivity check interval, in seconds.
|
int |
YBuzzer.getPlaySeqMaxSize()
Returns the maximum length of the playing sequence.
|
int |
YBuzzer.getPlaySeqSignature()
Returns the playing sequence signature.
|
int |
YBuzzer.getPlaySeqSize()
Returns the current length of the playing sequence.
|
int |
YNetwork.getPoeCurrent()
Returns the current consumed by the module from Power-over-Ethernet (PoE), in milliamps.
|
int |
YDigitalIO.getPortDiags()
Returns the port state diagnostics (Yocto-IO and Yocto-MaxiIO-V2 only).
|
int |
YDigitalIO.getPortDirection()
Returns the IO direction of all bits (i.e.
|
int |
YDigitalIO.getPortOpenDrain()
Returns the electrical interface for each bit of the port.
|
int |
YDigitalIO.getPortPolarity()
Returns the polarity of all the bits of the port.
|
int |
YDigitalIO.getPortSize()
Returns the number of bits (i.e.
|
int |
YDigitalIO.getPortState()
Returns the digital IO port state as an integer with each bit
representing a channel
value 0 = 0b00000000 -> all channels are OFF
value 1 = 0b00000001 -> channel #0 is ON
value 2 = 0b00000010 -> channel #1 is ON
value 3 = 0b00000011 -> channels #0 and #1 are ON
value 4 = 0b00000100 -> channel #2 is ON
and so on...
|
int |
YHubPort.getPortState()
Returns the current state of the Yocto-hub port.
|
int |
YServo.getPosition()
Returns the current servo position.
|
int |
YServo.getPositionAtPowerOn()
Returns the servo position at device power up.
|
int |
YLed.getPower()
Returns the current LED state.
|
int |
YDualPower.getPowerControl()
Returns the selected power source for module functions that require lots of current.
|
int |
YWakeUpMonitor.getPowerDuration()
Returns the maximal wake up time (in seconds) before automatically going to sleep.
|
int |
YPwmPowerSource.getPowerMode()
Returns the selected power source for the PWM on the same device.
|
int |
YPowerSupply.getPowerOutput()
Returns the power supply output switch state.
|
int |
YDualPower.getPowerState()
Returns the current power source for module functions that require lots of current.
|
int |
YBluetoothLink.getPreAmplifier()
Returns the audio pre-amplifier volume, in per cents.
|
int |
YProximity.getPresenceMinTime()
Returns the minimal detection duration before signalling a presence event.
|
String |
YNetwork.getPrimaryDNS()
Returns the IP address of the primary name server to be used by the module.
|
int |
YModule.getProductId()
Returns the USB device identifier of the module.
|
String |
YModule.getProductName()
Returns the commercial name of the module, as set by the factory.
|
int |
YModule.getProductRelease()
Returns the hardware release version of the module.
|
String |
YSerialPort.getProtocol()
Returns the type of protocol used over the serial line, as a string.
|
String |
YSpiPort.getProtocol()
Returns the type of protocol used over the serial line, as a string.
|
int |
YProximity.getProximityReportMode()
Returns the parameter (sensor value, presence or pulse count) returned by the get_currentValue
function and callbacks.
|
double |
YStepperMotor.getPullinSpeed()
Returns the motor speed immediately reachable from stop state, measured in steps per second.
|
long |
YProximity.getPulseCounter()
Returns the pulse counter value.
|
long |
YAnButton.getPulseCounter()
Returns the pulse counter value.
|
long |
YPwmInput.getPulseCounter()
Returns the pulse counter value.
|
double |
YPwmOutput.getPulseDuration()
Returns the PWM pulse length in milliseconds, as a floating point number.
|
double |
YPwmInput.getPulseDuration()
Returns the PWM pulse length in milliseconds, as a floating point number.
|
long |
YWatchdog.getPulseTimer()
Returns the number of milliseconds remaining before the watchdog is returned to idle position
(state A), during a measured pulse generation.
|
long |
YProximity.getPulseTimer()
Returns the timer of the pulse counter (ms).
|
long |
YRelay.getPulseTimer()
Returns the number of milliseconds remaining before the relays is returned to idle position
(state A), during a measured pulse generation.
|
long |
YAnButton.getPulseTimer()
Returns the timer of the pulses counter (ms).
|
long |
YPwmInput.getPulseTimer()
Returns the timer of the pulses counter (ms).
|
int |
YPwmInput.getPwmReportMode()
Returns the parameter (frequency/duty cycle, pulse width, edges count) returned by the
get_currentValue function and callbacks.
|
double |
YAltitude.getQnh()
Returns the barometric pressure adjusted to sea level used to compute
the altitude (QNH).
|
int |
YRangeFinder.getQuality()
Returns a measure quality estimate, based on measured dispersion.
|
int |
YServo.getRange()
Returns the current range of use of the servo.
|
int |
YRangeFinder.getRangeFinderMode()
Returns the range finder running mode.
|
int |
YAnButton.getRawValue()
Returns the current measured input value as-is (between 0 and 4095, included).
|
int |
YNetwork.getReadiness()
Returns the current established working mode of the network interface.
|
int |
YModule.getRebootCountdown()
Returns the remaining number of seconds before the module restarts, or zero when no
reboot has been scheduled.
|
int |
YDataLogger.getRecording()
Returns the current activation state of the data logger.
|
double |
YHumidity.getRelHum()
Returns the current relative humidity, in per cents.
|
String |
YBluetoothLink.getRemoteAddress()
Returns the MAC-48 address of the remote device to connect to.
|
String |
YBluetoothLink.getRemoteName()
Returns the bluetooth name the remote device, if found on the bluetooth network.
|
int |
YProximity.getRemovalMinTime()
Returns the minimal detection duration before signalling a removal event.
|
String |
YSensor.getReportFrequency()
Returns the timed value notification frequency, or "OFF" if timed
value notifications are disabled for this function.
|
int |
YDaisyChain.getRequiredChildCount()
Returns the number of child nodes expected in normal conditions.
|
double |
YSensor.getResolution()
Returns the resolution of the measured values.
|
int |
YColorLed.getRgbColor()
Returns the current RGB color of the LED.
|
int |
YColorLed.getRgbColorAtPowerOn()
Returns the configured color to be displayed when the module is turned on.
|
String |
YNetwork.getRouter()
Returns the IP address of the router on the device subnet (default gateway).
|
int |
YWatchdog.getRunning()
Returns the watchdog running state.
|
int |
YSerialPort.getRxCount()
Returns the total number of bytes received since last reset.
|
int |
YSpiPort.getRxCount()
Returns the total number of bytes received since last reset.
|
int |
YSerialPort.getRxMsgCount()
Returns the total number of messages received since last reset.
|
int |
YSpiPort.getRxMsgCount()
Returns the total number of messages received since last reset.
|
long |
YGps.getSatCount()
Returns the count of visible satellites.
|
String |
YNetwork.getSecondaryDNS()
Returns the IP address of the secondary name server to be used by the module.
|
int |
YWireless.getSecurity()
Returns the security algorithm used by the selected wireless network.
|
int |
YAnButton.getSensitivity()
Returns the sensibility for the input (between 1 and 1000) for triggering user callbacks.
|
int |
YSensor.getSensorState()
Returns the sensor health state code, which is zero when there is an up-to-date measure
available or a positive code if the sensor is not able to provide a measure right now.
|
int |
YTemperature.getSensorType()
Returns the temperature sensor type.
|
String |
YSerialPort.getSerialMode()
Returns the serial port communication parameters, as a string such as
"9600,8N1".
|
String |
YModule.getSerialNumber()
Returns the serial number of the module, as set by the factory.
|
int |
YSpiPort.getShiftSampling()
Returns true when the SDI line phase is shifted with regards to the SDO line.
|
int |
YOsControl.getShutdownCountdown()
Returns the remaining number of seconds before the OS shutdown, or zero when no
shutdown has been scheduled.
|
int |
YAudioIn.getSignal()
Returns the detected input signal level.
|
int |
YAudioOut.getSignal()
Returns the detected output current level.
|
double |
YGenericSensor.getSignalBias()
Returns the electric signal bias for zero shift adjustment.
|
String |
YGenericSensor.getSignalRange()
Returns the electric signal range used by the sensor.
|
int |
YGenericSensor.getSignalSampling()
Returns the electric signal sampling method to use.
|
String |
YTemperature.getSignalUnit()
Returns the measuring unit of the electrical signal used by the sensor.
|
String |
YGenericSensor.getSignalUnit()
Returns the measuring unit of the electrical signal used by the sensor.
|
double |
YProximity.getSignalValue()
Returns the current value of signal measured by the proximity sensor.
|
double |
YTemperature.getSignalValue()
Returns the current value of the electrical signal measured by the sensor.
|
double |
YGenericSensor.getSignalValue()
Returns the current value of the electrical signal measured by the sensor.
|
int |
YWakeUpMonitor.getSleepCountdown()
Returns the delay before the next sleep period.
|
int |
YMessageBox.getSlotsCount()
Returns the total number of message storage slots on the SIM card.
|
int |
YMessageBox.getSlotsInUse()
Returns the number of message storage slots currently in use.
|
double |
YStepperMotor.getSpeed()
Returns current motor speed, measured in steps per second.
|
double |
YQuadratureDecoder.getSpeed()
Returns the increments frequency, in Hz.
|
String |
YSpiPort.getSpiMode()
Returns the SPI port communication parameters, as a string such as
"125000,0,msb".
|
String |
YWireless.getSsid()
Returns the wireless network name (SSID).
|
int |
YSpiPort.getSsPolarity()
Returns the SS line polarity.
|
int |
YMotor.getStarterTime()
Returns the duration (in ms) during which the motor is driven at low frequency to help
it start up.
|
String |
YSerialPort.getStartupJob()
Returns the job file to use when the device is powered on.
|
String |
YSpiPort.getStartupJob()
Returns the job file to use when the device is powered on.
|
String |
YDisplay.getStartupSeq()
Returns the name of the sequence to play when the displayed is powered on.
|
int |
YWatchdog.getState()
Returns the state of the watchdog (A for the idle position, B for the active position).
|
int |
YRelay.getState()
Returns the state of the relays (A for the idle position, B for the active position).
|
int |
YWatchdog.getStateAtPowerOn()
Returns the state of the watchdog at device startup (A for the idle position, B for the active
position, UNCHANGED for no change).
|
int |
YRelay.getStateAtPowerOn()
Returns the state of the relays at device startup (A for the idle position, B for the active
position, UNCHANGED for no change).
|
int |
YStepperMotor.getStepping()
Returns the stepping mode used to drive the motor.
|
double |
YStepperMotor.getStepPos()
Returns the current logical motor position, measured in steps.
|
String |
YNetwork.getSubnetMask()
Returns the subnet mask currently used by the device.
|
int |
YStepperMotor.getTCurrRun()
Returns the torque regulation current when the motor is running, measured in mA.
|
int |
YStepperMotor.getTCurrStop()
Returns the torque regulation current when the motor is stopped, measured in mA.
|
String |
YAltitude.getTechnology()
Returns the technology used by the sesnor to compute
altitude.
|
double |
YWeighScale.getTempAvgAdaptRatio()
Returns the averaged temperature update rate, in per mille.
|
double |
YMultiCellWeighScale.getTempAvgAdaptRatio()
Returns the averaged temperature update rate, in per mille.
|
double |
YWeighScale.getTempChgAdaptRatio()
Returns the temperature change update rate, in per mille.
|
double |
YMultiCellWeighScale.getTempChgAdaptRatio()
Returns the temperature change update rate, in per mille.
|
long |
YRangeFinder.getTimeFrame()
Returns the time frame used to measure the distance and estimate the measure
reliability.
|
int |
YRealTimeClock.getTimeSet()
Returns true if the clock has been set, and false otherwise.
|
long |
YDataLogger.getTimeUTC()
Returns the Unix timestamp for current UTC time, if known.
|
long |
YWatchdog.getTriggerDelay()
Returns the waiting duration before a reset is automatically triggered by the watchdog, in milliseconds.
|
long |
YWatchdog.getTriggerDuration()
Returns the duration of resets caused by the watchdog, in milliseconds.
|
int |
YSerialPort.getTxCount()
Returns the total number of bytes transmitted since last reset.
|
int |
YSpiPort.getTxCount()
Returns the total number of bytes transmitted since last reset.
|
int |
YSerialPort.getTxMsgCount()
Returns the total number of messages send since last reset.
|
int |
YSpiPort.getTxMsgCount()
Returns the total number of messages send since last reset.
|
String |
YSensor.getUnit()
Returns the measuring unit for the measure.
|
long |
YGps.getUnixTime()
Returns the current time in Unix format (number of
seconds elapsed since Jan 1st, 1970).
|
long |
YRealTimeClock.getUnixTime()
Returns the current time in Unix format (number of elapsed seconds since Jan 1st, 1970).
|
long |
YModule.getUpTime()
Returns the number of milliseconds spent since the module was powered on.
|
int |
YDataLogger.getUsage()
Returns the percentage of datalogger memory in use.
|
int |
YModule.getUsbCurrent()
Returns the current consumed by the module on the USB bus, in milli-amps.
|
String |
YNetwork.getUserPassword()
Returns a hash string if a password has been set for "user" user,
or an empty string otherwise.
|
int |
YModule.getUserVar()
Returns the value previously stored in this attribute.
|
int |
YGps.getUtcOffset()
Returns the number of seconds between current time and UTC time (time zone).
|
int |
YRealTimeClock.getUtcOffset()
Returns the number of seconds between current time and UTC time (time zone).
|
String |
YGenericSensor.getValueRange()
Returns the physical value range measured by the sensor.
|
double |
YPowerSupply.getVInt()
Returns the internal voltage, in V.
|
int |
YPowerOutput.getVoltage()
Returns the voltage on the power output featured by the module.
|
double |
YVoltageOutput.getVoltageAtStartUp()
Returns the selected voltage output at device startup, in V.
|
double |
YPowerSupply.getVoltageAtStartUp()
Returns the selected voltage set point at device startup, in V.
|
int |
YSerialPort.getVoltageLevel()
Returns the voltage level used on the serial line.
|
int |
YSpiPort.getVoltageLevel()
Returns the voltage level used on the serial line.
|
int |
YPowerSupply.getVoltageSense()
Returns the output voltage control point.
|
double |
YPowerSupply.getVoltageSetPoint()
Returns the voltage set point, in V.
|
int |
YAudioIn.getVolume()
Returns audio input gain, in per cents.
|
int |
YBluetoothLink.getVolume()
Returns the connected headset volume, in per cents.
|
int |
YAudioOut.getVolume()
Returns audio output volume, in per cents.
|
int |
YBuzzer.getVolume()
Returns the volume of the signal sent to the buzzer/speaker.
|
String |
YAudioIn.getVolumeRange()
Returns the supported volume range.
|
String |
YAudioOut.getVolumeRange()
Returns the supported volume range.
|
int |
YWakeUpMonitor.getWakeUpReason()
Returns the latest wake up reason.
|
int |
YWakeUpMonitor.getWakeUpState()
Returns the current state of the monitor.
|
int |
YWakeUpSchedule.getWeekDays()
Returns the days of the week scheduled for wake up.
|
int |
YWireless.getWlanState()
Returns the current state of the wireless interface.
|
int |
YNetwork.getWwwWatchdogDelay()
Returns the allowed downtime of the WWW link (in seconds) before triggering an automated
reboot to try to recover Internet connectivity.
|
double |
YGyro.getXValue()
Returns the angular velocity around the X axis of the device, as a floating point number.
|
double |
YAccelerometer.getXValue()
Returns the X component of the acceleration, as a floating point number.
|
double |
YMagnetometer.getXValue()
Returns the X component of the magnetic field, as a floating point number.
|
double |
YGyro.getYValue()
Returns the angular velocity around the Y axis of the device, as a floating point number.
|
double |
YAccelerometer.getYValue()
Returns the Y component of the acceleration, as a floating point number.
|
double |
YMagnetometer.getYValue()
Returns the Y component of the magnetic field, as a floating point number.
|
double |
YWeighScale.getZeroTracking()
Returns the zero tracking threshold value.
|
double |
YMultiCellWeighScale.getZeroTracking()
Returns the zero tracking threshold value.
|
double |
YGyro.getZValue()
Returns the angular velocity around the Z axis of the device, as a floating point number.
|
double |
YAccelerometer.getZValue()
Returns the Z component of the acceleration, as a floating point number.
|
double |
YMagnetometer.getZValue()
Returns the Z component of the magnetic field, as a floating point number.
|
int |
YAPIContext.HandleEvents()
Maintains the device-to-library communication channel.
|
static int |
YAPI.HandleEvents()
Maintains the device-to-library communication channel.
|
boolean |
YModule.hasFunction(String funcId)
Tests if the device includes a specific function.
|
int |
YDisplayLayer.hide()
Hides the layer.
|
int |
YColorLedCluster.hsl_move(int ledIndex,
int count,
int hslValue,
int delay)
Allows you to modify the current color of a group of adjacent LEDs to another color, in a seamless and
autonomous manner.
|
int |
YColorLedCluster.hslArray_move(ArrayList<Integer> hslList,
int delay)
Sets up a smooth HSL color transition to the specified pixel-by-pixel list of HSL
color codes.
|
int |
YColorLedCluster.hslArrayOfs_move(int ledIndex,
ArrayList<Integer> hslList,
int delay)
Sets up a smooth HSL color transition to the specified pixel-by-pixel list of HSL
color codes.
|
int |
YColorLed.hslMove(int hsl_target,
int ms_duration)
Performs a smooth transition in the HSL color space between the current color and a target color.
|
int |
YAPIContext.InitAPI(int mode)
Initializes the Yoctopuce programming library explicitly.
|
static int |
YAPI.InitAPI(int mode)
Initializes the Yoctopuce programming library explicitly.
|
int |
YWireless.joinNetwork(String ssid,
String securityKey)
Changes the configuration of the wireless lan interface to connect to an existing
access point (infrastructure mode).
|
int |
YMotor.keepALive()
Rearms the controller failsafe timer.
|
int |
YDisplayLayer.lineTo(int x,
int y)
Draws a line from current drawing pointer position to the specified position.
|
int |
YColorLedCluster.linkLedToBlinkSeq(int ledIndex,
int count,
int seqIndex,
int offset)
Links adjacent LEDs to a specific sequence.
|
int |
YColorLedCluster.linkLedToBlinkSeqAtPowerOn(int ledIndex,
int count,
int seqIndex,
int offset)
Links adjacent LEDs to a specific sequence at device power-on.
|
int |
YColorLedCluster.linkLedToPeriodicBlinkSeq(int ledIndex,
int count,
int seqIndex,
int periods)
Links adjacent LEDs to a specific sequence.
|
int |
YFunction.load(long msValidity)
Preloads the function cache with a specified validity duration.
|
String |
YFunction.loadAttribute(String attrName)
Returns the current value of a single function attribute, as a text string, as quickly as
possible but without using the cached value.
|
int |
YSensor.loadCalibrationPoints(ArrayList<Double> rawValues,
ArrayList<Double> refValues)
Retrieves error correction data points previously entered using the method
calibrateFromPoints.
|
int |
YWeighScale.loadCompensationTable(int tableIndex,
ArrayList<Double> tempValues,
ArrayList<Double> compValues) |
int |
YDataSet.loadMore()
Loads the the next block of measures from the dataLogger, and updates
the progress indicator.
|
int |
YWeighScale.loadOffsetAvgCompensationTable(ArrayList<Double> tempValues,
ArrayList<Double> compValues)
Retrieves the weight offset thermal compensation table previously configured using the
set_offsetAvgCompensationTable function.
|
int |
YWeighScale.loadOffsetChgCompensationTable(ArrayList<Double> tempValues,
ArrayList<Double> compValues)
Retrieves the weight offset thermal compensation table previously configured using the
set_offsetChgCompensationTable function.
|
int |
YWeighScale.loadSpanAvgCompensationTable(ArrayList<Double> tempValues,
ArrayList<Double> compValues)
Retrieves the weight span thermal compensation table previously configured using the
set_spanAvgCompensationTable function.
|
int |
YWeighScale.loadSpanChgCompensationTable(ArrayList<Double> tempValues,
ArrayList<Double> compValues)
Retrieves the weight span thermal compensation table previously configured using the
set_spanChgCompensationTable function.
|
int |
YDataStream.loadStream() |
int |
YDataSet.loadSummary(byte[] data) |
int |
YModule.loadThermistorExtra(String funcId,
String jsonExtra) |
int |
YTemperature.loadThermistorResponseTable(ArrayList<Double> tempValues,
ArrayList<Double> resValues)
Retrieves the thermistor response table previously configured using the
set_thermistorResponseTable function.
|
int |
YModule.log(String text)
Adds a text message to the device logs.
|
int |
YPwmOutput.markForRepeat() |
ArrayList<Integer> |
YSerialPort.modbusReadBits(int slaveNo,
int pduAddr,
int nBits)
Reads one or more contiguous internal bits (or coil status) from a MODBUS serial device.
|
ArrayList<Integer> |
YSerialPort.modbusReadInputBits(int slaveNo,
int pduAddr,
int nBits)
Reads one or more contiguous input bits (or discrete inputs) from a MODBUS serial device.
|
ArrayList<Integer> |
YSerialPort.modbusReadInputRegisters(int slaveNo,
int pduAddr,
int nWords)
Reads one or more contiguous input registers (read-only registers) from a MODBUS serial device.
|
ArrayList<Integer> |
YSerialPort.modbusReadRegisters(int slaveNo,
int pduAddr,
int nWords)
Reads one or more contiguous internal registers (holding registers) from a MODBUS serial device.
|
ArrayList<Integer> |
YSerialPort.modbusWriteAndReadRegisters(int slaveNo,
int pduWriteAddr,
ArrayList<Integer> values,
int pduReadAddr,
int nReadWords)
Sets several contiguous internal registers (holding registers) on a MODBUS serial device,
then performs a contiguous read of a set of (possibly different) internal registers.
|
int |
YSerialPort.modbusWriteBit(int slaveNo,
int pduAddr,
int value)
Sets a single internal bit (or coil) on a MODBUS serial device.
|
int |
YSerialPort.modbusWriteBits(int slaveNo,
int pduAddr,
ArrayList<Integer> bits)
Sets several contiguous internal bits (or coils) on a MODBUS serial device.
|
int |
YSerialPort.modbusWriteRegister(int slaveNo,
int pduAddr,
int value)
Sets a single internal register (or holding register) on a MODBUS serial device.
|
int |
YSerialPort.modbusWriteRegisters(int slaveNo,
int pduAddr,
ArrayList<Integer> values)
Sets several contiguous internal registers (or holding registers) on a MODBUS serial device.
|
int |
YRefFrame.more3DCalibration()
Continues the sensors tridimensional calibration process previously
initiated using method start3DCalibration.
|
int |
YRefFrame.more3DCalibrationV1() |
int |
YRefFrame.more3DCalibrationV2() |
int |
YServo.move(int target,
int ms_duration)
Performs a smooth move at constant speed toward a given position.
|
int |
YMultiAxisController.moveRel(ArrayList<Double> relPos)
Starts all motors synchronously to reach a given relative position.
|
int |
YStepperMotor.moveRel(double relPos)
Starts the motor to reach a given relative position.
|
int |
YStepperMotor.moveRelSlow(double relPos,
double maxSpeed)
Starts the motor to reach a given relative position, keeping the speed under the
specified limit.
|
int |
YMultiAxisController.moveTo(ArrayList<Double> absPos)
Starts all motors synchronously to reach a given absolute position.
|
int |
YStepperMotor.moveTo(double absPos)
Starts the motor to reach a given absolute position.
|
int |
YDisplayLayer.moveTo(int x,
int y)
Moves the drawing pointer of this layer to the specified position.
|
int |
YFunction.muteValueCallbacks()
Disables the propagation of every new advertised value to the parent hub.
|
YSms |
YMessageBox.newMessage(String recipient)
Creates a new empty SMS message, to be configured and sent later on.
|
int |
YDisplay.newSequence()
Starts to record all display commands into a sequence, for later replay.
|
int |
YBuzzer.oncePlaySeq()
Starts the preprogrammed playing sequence and run it once only.
|
ArrayList<YDataSet> |
YDataLogger.parse_dataSets(byte[] json) |
static YFirmwareFile |
YFirmwareFile.Parse(String path,
byte[] data) |
int |
YMultiAxisController.pause(int waitMs)
Keep the motor in the same state for the specified amount of time, before processing next command.
|
int |
YStepperMotor.pause(int waitMs)
Keep the motor in the same state for the specified amount of time, before processing next command.
|
int |
YDisplay.pauseSequence(int delay_ms)
Waits for a specified delay (in milliseconds) before playing next
commands in current sequence.
|
int |
YPwmOutput.phaseMove(double target,
int ms_duration)
Performs a smooth transition toward a specified value of the phase shift between this channel
and the other channel.
|
String |
YNetwork.ping(String host)
Pings host to test the network connectivity.
|
int |
YBuzzer.playNotes(String notes)
Immediately play a note sequence.
|
int |
YDisplay.playSequence(String sequenceName)
Replays a display sequence previously recorded using
newSequence() and saveSequence().
|
int |
YAPIContext.PreregisterHub(String url)
Fault-tolerant alternative to RegisterHub().
|
static int |
YAPI.PreregisterHub(String url)
Fault-tolerant alternative to RegisterHub().
|
int |
YAPIContext.PreregisterHubWebSocketCallback(Object session) |
static int |
YAPI.PreregisterHubWebSocketCallback(Object session) |
int |
YAPIContext.PreregisterHubWebSocketCallback(Object session,
String user,
String pass) |
static int |
YAPI.PreregisterHubWebSocketCallback(Object session,
String user,
String pass) |
int |
YDataSet.processMore(int progress,
byte[] data) |
int |
YWatchdog.pulse(int ms_duration)
Sets the relay to output B (active) for a specified duration, then brings it
automatically back to output A (idle state).
|
int |
YRelay.pulse(int ms_duration)
Sets the relay to output B (active) for a specified duration, then brings it
automatically back to output A (idle state).
|
int |
YDigitalIO.pulse(int bitno,
int ms_duration)
Triggers a pulse on a single bit for a specified duration.
|
int |
YBuzzer.pulse(int frequency,
int duration)
Activates the buzzer for a short duration.
|
int |
YPwmOutput.pulseDurationMove(double ms_target,
int ms_duration)
Performs a smooth transition of the pulse duration toward a given value.
|
String |
YSerialPort.queryLine(String query,
int maxWait)
Sends a text line query to the serial port, and reads the reply, if any.
|
String |
YSpiPort.queryLine(String query,
int maxWait)
Sends a text line query to the serial port, and reads the reply, if any.
|
ArrayList<Integer> |
YSerialPort.queryMODBUS(int slaveNo,
ArrayList<Integer> pduBytes)
Sends a message to a specified MODBUS slave connected to the serial port, and reads the
reply, if any.
|
ArrayList<YCellRecord> |
YCellular.quickCellSurvey()
Returns a list of nearby cellular antennas, as required for quick
geolocation of the device.
|
int |
YSerialPort.read_avail()
Returns the number of bytes available to read in the input buffer starting from the
current absolute stream position pointer of the API object.
|
int |
YSpiPort.read_avail()
Returns the number of bytes available to read in the input buffer starting from the
current absolute stream position pointer of the API object.
|
ArrayList<Integer> |
YSerialPort.readArray(int nChars)
Reads data from the receive buffer as a list of bytes, starting at current stream position.
|
ArrayList<Integer> |
YSpiPort.readArray(int nChars)
Reads data from the receive buffer as a list of bytes, starting at current stream position.
|
byte[] |
YSerialPort.readBin(int nChars)
Reads data from the receive buffer as a binary buffer, starting at current stream position.
|
byte[] |
YSpiPort.readBin(int nChars)
Reads data from the receive buffer as a binary buffer, starting at current stream position.
|
int |
YSerialPort.readByte()
Reads one byte from the receive buffer, starting at current stream position.
|
int |
YSpiPort.readByte()
Reads one byte from the receive buffer, starting at current stream position.
|
String |
YSerialPort.readHex(int nBytes)
Reads data from the receive buffer as a hexadecimal string, starting at current stream position.
|
String |
YSpiPort.readHex(int nBytes)
Reads data from the receive buffer as a hexadecimal string, starting at current stream position.
|
String |
YSerialPort.readLine()
Reads a single line (or message) from the receive buffer, starting at current stream position.
|
String |
YSpiPort.readLine()
Reads a single line (or message) from the receive buffer, starting at current stream position.
|
ArrayList<String> |
YSerialPort.readMessages(String pattern,
int maxWait)
Searches for incoming messages in the serial port receive buffer matching a given pattern,
starting at current position.
|
ArrayList<String> |
YSpiPort.readMessages(String pattern,
int maxWait)
Searches for incoming messages in the serial port receive buffer matching a given pattern,
starting at current position.
|
String |
YSerialPort.readStr(int nChars)
Reads data from the receive buffer as a string, starting at current stream position.
|
String |
YSpiPort.readStr(int nChars)
Reads data from the receive buffer as a string, starting at current stream position.
|
int |
YModule.reboot(int secBeforeReboot)
Schedules a simple module reboot after the given number of seconds.
|
int |
YGyro.registerAnglesCallback(YGyro.YAnglesCallback callback)
Registers a callback function that will be invoked each time that the estimated
device orientation has changed.
|
int |
YAPIContext.RegisterHub(String url)
Setup the Yoctopuce library to use modules connected on a given machine.
|
static int |
YAPI.RegisterHub(String url)
Setup the Yoctopuce library to use modules connected on a given machine.
|
int |
YAPIContext.RegisterHub(String url,
InputStream request,
OutputStream response) |
static int |
YAPI.RegisterHub(String url,
InputStream request,
OutputStream response) |
int |
YAPIContext.RegisterHubHTTPCallback(InputStream request,
OutputStream response) |
int |
YModule.registerLogCallback(YModule.LogCallback callback)
Registers a device log callback function.
|
int |
YGyro.registerQuaternionCallback(YGyro.YQuatCallback callback)
Registers a callback function that will be invoked each time that the estimated
device orientation has changed.
|
int |
YBuzzer.reloadPlaySeq()
Reloads the preprogrammed playing sequence from the flash memory.
|
int |
YFiles.remove(String pathname)
Deletes a file, given by its full path name, from the filesystem.
|
int |
YPwmOutput.repeatFromMark() |
int |
YSerialPort.reset()
Clears the serial port buffer and resets counters to zero.
|
int |
YDisplayLayer.reset()
Reverts the layer to its initial state (fully transparent, default settings).
|
int |
YMultiAxisController.reset()
Reinitialize all controllers and clear all alert flags.
|
int |
YStepperMotor.reset()
Reinitialize the controller and clear all alert flags.
|
int |
YSpiPort.reset()
Clears the serial port buffer and resets counters to zero.
|
int |
YPower.reset()
Resets the energy counter.
|
int |
YDisplay.resetAll()
Clears the display screen and resets all display layers to their default state.
|
int |
YColorLed.resetBlinkSeq()
Resets the preprogrammed blinking sequence.
|
int |
YColorLedCluster.resetBlinkSeq(int seqIndex)
Stops a sequence execution and resets its contents.
|
int |
YProximity.resetCounter()
Resets the pulse counter value as well as its timer.
|
int |
YAnButton.resetCounter()
Returns the pulse counter value as well as its timer.
|
int |
YPwmInput.resetCounter()
Returns the pulse counter value as well as its timer.
|
int |
YBuzzer.resetPlaySeq()
Resets the preprogrammed playing sequence and sets the frequency to zero.
|
int |
YWakeUpMonitor.resetSleepCountDown()
Resets the sleep countdown.
|
int |
YMotor.resetStatus()
Reset the controller state to IDLE.
|
int |
YWatchdog.resetWatchdog()
Resets the watchdog.
|
int |
YModule.revertFromFlash()
Reloads the settings stored in the nonvolatile memory, as
when the module is powered on.
|
int |
YColorLedCluster.rgb_move(int ledIndex,
int count,
int rgbValue,
int delay)
Allows you to modify the current color of a group of adjacent LEDs to another color, in a seamless and
autonomous manner.
|
int |
YColorLedCluster.rgbArray_move(ArrayList<Integer> rgbList,
int delay)
Sets up a smooth RGB color transition to the specified pixel-by-pixel list of RGB
color codes.
|
int |
YColorLedCluster.rgbArrayOfs_move(int ledIndex,
ArrayList<Integer> rgbList,
int delay)
Sets up a smooth RGB color transition to the specified pixel-by-pixel list of RGB
color codes.
|
int |
YColorLed.rgbMove(int rgb_target,
int ms_duration)
Performs a smooth transition in the RGB color space between the current color and a target color.
|
int |
YRefFrame.save3DCalibration()
Applies the sensors tridimensional calibration parameters that have just been computed.
|
int |
YRefFrame.save3DCalibrationV1() |
int |
YRefFrame.save3DCalibrationV2() |
int |
YColorLedCluster.saveBlinkSeq(int seqIndex)
Saves the definition of a sequence.
|
int |
YColorLedCluster.saveLedsConfigAtPowerOn()
Saves the LEDs power-on configuration.
|
int |
YColorLedCluster.saveLedsState() |
int |
YBuzzer.savePlaySeq()
Saves the preprogrammed playing sequence to flash memory.
|
int |
YDisplay.saveSequence(String sequenceName)
Stops recording display commands and saves the sequence into the specified
file on the display internal memory.
|
int |
YModule.saveToFlash()
Saves current settings in the nonvolatile memory of the module.
|
int |
YDisplayLayer.selectColorPen(int color)
Selects the pen color for all subsequent drawing functions,
including text drawing.
|
int |
YDisplayLayer.selectEraser()
Selects an eraser instead of a pen for all subsequent drawing functions,
except for bitmap copy functions.
|
int |
YDisplayLayer.selectFont(String fontname)
Selects a font to use for the next text drawing functions, by providing the name of the
font file.
|
int |
YDisplayLayer.selectGrayPen(int graylevel)
Selects the pen gray level for all subsequent drawing functions,
including text drawing.
|
int |
YSerialPort.selectJob(String jobfile)
Load and start processing the specified job file.
|
int |
YSpiPort.selectJob(String jobfile)
Load and start processing the specified job file.
|
int |
YSms.send()
Sends the SMS to the recipient.
|
void |
WSHandlerInterface.sendBinary(ByteBuffer partialByte,
boolean isLast) |
void |
WSHandlerJEE.sendBinary(ByteBuffer partialByte,
boolean isLast) |
int |
YColorLedCluster.sendCommand(String command) |
int |
YSerialPort.sendCommand(String text) |
byte[] |
YFiles.sendCommand(String command) |
int |
YColorLed.sendCommand(String command) |
int |
YMultiAxisController.sendCommand(String command) |
int |
YStepperMotor.sendCommand(String command) |
int |
YSpiPort.sendCommand(String text) |
int |
YDisplay.sendCommand(String cmd) |
int |
YBuzzer.sendCommand(String command) |
int |
YMessageBox.sendFlashMessage(String recipient,
String message)
Sends a Flash SMS (class 0 message).
|
int |
YCellular.sendPUK(String puk,
String newPin)
Sends a PUK code to unlock the SIM card after three failed PIN code attempts, and
setup a new PIN into the SIM card.
|
int |
YMessageBox.sendTextMessage(String recipient,
String message)
Sends a regular text SMS, with standard parameters.
|
int |
YCarbonDioxide.set_abcPeriod(int newval)
Changes Automatic Baseline Calibration period, in hours.
|
int |
YColorLedCluster.set_activeLedCount(int newval)
Changes the number of LEDs currently handled by the device.
|
int |
YNetwork.set_adminPassword(String newval)
Changes the password for the "admin" user.
|
int |
YFunction.set_advertisedValue(String newval) |
int |
YSensor.set_advMode(int newval)
Changes the measuring mode used for the advertised value pushed to the parent hub.
|
int |
YCellular.set_airplaneMode(int newval)
Changes the activation state of airplane mode (radio turned off).
|
int |
YStepperMotor.set_alertMode(String newval) |
int |
YModule.set_allSettings(byte[] settings)
Restores all the settings of the device.
|
int |
YModule.set_allSettingsAndFiles(byte[] settings)
Restores all the settings and uploaded files to the module.
|
int |
YAnButton.set_analogCalibration(int newval)
Starts or stops the calibration process.
|
int |
YCellular.set_apn(String newval)
Returns the Access Point Name (APN) to be used, if needed.
|
int |
YCellular.set_apnAuth(String username,
String password)
Configure authentication parameters to connect to the APN.
|
int |
YCellular.set_apnSecret(String newval) |
int |
YWatchdog.set_autoStart(int newval)
Changes the watchdog running state at module power on.
|
int |
YDataLogger.set_autoStart(int newval)
Changes the default activation state of the data logger on power up.
|
int |
YStepperMotor.set_auxMode(String newval) |
int |
YStepperMotor.set_auxSignal(int newval)
Changes the value of the signal generated on the auxiliary output.
|
int |
YTilt.set_bandwidth(int newval)
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YCompass.set_bandwidth(int newval)
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YGyro.set_bandwidth(int newval)
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YAccelerometer.set_bandwidth(int newval)
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YMagnetometer.set_bandwidth(int newval)
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YModule.set_beacon(int newval)
Turns on or off the module localization beacon.
|
int |
YDataLogger.set_beaconDriven(int newval)
Changes the type of synchronisation of the data logger.
|
int |
YRefFrame.set_bearing(double newval)
Changes the reference bearing used by the compass.
|
int |
YDigitalIO.set_bitDirection(int bitno,
int bitdirection)
Changes the direction of a single bit (i.e.
|
int |
YDigitalIO.set_bitOpenDrain(int bitno,
int opendrain)
Changes the electrical interface of a single bit from the I/O port.
|
int |
YDigitalIO.set_bitPolarity(int bitno,
int bitpolarity)
Changes the polarity of a single bit from the I/O port.
|
int |
YDigitalIO.set_bitState(int bitno,
int bitstate)
Sets a single bit (i.e.
|
int |
YLed.set_blinking(int newval)
Changes the current LED signaling mode.
|
int |
YColorLedCluster.set_blinkSeqSpeed(int seqIndex,
int speed)
Changes the execution speed of a sequence.
|
int |
YColorLedCluster.set_blinkSeqStateAtPowerOn(int seqIndex,
int autostart)
Configures a sequence to make it start automatically at device
startup.
|
int |
YMotor.set_brakingForce(double newval)
Changes immediately the braking force applied to the motor (in percents).
|
int |
YDisplay.set_brightness(int newval)
Changes the brightness of the display.
|
int |
YAnButton.set_calibrationMax(int newval)
Changes the maximal calibration value for the input (between 0 and 4095, included), without actually
starting the automated calibration.
|
int |
YAnButton.set_calibrationMin(int newval)
Changes the minimal calibration value for the input (between 0 and 4095, included), without actually
starting the automated calibration.
|
int |
YRefFrame.set_calibrationParam(String newval) |
int |
YSensor.set_calibrationParam(String newval) |
int |
YNetwork.set_callbackCredentials(String newval)
Changes the credentials required to connect to the callback address.
|
int |
YNetwork.set_callbackEncoding(int newval)
Changes the encoding standard to use for representing notification values.
|
int |
YNetwork.set_callbackInitialDelay(int newval)
Changes the initial waiting time before first callback notifications, in seconds.
|
int |
YNetwork.set_callbackMaxDelay(int newval)
Changes the waiting time between two HTTP callbacks when there is nothing new.
|
int |
YNetwork.set_callbackMethod(int newval)
Changes the HTTP method used to notify callbacks for significant state changes.
|
int |
YNetwork.set_callbackMinDelay(int newval)
Changes the minimum waiting time between two HTTP callbacks, in seconds.
|
int |
YNetwork.set_callbackSchedule(String newval)
Changes the HTTP callback schedule strategy, as a text string.
|
int |
YNetwork.set_callbackUrl(String newval)
Changes the callback URL to notify significant state changes.
|
int |
YMultiCellWeighScale.set_cellCount(int newval)
Changes the number of load cells in use.
|
int |
YDataLogger.set_clearHistory(int newval) |
int |
YColorLedCluster.set_command(String newval) |
int |
YCarbonDioxide.set_command(String newval) |
int |
YSerialPort.set_command(String newval) |
int |
YMessageBox.set_command(String newval) |
int |
YBluetoothLink.set_command(String newval) |
int |
YTemperature.set_command(String newval) |
int |
YDigitalIO.set_command(String newval) |
int |
YMultiSensController.set_command(String newval) |
int |
YRangeFinder.set_command(String newval) |
int |
YColorLed.set_command(String newval) |
int |
YGps.set_command(String newval) |
int |
YMultiAxisController.set_command(String newval) |
int |
YCellular.set_command(String newval) |
int |
YWeighScale.set_command(String newval) |
int |
YPowerSupply.set_command(String newval) |
int |
YStepperMotor.set_command(String newval) |
int |
YSpiPort.set_command(String newval) |
int |
YDisplay.set_command(String newval) |
int |
YBuzzer.set_command(String newval) |
int |
YMotor.set_command(String newval) |
int |
YMultiCellWeighScale.set_command(String newval) |
int |
YGps.set_coordSystem(int newval)
Changes the representation system used for positioning data.
|
int |
YCurrentLoopOutput.set_current(double newval)
Changes the current loop, the valid range is from 3 to 21mA.
|
int |
YPowerSupply.set_currentAtStartUp(double newval)
Changes the current limit at device start up.
|
int |
YCurrentLoopOutput.set_currentAtStartUp(double newval)
Changes the loop current at device start up.
|
int |
YSerialPort.set_currentJob(String newval)
Changes the job to use when the device is powered on.
|
int |
YSpiPort.set_currentJob(String newval)
Changes the job to use when the device is powered on.
|
int |
YPowerSupply.set_currentLimit(double newval)
Changes the current limit, in mA.
|
int |
YCurrentLoopOutput.set_currentTransition(String newval) |
int |
YLightSensor.set_currentValue(double newval) |
int |
YAltitude.set_currentValue(double newval)
Changes the current estimated altitude.
|
int |
YQuadratureDecoder.set_currentValue(double newval)
Changes the current expected position of the quadrature decoder.
|
int |
YVoltageOutput.set_currentVoltage(double newval)
Changes the output voltage, in V.
|
int |
YMotor.set_cutOffVoltage(double newval)
Changes the threshold voltage under which the controller automatically switches to error state
and prevents further current draw.
|
int |
YCellular.set_dataReceived(int newval)
Changes the value of the incoming data counter.
|
int |
YCellular.set_dataSent(int newval)
Changes the value of the outgoing data counter.
|
int |
YPwmInput.set_debouncePeriod(int newval)
Changes the shortest expected pulse duration, in ms.
|
int |
YQuadratureDecoder.set_decoding(int newval)
Changes the activation state of the quadrature decoder.
|
int |
YNetwork.set_defaultPage(String newval)
Changes the default HTML page returned by the hub.
|
int |
YRelay.set_delayedPulseTimer(YRelay.YDelayedPulse newval) |
int |
YWatchdog.set_delayedPulseTimer(YWatchdog.YDelayedPulse newval) |
int |
YProximity.set_detectionHysteresis(int newval)
Changes the hysteresis used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
|
int |
YProximity.set_detectionThreshold(int newval)
Changes the threshold used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
|
int |
YNetwork.set_discoverable(int newval)
Changes the activation state of the multicast announce protocols to allow easy
discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
|
int |
YSegmentedDisplay.set_displayedText(String newval)
Changes the text currently displayed on the screen.
|
int |
YSegmentedDisplay.set_displayMode(int newval) |
int |
YMotor.set_drivingForce(double newval)
Changes immediately the power sent to the motor.
|
int |
YPwmOutput.set_dutyCycle(double newval)
Changes the PWM duty cycle, in per cents.
|
int |
YPwmOutput.set_dutyCycleAtPowerOn(double newval)
Changes the PWM duty cycle at device power on.
|
int |
YCurrent.set_enabled(int newval)
Changes the activation state of this input.
|
int |
YPwmOutput.set_enabled(int newval)
Stops or starts the PWM.
|
int |
YDisplay.set_enabled(int newval)
Changes the power state of the display.
|
int |
YServo.set_enabled(int newval)
Stops or starts the servo.
|
int |
YHubPort.set_enabled(int newval)
Changes the activation of the Yocto-hub port.
|
int |
YGenericSensor.set_enabled(int newval)
Changes the activation state of this input.
|
int |
YVoltage.set_enabled(int newval)
Changes the activation state of this input.
|
int |
YCellular.set_enableData(int newval)
Changes the condition for enabling IP data services (GPRS).
|
int |
YPwmOutput.set_enabledAtPowerOn(int newval)
Changes the state of the PWM at device power on.
|
int |
YServo.set_enabledAtPowerOn(int newval)
Configure the servo signal generator state at power up.
|
int |
YWeighScale.set_excitation(int newval)
Changes the current load cell bridge excitation method.
|
int |
YMultiCellWeighScale.set_excitation(int newval)
Changes the current load cell bridge excitation method.
|
int |
YModule.set_extraSettings(String jsonExtra) |
int |
YMotor.set_failSafeTimeout(int newval)
Changes the delay in milliseconds allowed for the controller to run autonomously without
receiving any instruction from the control process.
|
int |
YPwmOutput.set_frequency(double newval)
Changes the PWM frequency.
|
int |
YBuzzer.set_frequency(double newval)
Changes the frequency of the signal sent to the buzzer.
|
int |
YMotor.set_frequency(double newval)
Changes the PWM frequency used to control the motor.
|
int |
YRefFrame.set_fusionMode(int newval) |
int |
YAccelerometer.set_gravityCancellation(int newval) |
int |
YRangeFinder.set_hardwareCalibration(String newval) |
int |
YSensor.set_highestValue(double newval)
Changes the recorded maximal value observed.
|
int |
YWakeUpSchedule.set_hours(int newval)
Changes the hours when a wake up must take place.
|
int |
YColorLed.set_hslColor(int newval)
Changes the current color of the LED, using a color HSL.
|
int |
YColorLedCluster.set_hslColor(int ledIndex,
int count,
int hslValue)
Changes the current color of consecutive LEDs in the cluster, using a HSL color.
|
int |
YColorLedCluster.set_hslColorArray(int ledIndex,
ArrayList<Integer> hslList)
Sends 24bit HSL colors (provided as a list of integers) to the LED HSL buffer, as is.
|
int |
YColorLedCluster.set_hslColorAtPowerOn(int ledIndex,
int count,
int hslValue)
Changes the color at device startup of consecutive LEDs in the cluster, using a HSL color.
|
int |
YColorLedCluster.set_hslColorBuffer(int ledIndex,
byte[] buff)
Sends a binary buffer to the LED HSL buffer, as is.
|
int |
YColorLed.set_hslMove(YColorLed.YMove newval) |
int |
YNetwork.set_httpPort(int newval)
Changes the default HTML page returned by the hub.
|
int |
YNetwork.set_ipConfig(String newval) |
int |
YColorLedCluster.set_ledType(int newval)
Changes the RGB LED type currently handled by the device.
|
int |
YCellular.set_lockedOperator(String newval)
Changes the name of the cell operator to be used.
|
int |
YSensor.set_logFrequency(String newval)
Changes the datalogger recording frequency for this function.
|
int |
YFunction.set_logicalName(String newval)
Changes the logical name of the function.
|
int |
YSensor.set_lowestValue(double newval)
Changes the recorded minimal value observed.
|
int |
YLed.set_luminosity(int newval)
Changes the current LED intensity (in per cent).
|
int |
YModule.set_luminosity(int newval)
Changes the luminosity of the module informative leds.
|
int |
YMultiSensController.set_maintenanceMode(int newval)
Changes the device mode to enable maintenance and to stop sensor polling.
|
int |
YStepperMotor.set_maxAccel(double newval)
Changes the maximal motor acceleration, measured in steps per second^2.
|
int |
YStepperMotor.set_maxSpeed(double newval)
Changes the maximal motor speed, measured in steps per second.
|
int |
YWatchdog.set_maxTimeOnStateA(long newval)
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
|
int |
YRelay.set_maxTimeOnStateA(long newval)
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
|
int |
YWatchdog.set_maxTimeOnStateB(long newval)
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
|
int |
YRelay.set_maxTimeOnStateB(long newval)
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
|
int |
YLightSensor.set_measureType(int newval)
Changes the light sensor type used in the device.
|
int |
YPower.set_meter(double newval) |
int |
YWakeUpSchedule.set_minutes(long bitmap)
Changes all the minutes where a wake up must take place.
|
int |
YWakeUpSchedule.set_minutesA(int newval)
Changes the minutes in the 00-29 interval when a wake up must take place.
|
int |
YWakeUpSchedule.set_minutesB(int newval)
Changes the minutes in the 30-59 interval when a wake up must take place.
|
int |
YWakeUpSchedule.set_monthDays(int newval)
Changes the days of the month when a wake up must take place.
|
int |
YWakeUpSchedule.set_months(int newval)
Changes the months when a wake up must take place.
|
int |
YMotor.set_motorStatus(int newval) |
int |
YRefFrame.set_mountPos(int newval) |
int |
YRefFrame.set_mountPosition(YRefFrame.MOUNTPOSITION position,
YRefFrame.MOUNTORIENTATION orientation)
Changes the compass and tilt sensor frame of reference.
|
int |
YServo.set_move(YServo.YMove newval) |
int |
YAudioIn.set_mute(int newval)
Changes the state of the mute function.
|
int |
YBluetoothLink.set_mute(int newval)
Changes the state of the mute function.
|
int |
YAudioOut.set_mute(int newval)
Changes the state of the mute function.
|
int |
YMultiAxisController.set_nAxis(int newval)
Changes the number of synchronized controllers.
|
int |
YServo.set_neutral(int newval)
Changes the duration of the pulse corresponding to the neutral position of the servo.
|
int |
YWakeUpMonitor.set_nextWakeUp(long newval)
Changes the days of the week when a wake up must take place.
|
int |
YMultiSensController.set_nSensors(int newval)
Changes the number of sensors to poll.
|
int |
YTemperature.set_ntcParameters(double res25,
double beta)
Configures NTC thermistor parameters in order to properly compute the temperature from
the measured resistance.
|
int |
YNetwork.set_ntpServer(String newval)
Changes the IP address of the NTP server to be used by the module.
|
int |
YWeighScale.set_offsetAvgCompensationTable(ArrayList<Double> tempValues,
ArrayList<Double> compValues)
Records a weight offset thermal compensation table, in order to automatically correct the
measured weight based on the averaged compensation temperature.
|
int |
YWeighScale.set_offsetChgCompensationTable(ArrayList<Double> tempValues,
ArrayList<Double> compValues)
Records a weight offset thermal compensation table, in order to automatically correct the
measured weight based on the variation of temperature.
|
int |
YDisplay.set_orientation(int newval)
Changes the display orientation.
|
int |
YWatchdog.set_output(int newval)
Changes the output state of the watchdog, when used as a simple switch (single throw).
|
int |
YRelay.set_output(int newval)
Changes the output state of the relays, when used as a simple switch (single throw).
|
int |
YDigitalIO.set_outputVoltage(int newval)
Changes the voltage source used to drive output bits.
|
int |
YStepperMotor.set_overcurrent(int newval)
Changes the overcurrent alert and emergency stop threshold, measured in mA.
|
int |
YMotor.set_overCurrentLimit(int newval)
Changes the current threshold (in mA) above which the controller automatically
switches to error state.
|
int |
YBluetoothLink.set_pairingPin(String newval)
Changes the PIN code used by the module for bluetooth pairing.
|
int |
YMessageBox.set_pduReceived(int newval)
Changes the value of the incoming SMS units counter.
|
int |
YMessageBox.set_pduSent(int newval)
Changes the value of the outgoing SMS units counter.
|
int |
YPwmOutput.set_period(double newval)
Changes the PWM period in milliseconds.
|
int |
YNetwork.set_periodicCallbackSchedule(String interval,
int offset)
Setup periodic HTTP callbacks (simplified function).
|
int |
YModule.set_persistentSettings(int newval) |
int |
YCellular.set_pin(String newval)
Changes the PIN code used by the module to access the SIM card.
|
int |
YCellular.set_pingInterval(int newval)
Changes the automated connectivity check interval, in seconds.
|
int |
YDigitalIO.set_portDirection(int newval)
Changes the IO direction of all bits (i.e.
|
int |
YDigitalIO.set_portOpenDrain(int newval)
Changes the electrical interface for each bit of the port.
|
int |
YDigitalIO.set_portPolarity(int newval)
Changes the polarity of all the bits of the port: For each bit set to 0, the matching I/O works the regular,
intuitive way; for each bit set to 1, the I/O works in reverse mode.
|
int |
YDigitalIO.set_portState(int newval)
Changes the state of all digital IO port's channels at once,
the parameter is an integer with each bit representing a channel.
|
int |
YServo.set_position(int newval)
Changes immediately the servo driving position.
|
int |
YServo.set_positionAtPowerOn(int newval)
Configure the servo position at device power up.
|
int |
YLed.set_power(int newval)
Changes the state of the LED.
|
int |
YDualPower.set_powerControl(int newval)
Changes the selected power source for module functions that require lots of current.
|
int |
YWakeUpMonitor.set_powerDuration(int newval)
Changes the maximal wake up time (seconds) before automatically going to sleep.
|
int |
YPwmPowerSource.set_powerMode(int newval)
Changes the PWM power source.
|
int |
YPowerSupply.set_powerOutput(int newval)
Changes the power supply output switch state.
|
int |
YBluetoothLink.set_preAmplifier(int newval)
Changes the audio pre-amplifier volume, in per cents.
|
int |
YProximity.set_presenceMinTime(int newval)
Changes the minimal detection duration before signalling a presence event.
|
int |
YNetwork.set_primaryDNS(String newval)
Changes the IP address of the primary name server to be used by the module.
|
int |
YSerialPort.set_protocol(String newval)
Changes the type of protocol used over the serial line.
|
int |
YSpiPort.set_protocol(String newval)
Changes the type of protocol used over the serial line.
|
int |
YProximity.set_proximityReportMode(int newval)
Changes the parameter type (sensor value, presence or pulse count) returned by the
get_currentValue function and callbacks.
|
int |
YStepperMotor.set_pullinSpeed(double newval)
Changes the motor speed immediately reachable from stop state, measured in steps per second.
|
int |
YProximity.set_pulseCounter(long newval) |
int |
YAnButton.set_pulseCounter(long newval) |
int |
YPwmInput.set_pulseCounter(long newval) |
int |
YPwmOutput.set_pulseDuration(double newval)
Changes the PWM pulse length, in milliseconds.
|
int |
YWatchdog.set_pulseTimer(long newval) |
int |
YRelay.set_pulseTimer(long newval) |
int |
YPwmInput.set_pwmReportMode(int newval)
Changes the parameter type (frequency/duty cycle, pulse width, or edge count) returned by the
get_currentValue function and callbacks.
|
int |
YPwmOutput.set_pwmTransition(String newval) |
int |
YAltitude.set_qnh(double newval)
Changes the barometric pressure adjusted to sea level used to compute
the altitude (QNH).
|
int |
YServo.set_range(int newval)
Changes the range of use of the servo, specified in per cents.
|
int |
YRangeFinder.set_rangeFinderMode(int newval)
Changes the rangefinder running mode, allowing you to put priority on
precision, speed or maximum range.
|
int |
YModule.set_rebootCountdown(int newval) |
int |
YDataLogger.set_recording(int newval)
Changes the activation state of the data logger to start/stop recording data.
|
int |
YBluetoothLink.set_remoteAddress(String newval)
Changes the MAC-48 address defining which remote device to connect to.
|
int |
YProximity.set_removalMinTime(int newval)
Changes the minimal detection duration before signalling a removal event.
|
int |
YSensor.set_reportFrequency(String newval)
Changes the timed value notification frequency for this function.
|
int |
YDaisyChain.set_requiredChildCount(int newval)
Changes the number of child nodes expected in normal conditions.
|
int |
YSensor.set_resolution(double newval)
Changes the resolution of the measured physical values.
|
int |
YColorLed.set_rgbColor(int newval)
Changes the current color of the LED, using an RGB color.
|
int |
YColorLedCluster.set_rgbColor(int ledIndex,
int count,
int rgbValue)
Changes the current color of consecutive LEDs in the cluster, using a RGB color.
|
int |
YColorLedCluster.set_rgbColorArray(int ledIndex,
ArrayList<Integer> rgbList)
Sends 24bit RGB colors (provided as a list of integers) to the LED RGB buffer, as is.
|
int |
YColorLed.set_rgbColorAtPowerOn(int newval)
Changes the color that the LED will display by default when the module is turned on.
|
int |
YColorLedCluster.set_rgbColorAtPowerOn(int ledIndex,
int count,
int rgbValue)
Changes the color at device startup of consecutive LEDs in the cluster, using a RGB color.
|
int |
YColorLedCluster.set_rgbColorBuffer(int ledIndex,
byte[] buff)
Sends a binary buffer to the LED RGB buffer, as is.
|
int |
YColorLed.set_rgbMove(YColorLed.YMove newval) |
int |
YSerialPort.set_RTS(int val)
Manually sets the state of the RTS line.
|
int |
YWatchdog.set_running(int newval)
Changes the running state of the watchdog.
|
int |
YNetwork.set_secondaryDNS(String newval)
Changes the IP address of the secondary name server to be used by the module.
|
int |
YAnButton.set_sensitivity(int newval)
Changes the sensibility for the input (between 1 and 1000) for triggering user callbacks.
|
int |
YTemperature.set_sensorType(int newval)
Changes the temperature sensor type.
|
int |
YSerialPort.set_serialMode(String newval)
Changes the serial port communication parameters, with a string such as
"9600,8N1".
|
int |
YSpiPort.set_shiftSampling(int newval)
Changes the SDI line sampling shift.
|
int |
YOsControl.set_shutdownCountdown(int newval) |
int |
YGenericSensor.set_signalBias(double newval)
Changes the electric signal bias for zero shift adjustment.
|
int |
YGenericSensor.set_signalRange(String newval)
Changes the electric signal range used by the sensor.
|
int |
YGenericSensor.set_signalSampling(int newval)
Changes the electric signal sampling method to use.
|
int |
YWakeUpMonitor.set_sleepCountdown(int newval)
Changes the delay before the next sleep period.
|
int |
YWeighScale.set_spanAvgCompensationTable(ArrayList<Double> tempValues,
ArrayList<Double> compValues)
Records a weight span thermal compensation table, in order to automatically correct the
measured weight based on the compensation temperature.
|
int |
YWeighScale.set_spanChgCompensationTable(ArrayList<Double> tempValues,
ArrayList<Double> compValues)
Records a weight span thermal compensation table, in order to automatically correct the
measured weight based on the variation of temperature.
|
int |
YSpiPort.set_spiMode(String newval)
Changes the SPI port communication parameters, with a string such as
"125000,0,msb".
|
int |
YSpiPort.set_SS(int val)
Manually sets the state of the SS line.
|
int |
YSpiPort.set_ssPolarity(int newval)
Changes the SS line polarity.
|
int |
YMotor.set_starterTime(int newval)
Changes the duration (in ms) during which the motor is driven at low frequency to help
it start up.
|
int |
YSerialPort.set_startupJob(String newval)
Changes the job to use when the device is powered on.
|
int |
YSpiPort.set_startupJob(String newval)
Changes the job to use when the device is powered on.
|
int |
YDisplay.set_startupSeq(String newval)
Changes the name of the sequence to play when the displayed is powered on.
|
int |
YWatchdog.set_state(int newval)
Changes the state of the watchdog (A for the idle position, B for the active position).
|
int |
YRelay.set_state(int newval)
Changes the state of the relays (A for the idle position, B for the active position).
|
int |
YWatchdog.set_stateAtPowerOn(int newval)
Preset the state of the watchdog at device startup (A for the idle position,
B for the active position, UNCHANGED for no modification).
|
int |
YRelay.set_stateAtPowerOn(int newval)
Preset the state of the relays at device startup (A for the idle position,
B for the active position, UNCHANGED for no modification).
|
int |
YStepperMotor.set_stepping(int newval)
Changes the stepping mode used to drive the motor.
|
int |
YStepperMotor.set_stepPos(double newval)
Changes the current logical motor position, measured in steps.
|
int |
YStepperMotor.set_tCurrRun(int newval)
Changes the torque regulation current when the motor is running, measured in mA.
|
int |
YStepperMotor.set_tCurrStop(int newval)
Changes the torque regulation current when the motor is stopped, measured in mA.
|
int |
YWeighScale.set_tempAvgAdaptRatio(double newval)
Changes the averaged temperature update rate, in per mille.
|
int |
YMultiCellWeighScale.set_tempAvgAdaptRatio(double newval)
Changes the averaged temperature update rate, in per mille.
|
int |
YWeighScale.set_tempChgAdaptRatio(double newval)
Changes the temperature change update rate, in per mille.
|
int |
YMultiCellWeighScale.set_tempChgAdaptRatio(double newval)
Changes the temperature change update rate, in per mille.
|
int |
YTemperature.set_thermistorResponseTable(ArrayList<Double> tempValues,
ArrayList<Double> resValues)
Records a thermistor response table, in order to interpolate the temperature from
the measured resistance.
|
int |
YRangeFinder.set_timeFrame(long newval)
Changes the time frame used to measure the distance and estimate the measure
reliability.
|
int |
YDataLogger.set_timeUTC(long newval)
Changes the current UTC time reference used for recorded data.
|
int |
YWatchdog.set_triggerDelay(long newval)
Changes the waiting delay before a reset is triggered by the watchdog, in milliseconds.
|
int |
YWatchdog.set_triggerDuration(long newval)
Changes the duration of resets caused by the watchdog, in milliseconds.
|
int |
YTemperature.set_unit(String newval)
Changes the measuring unit for the measured temperature.
|
int |
YRangeFinder.set_unit(String newval)
Changes the measuring unit for the measured range.
|
int |
YWeighScale.set_unit(String newval)
Changes the measuring unit for the weight.
|
int |
YHumidity.set_unit(String newval)
Changes the primary unit for measuring humidity.
|
int |
YGenericSensor.set_unit(String newval)
Changes the measuring unit for the measured value.
|
int |
YPwmInput.set_unit(String newval)
Changes the measuring unit for the measured quantity.
|
int |
YMultiCellWeighScale.set_unit(String newval)
Changes the measuring unit for the weight.
|
int |
YRealTimeClock.set_unixTime(long newval)
Changes the current time.
|
int |
YNetwork.set_userPassword(String newval)
Changes the password for the "user" user.
|
int |
YModule.set_userVar(int newval)
Stores a 32 bit value in the device RAM.
|
int |
YGps.set_utcOffset(int newval)
Changes the number of seconds between current time and UTC time (time zone).
|
int |
YRealTimeClock.set_utcOffset(int newval)
Changes the number of seconds between current time and UTC time (time zone).
|
int |
YGenericSensor.set_valueRange(String newval)
Changes the physical value range measured by the sensor.
|
int |
YPowerOutput.set_voltage(int newval)
Changes the voltage on the power output provided by the
module.
|
int |
YVoltageOutput.set_voltageAtStartUp(double newval)
Changes the output voltage at device start up.
|
int |
YPowerSupply.set_voltageAtStartUp(double newval)
Changes the voltage set point at device start up.
|
int |
YSerialPort.set_voltageLevel(int newval)
Changes the voltage type used on the serial line.
|
int |
YSpiPort.set_voltageLevel(int newval)
Changes the voltage type used on the serial line.
|
int |
YPowerSupply.set_voltageSense(int newval)
Changes the voltage control point.
|
int |
YPowerSupply.set_voltageSetPoint(double newval)
Changes the voltage set point, in V.
|
int |
YVoltageOutput.set_voltageTransition(String newval) |
int |
YPowerSupply.set_voltageTransition(String newval) |
int |
YAudioIn.set_volume(int newval)
Changes audio input gain, in per cents.
|
int |
YBluetoothLink.set_volume(int newval)
Changes the connected headset volume, in per cents.
|
int |
YAudioOut.set_volume(int newval)
Changes audio output volume, in per cents.
|
int |
YBuzzer.set_volume(int newval)
Changes the volume of the signal sent to the buzzer/speaker.
|
int |
YWakeUpMonitor.set_wakeUpState(int newval) |
int |
YWakeUpSchedule.set_weekDays(int newval)
Changes the days of the week when a wake up must take place.
|
int |
YWireless.set_wlanConfig(String newval) |
int |
YNetwork.set_wwwWatchdogDelay(int newval)
Changes the allowed downtime of the WWW link (in seconds) before triggering an automated
reboot to try to recover Internet connectivity.
|
int |
YWeighScale.set_zeroTracking(double newval)
Changes the zero tracking threshold value.
|
int |
YMultiCellWeighScale.set_zeroTracking(double newval)
Changes the zero tracking threshold value.
|
int |
YCarbonDioxide.setAbcPeriod(int newval)
Changes Automatic Baseline Calibration period, in hours.
|
int |
YColorLedCluster.setActiveLedCount(int newval)
Changes the number of LEDs currently handled by the device.
|
int |
YNetwork.setAdminPassword(String newval)
Changes the password for the "admin" user.
|
int |
YSensor.setAdvMode(int newval)
Changes the measuring mode used for the advertised value pushed to the parent hub.
|
int |
YCellular.setAirplaneMode(int newval)
Changes the activation state of airplane mode (radio turned off).
|
int |
YAnButton.setAnalogCalibration(int newval)
Starts or stops the calibration process.
|
int |
YDisplayLayer.setAntialiasingMode(boolean mode)
Enables or disables anti-aliasing for drawing oblique lines and circles.
|
int |
YCellular.setApn(String newval)
Returns the Access Point Name (APN) to be used, if needed.
|
int |
YWatchdog.setAutoStart(int newval)
Changes the watchdog running state at module power on.
|
int |
YDataLogger.setAutoStart(int newval)
Changes the default activation state of the data logger on power up.
|
int |
YStepperMotor.setAuxSignal(int newval)
Changes the value of the signal generated on the auxiliary output.
|
int |
YTilt.setBandwidth(int newval)
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YCompass.setBandwidth(int newval)
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YGyro.setBandwidth(int newval)
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YAccelerometer.setBandwidth(int newval)
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YMagnetometer.setBandwidth(int newval)
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
|
int |
YModule.setBeacon(int newval)
Turns on or off the module localization beacon.
|
int |
YDataLogger.setBeaconDriven(int newval)
Changes the type of synchronisation of the data logger.
|
int |
YRefFrame.setBearing(double newval)
Changes the reference bearing used by the compass.
|
int |
YLed.setBlinking(int newval)
Changes the current LED signaling mode.
|
int |
YMotor.setBrakingForce(double newval)
Changes immediately the braking force applied to the motor (in percents).
|
int |
YDisplay.setBrightness(int newval)
Changes the brightness of the display.
|
int |
YAnButton.setCalibrationMax(int newval)
Changes the maximal calibration value for the input (between 0 and 4095, included), without actually
starting the automated calibration.
|
int |
YAnButton.setCalibrationMin(int newval)
Changes the minimal calibration value for the input (between 0 and 4095, included), without actually
starting the automated calibration.
|
int |
YNetwork.setCallbackCredentials(String newval)
Changes the credentials required to connect to the callback address.
|
int |
YNetwork.setCallbackEncoding(int newval)
Changes the encoding standard to use for representing notification values.
|
int |
YNetwork.setCallbackInitialDelay(int newval)
Changes the initial waiting time before first callback notifications, in seconds.
|
int |
YNetwork.setCallbackMaxDelay(int newval)
Changes the waiting time between two HTTP callbacks when there is nothing new.
|
int |
YNetwork.setCallbackMethod(int newval)
Changes the HTTP method used to notify callbacks for significant state changes.
|
int |
YNetwork.setCallbackMinDelay(int newval)
Changes the minimum waiting time between two HTTP callbacks, in seconds.
|
int |
YNetwork.setCallbackSchedule(String newval)
Changes the HTTP callback schedule strategy, as a text string.
|
int |
YNetwork.setCallbackUrl(String newval)
Changes the callback URL to notify significant state changes.
|
int |
YMultiCellWeighScale.setCellCount(int newval)
Changes the number of load cells in use.
|
int |
YWeighScale.setCompensationTable(int tableIndex,
ArrayList<Double> tempValues,
ArrayList<Double> compValues) |
int |
YDisplayLayer.setConsoleBackground(int bgcol)
Sets up the background color used by the clearConsole function and by
the console scrolling feature.
|
int |
YDisplayLayer.setConsoleMargins(int x1,
int y1,
int x2,
int y2)
Sets up display margins for the consoleOut function.
|
int |
YDisplayLayer.setConsoleWordWrap(boolean wordwrap)
Sets up the wrapping behavior used by the consoleOut function.
|
int |
YGps.setCoordSystem(int newval)
Changes the representation system used for positioning data.
|
int |
YCurrentLoopOutput.setCurrent(double newval)
Changes the current loop, the valid range is from 3 to 21mA.
|
int |
YPowerSupply.setCurrentAtStartUp(double newval)
Changes the current limit at device start up.
|
int |
YCurrentLoopOutput.setCurrentAtStartUp(double newval)
Changes the loop current at device start up.
|
int |
YSerialPort.setCurrentJob(String newval)
Changes the job to use when the device is powered on.
|
int |
YSpiPort.setCurrentJob(String newval)
Changes the job to use when the device is powered on.
|
int |
YPowerSupply.setCurrentLimit(double newval)
Changes the current limit, in mA.
|
int |
YAltitude.setCurrentValue(double newval)
Changes the current estimated altitude.
|
int |
YQuadratureDecoder.setCurrentValue(double newval)
Changes the current expected position of the quadrature decoder.
|
int |
YVoltageOutput.setCurrentVoltage(double newval)
Changes the output voltage, in V.
|
int |
YMotor.setCutOffVoltage(double newval)
Changes the threshold voltage under which the controller automatically switches to error state
and prevents further current draw.
|
int |
YCellular.setDataReceived(int newval)
Changes the value of the incoming data counter.
|
int |
YCellular.setDataSent(int newval)
Changes the value of the outgoing data counter.
|
int |
YPwmInput.setDebouncePeriod(int newval)
Changes the shortest expected pulse duration, in ms.
|
int |
YQuadratureDecoder.setDecoding(int newval)
Changes the activation state of the quadrature decoder.
|
int |
YNetwork.setDefaultPage(String newval)
Changes the default HTML page returned by the hub.
|
int |
YProximity.setDetectionHysteresis(int newval)
Changes the hysteresis used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
|
int |
YProximity.setDetectionThreshold(int newval)
Changes the threshold used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
|
int |
YNetwork.setDiscoverable(int newval)
Changes the activation state of the multicast announce protocols to allow easy
discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
|
int |
YSegmentedDisplay.setDisplayedText(String newval)
Changes the text currently displayed on the screen.
|
int |
YMotor.setDrivingForce(double newval)
Changes immediately the power sent to the motor.
|
int |
YPwmOutput.setDutyCycle(double newval)
Changes the PWM duty cycle, in per cents.
|
int |
YPwmOutput.setDutyCycleAtPowerOn(double newval)
Changes the PWM duty cycle at device power on.
|
int |
YCurrent.setEnabled(int newval)
Changes the activation state of this input.
|
int |
YPwmOutput.setEnabled(int newval)
Stops or starts the PWM.
|
int |
YDisplay.setEnabled(int newval)
Changes the power state of the display.
|
int |
YServo.setEnabled(int newval)
Stops or starts the servo.
|
int |
YHubPort.setEnabled(int newval)
Changes the activation of the Yocto-hub port.
|
int |
YGenericSensor.setEnabled(int newval)
Changes the activation state of this input.
|
int |
YVoltage.setEnabled(int newval)
Changes the activation state of this input.
|
int |
YCellular.setEnableData(int newval)
Changes the condition for enabling IP data services (GPRS).
|
int |
YPwmOutput.setEnabledAtPowerOn(int newval)
Changes the state of the PWM at device power on.
|
int |
YServo.setEnabledAtPowerOn(int newval)
Configure the servo signal generator state at power up.
|
int |
YWeighScale.setExcitation(int newval)
Changes the current load cell bridge excitation method.
|
int |
YMultiCellWeighScale.setExcitation(int newval)
Changes the current load cell bridge excitation method.
|
int |
YMotor.setFailSafeTimeout(int newval)
Changes the delay in milliseconds allowed for the controller to run autonomously without
receiving any instruction from the control process.
|
int |
YPwmOutput.setFrequency(double newval)
Changes the PWM frequency.
|
int |
YBuzzer.setFrequency(double newval)
Changes the frequency of the signal sent to the buzzer.
|
int |
YMotor.setFrequency(double newval)
Changes the PWM frequency used to control the motor.
|
int |
YSensor.setHighestValue(double newval)
Changes the recorded maximal value observed.
|
int |
YWakeUpSchedule.setHours(int newval)
Changes the hours when a wake up must take place.
|
int |
YColorLed.setHslColor(int newval)
Changes the current color of the LED, using a color HSL.
|
int |
YNetwork.setHttpPort(int newval)
Changes the default HTML page returned by the hub.
|
int |
YDisplayLayer.setLayerPosition(int x,
int y,
int scrollTime)
Sets the position of the layer relative to the display upper left corner.
|
int |
YColorLedCluster.setLedType(int newval)
Changes the RGB LED type currently handled by the device.
|
int |
YCellular.setLockedOperator(String newval)
Changes the name of the cell operator to be used.
|
int |
YSensor.setLogFrequency(String newval)
Changes the datalogger recording frequency for this function.
|
int |
YFunction.setLogicalName(String newval)
Changes the logical name of the function.
|
int |
YSensor.setLowestValue(double newval)
Changes the recorded minimal value observed.
|
int |
YLed.setLuminosity(int newval)
Changes the current LED intensity (in per cent).
|
int |
YModule.setLuminosity(int newval)
Changes the luminosity of the module informative leds.
|
int |
YMultiSensController.setMaintenanceMode(int newval)
Changes the device mode to enable maintenance and to stop sensor polling.
|
int |
YStepperMotor.setMaxAccel(double newval)
Changes the maximal motor acceleration, measured in steps per second^2.
|
int |
YStepperMotor.setMaxSpeed(double newval)
Changes the maximal motor speed, measured in steps per second.
|
int |
YWatchdog.setMaxTimeOnStateA(long newval)
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
|
int |
YRelay.setMaxTimeOnStateA(long newval)
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
|
int |
YWatchdog.setMaxTimeOnStateB(long newval)
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
|
int |
YRelay.setMaxTimeOnStateB(long newval)
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
|
int |
YLightSensor.setMeasureType(int newval)
Changes the light sensor type used in the device.
|
int |
YWakeUpSchedule.setMinutesA(int newval)
Changes the minutes in the 00-29 interval when a wake up must take place.
|
int |
YWakeUpSchedule.setMinutesB(int newval)
Changes the minutes in the 30-59 interval when a wake up must take place.
|
int |
YWakeUpSchedule.setMonthDays(int newval)
Changes the days of the month when a wake up must take place.
|
int |
YWakeUpSchedule.setMonths(int newval)
Changes the months when a wake up must take place.
|
int |
YAudioIn.setMute(int newval)
Changes the state of the mute function.
|
int |
YBluetoothLink.setMute(int newval)
Changes the state of the mute function.
|
int |
YAudioOut.setMute(int newval)
Changes the state of the mute function.
|
int |
YMultiAxisController.setNAxis(int newval)
Changes the number of synchronized controllers.
|
int |
YServo.setNeutral(int newval)
Changes the duration of the pulse corresponding to the neutral position of the servo.
|
int |
YWakeUpMonitor.setNextWakeUp(long newval)
Changes the days of the week when a wake up must take place.
|
int |
YMultiSensController.setNSensors(int newval)
Changes the number of sensors to poll.
|
int |
YNetwork.setNtpServer(String newval)
Changes the IP address of the NTP server to be used by the module.
|
int |
YDisplay.setOrientation(int newval)
Changes the display orientation.
|
int |
YWatchdog.setOutput(int newval)
Changes the output state of the watchdog, when used as a simple switch (single throw).
|
int |
YRelay.setOutput(int newval)
Changes the output state of the relays, when used as a simple switch (single throw).
|
int |
YDigitalIO.setOutputVoltage(int newval)
Changes the voltage source used to drive output bits.
|
int |
YStepperMotor.setOvercurrent(int newval)
Changes the overcurrent alert and emergency stop threshold, measured in mA.
|
int |
YMotor.setOverCurrentLimit(int newval)
Changes the current threshold (in mA) above which the controller automatically
switches to error state.
|
int |
YBluetoothLink.setPairingPin(String newval)
Changes the PIN code used by the module for bluetooth pairing.
|
int |
YMessageBox.setPduReceived(int newval)
Changes the value of the incoming SMS units counter.
|
int |
YMessageBox.setPduSent(int newval)
Changes the value of the outgoing SMS units counter.
|
int |
YPwmOutput.setPeriod(double newval)
Changes the PWM period in milliseconds.
|
int |
YCellular.setPin(String newval)
Changes the PIN code used by the module to access the SIM card.
|
int |
YCellular.setPingInterval(int newval)
Changes the automated connectivity check interval, in seconds.
|
int |
YDigitalIO.setPortDirection(int newval)
Changes the IO direction of all bits (i.e.
|
int |
YDigitalIO.setPortOpenDrain(int newval)
Changes the electrical interface for each bit of the port.
|
int |
YDigitalIO.setPortPolarity(int newval)
Changes the polarity of all the bits of the port: For each bit set to 0, the matching I/O works the regular,
intuitive way; for each bit set to 1, the I/O works in reverse mode.
|
int |
YDigitalIO.setPortState(int newval)
Changes the state of all digital IO port's channels at once,
the parameter is an integer with each bit representing a channel.
|
int |
YServo.setPosition(int newval)
Changes immediately the servo driving position.
|
int |
YServo.setPositionAtPowerOn(int newval)
Configure the servo position at device power up.
|
int |
YLed.setPower(int newval)
Changes the state of the LED.
|
int |
YDualPower.setPowerControl(int newval)
Changes the selected power source for module functions that require lots of current.
|
int |
YWakeUpMonitor.setPowerDuration(int newval)
Changes the maximal wake up time (seconds) before automatically going to sleep.
|
int |
YPwmPowerSource.setPowerMode(int newval)
Changes the PWM power source.
|
int |
YPowerSupply.setPowerOutput(int newval)
Changes the power supply output switch state.
|
int |
YBluetoothLink.setPreAmplifier(int newval)
Changes the audio pre-amplifier volume, in per cents.
|
int |
YProximity.setPresenceMinTime(int newval)
Changes the minimal detection duration before signalling a presence event.
|
int |
YNetwork.setPrimaryDNS(String newval)
Changes the IP address of the primary name server to be used by the module.
|
int |
YSerialPort.setProtocol(String newval)
Changes the type of protocol used over the serial line.
|
int |
YSpiPort.setProtocol(String newval)
Changes the type of protocol used over the serial line.
|
int |
YProximity.setProximityReportMode(int newval)
Changes the parameter type (sensor value, presence or pulse count) returned by the
get_currentValue function and callbacks.
|
int |
YStepperMotor.setPullinSpeed(double newval)
Changes the motor speed immediately reachable from stop state, measured in steps per second.
|
int |
YPwmOutput.setPulseDuration(double newval)
Changes the PWM pulse length, in milliseconds.
|
int |
YPwmInput.setPwmReportMode(int newval)
Changes the parameter type (frequency/duty cycle, pulse width, or edge count) returned by the
get_currentValue function and callbacks.
|
int |
YAltitude.setQnh(double newval)
Changes the barometric pressure adjusted to sea level used to compute
the altitude (QNH).
|
int |
YServo.setRange(int newval)
Changes the range of use of the servo, specified in per cents.
|
int |
YRangeFinder.setRangeFinderMode(int newval)
Changes the rangefinder running mode, allowing you to put priority on
precision, speed or maximum range.
|
int |
YDataLogger.setRecording(int newval)
Changes the activation state of the data logger to start/stop recording data.
|
int |
YBluetoothLink.setRemoteAddress(String newval)
Changes the MAC-48 address defining which remote device to connect to.
|
int |
YProximity.setRemovalMinTime(int newval)
Changes the minimal detection duration before signalling a removal event.
|
int |
YSensor.setReportFrequency(String newval)
Changes the timed value notification frequency for this function.
|
int |
YDaisyChain.setRequiredChildCount(int newval)
Changes the number of child nodes expected in normal conditions.
|
int |
YSensor.setResolution(double newval)
Changes the resolution of the measured physical values.
|
int |
YColorLed.setRgbColor(int newval)
Changes the current color of the LED, using an RGB color.
|
int |
YColorLed.setRgbColorAtPowerOn(int newval)
Changes the color that the LED will display by default when the module is turned on.
|
int |
YWatchdog.setRunning(int newval)
Changes the running state of the watchdog.
|
int |
YNetwork.setSecondaryDNS(String newval)
Changes the IP address of the secondary name server to be used by the module.
|
int |
YAnButton.setSensitivity(int newval)
Changes the sensibility for the input (between 1 and 1000) for triggering user callbacks.
|
int |
YTemperature.setSensorType(int newval)
Changes the temperature sensor type.
|
int |
YSerialPort.setSerialMode(String newval)
Changes the serial port communication parameters, with a string such as
"9600,8N1".
|
int |
YSpiPort.setShiftSampling(int newval)
Changes the SDI line sampling shift.
|
int |
YGenericSensor.setSignalBias(double newval)
Changes the electric signal bias for zero shift adjustment.
|
int |
YGenericSensor.setSignalRange(String newval)
Changes the electric signal range used by the sensor.
|
int |
YGenericSensor.setSignalSampling(int newval)
Changes the electric signal sampling method to use.
|
int |
YWakeUpMonitor.setSleepCountdown(int newval)
Changes the delay before the next sleep period.
|
int |
YSpiPort.setSpiMode(String newval)
Changes the SPI port communication parameters, with a string such as
"125000,0,msb".
|
int |
YSpiPort.setSsPolarity(int newval)
Changes the SS line polarity.
|
int |
YMotor.setStarterTime(int newval)
Changes the duration (in ms) during which the motor is driven at low frequency to help
it start up.
|
int |
YSerialPort.setStartupJob(String newval)
Changes the job to use when the device is powered on.
|
int |
YSpiPort.setStartupJob(String newval)
Changes the job to use when the device is powered on.
|
int |
YDisplay.setStartupSeq(String newval)
Changes the name of the sequence to play when the displayed is powered on.
|
int |
YWatchdog.setState(int newval)
Changes the state of the watchdog (A for the idle position, B for the active position).
|
int |
YRelay.setState(int newval)
Changes the state of the relays (A for the idle position, B for the active position).
|
int |
YWatchdog.setStateAtPowerOn(int newval)
Preset the state of the watchdog at device startup (A for the idle position,
B for the active position, UNCHANGED for no modification).
|
int |
YRelay.setStateAtPowerOn(int newval)
Preset the state of the relays at device startup (A for the idle position,
B for the active position, UNCHANGED for no modification).
|
int |
YStepperMotor.setStepping(int newval)
Changes the stepping mode used to drive the motor.
|
int |
YStepperMotor.setStepPos(double newval)
Changes the current logical motor position, measured in steps.
|
int |
YStepperMotor.setTCurrRun(int newval)
Changes the torque regulation current when the motor is running, measured in mA.
|
int |
YStepperMotor.setTCurrStop(int newval)
Changes the torque regulation current when the motor is stopped, measured in mA.
|
int |
YWeighScale.setTempAvgAdaptRatio(double newval)
Changes the averaged temperature update rate, in per mille.
|
int |
YMultiCellWeighScale.setTempAvgAdaptRatio(double newval)
Changes the averaged temperature update rate, in per mille.
|
int |
YWeighScale.setTempChgAdaptRatio(double newval)
Changes the temperature change update rate, in per mille.
|
int |
YMultiCellWeighScale.setTempChgAdaptRatio(double newval)
Changes the temperature change update rate, in per mille.
|
static void |
YAPI.SetThreadSpecificMode() |
int |
YRangeFinder.setTimeFrame(long newval)
Changes the time frame used to measure the distance and estimate the measure
reliability.
|
int |
YDataLogger.setTimeUTC(long newval)
Changes the current UTC time reference used for recorded data.
|
int |
YWatchdog.setTriggerDelay(long newval)
Changes the waiting delay before a reset is triggered by the watchdog, in milliseconds.
|
int |
YWatchdog.setTriggerDuration(long newval)
Changes the duration of resets caused by the watchdog, in milliseconds.
|
int |
YTemperature.setUnit(String newval)
Changes the measuring unit for the measured temperature.
|
int |
YRangeFinder.setUnit(String newval)
Changes the measuring unit for the measured range.
|
int |
YWeighScale.setUnit(String newval)
Changes the measuring unit for the weight.
|
int |
YHumidity.setUnit(String newval)
Changes the primary unit for measuring humidity.
|
int |
YGenericSensor.setUnit(String newval)
Changes the measuring unit for the measured value.
|
int |
YPwmInput.setUnit(String newval)
Changes the measuring unit for the measured quantity.
|
int |
YMultiCellWeighScale.setUnit(String newval)
Changes the measuring unit for the weight.
|
int |
YRealTimeClock.setUnixTime(long newval)
Changes the current time.
|
int |
YMultiSensController.setupAddress(int addr)
Configures the I2C address of the only sensor connected to the device.
|
int |
YWeighScale.setupSpan(double currWeight,
double maxWeight)
Configures the load cell span parameters (stored in the corresponding genericSensor)
so that the current signal corresponds to the specified reference weight.
|
int |
YMultiCellWeighScale.setupSpan(double currWeight,
double maxWeight)
Configures the load cells span parameters (stored in the corresponding genericSensors)
so that the current signal corresponds to the specified reference weight.
|
int |
YNetwork.setUserPassword(String newval)
Changes the password for the "user" user.
|
int |
YModule.setUserVar(int newval)
Stores a 32 bit value in the device RAM.
|
int |
YGps.setUtcOffset(int newval)
Changes the number of seconds between current time and UTC time (time zone).
|
int |
YRealTimeClock.setUtcOffset(int newval)
Changes the number of seconds between current time and UTC time (time zone).
|
int |
YGenericSensor.setValueRange(String newval)
Changes the physical value range measured by the sensor.
|
int |
YPowerOutput.setVoltage(int newval)
Changes the voltage on the power output provided by the
module.
|
int |
YVoltageOutput.setVoltageAtStartUp(double newval)
Changes the output voltage at device start up.
|
int |
YPowerSupply.setVoltageAtStartUp(double newval)
Changes the voltage set point at device start up.
|
int |
YSerialPort.setVoltageLevel(int newval)
Changes the voltage type used on the serial line.
|
int |
YSpiPort.setVoltageLevel(int newval)
Changes the voltage type used on the serial line.
|
int |
YPowerSupply.setVoltageSense(int newval)
Changes the voltage control point.
|
int |
YPowerSupply.setVoltageSetPoint(double newval)
Changes the voltage set point, in V.
|
int |
YAudioIn.setVolume(int newval)
Changes audio input gain, in per cents.
|
int |
YBluetoothLink.setVolume(int newval)
Changes the connected headset volume, in per cents.
|
int |
YAudioOut.setVolume(int newval)
Changes audio output volume, in per cents.
|
int |
YBuzzer.setVolume(int newval)
Changes the volume of the signal sent to the buzzer/speaker.
|
int |
YWakeUpSchedule.setWeekDays(int newval)
Changes the days of the week when a wake up must take place.
|
int |
YNetwork.setWwwWatchdogDelay(int newval)
Changes the allowed downtime of the WWW link (in seconds) before triggering an automated
reboot to try to recover Internet connectivity.
|
int |
YWeighScale.setZeroTracking(double newval)
Changes the zero tracking threshold value.
|
int |
YMultiCellWeighScale.setZeroTracking(double newval)
Changes the zero tracking threshold value.
|
int |
YOsControl.shutdown(int secBeforeShutDown)
Schedules an OS shutdown after a given number of seconds.
|
int |
YWakeUpMonitor.sleep(int secBeforeSleep)
Goes to sleep until the next wake up condition is met, the
RTC time must have been set before calling this function.
|
int |
YAPIContext.Sleep(long ms_duration)
Pauses the execution flow for a specified duration.
|
static int |
YAPI.Sleep(long ms_duration)
Pauses the execution flow for a specified duration.
|
int |
YWakeUpMonitor.sleepFor(int secUntilWakeUp,
int secBeforeSleep)
Goes to sleep for a specific duration or until the next wake up condition is met, the
RTC time must have been set before calling this function.
|
int |
YWakeUpMonitor.sleepUntil(int wakeUpTime,
int secBeforeSleep)
Go to sleep until a specific date is reached or until the next wake up condition is met, the
RTC time must have been set before calling this function.
|
ArrayList<YSnoopingRecord> |
YSerialPort.snoopMessages(int maxWait)
Retrieves messages (both direction) in the serial port buffer, starting at current position.
|
int |
YWireless.softAPNetwork(String ssid,
String securityKey)
Changes the configuration of the wireless lan interface to create a new wireless
network by emulating a WiFi access point (Soft AP).
|
int |
YRefFrame.start3DCalibration()
Initiates the sensors tridimensional calibration process.
|
int |
YColorLed.startBlinkSeq()
Starts the preprogrammed blinking sequence.
|
int |
YColorLedCluster.startBlinkSeq(int seqIndex)
Starts a sequence execution: every LED linked to that sequence starts to
run it in a loop.
|
int |
YSensor.startDataLogger()
Starts the data logger on the device.
|
int |
YBuzzer.startPlaySeq()
Starts the preprogrammed playing sequence.
|
int |
YWireless.startWlanScan()
Triggers a scan of the wireless frequency and builds the list of available networks.
|
int |
YColorLed.stopBlinkSeq()
Stops the preprogrammed blinking sequence.
|
int |
YColorLedCluster.stopBlinkSeq(int seqIndex)
Stops a sequence execution.
|
int |
YSensor.stopDataLogger()
Stops the datalogger on the device.
|
int |
YBuzzer.stopPlaySeq()
Stops the preprogrammed playing sequence and sets the frequency to zero.
|
int |
YDisplay.stopSequence()
Stops immediately any ongoing sequence replay.
|
int |
YDisplay.swapLayerContent(int layerIdA,
int layerIdB)
Swaps the whole content of two layers.
|
int |
YWeighScale.tare()
Adapts the load cell signal bias (stored in the corresponding genericSensor)
so that the current signal corresponds to a zero weight.
|
int |
YMultiCellWeighScale.tare()
Adapts the load cell signal bias (stored in the corresponding genericSensor)
so that the current signal corresponds to a zero weight.
|
int |
YAPIContext.TestHub(String url,
int mstimeout)
Test if the hub is reachable.
|
static int |
YAPI.TestHub(String url,
int mstimeout)
Test if the hub is reachable.
|
int |
YDigitalIO.toggle_bitState(int bitno)
Reverts a single bit (i.e.
|
int |
YWatchdog.toggle()
Switch the relay to the opposite state.
|
int |
YRelay.toggle()
Switch the relay to the opposite state.
|
int |
YCarbonDioxide.triggerBaselineCalibration()
Triggers a baseline calibration at standard CO2 ambiant level (400ppm).
|
int |
YNetwork.triggerCallback()
Trigger an HTTP callback quickly.
|
int |
YModule.triggerConfigChangeCallback()
Triggers a configuration change callback, to check if they are supported or not.
|
int |
YModule.triggerFirmwareUpdate(int secBeforeReboot)
Schedules a module reboot into special firmware update mode.
|
int |
YAPIContext.TriggerHubDiscovery()
Force a hub discovery, if a callback as been registered with yRegisterHubDiscoveryCallback it
will be called for each net work hub that will respond to the discovery.
|
static int |
YAPI.TriggerHubDiscovery()
Force a hub discovery, if a callback as been registered with yRegisterHubDiscoveryCallback it
will be called for each net work hub that will respond to the discovery.
|
int |
YRangeFinder.triggerOffsetCalibration(double targetDist)
Triggers the hardware offset calibration of the distance sensor.
|
int |
YPwmOutput.triggerPulsesByDuration(double ms_target,
int n_pulses)
Trigger a given number of pulses of specified duration, at current frequency.
|
int |
YPwmOutput.triggerPulsesByDutyCycle(double target,
int n_pulses)
Trigger a given number of pulses of specified duration, at current frequency.
|
int |
YPwmOutput.triggerPulsesByFrequency(double target,
int n_pulses)
Trigger a given number of pulses at the specified frequency, using current duty cycle.
|
int |
YRangeFinder.triggerSpadCalibration()
Triggers the photon detector hardware calibration.
|
int |
YRangeFinder.triggerTemperatureCalibration()
Triggers a sensor calibration according to the current ambient temperature.
|
int |
YRangeFinder.triggerXTalkCalibration(double targetDist)
Triggers the hardware cross-talk calibration of the distance sensor.
|
int |
YCarbonDioxide.triggerZeroCalibration()
Triggers a zero calibration of the sensor on carbon dioxide-free air.
|
int |
YCarbonDioxide.triggetBaselineCalibration() |
int |
YCarbonDioxide.triggetZeroCalibration() |
int |
YDisplayLayer.unhide()
Shows the layer.
|
int |
YColorLedCluster.unlinkLedFromBlinkSeq(int ledIndex,
int count)
Unlinks adjacent LEDs from a sequence.
|
int |
YFunction.unmuteValueCallbacks()
Re-enables the propagation of every new advertised value to the parent hub.
|
int |
YAPIContext.UpdateDeviceList()
Triggers a (re)detection of connected Yoctopuce modules.
|
static int |
YAPI.UpdateDeviceList()
Triggers a (re)detection of connected Yoctopuce modules.
|
YFirmwareUpdate |
YModule.updateFirmware(String path)
Prepares a firmware update of the module.
|
YFirmwareUpdate |
YModule.updateFirmwareEx(String path,
boolean force)
Prepares a firmware update of the module.
|
int |
YFiles.upload(String pathname,
byte[] content)
Uploads a file to the filesystem, to the specified full path name.
|
int |
YDisplay.upload(String pathname,
byte[] content)
Uploads an arbitrary file (for instance a GIF file) to the display, to the
specified full path name.
|
int |
YSerialPort.uploadJob(String jobfile,
String jsonDef)
Saves the job definition string (JSON data) into a job file.
|
int |
YSpiPort.uploadJob(String jobfile,
String jsonDef)
Saves the job definition string (JSON data) into a job file.
|
int |
YNetwork.useDHCP(String fallbackIpAddr,
int fallbackSubnetMaskLen,
String fallbackRouter)
Changes the configuration of the network interface to enable the use of an
IP address received from a DHCP server.
|
int |
YNetwork.useDHCPauto()
Changes the configuration of the network interface to enable the use of an
IP address received from a DHCP server.
|
int |
YNetwork.useStaticIP(String ipAddress,
int subnetMaskLen,
String router)
Changes the configuration of the network interface to use a static IP address.
|
int |
YVoltageOutput.voltageMove(double V_target,
int ms_duration)
Performs a smooth transition of output voltage.
|
int |
YPowerSupply.voltageMove(double V_target,
int ms_duration)
Performs a smooth transition of output voltage.
|
int |
YBuzzer.volumeMove(int volume,
int duration)
Makes the buzzer volume change over a period of time, frequency stays untouched.
|
int |
YWakeUpMonitor.wakeUp()
Forces a wake up.
|
int |
YSerialPort.writeArray(ArrayList<Integer> byteList)
Sends a byte sequence (provided as a list of bytes) to the serial port.
|
int |
YSpiPort.writeArray(ArrayList<Integer> byteList)
Sends a byte sequence (provided as a list of bytes) to the serial port.
|
int |
YSerialPort.writeBin(byte[] buff)
Sends a binary buffer to the serial port, as is.
|
int |
YSpiPort.writeBin(byte[] buff)
Sends a binary buffer to the serial port, as is.
|
int |
YSerialPort.writeByte(int code)
Sends a single byte to the serial port.
|
int |
YSpiPort.writeByte(int code)
Sends a single byte to the serial port.
|
int |
YSerialPort.writeHex(String hexString)
Sends a byte sequence (provided as a hexadecimal string) to the serial port.
|
int |
YSpiPort.writeHex(String hexString)
Sends a byte sequence (provided as a hexadecimal string) to the serial port.
|
int |
YSerialPort.writeLine(String text)
Sends an ASCII string to the serial port, followed by a line break (CR LF).
|
int |
YSpiPort.writeLine(String text)
Sends an ASCII string to the serial port, followed by a line break (CR LF).
|
int |
YSerialPort.writeMODBUS(String hexString)
Sends a MODBUS message (provided as a hexadecimal string) to the serial port.
|
int |
YSerialPort.writeStr(String text)
Sends an ASCII string to the serial port, as is.
|
int |
YSpiPort.writeStr(String text)
Sends an ASCII string to the serial port, as is.
|
int |
YGenericSensor.zeroAdjust()
Adjusts the signal bias so that the current signal value is need
precisely as zero.
|
Constructor and Description |
---|
YFileRecord(String json_str) |
Copyright © 2019. All rights reserved.