Modifier and Type | Method and Description |
---|---|
protected int |
YAPI._AddNewHub(String url,
boolean reportConnnectionLost,
InputStream request,
OutputStream response) |
protected org.json.JSONObject |
YFunction._devRequest(String extra) |
protected byte[] |
YFunction._download(String url) |
String |
YSensor._encodeCalibrationPoints(ArrayList<Double> rawValues,
ArrayList<Double> refValues) |
protected YDevice |
YModule._getDev() |
int |
YAPI._HandleEvents() |
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 void |
YFunction._parse(org.json.JSONObject json,
long msValidity) |
protected int |
YDataSet._parse(String json_str) |
int |
YAPI._PreregisterHub(String url) |
int |
YAPI._RegisterHub(String url) |
int |
YAPI._RegisterHub(String url,
InputStream request,
OutputStream response) |
protected int |
YFunction._setAttr(String attr,
String newval) |
int |
YAPI._Sleep(long ms_duration) |
protected void |
YFunction._throw(int error,
String message) |
int |
YAPI._TriggerHubDiscovery() |
int |
YAPI._UpdateDeviceList() |
protected int |
YFunction._upload(String path,
byte[] content) |
protected int |
YFunction._upload(String pathname,
String content) |
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 |
YMotor.breakingForceMove(double targetPower,
int delay)
Changes progressively the breaking 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 |
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 |
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 |
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.
|
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 moteur for a specific duration.
|
int |
YPwmOutput.dutyCycleMove(double target,
int ms_duration)
Performs a smooth change of the pulse duration toward a given value.
|
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.
|
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()
Reinitializes the filesystem to its clean, unfragmented, empty state.
|
int |
YModule.functionCount() |
String |
YModule.functionId(int functionIndex) |
String |
YModule.functionName(int functionIndex) |
String |
YModule.functionValue(int functionIndex) |
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 the current value of the function (no more than 6 characters).
|
int |
YAnButton.get_analogCalibration()
Tells if a calibration process is currently ongoing.
|
int |
YWatchdog.get_autoStart()
Returns the watchdog runing state at module power on.
|
int |
YDataLogger.get_autoStart()
Returns the default activation state of the data logger on power up.
|
double |
YDataStream.get_averageValue()
Returns the average of all measures observed within this stream.
|
int |
YCompass.get_axis() |
int |
YTilt.get_axis() |
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.
|
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 from the I/O port (0 means the bit is an input, 1 an output).
|
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 of the I/O port.
|
int |
YLed.get_blinking()
Returns the current led signaling mode.
|
double |
YMotor.get_breakingForce()
Returns the breaking 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() |
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_callbackMaxDelay()
Returns the maximum waiting time between two callback notifications, in seconds.
|
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 callback notifications, in seconds.
|
String |
YNetwork.get_callbackUrl()
Returns the callback URL to notify of significant state changes.
|
int |
YWireless.get_channel()
Returns the 802.11 channel currently used, or 0 when the selected network has not been found.
|
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 |
YMotor.get_command() |
String |
YDisplay.get_command() |
String |
YDigitalIO.get_command() |
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.
|
double |
YSensor.get_currentRawValue()
Returns the uncalibrated, unrounded raw value returned by the sensor.
|
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 |
YSensor.get_currentValue()
Returns the current value of the measure.
|
double |
YMotor.get_cutOffVoltage()
Returns the threshold voltage under which the controller will automatically switch to error state
and prevent further current draw.
|
double |
YDataStream.get_data(int row,
int col)
Returns a single measure from the data stream, specified by its
row and column index.
|
ArrayList<ArrayList<Double>> |
YDataStream.get_dataRows()
Returns the whole data set contained in the stream, as a bidimensional
table of numbers.
|
ArrayList<YDataSet> |
YDataLogger.get_dataSets()
Returns a list of YDataSet objects that can be used to retrieve
all measures stored by the data logger.
|
int |
YDataLogger.get_dataStreams(ArrayList<YDataStream> v)
Builds a list of all data streams hold by the data logger (legacy method).
|
String |
YRealTimeClock.get_dateTime()
Returns the current time in the form "YYYY/MM/DD hh:mm:ss"
|
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 |
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).
|
int |
YDisplay.get_displayHeight()
Returns the display height, in pixels.
|
int |
YDisplayLayer.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 |
YDisplay.get_displayType()
Returns the display type: monochrome, gray levels or full color.
|
int |
YDisplay.get_displayWidth()
Returns the display width, in pixels.
|
int |
YDisplayLayer.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%.
|
int |
YDataStream.get_duration()
Returns the approximate duration of this stream, in seconds.
|
double |
YPwmOutput.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 |
YPwmOutput.get_enabled()
Returns the state of the PWMs.
|
int |
YHubPort.get_enabled()
Returns true if the Yocto-hub port is powered, false otherwise.
|
int |
YServo.get_enabled()
Returns the state of the servos.
|
int |
YDisplay.get_enabled()
Returns true if the screen is powered, false otherwise.
|
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 |
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.
|
int |
YPwmOutput.get_frequency()
Returns the PWM frequency in Hz.
|
int |
YMotor.get_frequency()
Returns the PWM frequency used to control the motor.
|
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.
|
String |
YDataSet.get_hardwareId()
Returns the unique hardware identifier of the function who performed the measures,
in the form SERIAL.FUNCTIONID.
|
String |
YFunction.get_hardwareId()
Returns the unique hardware identifier of the function 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() |
byte[] |
YModule.get_icon2d()
Returns the icon of the module.
|
String |
YNetwork.get_ipAddress()
Returns the IP address currently in use by the device.
|
String |
YNetwork.get_ipConfig() |
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.
|
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 transitionned 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 transitionned from closed to open).
|
int |
YDisplay.get_layerCount()
Returns the number of available layers to draw on.
|
int |
YDisplay.get_layerHeight()
Returns the height of the layers to draw on, in pixels.
|
int |
YDisplayLayer.get_layerHeight()
Returns the height of the layers to draw on, in pixels.
|
int |
YDisplay.get_layerWidth()
Returns the width of the layers to draw on, in pixels.
|
int |
YDisplayLayer.get_layerWidth()
Returns the width of the layers to draw on, in pixels.
|
int |
YWireless.get_linkQuality()
Returns the link quality, expressed in percent.
|
ArrayList<YFileRecord> |
YFiles.get_list(String pattern)
Returns a list of YFileRecord objects that describe files currently loaded
in the filesystem.
|
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.
|
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.
|
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.
|
ArrayList<YMeasure> |
YDataSet.get_measures()
Returns all measured values currently available for this DataSet,
as a list of YMeasure objects.
|
String |
YWireless.get_message()
Returns the latest status message from the wireless interface.
|
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 intervalof 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 |
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 |
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 occurence
|
long |
YWakeUpMonitor.get_nextWakeUp()
Returns the next scheduled wake up date/time (UNIX format)
|
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 |
YMotor.get_overCurrentLimit()
Returns the current threshold (in mA) above which the controller will automatically
switch to error state.
|
double |
YPwmOutput.get_period()
Returns the PWM period in milliseconds.
|
int |
YModule.get_persistentSettings()
Returns the current state of persistent module settings.
|
double |
YGyro.get_pitch()
Returns the estimated pitch angle, based on the integration of
gyroscopic measures combined with acceleration and
magnetic field measurements.
|
int |
YNetwork.get_poeCurrent()
Returns the current consumed by the module from Power-over-Ethernet (PoE), in milli-amps.
|
int |
YDigitalIO.get_portDirection()
Returns the IO direction of all bits of the port: 0 makes a bit an input, 1 makes it an output.
|
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 implemented in the I/O port.
|
int |
YHubPort.get_portState()
Returns the current state of the Yocto-hub port.
|
int |
YDigitalIO.get_portState()
Returns the digital IO port state: bit 0 represents input 0, and so on.
|
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 |
YDualPower.get_powerState()
Returns the current power source for module functions that require lots of current.
|
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.
|
long |
YAnButton.get_pulseCounter()
Returns the pulse counter value
|
double |
YPwmOutput.get_pulseDuration()
Returns the PWM pulse length in milliseconds.
|
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 |
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)
|
String |
YPwmOutput.get_pwmTransition() |
double |
YAltitude.get_qnh()
Returns the barometric pressure adjusted to sea level used to compute
the altitude (QNH).
|
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.
|
int |
YServo.get_range()
Returns the current range of use of the servo.
|
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(long startTime,
long 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.
|
String |
YSensor.get_reportFrequency()
Returns the timed value notification frequency, or "OFF" if timed
value notifications are disabled for this function.
|
double |
YSensor.get_resolution()
Returns the resolution of the measured values.
|
int |
YColorLed.get_rgbColor()
Returns the current RGB color of the led.
|
int |
YColorLed.get_rgbColorAtPowerOn()
Returns the configured color to be displayed when the module is turned on.
|
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.
|
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 |
YTemperature.get_sensorType()
Returns the temperature sensor type.
|
String |
YModule.get_serialNumber()
Returns the serial number of the module, as set by the factory.
|
int |
YOsControl.get_shutdownCountdown()
Returns the remaining number of seconds before the OS shutdown, or zero when no
shutdown has been scheduled.
|
String |
YGenericSensor.get_signalRange()
Returns the electric signal range used by the sensor.
|
String |
YGenericSensor.get_signalUnit()
Returns the measuring unit of the electrical signal used by the sensor.
|
double |
YGenericSensor.get_signalValue()
Returns the measured value of the electrical signal used by the sensor.
|
int |
YWakeUpMonitor.get_sleepCountdown()
Returns the delay before the next sleep period.
|
String |
YWireless.get_ssid()
Returns the wireless network name (SSID).
|
int |
YMotor.get_starterTime()
Returns the duration (in ms) during which the motor is driven at low frequency to help
it start up.
|
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).
|
String |
YNetwork.get_subnetMask()
Returns the subnet mask currently used by the device.
|
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.
|
String |
YSensor.get_unit()
Returns the measuring unit for the measure.
|
String |
YDataSet.get_unit()
Returns the measuring unit for the measured value.
|
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.
|
int |
YModule.get_usbBandwidth()
Returns the number of USB interfaces used by the module.
|
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 |
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.
|
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 |
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 |
YMagnetometer.get_xValue()
Returns the X component of the magnetic field, as a floating point number.
|
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_yValue()
Returns the Y 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_zValue()
Returns the Z component of the magnetic field, as a floating point number.
|
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.
|
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 the current value of the function (no more than 6 characters).
|
int |
YAnButton.getAnalogCalibration()
Tells if a calibration process is currently ongoing.
|
int |
YWatchdog.getAutoStart()
Returns the watchdog runing state at module power on.
|
int |
YDataLogger.getAutoStart()
Returns the default activation state of the data logger on power up.
|
int |
YCompass.getAxis() |
int |
YTilt.getAxis() |
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.
|
double |
YRefFrame.getBearing()
Returns the reference bearing used by the compass.
|
int |
YLed.getBlinking()
Returns the current led signaling mode.
|
double |
YMotor.getBreakingForce()
Returns the breaking 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 |
YRefFrame.getCalibrationParam() |
String |
YSensor.getCalibrationParam() |
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.getCallbackMaxDelay()
Returns the maximum waiting time between two callback notifications, in seconds.
|
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 callback notifications, in seconds.
|
String |
YNetwork.getCallbackUrl()
Returns the callback URL to notify of significant state changes.
|
int |
YWireless.getChannel()
Returns the 802.11 channel currently used, or 0 when the selected network has not been found.
|
int |
YDataLogger.getClearHistory() |
String |
YMotor.getCommand() |
String |
YDisplay.getCommand() |
String |
YDigitalIO.getCommand() |
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 |
YSensor.getCurrentRawValue()
Returns the uncalibrated, unrounded raw value returned by the sensor.
|
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 |
YSensor.getCurrentValue()
Returns the current value of the measure.
|
double |
YMotor.getCutOffVoltage()
Returns the threshold voltage under which the controller will automatically switch to error state
and prevent further current draw.
|
org.json.JSONTokener |
YDataLogger.getData(Integer runIdx,
Integer timeIdx)
Internal function to retrieve datalogger memory
|
int |
YDataLogger.getDataStreams(ArrayList<YDataStream> v) |
String |
YRealTimeClock.getDateTime()
Returns the current time in the form "YYYY/MM/DD hh:mm:ss"
|
YWatchdog.YDelayedPulse |
YWatchdog.getDelayedPulseTimer() |
YRelay.YDelayedPulse |
YRelay.getDelayedPulseTimer() |
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).
|
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 |
YPwmOutput.getDutyCycleAtPowerOn()
Returns the PWMs duty cycle at device power on as a floating point number between 0 and 100
|
int |
YPwmOutput.getEnabled()
Returns the state of the PWMs.
|
int |
YHubPort.getEnabled()
Returns true if the Yocto-hub port is powered, false otherwise.
|
int |
YServo.getEnabled()
Returns the state of the servos.
|
int |
YDisplay.getEnabled()
Returns true if the screen is powered, false otherwise.
|
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 |
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.
|
int |
YPwmOutput.getFrequency()
Returns the PWM frequency in Hz.
|
int |
YMotor.getFrequency()
Returns the PWM frequency used to control the motor.
|
String |
YFunction.getFriendlyName() |
String |
YFunction.getFunctionId() |
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.
|
YColorLed.YMove |
YColorLed.getHslMove() |
String |
YNetwork.getIpAddress()
Returns the IP address currently in use by the device.
|
String |
YNetwork.getIpConfig() |
int |
YAnButton.getIsPressed()
Returns true if the input (considered as binary) is active (closed contact), and false otherwise.
|
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 transitionned 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 transitionned from closed to open).
|
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.
|
int |
YWireless.getLinkQuality()
Returns the link quality, expressed in percent.
|
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.
|
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.
|
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.
|
String |
YWireless.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 intervalof 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 |
YMotor.getMotorStatus()
Return the controller state.
|
int |
YRefFrame.getMountPos() |
YServo.YMove |
YServo.getMove() |
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 occurence
|
long |
YWakeUpMonitor.getNextWakeUp()
Returns the next scheduled wake up date/time (UNIX format)
|
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 |
YMotor.getOverCurrentLimit()
Returns the current threshold (in mA) above which the controller will automatically
switch to error state.
|
double |
YPwmOutput.getPeriod()
Returns the PWM period in milliseconds.
|
int |
YModule.getPersistentSettings()
Returns the current state of persistent module settings.
|
int |
YNetwork.getPoeCurrent()
Returns the current consumed by the module from Power-over-Ethernet (PoE), in milli-amps.
|
int |
YDigitalIO.getPortDirection()
Returns the IO direction of all bits of the port: 0 makes a bit an input, 1 makes it an output.
|
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 implemented in the I/O port.
|
int |
YHubPort.getPortState()
Returns the current state of the Yocto-hub port.
|
int |
YDigitalIO.getPortState()
Returns the digital IO port state: bit 0 represents input 0, and so on.
|
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 |
YDualPower.getPowerState()
Returns the current power source for module functions that require lots of current.
|
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.
|
long |
YAnButton.getPulseCounter()
Returns the pulse counter value
|
double |
YPwmOutput.getPulseDuration()
Returns the PWM pulse length in milliseconds.
|
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 |
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)
|
String |
YPwmOutput.getPwmTransition() |
double |
YAltitude.getQnh()
Returns the barometric pressure adjusted to sea level used to compute
the altitude (QNH).
|
int |
YServo.getRange()
Returns the current range of use of the servo.
|
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.
|
String |
YSensor.getReportFrequency()
Returns the timed value notification frequency, or "OFF" if timed
value notifications are disabled for this function.
|
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.
|
YColorLed.YMove |
YColorLed.getRgbMove() |
String |
YNetwork.getRouter()
Returns the IP address of the router on the device subnet (default gateway).
|
long |
YWakeUpMonitor.getRtcTime() |
int |
YWatchdog.getRunning()
Returns the watchdog running state.
|
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 |
YTemperature.getSensorType()
Returns the temperature sensor type.
|
String |
YModule.getSerialNumber()
Returns the serial number of the module, as set by the factory.
|
int |
YOsControl.getShutdownCountdown()
Returns the remaining number of seconds before the OS shutdown, or zero when no
shutdown has been scheduled.
|
String |
YGenericSensor.getSignalRange()
Returns the electric signal range used by the sensor.
|
String |
YGenericSensor.getSignalUnit()
Returns the measuring unit of the electrical signal used by the sensor.
|
double |
YGenericSensor.getSignalValue()
Returns the measured value of the electrical signal used by the sensor.
|
int |
YWakeUpMonitor.getSleepCountdown()
Returns the delay before the next sleep period.
|
String |
YWireless.getSsid()
Returns the wireless network name (SSID).
|
int |
YMotor.getStarterTime()
Returns the duration (in ms) during which the motor is driven at low frequency to help
it start up.
|
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).
|
String |
YNetwork.getSubnetMask()
Returns the subnet mask currently used by the device.
|
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.
|
String |
YSensor.getUnit()
Returns the measuring unit for the measure.
|
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 |
YModule.getUsbBandwidth()
Returns the number of USB interfaces used by the module.
|
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 |
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.
|
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.
|
String |
YWireless.getWlanConfig() |
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 |
YMagnetometer.getXValue()
Returns the X component of the magnetic field, as a floating point number.
|
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.getYValue()
Returns the Y 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.getZValue()
Returns the Z component of the magnetic field, as a floating point number.
|
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.
|
static int |
YAPI.HandleEvents()
Maintains the device-to-library communication channel.
|
int |
YDisplayLayer.hide()
Hides the layer.
|
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.
|
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 |
YFunction.load(long msValidity)
Preloads the function cache with a specified validity duration.
|
int |
YSensor.loadCalibrationPoints(ArrayList<Double> rawValues,
ArrayList<Double> refValues)
Retrieves error correction data points previously entered using the method
calibrateFromPoints.
|
int |
YDataSet.loadMore()
Loads the the next block of measures from the dataLogger, and updates
the progress indicator.
|
int |
YDataStream.loadStream() |
int |
YOldDataStream.loadStream() |
int |
YRefFrame.more3DCalibration()
Continues the sensors tridimensional calibration process previously
initiated using method start3DCalibration.
|
int |
YServo.move(int target,
int ms_duration)
Performs a smooth move at constant speed toward a given position.
|
int |
YDisplayLayer.moveTo(int x,
int y)
Moves the drawing pointer of this layer to the specified position.
|
int |
YDisplay.newSequence()
Starts to record all display commands into a sequence, for later replay.
|
ArrayList<YDataSet> |
YDataLogger.parse_dataSets(byte[] json) |
int |
YDataStream.parse(byte[] sdata) |
int |
YDisplay.pauseSequence(int delay_ms)
Waits for a specified delay (in milliseconds) before playing next
commands in current sequence.
|
String |
YNetwork.ping(String host)
Pings str_host to test the network connectivity.
|
int |
YDisplay.playSequence(String sequenceName)
Replays a display sequence previously recorded using
newSequence() and saveSequence().
|
static int |
YAPI.PreregisterHub(String url)
Fault-tolerant alternative to RegisterHub().
|
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 |
YPwmOutput.pulseDurationMove(double ms_target,
int ms_duration)
Performs a smooth transistion of the pulse duration toward a given value.
|
int |
YModule.reboot(int secBeforeReboot)
Schedules a simple module reboot after the given number of seconds.
|
int |
YDevice.refresh() |
int |
YGyro.registerAnglesCallback(YGyro.YAnglesCallback callback)
Registers a callback function that will be invoked each time that the estimated
device orientation has changed.
|
static int |
YAPI.RegisterHub(String url)
Setup the Yoctopuce library to use modules connected on a given machine.
|
static int |
YAPI.RegisterHub(String url,
InputStream request,
OutputStream response) |
int |
YGyro.registerQuaternionCallback(YGyro.YQuatCallback callback)
Registers a callback function that will be invoked each time that the estimated
device orientation has changed.
|
int |
YFiles.remove(String pathname)
Deletes a file, given by its full path name, from the filesystem.
|
String |
YDevice.requestAPI() |
int |
YPower.reset()
Resets the energy counter.
|
int |
YDisplayLayer.reset()
Reverts the layer to its initial state (fully transparent, default settings).
|
int |
YDisplay.resetAll()
Clears the display screen and resets all display layers to their default state.
|
int |
YAnButton.resetCounter()
Returns the pulse counter value as well as his timer
|
void |
YDisplay.resetHiddenLayerFlags() |
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 |
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 |
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 text drawing and 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.
|
byte[] |
YFiles.sendCommand(String command) |
int |
YDisplay.sendCommand(String cmd) |
int |
YNetwork.set_adminPassword(String newval)
Changes the password for the "admin" user.
|
int |
YAnButton.set_analogCalibration(int newval)
Starts or stops the calibration process.
|
int |
YWatchdog.set_autoStart(int newval)
Changes the watchdog runningsttae at module power on.
|
int |
YDataLogger.set_autoStart(int newval)
Changes the default activation state of the data logger on power up.
|
int |
YModule.set_beacon(int newval)
Turns on or off the module localization beacon.
|
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 from the I/O port.
|
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 of the I/O port.
|
int |
YLed.set_blinking(int newval)
Changes the current led signaling mode.
|
int |
YMotor.set_breakingForce(double newval)
Changes immediately the breaking force applied to the motor (in per cents).
|
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_callbackMaxDelay(int newval)
Changes the maximum waiting time between two callback notifications, in seconds.
|
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 callback notifications, in seconds.
|
int |
YNetwork.set_callbackUrl(String newval)
Changes the callback URL to notify significant state changes.
|
int |
YDataLogger.set_clearHistory(int newval) |
int |
YMotor.set_command(String newval) |
int |
YDisplay.set_command(String newval) |
int |
YDigitalIO.set_command(String newval) |
int |
YAltitude.set_currentValue(double newval)
Changes the current estimated altitude.
|
int |
YLightSensor.set_currentValue(double newval) |
int |
YMotor.set_cutOffVoltage(double newval)
Changes the threshold voltage under which the controller will automatically switch to error state
and prevent further current draw.
|
int |
YRelay.set_delayedPulseTimer(YRelay.YDelayedPulse newval) |
int |
YWatchdog.set_delayedPulseTimer(YWatchdog.YDelayedPulse newval) |
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 |
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 |
YPwmOutput.set_enabled(int newval)
Stops or starts the PWM.
|
int |
YHubPort.set_enabled(int newval)
Changes the activation of the Yocto-hub port.
|
int |
YServo.set_enabled(int newval)
Stops or starts the servo.
|
int |
YDisplay.set_enabled(int newval)
Changes the power state of the display.
|
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 |
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(int newval)
Changes the PWM frequency.
|
int |
YMotor.set_frequency(int newval)
Changes the PWM frequency used to control the motor.
|
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 |
YColorLed.set_hslMove(YColorLed.YMove newval) |
int |
YNetwork.set_ipConfig(String newval) |
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 |
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 |
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 |
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 |
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 |
YMotor.set_overCurrentLimit(int newval)
Changes tthe current threshold (in mA) above which the controller will automatically
switch to error state.
|
int |
YPwmOutput.set_period(double newval)
Changes the PWM period.
|
int |
YModule.set_persistentSettings(int newval) |
int |
YDigitalIO.set_portDirection(int newval)
Changes the IO direction of all bits of the port: 0 makes a bit an input, 1 makes it an output.
|
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: 0 makes a bit an input, 1 makes it an output.
|
int |
YDigitalIO.set_portState(int newval)
Changes the digital IO port state: bit 0 represents input 0, and so on.
|
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 |
YNetwork.set_primaryDNS(String newval)
Changes the IP address of the primary name server to be used by the module.
|
int |
YAnButton.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 |
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 |
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 |
YSensor.set_reportFrequency(String newval)
Changes the timed value notification frequency for this function.
|
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 a RGB color.
|
int |
YColorLed.set_rgbColorAtPowerOn(int newval)
Changes the color that the led will display by default when the module is turned on.
|
int |
YColorLed.set_rgbMove(YColorLed.YMove newval) |
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)
Modify the temperature sensor type.
|
int |
YOsControl.set_shutdownCountdown(int newval) |
int |
YGenericSensor.set_signalRange(String newval)
Changes the electric signal range used by the sensor.
|
int |
YWakeUpMonitor.set_sleepCountdown(int newval)
Changes the delay before the next sleep period.
|
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 |
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 |
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 |
YGenericSensor.set_unit(String newval)
Changes the measuring unit for the measured value.
|
int |
YRealTimeClock.set_unixTime(long newval)
Changes the current time.
|
int |
YNetwork.set_userPassword(String newval)
Changes the password for the "user" user.
|
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 |
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 |
YNetwork.setAdminPassword(String newval)
Changes the password for the "admin" user.
|
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 |
YWatchdog.setAutoStart(int newval)
Changes the watchdog runningsttae at module power on.
|
int |
YDataLogger.setAutoStart(int newval)
Changes the default activation state of the data logger on power up.
|
int |
YModule.setBeacon(int newval)
Turns on or off the module localization beacon.
|
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.setBreakingForce(double newval)
Changes immediately the breaking force applied to the motor (in per cents).
|
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 |
YRefFrame.setCalibrationParam(String newval) |
int |
YSensor.setCalibrationParam(String newval) |
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.setCallbackMaxDelay(int newval)
Changes the maximum waiting time between two callback notifications, in seconds.
|
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 callback notifications, in seconds.
|
int |
YNetwork.setCallbackUrl(String newval)
Changes the callback URL to notify significant state changes.
|
int |
YDataLogger.setClearHistory(int newval) |
int |
YMotor.setCommand(String newval) |
int |
YDisplay.setCommand(String newval) |
int |
YDigitalIO.setCommand(String newval) |
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 behaviour used by the consoleOut function.
|
int |
YAltitude.setCurrentValue(double newval)
Changes the current estimated altitude.
|
int |
YLightSensor.setCurrentValue(double newval) |
int |
YMotor.setCutOffVoltage(double newval)
Changes the threshold voltage under which the controller will automatically switch to error state
and prevent further current draw.
|
int |
YRelay.setDelayedPulseTimer(YRelay.YDelayedPulse newval) |
int |
YWatchdog.setDelayedPulseTimer(YWatchdog.YDelayedPulse newval) |
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 |
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 |
YPwmOutput.setEnabled(int newval)
Stops or starts the PWM.
|
int |
YHubPort.setEnabled(int newval)
Changes the activation of the Yocto-hub port.
|
int |
YServo.setEnabled(int newval)
Stops or starts the servo.
|
int |
YDisplay.setEnabled(int newval)
Changes the power state of the display.
|
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 |
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(int newval)
Changes the PWM frequency.
|
int |
YMotor.setFrequency(int 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 |
YColorLed.setHslMove(YColorLed.YMove newval) |
int |
YNetwork.setIpConfig(String newval) |
int |
YDisplayLayer.setLayerPosition(int x,
int y,
int scrollTime)
Sets the position of the layer relative to the display upper left corner.
|
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 |
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 |
YPower.setMeter(double newval) |
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 |
YMotor.setMotorStatus(int newval) |
int |
YRefFrame.setMountPos(int newval) |
int |
YServo.setMove(YServo.YMove newval) |
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 |
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 |
YMotor.setOverCurrentLimit(int newval)
Changes tthe current threshold (in mA) above which the controller will automatically
switch to error state.
|
int |
YPwmOutput.setPeriod(double newval)
Changes the PWM period.
|
int |
YModule.setPersistentSettings(int newval) |
int |
YDigitalIO.setPortDirection(int newval)
Changes the IO direction of all bits of the port: 0 makes a bit an input, 1 makes it an output.
|
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: 0 makes a bit an input, 1 makes it an output.
|
int |
YDigitalIO.setPortState(int newval)
Changes the digital IO port state: bit 0 represents input 0, and so on.
|
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 |
YNetwork.setPrimaryDNS(String newval)
Changes the IP address of the primary name server to be used by the module.
|
int |
YAnButton.setPulseCounter(long newval) |
int |
YPwmOutput.setPulseDuration(double newval)
Changes the PWM pulse length, in milliseconds.
|
int |
YWatchdog.setPulseTimer(long newval) |
int |
YRelay.setPulseTimer(long newval) |
int |
YPwmOutput.setPwmTransition(String newval) |
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 |
YModule.setRebootCountdown(int newval) |
int |
YDataLogger.setRecording(int newval)
Changes the activation state of the data logger to start/stop recording data.
|
int |
YSensor.setReportFrequency(String newval)
Changes the timed value notification frequency for this function.
|
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 a RGB color.
|
int |
YColorLed.setRgbColorAtPowerOn(int newval)
Changes the color that the led will display by default when the module is turned on.
|
int |
YColorLed.setRgbMove(YColorLed.YMove newval) |
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)
Modify the temperature sensor type.
|
int |
YOsControl.setShutdownCountdown(int newval) |
int |
YGenericSensor.setSignalRange(String newval)
Changes the electric signal range used by the sensor.
|
int |
YWakeUpMonitor.setSleepCountdown(int newval)
Changes the delay before the next sleep period.
|
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 |
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).
|
static void |
YAPI.SetThreadSpecificMode() |
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 |
YGenericSensor.setUnit(String newval)
Changes the measuring unit for the measured value.
|
int |
YRealTimeClock.setUnixTime(long newval)
Changes the current time.
|
int |
YNetwork.setUserPassword(String newval)
Changes the password for the "user" user.
|
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 |
YWakeUpMonitor.setWakeUpState(int newval) |
int |
YWakeUpSchedule.setWeekDays(int newval)
Changes the days of the week when a wake up must take place.
|
int |
YWireless.setWlanConfig(String newval) |
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 |
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.
|
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.
|
int |
YRefFrame.start3DCalibration()
Initiates the sensors tridimensional calibration process.
|
int |
YDisplay.stopSequence()
Stops immediately any ongoing sequence replay.
|
int |
YDisplay.swapLayerContent(int layerIdA,
int layerIdB)
Swaps the whole content of two layers.
|
int |
YDigitalIO.toggle_bitState(int bitno)
Reverts a single bit of the I/O port.
|
int |
YModule.triggerFirmwareUpdate(int secBeforeReboot)
Schedules a module reboot into special firmware update mode.
|
int |
YAPI.TriggerHubDiscovery()
Force a hub discovery, if a callback as been registered with yRegisterDeviceRemovalCallback it
will be called for each net work hub that will respond to the discovery.
|
int |
YDisplayLayer.unhide()
Shows the layer.
|
static int |
YAPI.UpdateDeviceList()
Triggers a (re)detection of connected Yoctopuce modules.
|
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 |
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.useStaticIP(String ipAddress,
int subnetMaskLen,
String router)
Changes the configuration of the network interface to use a static IP address.
|
int |
YWakeUpMonitor.wakeUp()
Forces a wake up.
|
Constructor and Description |
---|
YDataSet(YFunction parent,
String json) |
YFileRecord(String json_str) |
YUSBHub(int idx) |
Copyright © 2014. All rights reserved.