- fade(int, int) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Smoothly changes the brightness of the screen to produce a fade-in or fade-out
effect.
- FAILSAFETIMEOUT_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YMotor
-
invalid failSafeTimeout value
- fetchPdu(int) - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
- FILE_NOT_FOUND - Static variable in class com.yoctopuce.YoctoAPI.YAPI
-
- fileExist(String) - Method in class com.yoctopuce.YoctoAPI.YFiles
-
Test if a file exist on the filesystem of the module.
- FILESCOUNT_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YFiles
-
invalid filesCount value
- FindAccelerometer(String) - Static method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Retrieves an accelerometer for a given identifier.
- FindAccelerometerInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Retrieves an accelerometer for a given identifier in a YAPI context.
- FindAltitude(String) - Static method in class com.yoctopuce.YoctoAPI.YAltitude
-
Retrieves an altimeter for a given identifier.
- FindAltitudeInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YAltitude
-
Retrieves an altimeter for a given identifier in a YAPI context.
- FindAnButton(String) - Static method in class com.yoctopuce.YoctoAPI.YAnButton
-
Retrieves an analog input for a given identifier.
- FindAnButtonInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YAnButton
-
Retrieves an analog input for a given identifier in a YAPI context.
- FindArithmeticSensor(String) - Static method in class com.yoctopuce.YoctoAPI.YArithmeticSensor
-
Retrieves an arithmetic sensor for a given identifier.
- FindArithmeticSensorInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YArithmeticSensor
-
Retrieves an arithmetic sensor for a given identifier in a YAPI context.
- FindAudioIn(String) - Static method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Retrieves an audio input for a given identifier.
- FindAudioInInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Retrieves an audio input for a given identifier in a YAPI context.
- FindAudioOut(String) - Static method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Retrieves an audio output for a given identifier.
- FindAudioOutInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Retrieves an audio output for a given identifier in a YAPI context.
- FindBluetoothLink(String) - Static method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Retrieves a cellular interface for a given identifier.
- FindBluetoothLinkInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Retrieves a cellular interface for a given identifier in a YAPI context.
- FindBuzzer(String) - Static method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Retrieves a buzzer for a given identifier.
- FindBuzzerInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Retrieves a buzzer for a given identifier in a YAPI context.
- FindCarbonDioxide(String) - Static method in class com.yoctopuce.YoctoAPI.YCarbonDioxide
-
Retrieves a CO2 sensor for a given identifier.
- FindCarbonDioxideInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YCarbonDioxide
-
Retrieves a CO2 sensor for a given identifier in a YAPI context.
- FindCellular(String) - Static method in class com.yoctopuce.YoctoAPI.YCellular
-
Retrieves a cellular interface for a given identifier.
- FindCellularInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YCellular
-
Retrieves a cellular interface for a given identifier in a YAPI context.
- FindColorLed(String) - Static method in class com.yoctopuce.YoctoAPI.YColorLed
-
Retrieves an RGB LED for a given identifier.
- FindColorLedCluster(String) - Static method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Retrieves a RGB LED cluster for a given identifier.
- FindColorLedClusterInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Retrieves a RGB LED cluster for a given identifier in a YAPI context.
- FindColorLedInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YColorLed
-
Retrieves an RGB LED for a given identifier in a YAPI context.
- FindCompass(String) - Static method in class com.yoctopuce.YoctoAPI.YCompass
-
Retrieves a compass for a given identifier.
- FindCompassInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YCompass
-
Retrieves a compass for a given identifier in a YAPI context.
- FindCurrent(String) - Static method in class com.yoctopuce.YoctoAPI.YCurrent
-
Retrieves a current sensor for a given identifier.
- FindCurrentInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YCurrent
-
Retrieves a current sensor for a given identifier in a YAPI context.
- FindCurrentLoopOutput(String) - Static method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Retrieves a 4-20mA output for a given identifier.
- FindCurrentLoopOutputInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Retrieves a 4-20mA output for a given identifier in a YAPI context.
- FindDaisyChain(String) - Static method in class com.yoctopuce.YoctoAPI.YDaisyChain
-
Retrieves a module chain for a given identifier.
- FindDaisyChainInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YDaisyChain
-
Retrieves a module chain for a given identifier in a YAPI context.
- FindDataLogger(String) - Static method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Retrieves a data logger for a given identifier.
- FindDataLoggerInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Retrieves a data logger for a given identifier in a YAPI context.
- FindDigitalIO(String) - Static method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Retrieves a digital IO port for a given identifier.
- FindDigitalIOInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Retrieves a digital IO port for a given identifier in a YAPI context.
- FindDisplay(String) - Static method in class com.yoctopuce.YoctoAPI.YDisplay
-
Retrieves a display for a given identifier.
- FindDisplayInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YDisplay
-
Retrieves a display for a given identifier in a YAPI context.
- FindDualPower(String) - Static method in class com.yoctopuce.YoctoAPI.YDualPower
-
Retrieves a dual power control for a given identifier.
- FindDualPowerInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YDualPower
-
Retrieves a dual power control for a given identifier in a YAPI context.
- FindFiles(String) - Static method in class com.yoctopuce.YoctoAPI.YFiles
-
Retrieves a filesystem for a given identifier.
- FindFilesInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YFiles
-
Retrieves a filesystem for a given identifier in a YAPI context.
- FindFunction(String) - Static method in class com.yoctopuce.YoctoAPI.YFunction
-
Retrieves a function for a given identifier.
- FindFunctionInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YFunction
-
Retrieves a function for a given identifier in a YAPI context.
- FindGenericSensor(String) - Static method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Retrieves a generic sensor for a given identifier.
- FindGenericSensorInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Retrieves a generic sensor for a given identifier in a YAPI context.
- FindGps(String) - Static method in class com.yoctopuce.YoctoAPI.YGps
-
Retrieves a GPS for a given identifier.
- FindGpsInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YGps
-
Retrieves a GPS for a given identifier in a YAPI context.
- FindGroundSpeed(String) - Static method in class com.yoctopuce.YoctoAPI.YGroundSpeed
-
Retrieves a ground speed sensor for a given identifier.
- FindGroundSpeedInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YGroundSpeed
-
Retrieves a ground speed sensor for a given identifier in a YAPI context.
- FindGyro(String) - Static method in class com.yoctopuce.YoctoAPI.YGyro
-
Retrieves a gyroscope for a given identifier.
- FindGyroInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YGyro
-
Retrieves a gyroscope for a given identifier in a YAPI context.
- findHomePosition(ArrayList<Double>) - Method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
Starts all motors backward at the specified speeds, to search for the motor home position.
- findHomePosition(double) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Starts the motor backward at the specified speed, to search for the motor home position.
- FindHubPort(String) - Static method in class com.yoctopuce.YoctoAPI.YHubPort
-
Retrieves a Yocto-hub port for a given identifier.
- FindHubPortInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YHubPort
-
Retrieves a Yocto-hub port for a given identifier in a YAPI context.
- FindHumidity(String) - Static method in class com.yoctopuce.YoctoAPI.YHumidity
-
Retrieves a humidity sensor for a given identifier.
- FindHumidityInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YHumidity
-
Retrieves a humidity sensor for a given identifier in a YAPI context.
- FindI2cPort(String) - Static method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Retrieves an I2C port for a given identifier.
- FindI2cPortInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Retrieves an I2C port for a given identifier in a YAPI context.
- FindLatitude(String) - Static method in class com.yoctopuce.YoctoAPI.YLatitude
-
Retrieves a latitude sensor for a given identifier.
- FindLatitudeInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YLatitude
-
Retrieves a latitude sensor for a given identifier in a YAPI context.
- FindLed(String) - Static method in class com.yoctopuce.YoctoAPI.YLed
-
Retrieves a LED for a given identifier.
- FindLedInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YLed
-
Retrieves a LED for a given identifier in a YAPI context.
- FindLightSensor(String) - Static method in class com.yoctopuce.YoctoAPI.YLightSensor
-
Retrieves a light sensor for a given identifier.
- FindLightSensorInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YLightSensor
-
Retrieves a light sensor for a given identifier in a YAPI context.
- FindLongitude(String) - Static method in class com.yoctopuce.YoctoAPI.YLongitude
-
Retrieves a longitude sensor for a given identifier.
- FindLongitudeInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YLongitude
-
Retrieves a longitude sensor for a given identifier in a YAPI context.
- FindMagnetometer(String) - Static method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Retrieves a magnetometer for a given identifier.
- FindMagnetometerInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Retrieves a magnetometer for a given identifier in a YAPI context.
- FindMessageBox(String) - Static method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Retrieves a MessageBox interface for a given identifier.
- FindMessageBoxInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Retrieves a MessageBox interface for a given identifier in a YAPI context.
- FindModule(String) - Static method in class com.yoctopuce.YoctoAPI.YModule
-
Allows you to find a module from its serial number or from its logical name.
- FindModuleInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YModule
-
Retrieves a module for a given identifier in a YAPI context.
- FindMotor(String) - Static method in class com.yoctopuce.YoctoAPI.YMotor
-
Retrieves a motor for a given identifier.
- FindMotorInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YMotor
-
Retrieves a motor for a given identifier in a YAPI context.
- FindMultiAxisController(String) - Static method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
Retrieves a multi-axis controller for a given identifier.
- FindMultiAxisControllerInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
Retrieves a multi-axis controller for a given identifier in a YAPI context.
- FindMultiCellWeighScale(String) - Static method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Retrieves a multi-cell weighing scale sensor for a given identifier.
- FindMultiCellWeighScaleInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Retrieves a multi-cell weighing scale sensor for a given identifier in a YAPI context.
- FindMultiSensController(String) - Static method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Retrieves a multi-sensor controller for a given identifier.
- FindMultiSensControllerInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Retrieves a multi-sensor controller for a given identifier in a YAPI context.
- FindNetwork(String) - Static method in class com.yoctopuce.YoctoAPI.YNetwork
-
Retrieves a network interface for a given identifier.
- FindNetworkInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YNetwork
-
Retrieves a network interface for a given identifier in a YAPI context.
- FindOsControl(String) - Static method in class com.yoctopuce.YoctoAPI.YOsControl
-
Retrieves OS control for a given identifier.
- FindOsControlInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YOsControl
-
Retrieves OS control for a given identifier in a YAPI context.
- FindPower(String) - Static method in class com.yoctopuce.YoctoAPI.YPower
-
Retrieves a electrical power sensor for a given identifier.
- FindPowerInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YPower
-
Retrieves a electrical power sensor for a given identifier in a YAPI context.
- FindPowerOutput(String) - Static method in class com.yoctopuce.YoctoAPI.YPowerOutput
-
Retrieves a dual power output control for a given identifier.
- FindPowerOutputInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YPowerOutput
-
Retrieves a dual power output control for a given identifier in a YAPI context.
- FindPowerSupply(String) - Static method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Retrieves a regulated power supply for a given identifier.
- FindPowerSupplyInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Retrieves a regulated power supply for a given identifier in a YAPI context.
- FindPressure(String) - Static method in class com.yoctopuce.YoctoAPI.YPressure
-
Retrieves a pressure sensor for a given identifier.
- FindPressureInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YPressure
-
Retrieves a pressure sensor for a given identifier in a YAPI context.
- FindProximity(String) - Static method in class com.yoctopuce.YoctoAPI.YProximity
-
Retrieves a proximity sensor for a given identifier.
- FindProximityInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YProximity
-
Retrieves a proximity sensor for a given identifier in a YAPI context.
- FindPwmInput(String) - Static method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Retrieves a PWM input for a given identifier.
- FindPwmInputInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Retrieves a PWM input for a given identifier in a YAPI context.
- FindPwmOutput(String) - Static method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Retrieves a PWM for a given identifier.
- FindPwmOutputInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Retrieves a PWM for a given identifier in a YAPI context.
- FindPwmPowerSource(String) - Static method in class com.yoctopuce.YoctoAPI.YPwmPowerSource
-
Retrieves a voltage source for a given identifier.
- FindPwmPowerSourceInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YPwmPowerSource
-
Retrieves a voltage source for a given identifier in a YAPI context.
- FindQt(String) - Static method in class com.yoctopuce.YoctoAPI.YQt
-
Retrieves a quaternion component for a given identifier.
- FindQtInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YQt
-
Retrieves a quaternion component for a given identifier in a YAPI context.
- FindQuadratureDecoder(String) - Static method in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
Retrieves a quadrature decoder for a given identifier.
- FindQuadratureDecoderInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
Retrieves a quadrature decoder for a given identifier in a YAPI context.
- FindRangeFinder(String) - Static method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Retrieves a range finder for a given identifier.
- FindRangeFinderInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Retrieves a range finder for a given identifier in a YAPI context.
- FindRealTimeClock(String) - Static method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Retrieves a clock for a given identifier.
- FindRealTimeClockInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Retrieves a clock for a given identifier in a YAPI context.
- FindRefFrame(String) - Static method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Retrieves a reference frame for a given identifier.
- FindRefFrameInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Retrieves a reference frame for a given identifier in a YAPI context.
- FindRelay(String) - Static method in class com.yoctopuce.YoctoAPI.YRelay
-
Retrieves a relay for a given identifier.
- FindRelayInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YRelay
-
Retrieves a relay for a given identifier in a YAPI context.
- FindSegmentedDisplay(String) - Static method in class com.yoctopuce.YoctoAPI.YSegmentedDisplay
-
Retrieves a segmented display for a given identifier.
- FindSegmentedDisplayInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YSegmentedDisplay
-
Retrieves a segmented display for a given identifier in a YAPI context.
- FindSensor(String) - Static method in class com.yoctopuce.YoctoAPI.YSensor
-
Retrieves a sensor for a given identifier.
- FindSensorInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YSensor
-
Retrieves a sensor for a given identifier in a YAPI context.
- FindSerialPort(String) - Static method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Retrieves a serial port for a given identifier.
- FindSerialPortInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Retrieves a serial port for a given identifier in a YAPI context.
- FindServo(String) - Static method in class com.yoctopuce.YoctoAPI.YServo
-
Retrieves a servo for a given identifier.
- FindServoInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YServo
-
Retrieves a servo for a given identifier in a YAPI context.
- FindSpiPort(String) - Static method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Retrieves a SPI port for a given identifier.
- FindSpiPortInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Retrieves a SPI port for a given identifier in a YAPI context.
- FindStepperMotor(String) - Static method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Retrieves a stepper motor for a given identifier.
- FindStepperMotorInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Retrieves a stepper motor for a given identifier in a YAPI context.
- FindTemperature(String) - Static method in class com.yoctopuce.YoctoAPI.YTemperature
-
Retrieves a temperature sensor for a given identifier.
- FindTemperatureInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YTemperature
-
Retrieves a temperature sensor for a given identifier in a YAPI context.
- FindTilt(String) - Static method in class com.yoctopuce.YoctoAPI.YTilt
-
Retrieves a tilt sensor for a given identifier.
- FindTiltInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YTilt
-
Retrieves a tilt sensor for a given identifier in a YAPI context.
- FindTvoc(String) - Static method in class com.yoctopuce.YoctoAPI.YTvoc
-
Retrieves a Total Volatile Organic Compound sensor for a given identifier.
- FindTvocInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YTvoc
-
Retrieves a Total Volatile Organic Compound sensor for a given identifier in a YAPI context.
- FindVoc(String) - Static method in class com.yoctopuce.YoctoAPI.YVoc
-
Retrieves a Volatile Organic Compound sensor for a given identifier.
- FindVocInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YVoc
-
Retrieves a Volatile Organic Compound sensor for a given identifier in a YAPI context.
- FindVoltage(String) - Static method in class com.yoctopuce.YoctoAPI.YVoltage
-
Retrieves a voltage sensor for a given identifier.
- FindVoltageInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YVoltage
-
Retrieves a voltage sensor for a given identifier in a YAPI context.
- FindVoltageOutput(String) - Static method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
Retrieves a voltage output for a given identifier.
- FindVoltageOutputInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
Retrieves a voltage output for a given identifier in a YAPI context.
- FindWakeUpMonitor(String) - Static method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Retrieves a monitor for a given identifier.
- FindWakeUpMonitorInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Retrieves a monitor for a given identifier in a YAPI context.
- FindWakeUpSchedule(String) - Static method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Retrieves a wake up schedule for a given identifier.
- FindWakeUpScheduleInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Retrieves a wake up schedule for a given identifier in a YAPI context.
- FindWatchdog(String) - Static method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Retrieves a watchdog for a given identifier.
- FindWatchdogInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Retrieves a watchdog for a given identifier in a YAPI context.
- FindWeighScale(String) - Static method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Retrieves a weighing scale sensor for a given identifier.
- FindWeighScaleInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Retrieves a weighing scale sensor for a given identifier in a YAPI context.
- FindWireless(String) - Static method in class com.yoctopuce.YoctoAPI.YWireless
-
Retrieves a wireless lan interface for a given identifier.
- FindWirelessInContext(YAPIContext, String) - Static method in class com.yoctopuce.YoctoAPI.YWireless
-
Retrieves a wireless lan interface for a given identifier in a YAPI context.
- FIRMWARERELEASE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YModule
-
invalid firmwareRelease value
- FirstAccelerometer() - Static method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Starts the enumeration of accelerometers currently accessible.
- FirstAccelerometerInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Starts the enumeration of accelerometers currently accessible.
- FirstAltitude() - Static method in class com.yoctopuce.YoctoAPI.YAltitude
-
Starts the enumeration of altimeters currently accessible.
- FirstAltitudeInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YAltitude
-
Starts the enumeration of altimeters currently accessible.
- FirstAnButton() - Static method in class com.yoctopuce.YoctoAPI.YAnButton
-
Starts the enumeration of analog inputs currently accessible.
- FirstAnButtonInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YAnButton
-
Starts the enumeration of analog inputs currently accessible.
- FirstArithmeticSensor() - Static method in class com.yoctopuce.YoctoAPI.YArithmeticSensor
-
Starts the enumeration of arithmetic sensors currently accessible.
- FirstArithmeticSensorInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YArithmeticSensor
-
Starts the enumeration of arithmetic sensors currently accessible.
- FirstAudioIn() - Static method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Starts the enumeration of audio inputs currently accessible.
- FirstAudioInInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Starts the enumeration of audio inputs currently accessible.
- FirstAudioOut() - Static method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Starts the enumeration of audio outputs currently accessible.
- FirstAudioOutInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Starts the enumeration of audio outputs currently accessible.
- FirstBluetoothLink() - Static method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Starts the enumeration of cellular interfaces currently accessible.
- FirstBluetoothLinkInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Starts the enumeration of cellular interfaces currently accessible.
- FirstBuzzer() - Static method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Starts the enumeration of buzzers currently accessible.
- FirstBuzzerInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Starts the enumeration of buzzers currently accessible.
- FirstCarbonDioxide() - Static method in class com.yoctopuce.YoctoAPI.YCarbonDioxide
-
Starts the enumeration of CO2 sensors currently accessible.
- FirstCarbonDioxideInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YCarbonDioxide
-
Starts the enumeration of CO2 sensors currently accessible.
- FirstCellular() - Static method in class com.yoctopuce.YoctoAPI.YCellular
-
Starts the enumeration of cellular interfaces currently accessible.
- FirstCellularInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YCellular
-
Starts the enumeration of cellular interfaces currently accessible.
- FirstColorLed() - Static method in class com.yoctopuce.YoctoAPI.YColorLed
-
Starts the enumeration of RGB LEDs currently accessible.
- FirstColorLedCluster() - Static method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Starts the enumeration of RGB LED clusters currently accessible.
- FirstColorLedClusterInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Starts the enumeration of RGB LED clusters currently accessible.
- FirstColorLedInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YColorLed
-
Starts the enumeration of RGB LEDs currently accessible.
- FirstCompass() - Static method in class com.yoctopuce.YoctoAPI.YCompass
-
Starts the enumeration of compasses currently accessible.
- FirstCompassInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YCompass
-
Starts the enumeration of compasses currently accessible.
- FirstCurrent() - Static method in class com.yoctopuce.YoctoAPI.YCurrent
-
Starts the enumeration of current sensors currently accessible.
- FirstCurrentInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YCurrent
-
Starts the enumeration of current sensors currently accessible.
- FirstCurrentLoopOutput() - Static method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Starts the enumeration of 4-20mA outputs currently accessible.
- FirstCurrentLoopOutputInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Starts the enumeration of 4-20mA outputs currently accessible.
- FirstDaisyChain() - Static method in class com.yoctopuce.YoctoAPI.YDaisyChain
-
Starts the enumeration of module chains currently accessible.
- FirstDaisyChainInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YDaisyChain
-
Starts the enumeration of module chains currently accessible.
- FirstDataLogger() - Static method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Starts the enumeration of data loggers currently accessible.
- FirstDataLoggerInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Starts the enumeration of data loggers currently accessible.
- FirstDigitalIO() - Static method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Starts the enumeration of digital IO ports currently accessible.
- FirstDigitalIOInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Starts the enumeration of digital IO ports currently accessible.
- FirstDisplay() - Static method in class com.yoctopuce.YoctoAPI.YDisplay
-
Starts the enumeration of displays currently accessible.
- FirstDisplayInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YDisplay
-
Starts the enumeration of displays currently accessible.
- FirstDualPower() - Static method in class com.yoctopuce.YoctoAPI.YDualPower
-
Starts the enumeration of dual power controls currently accessible.
- FirstDualPowerInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YDualPower
-
Starts the enumeration of dual power controls currently accessible.
- FirstFiles() - Static method in class com.yoctopuce.YoctoAPI.YFiles
-
Starts the enumeration of filesystems currently accessible.
- FirstFilesInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YFiles
-
Starts the enumeration of filesystems currently accessible.
- FirstFunction() - Static method in class com.yoctopuce.YoctoAPI.YFunction
-
comment from .yc definition
- FirstFunctionInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YFunction
-
comment from .yc definition
- FirstGenericSensor() - Static method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Starts the enumeration of generic sensors currently accessible.
- FirstGenericSensorInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Starts the enumeration of generic sensors currently accessible.
- FirstGps() - Static method in class com.yoctopuce.YoctoAPI.YGps
-
Starts the enumeration of GPS currently accessible.
- FirstGpsInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YGps
-
Starts the enumeration of GPS currently accessible.
- FirstGroundSpeed() - Static method in class com.yoctopuce.YoctoAPI.YGroundSpeed
-
Starts the enumeration of ground speed sensors currently accessible.
- FirstGroundSpeedInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YGroundSpeed
-
Starts the enumeration of ground speed sensors currently accessible.
- FirstGyro() - Static method in class com.yoctopuce.YoctoAPI.YGyro
-
Starts the enumeration of gyroscopes currently accessible.
- FirstGyroInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YGyro
-
Starts the enumeration of gyroscopes currently accessible.
- FirstHubPort() - Static method in class com.yoctopuce.YoctoAPI.YHubPort
-
Starts the enumeration of Yocto-hub ports currently accessible.
- FirstHubPortInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YHubPort
-
Starts the enumeration of Yocto-hub ports currently accessible.
- FirstHumidity() - Static method in class com.yoctopuce.YoctoAPI.YHumidity
-
Starts the enumeration of humidity sensors currently accessible.
- FirstHumidityInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YHumidity
-
Starts the enumeration of humidity sensors currently accessible.
- FirstI2cPort() - Static method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Starts the enumeration of I2C ports currently accessible.
- FirstI2cPortInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Starts the enumeration of I2C ports currently accessible.
- FirstLatitude() - Static method in class com.yoctopuce.YoctoAPI.YLatitude
-
Starts the enumeration of latitude sensors currently accessible.
- FirstLatitudeInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YLatitude
-
Starts the enumeration of latitude sensors currently accessible.
- FirstLed() - Static method in class com.yoctopuce.YoctoAPI.YLed
-
Starts the enumeration of LEDs currently accessible.
- FirstLedInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YLed
-
Starts the enumeration of LEDs currently accessible.
- FirstLightSensor() - Static method in class com.yoctopuce.YoctoAPI.YLightSensor
-
Starts the enumeration of light sensors currently accessible.
- FirstLightSensorInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YLightSensor
-
Starts the enumeration of light sensors currently accessible.
- FirstLongitude() - Static method in class com.yoctopuce.YoctoAPI.YLongitude
-
Starts the enumeration of longitude sensors currently accessible.
- FirstLongitudeInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YLongitude
-
Starts the enumeration of longitude sensors currently accessible.
- FirstMagnetometer() - Static method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Starts the enumeration of magnetometers currently accessible.
- FirstMagnetometerInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Starts the enumeration of magnetometers currently accessible.
- FirstMessageBox() - Static method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Starts the enumeration of MessageBox interfaces currently accessible.
- FirstMessageBoxInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Starts the enumeration of MessageBox interfaces currently accessible.
- FirstModule() - Static method in class com.yoctopuce.YoctoAPI.YModule
-
Starts the enumeration of modules currently accessible.
- FirstModuleInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YModule
-
comment from .yc definition
- FirstMotor() - Static method in class com.yoctopuce.YoctoAPI.YMotor
-
Starts the enumeration of motors currently accessible.
- FirstMotorInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YMotor
-
Starts the enumeration of motors currently accessible.
- FirstMultiAxisController() - Static method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
Starts the enumeration of multi-axis controllers currently accessible.
- FirstMultiAxisControllerInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
Starts the enumeration of multi-axis controllers currently accessible.
- FirstMultiCellWeighScale() - Static method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Starts the enumeration of multi-cell weighing scale sensors currently accessible.
- FirstMultiCellWeighScaleInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Starts the enumeration of multi-cell weighing scale sensors currently accessible.
- FirstMultiSensController() - Static method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Starts the enumeration of multi-sensor controllers currently accessible.
- FirstMultiSensControllerInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Starts the enumeration of multi-sensor controllers currently accessible.
- FirstNetwork() - Static method in class com.yoctopuce.YoctoAPI.YNetwork
-
Starts the enumeration of network interfaces currently accessible.
- FirstNetworkInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YNetwork
-
Starts the enumeration of network interfaces currently accessible.
- FirstOsControl() - Static method in class com.yoctopuce.YoctoAPI.YOsControl
-
Starts the enumeration of OS control currently accessible.
- FirstOsControlInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YOsControl
-
Starts the enumeration of OS control currently accessible.
- FirstPower() - Static method in class com.yoctopuce.YoctoAPI.YPower
-
Starts the enumeration of electrical power sensors currently accessible.
- FirstPowerInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YPower
-
Starts the enumeration of electrical power sensors currently accessible.
- FirstPowerOutput() - Static method in class com.yoctopuce.YoctoAPI.YPowerOutput
-
Starts the enumeration of dual power output controls currently accessible.
- FirstPowerOutputInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YPowerOutput
-
Starts the enumeration of dual power output controls currently accessible.
- FirstPowerSupply() - Static method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Starts the enumeration of regulated power supplies currently accessible.
- FirstPowerSupplyInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Starts the enumeration of regulated power supplies currently accessible.
- FirstPressure() - Static method in class com.yoctopuce.YoctoAPI.YPressure
-
Starts the enumeration of pressure sensors currently accessible.
- FirstPressureInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YPressure
-
Starts the enumeration of pressure sensors currently accessible.
- FirstProximity() - Static method in class com.yoctopuce.YoctoAPI.YProximity
-
Starts the enumeration of proximity sensors currently accessible.
- FirstProximityInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YProximity
-
Starts the enumeration of proximity sensors currently accessible.
- FirstPwmInput() - Static method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Starts the enumeration of PWM inputs currently accessible.
- FirstPwmInputInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Starts the enumeration of PWM inputs currently accessible.
- FirstPwmOutput() - Static method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Starts the enumeration of PWMs currently accessible.
- FirstPwmOutputInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Starts the enumeration of PWMs currently accessible.
- FirstPwmPowerSource() - Static method in class com.yoctopuce.YoctoAPI.YPwmPowerSource
-
Starts the enumeration of Voltage sources currently accessible.
- FirstPwmPowerSourceInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YPwmPowerSource
-
Starts the enumeration of Voltage sources currently accessible.
- FirstQt() - Static method in class com.yoctopuce.YoctoAPI.YQt
-
Starts the enumeration of quaternion components currently accessible.
- FirstQtInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YQt
-
Starts the enumeration of quaternion components currently accessible.
- FirstQuadratureDecoder() - Static method in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
Starts the enumeration of quadrature decoders currently accessible.
- FirstQuadratureDecoderInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
Starts the enumeration of quadrature decoders currently accessible.
- FirstRangeFinder() - Static method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Starts the enumeration of range finders currently accessible.
- FirstRangeFinderInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Starts the enumeration of range finders currently accessible.
- FirstRealTimeClock() - Static method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Starts the enumeration of clocks currently accessible.
- FirstRealTimeClockInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Starts the enumeration of clocks currently accessible.
- FirstRefFrame() - Static method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Starts the enumeration of reference frames currently accessible.
- FirstRefFrameInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Starts the enumeration of reference frames currently accessible.
- FirstRelay() - Static method in class com.yoctopuce.YoctoAPI.YRelay
-
Starts the enumeration of relays currently accessible.
- FirstRelayInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YRelay
-
Starts the enumeration of relays currently accessible.
- FirstSegmentedDisplay() - Static method in class com.yoctopuce.YoctoAPI.YSegmentedDisplay
-
Starts the enumeration of segmented displays currently accessible.
- FirstSegmentedDisplayInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YSegmentedDisplay
-
Starts the enumeration of segmented displays currently accessible.
- FirstSensor() - Static method in class com.yoctopuce.YoctoAPI.YSensor
-
Starts the enumeration of sensors currently accessible.
- FirstSensorInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YSensor
-
Starts the enumeration of sensors currently accessible.
- FirstSerialPort() - Static method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Starts the enumeration of serial ports currently accessible.
- FirstSerialPortInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Starts the enumeration of serial ports currently accessible.
- FirstServo() - Static method in class com.yoctopuce.YoctoAPI.YServo
-
Starts the enumeration of servos currently accessible.
- FirstServoInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YServo
-
Starts the enumeration of servos currently accessible.
- FirstSpiPort() - Static method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Starts the enumeration of SPI ports currently accessible.
- FirstSpiPortInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Starts the enumeration of SPI ports currently accessible.
- FirstStepperMotor() - Static method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Starts the enumeration of stepper motors currently accessible.
- FirstStepperMotorInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Starts the enumeration of stepper motors currently accessible.
- FirstTemperature() - Static method in class com.yoctopuce.YoctoAPI.YTemperature
-
Starts the enumeration of temperature sensors currently accessible.
- FirstTemperatureInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YTemperature
-
Starts the enumeration of temperature sensors currently accessible.
- FirstTilt() - Static method in class com.yoctopuce.YoctoAPI.YTilt
-
Starts the enumeration of tilt sensors currently accessible.
- FirstTiltInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YTilt
-
Starts the enumeration of tilt sensors currently accessible.
- FirstTvoc() - Static method in class com.yoctopuce.YoctoAPI.YTvoc
-
Starts the enumeration of Total Volatile Organic Compound sensors currently accessible.
- FirstTvocInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YTvoc
-
Starts the enumeration of Total Volatile Organic Compound sensors currently accessible.
- FirstVoc() - Static method in class com.yoctopuce.YoctoAPI.YVoc
-
Starts the enumeration of Volatile Organic Compound sensors currently accessible.
- FirstVocInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YVoc
-
Starts the enumeration of Volatile Organic Compound sensors currently accessible.
- FirstVoltage() - Static method in class com.yoctopuce.YoctoAPI.YVoltage
-
Starts the enumeration of voltage sensors currently accessible.
- FirstVoltageInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YVoltage
-
Starts the enumeration of voltage sensors currently accessible.
- FirstVoltageOutput() - Static method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
Starts the enumeration of voltage outputs currently accessible.
- FirstVoltageOutputInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
Starts the enumeration of voltage outputs currently accessible.
- FirstWakeUpMonitor() - Static method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Starts the enumeration of monitors currently accessible.
- FirstWakeUpMonitorInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Starts the enumeration of monitors currently accessible.
- FirstWakeUpSchedule() - Static method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Starts the enumeration of wake up schedules currently accessible.
- FirstWakeUpScheduleInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Starts the enumeration of wake up schedules currently accessible.
- FirstWatchdog() - Static method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Starts the enumeration of watchdog currently accessible.
- FirstWatchdogInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Starts the enumeration of watchdog currently accessible.
- FirstWeighScale() - Static method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Starts the enumeration of weighing scale sensors currently accessible.
- FirstWeighScaleInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Starts the enumeration of weighing scale sensors currently accessible.
- FirstWireless() - Static method in class com.yoctopuce.YoctoAPI.YWireless
-
Starts the enumeration of wireless lan interfaces currently accessible.
- FirstWirelessInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YWireless
-
Starts the enumeration of wireless lan interfaces currently accessible.
- flush_now() - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
- flushLayers() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
- forgetAllDataStreams() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Clears the data logger memory and discards all recorded data streams.
- format_fs() - Method in class com.yoctopuce.YoctoAPI.YFiles
-
Reinitialize the filesystem to its clean, unfragmented, empty state.
- FreeAPI() - Static method in class com.yoctopuce.YoctoAPI.YAPI
-
Frees dynamically allocated memory blocks used by the Yoctopuce library.
- FreeAPI() - Method in class com.yoctopuce.YoctoAPI.YAPIContext
-
Frees dynamically allocated memory blocks used by the Yoctopuce library.
- FREESPACE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YFiles
-
invalid freeSpace value
- freqMove(int, int) - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Makes the buzzer frequency change over a period of time.
- FREQUENCY_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YBuzzer
-
invalid frequency value
- FREQUENCY_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YMotor
-
invalid frequency value
- FREQUENCY_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YPwmInput
-
invalid frequency value
- FREQUENCY_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YPwmOutput
-
invalid frequency value
- frequencyMove(double, int) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Performs a smooth frequency change toward a given value.
- fromInt(int) - Static method in enum com.yoctopuce.YoctoAPI.YDisplayLayer.ALIGN
-
- fromInt(int) - Static method in enum com.yoctopuce.YoctoAPI.YRefFrame.MOUNTORIENTATION
-
- fromInt(int) - Static method in enum com.yoctopuce.YoctoAPI.YRefFrame.MOUNTPOSITION
-
- functionBaseType(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Retrieves the base type of the nth function on the module.
- functionCount() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the number of functions (beside the "module" interface) available on the module.
- functionDescriptor() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
- FUNCTIONDESCRIPTOR_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YFunction
-
- functionId(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Retrieves the hardware identifier of the nth function on the module.
- functionName(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Retrieves the logical name of the nth function on the module.
- functionType(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Retrieves the type of the nth function on the module.
- functionValue(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Retrieves the advertised value of the nth function on the module.
- FUSIONMODE_COMPASS - Static variable in class com.yoctopuce.YoctoAPI.YRefFrame
-
- FUSIONMODE_IMU - Static variable in class com.yoctopuce.YoctoAPI.YRefFrame
-
- FUSIONMODE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YRefFrame
-
- FUSIONMODE_M4G - Static variable in class com.yoctopuce.YoctoAPI.YRefFrame
-
- FUSIONMODE_NDOF - Static variable in class com.yoctopuce.YoctoAPI.YRefFrame
-
invalid fusionMode value
- FUSIONMODE_NDOF_FMC_OFF - Static variable in class com.yoctopuce.YoctoAPI.YRefFrame
-
- generateParts() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- generatePdu() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_3DCalibrationHint() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Returns instructions to proceed to the tridimensional calibration initiated with
method start3DCalibration.
- get_3DCalibrationLogMsg() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Returns the latest log message from the calibration process.
- get_3DCalibrationProgress() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Returns the global process indicator for the tridimensional calibration
initiated with method start3DCalibration.
- get_3DCalibrationStage() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Returns index of the current stage of the calibration
initiated with method start3DCalibration.
- get_3DCalibrationStageProgress() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Returns the process indicator for the current stage of the calibration
initiated with method start3DCalibration.
- get_abcPeriod() - Method in class com.yoctopuce.YoctoAPI.YCarbonDioxide
-
Returns the Automatic Baseline Calibration period, in hours.
- get_absHum() - Method in class com.yoctopuce.YoctoAPI.YHumidity
-
Returns the current absolute humidity, in grams per cubic meter of air.
- get_activeLedCount() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns the number of LEDs currently handled by the device.
- get_adminPassword() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns a hash string if a password has been set for user "admin",
or an empty string otherwise.
- get_advertisedValue() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Returns a short string representing the current state of the function.
- get_advMode() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the measuring mode used for the advertised value pushed to the parent hub.
- get_airplaneMode() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns true if the airplane mode is active (radio turned off).
- get_alertMode() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
- get_allSettings() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns all the settings and uploaded files of the module.
- get_alphabet() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_altitude() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current altitude.
- get_analogCalibration() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Tells if a calibration process is currently ongoing.
- get_apn() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the Access Point Name (APN) to be used, if needed.
- get_apnSecret() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns an opaque string if APN authentication parameters have been configured
in the device, or an empty string otherwise.
- get_autoStart() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns the default activation state of the data logger on power up.
- get_autoStart() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the watchdog running state at module power on.
- get_auxMode() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
- get_auxSignal() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the current value of the signal generated on the auxiliary output.
- get_availableOperators() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the list detected cell operators in the neighborhood.
- get_averageValue() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns the average of all measures observed within this stream.
- get_averageValue() - Method in class com.yoctopuce.YoctoAPI.YMeasure
-
Returns the average value observed during the time interval
covered by this measure.
- get_axis() - Method in class com.yoctopuce.YoctoAPI.YCompass
-
- get_axis() - Method in class com.yoctopuce.YoctoAPI.YTilt
-
- get_bandwidth() - Method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- get_bandwidth() - Method in class com.yoctopuce.YoctoAPI.YCompass
-
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- get_bandwidth() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- get_bandwidth() - Method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- get_bandwidth() - Method in class com.yoctopuce.YoctoAPI.YTilt
-
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- get_baudRate() - Method in class com.yoctopuce.YoctoAPI.YHubPort
-
Returns the current baud rate used by this Yocto-hub port, in kbps.
- get_beacon() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the state of the localization beacon.
- get_beaconDriven() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns true if the data logger is synchronised with the localization beacon.
- get_bearing() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Returns the reference bearing used by the compass.
- get_bitDirection(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the direction of a single bit (i.e.
- get_bitOpenDrain(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the type of electrical interface of a single bit from the I/O port.
- get_bitPolarity(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
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).
- get_bitState(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the state of a single bit (i.e.
- get_blinking() - Method in class com.yoctopuce.YoctoAPI.YLed
-
Returns the current LED signaling mode.
- get_blinkSeqMaxCount() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns the maximum number of sequences that the device can handle.
- get_blinkSeqMaxSize() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Returns the maximum length of the blinking sequence.
- get_blinkSeqMaxSize() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns the maximum length of sequences.
- get_blinkSeqSignature() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Return the blinking sequence signature.
- get_blinkSeqSignatures(int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns a list on 32 bit signatures for specified blinking sequences.
- get_blinkSeqSize() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Returns the current length of the blinking sequence.
- get_blinkSeqState(int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns a list of integers with the started state for specified blinking sequences.
- get_blinkSeqStateAtPowerOn(int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns a list of integers with the "auto-start at power on" flag state for specified blinking sequences.
- get_blinkSeqStateSpeed(int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns a list of integers with the current speed for specified blinking sequences.
- get_brakingForce() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the braking force applied to the motor, as a percentage.
- get_brightness() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the luminosity of the module informative LEDs (from 0 to 100).
- get_calibratedValue() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the current calibrated input value (between 0 and 1000, included).
- get_calibrationMax() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the maximal value measured during the calibration (between 0 and 4095, included).
- get_calibrationMin() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the minimal value measured during the calibration (between 0 and 4095, included).
- get_calibrationParam() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
- get_calibrationParam() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
- get_calibrationState() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Returns the 3D sensor calibration state (Yocto-3D-V2 only).
- get_callbackCredentials() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns a hashed version of the notification callback credentials if set,
or an empty string otherwise.
- get_callbackEncoding() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the encoding standard to use for representing notification values.
- get_callbackInitialDelay() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the initial waiting time before first callback notifications, in seconds.
- get_callbackMaxDelay() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the waiting time between two HTTP callbacks when there is nothing new.
- get_callbackMethod() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the HTTP method used to notify callbacks for significant state changes.
- get_callbackMinDelay() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the minimum waiting time between two HTTP callbacks, in seconds.
- get_callbackSchedule() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the HTTP callback schedule strategy, as a text string.
- get_callbackUrl() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the callback URL to notify of significant state changes.
- get_cellCount() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the number of load cells in use.
- get_cellId() - Method in class com.yoctopuce.YoctoAPI.YCellRecord
-
- get_cellIdentifier() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the unique identifier of the cellular antenna in use: MCC, MNC, LAC and Cell ID.
- get_cellOperator() - Method in class com.yoctopuce.YoctoAPI.YCellRecord
-
- get_cellOperator() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the name of the cell operator currently in use.
- get_cellType() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Active cellular connection type.
- get_channel() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns the 802.11 channel currently used, or 0 when the selected network has not been found.
- get_channel() - Method in class com.yoctopuce.YoctoAPI.YWlanRecord
-
Returns the 802.11 channel.
- get_childCount() - Method in class com.yoctopuce.YoctoAPI.YDaisyChain
-
Returns the number of child nodes currently detected.
- get_clearHistory() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
- get_columnCount() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns the number of data columns present in this stream.
- get_columnNames() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns the title (or meaning) of each data column present in this stream.
- get_command() - Method in class com.yoctopuce.YoctoAPI.YArithmeticSensor
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YCarbonDioxide
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YGps
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
- get_command() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
- get_compensation() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the current current thermal compensation value.
- get_compensation() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the current current thermal compensation value.
- get_compTempAvg() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the current averaged temperature, used for thermal compensation.
- get_compTempAvg() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the current averaged temperature, used for thermal compensation.
- get_compTempChg() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the current temperature variation, used for thermal compensation.
- get_compTempChg() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the current temperature variation, used for thermal compensation.
- get_concatCount() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_concatIndex() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_concatSignature() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_constellation() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the the satellites constellation used to compute
positioning data.
- get_coordSystem() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the representation system used for positioning data.
- get_cosPhi() - Method in class com.yoctopuce.YoctoAPI.YPower
-
Returns the power factor (the ratio between the real power consumed,
measured in W, and the apparent power provided, measured in VA).
- get_countdown() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Returns the number of milliseconds remaining before a pulse (delayedPulse() call)
When there is no scheduled pulse, returns zero.
- get_countdown() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the number of milliseconds remaining before a pulse (delayedPulse() call)
When there is no scheduled pulse, returns zero.
- get_crc() - Method in class com.yoctopuce.YoctoAPI.YFileRecord
-
Returns the 32-bit CRC of the file content.
- get_CTS() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Reads the level of the CTS line.
- get_current() - Method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Returns the loop current set point in mA.
- get_currentAtStartUp() - Method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Returns the current in the loop at device startup, in mA.
- get_currentAtStartUp() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the selected current limit at device startup, in mA.
- get_currentJob() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the name of the job file currently in use.
- get_currentJob() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the name of the job file currently in use.
- get_currentJob() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the name of the job file currently in use.
- get_currentLimit() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the current limit, in mA.
- get_currentRawValue() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the uncalibrated, unrounded raw value returned by the
sensor, in the specified unit, as a floating point number.
- get_currentRunIndex() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns the current run number, corresponding to the number of times the module was
powered on with the dataLogger enabled at some point.
- get_currentTemperature() - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Returns the current sensor temperature, as a floating point number.
- get_currentTransition() - Method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
- get_currentValue() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the current value of the measure, in the specified unit, as a floating point number.
- get_currentVoltage() - Method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
Returns the output voltage set point, in V.
- get_cutOffVoltage() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the threshold voltage under which the controller automatically switches to error state
and prevents further current draw.
- get_daisyState() - Method in class com.yoctopuce.YoctoAPI.YDaisyChain
-
Returns the state of the daisy-link between modules.
- get_data(int, int) - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns a single measure from the data stream, specified by its
row and column index.
- get_dataLogger() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the YDatalogger object of the device hosting the sensor.
- get_dataReceived() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the number of bytes received so far.
- get_dataRows() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns the whole data set contained in the stream, as a bidimensional
table of numbers.
- get_dataSamplesInterval() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
- get_dataSamplesIntervalMs() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns the number of milliseconds between two consecutive
rows of this data stream.
- get_dataSent() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the number of bytes sent so far.
- get_dataSets() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns a list of YDataSet objects that can be used to retrieve
all measures stored by the data logger.
- get_dateTime() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current time in the form "YYYY/MM/DD hh:mm:ss".
- get_dateTime() - Method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Returns the current time in the form "YYYY/MM/DD hh:mm:ss".
- get_dcs() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_debouncePeriod() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the shortest expected pulse duration, in ms.
- get_decoding() - Method in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
Returns the current activation state of the quadrature decoder.
- get_defaultPage() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the HTML page to serve for the URL "/"" of the hub.
- get_delayedPulseTimer() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
- get_delayedPulseTimer() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
- get_description() - Method in class com.yoctopuce.YoctoAPI.YArithmeticSensor
-
Returns a short informative description of the formula.
- get_detectedWlans() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns a list of YWlanRecord objects that describe detected Wireless networks.
- get_detectionHysteresis() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the hysteresis used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
- get_detectionThreshold() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the threshold used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
- get_diags() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the stepper motor controller diagnostics, as a bitmap.
- get_dilution() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current horizontal dilution of precision,
the smaller that number is, the better .
- get_direction() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current move bearing in degrees, zero
is the true (geographic) north.
- get_direction() - Method in class com.yoctopuce.YoctoAPI.YSnoopingRecord
-
- get_discoverable() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the activation state of the multicast announce protocols to allow easy
discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
- get_display() - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Gets parent YDisplay.
- get_displayedText() - Method in class com.yoctopuce.YoctoAPI.YSegmentedDisplay
-
Returns the text currently displayed on the screen.
- get_displayHeight() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the display height, in pixels.
- get_displayHeight() - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Returns the display height, in pixels.
- get_displayLayer(int) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns a YDisplayLayer object that can be used to draw on the specified
layer.
- get_displayMode() - Method in class com.yoctopuce.YoctoAPI.YSegmentedDisplay
-
- get_displayType() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the display type: monochrome, gray levels or full color.
- get_displayWidth() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the display width, in pixels.
- get_displayWidth() - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Returns the display width, in pixels.
- get_drivingForce() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the power sent to the motor, as a percentage between -100% and +100%.
- get_dutyCycle() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the PWM duty cycle, in per cents.
- get_dutyCycle() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the PWM duty cycle, in per cents.
- get_dutyCycleAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the PWMs duty cycle at device power on as a floating point number between 0 and 100.
- get_enabled() - Method in class com.yoctopuce.YoctoAPI.YCurrent
-
Returns the activation state of this input.
- get_enabled() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns true if the screen is powered, false otherwise.
- get_enabled() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the activation state of this input.
- get_enabled() - Method in class com.yoctopuce.YoctoAPI.YHubPort
-
Returns true if the Yocto-hub port is powered, false otherwise.
- get_enabled() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the state of the PWMs.
- get_enabled() - Method in class com.yoctopuce.YoctoAPI.YServo
-
Returns the state of the servos.
- get_enabled() - Method in class com.yoctopuce.YoctoAPI.YVoltage
-
Returns the activation state of this input.
- get_enableData() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the condition for enabling IP data services (GPRS).
- get_enabledAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the state of the PWM at device power on.
- get_enabledAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YServo
-
Returns the servo signal generator state at power up.
- get_endTimeUTC() - Method in class com.yoctopuce.YoctoAPI.YDataSet
-
Returns the end time of the dataset, relative to the Jan 1, 1970.
- get_endTimeUTC() - Method in class com.yoctopuce.YoctoAPI.YMeasure
-
Returns the end time of the measure, relative to the Jan 1, 1970 UTC
(Unix timestamp).
- get_endTimeUTC_asDate() - Method in class com.yoctopuce.YoctoAPI.YMeasure
-
- get_errCount() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the total number of communication errors detected since last reset.
- get_errCount() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the total number of communication errors detected since last reset.
- get_errCount() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the total number of communication errors detected since last reset.
- get_errorMessage() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Returns the error message of the latest error with the function.
- get_errorType() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Returns the numerical error code of the latest error with the function.
- get_excitation() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the current load cell bridge excitation method.
- get_excitation() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the current load cell bridge excitation method.
- get_extVoltage() - Method in class com.yoctopuce.YoctoAPI.YDualPower
-
Returns the measured voltage on the external power source, in millivolts.
- get_failSafeTimeout() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the delay in milliseconds allowed for the controller to run autonomously without
receiving any instruction from the control process.
- get_filesCount() - Method in class com.yoctopuce.YoctoAPI.YFiles
-
Returns the number of files currently loaded in the filesystem.
- get_firmwareRelease() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the version of the firmware embedded in the module.
- get_firstDataSamplesInterval() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
- get_freeSpace() - Method in class com.yoctopuce.YoctoAPI.YFiles
-
Returns the free space for uploading new files to the filesystem, in bytes.
- get_frequency() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Returns the frequency of the signal sent to the buzzer/speaker.
- get_frequency() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the PWM frequency used to control the motor.
- get_frequency() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the PWM frequency in Hz.
- get_frequency() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the PWM frequency in Hz.
- get_friendlyName() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Returns a global identifier of the function in the format MODULE_NAME.FUNCTION_NAME.
- get_functionDescriptor() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Returns a unique identifier of type YFUN_DESCR corresponding to the function.
- get_functionId() - Method in class com.yoctopuce.YoctoAPI.YDataSet
-
Returns the hardware identifier of the function that performed the measure,
without reference to the module.
- get_functionId() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Returns the hardware identifier of the function, without reference to the module.
- get_functionIds(String) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Retrieve all hardware identifier that match the type passed in argument.
- get_fusionMode() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Returns the BNO055 fusion mode.
- get_globalState() - Method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
Returns the stepper motor set overall state.
- get_gravityCancellation() - Method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
- get_groundSpeed() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current ground speed in Km/h.
- get_hardwareCalibration() - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
- get_hardwareCalibrationTemperature() - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Returns the temperature at the time when the latest calibration was performed.
- get_hardwareId() - Method in class com.yoctopuce.YoctoAPI.YDataSet
-
Returns the unique hardware identifier of the function who performed the measures,
in the form SERIAL.FUNCTIONID.
- get_hardwareId() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Returns the unique hardware identifier of the function in the form SERIAL.FUNCTIONID.
- get_hardwareId() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the unique hardware identifier of the module.
- get_heading() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Returns the estimated heading angle, based on the integration of
gyroscopic measures combined with acceleration and
magnetic field measurements.
- get_highestValue() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the maximal value observed for the measure since the device was started.
- get_hours() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the hours scheduled for wake up.
- get_hslColor() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Returns the current HSL color of the LED.
- get_hslMove() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
- get_httpPort() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the HTML page to serve for the URL "/"" of the hub.
- get_i2cMode() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the SPI port communication parameters, as a string such as
"400kbps,2000ms,NoRestart".
- get_i2cVoltageLevel() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the voltage level used on the I2C bus.
- get_icon2d() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the icon of the module.
- get_imsi() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
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.
- get_inputVoltage() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the measured input voltage, in V.
- get_ipAddress() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the IP address currently in use by the device.
- get_ipConfig() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the IP configuration of the network interface.
- get_isFixed() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns TRUE if the receiver has found enough satellites to work.
- get_isPresent() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns true if the input (considered as binary) is active (detection value is smaller than the
specified threshold), and false otherwise.
- get_isPressed() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns true if the input (considered as binary) is active (closed contact), and false otherwise.
- get_lastLogs() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns a string with last logs of the module.
- get_lastMsg() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the latest message fully received (for Line and Frame protocols).
- get_lastMsg() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the latest message fully received (for Line, Frame and Modbus protocols).
- get_lastMsg() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the latest message fully received (for Line and Frame protocols).
- get_lastTimeApproached() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the number of elapsed milliseconds between the module power on and the last observed
detection (the input contact transitioned from absent to present).
- get_lastTimePressed() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
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).
- get_lastTimeReleased() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
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).
- get_lastTimeRemoved() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the number of elapsed milliseconds between the module power on and the last observed
detection (the input contact transitioned from present to absent).
- get_latitude() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current latitude.
- get_layerCount() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the number of available layers to draw on.
- get_layerHeight() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the height of the layers to draw on, in pixels.
- get_layerHeight() - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Returns the height of the layers to draw on, in pixels.
- get_layerWidth() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the width of the layers to draw on, in pixels.
- get_layerWidth() - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Returns the width of the layers to draw on, in pixels.
- get_ldoTemperature() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the LDO temperature, in Celsius.
- get_ledType() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns the RGB LED type currently handled by the device.
- get_linkedSeqArray(int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns a list on sequence index for each RGB LED.
- get_linkQuality() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the bluetooth receiver signal strength, in pourcents, or 0 if no connection is established.
- get_linkQuality() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the link quality, expressed in percent.
- get_linkQuality() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns the link quality, expressed in percent.
- get_linkQuality() - Method in class com.yoctopuce.YoctoAPI.YWlanRecord
-
Returns the quality of the wireless network link, in per cents.
- get_linkState() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the bluetooth link state.
- get_list(String) - Method in class com.yoctopuce.YoctoAPI.YFiles
-
Returns a list of YFileRecord objects that describe files currently loaded
in the filesystem.
- get_locationAreaCode() - Method in class com.yoctopuce.YoctoAPI.YCellRecord
-
- get_lockedOperator() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
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.
- get_logCallback() - Method in class com.yoctopuce.YoctoAPI.YModule
-
- get_logFrequency() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the datalogger recording frequency for this function, or "OFF"
when measures are not stored in the data logger flash memory.
- get_logicalName() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Returns the logical name of the function.
- get_longitude() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current longitude.
- get_loopPower() - Method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Returns the loop powerstate.
- get_lowestValue() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the minimal value observed for the measure since the device was started.
- get_luminosity() - Method in class com.yoctopuce.YoctoAPI.YLed
-
Returns the current LED intensity (in per cent).
- get_luminosity() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the luminosity of the module informative LEDs (from 0 to 100).
- get_macAddress() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the MAC address of the network interface.
- get_magneticHeading() - Method in class com.yoctopuce.YoctoAPI.YCompass
-
Returns the magnetic heading, regardless of the configured bearing.
- get_maintenanceMode() - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Returns true when the device is in maintenance mode.
- get_maxAccel() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the maximal motor acceleration, measured in steps per second^2.
- get_maxLedCount() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns the maximum number of LEDs that the device can handle.
- get_maxSensors() - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Returns the maximum configurable sensor count allowed on this device.
- get_maxSpeed() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the maximal motor speed, measured in steps per second.
- get_maxTimeOnStateA() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
- get_maxTimeOnStateA() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
- get_maxTimeOnStateB() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
- get_maxTimeOnStateB() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
- get_maxValue() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns the largest measure observed within this stream.
- get_maxValue() - Method in class com.yoctopuce.YoctoAPI.YMeasure
-
Returns the largest value observed during the time interval
covered by this measure.
- get_measuredCurrent() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the measured output current, in mA.
- get_measuredVoltage() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the measured output voltage, in V.
- get_measureQuality() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Returns estimated quality of the orientation (Yocto-3D-V2 only).
- get_measures() - Method in class com.yoctopuce.YoctoAPI.YDataSet
-
Returns all measured values currently available for this DataSet,
as a list of YMeasure objects.
- get_measuresAt(YMeasure) - Method in class com.yoctopuce.YoctoAPI.YDataSet
-
Returns the detailed set of measures for the time interval corresponding
to a given condensed measures previously returned by get_preview().
- get_measureType() - Method in class com.yoctopuce.YoctoAPI.YLightSensor
-
Returns the type of light measure.
- get_message() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the latest status message from the wireless interface.
- get_message() - Method in class com.yoctopuce.YoctoAPI.YSnoopingRecord
-
- get_message() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns the latest status message from the wireless interface.
- get_messages() - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Returns the list of messages received and not deleted.
- get_meter() - Method in class com.yoctopuce.YoctoAPI.YPower
-
Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time.
- get_meterTimer() - Method in class com.yoctopuce.YoctoAPI.YPower
-
Returns the elapsed time since last energy counter reset, in seconds.
- get_minutes() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns all the minutes of each hour that are scheduled for wake up.
- get_minutesA() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the minutes in the 00-29 interval of each hour scheduled for wake up.
- get_minutesB() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the minutes in the 30-59 interval of each hour scheduled for wake up.
- get_minValue() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns the smallest measure observed within this stream.
- get_minValue() - Method in class com.yoctopuce.YoctoAPI.YMeasure
-
Returns the smallest value observed during the time interval
covered by this measure.
- get_mobileCountryCode() - Method in class com.yoctopuce.YoctoAPI.YCellRecord
-
- get_mobileNetworkCode() - Method in class com.yoctopuce.YoctoAPI.YCellRecord
-
- get_module() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Gets the YModule object for the device on which the function is located.
- get_monthDays() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the days of the month scheduled for wake up.
- get_months() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the months scheduled for wake up.
- get_motorState() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the motor working state.
- get_motorStatus() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Return the controller state.
- get_mountOrientation() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
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.
- get_mountPos() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
- get_mountPosition() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
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.
- get_move() - Method in class com.yoctopuce.YoctoAPI.YServo
-
- get_msgClass() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_msgRef() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_mute() - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Returns the state of the mute function.
- get_mute() - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Returns the state of the mute function.
- get_mute() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the state of the mute function.
- get_name() - Method in class com.yoctopuce.YoctoAPI.YFileRecord
-
Returns the name of the file.
- get_nAxis() - Method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
Returns the number of synchronized controllers.
- get_neutral() - Method in class com.yoctopuce.YoctoAPI.YServo
-
Returns the duration in microseconds of a neutral pulse for the servo.
- get_nextOccurence() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the date/time (seconds) of the next wake up occurrence.
- get_nextWakeUp() - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Returns the next scheduled wake up date/time (UNIX format).
- get_noSignalFor() - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Returns the number of seconds elapsed without detecting a signal.
- get_noSignalFor() - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Returns the number of seconds elapsed without detecting a signal.
- get_nSensors() - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Returns the number of sensors to poll.
- get_ntpServer() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the IP address of the NTP server to be used by the device.
- get_orientation() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the currently selected display orientation.
- get_output() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Returns the output state of the relays, when used as a simple switch (single throw).
- get_output() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the output state of the watchdog, when used as a simple switch (single throw).
- get_outputVoltage() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the voltage source used to drive output bits.
- get_overcurrent() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the overcurrent alert and emergency stop threshold, measured in mA.
- get_overCurrentLimit() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the current threshold (in mA) above which the controller automatically
switches to error state.
- get_ownAddress() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the MAC-48 address of the bluetooth interface, which is unique on the bluetooth network.
- get_pairingPin() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
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.
- get_parentHub() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the serial number of the YoctoHub on which this module is connected.
- get_partCount() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_parts() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_pdu() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_pduReceived() - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Returns the number of SMS units received so far.
- get_pdus() - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
- get_pduSent() - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Returns the number of SMS units sent so far.
- get_period() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the PWM period in milliseconds.
- get_period() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the PWM period in milliseconds.
- get_persistentSettings() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the current state of persistent module settings.
- get_pin() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
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.
- get_pingInterval() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the automated connectivity check interval, in seconds.
- get_pitch() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Returns the estimated pitch angle, based on the integration of
gyroscopic measures combined with acceleration and
magnetic field measurements.
- get_playSeqMaxSize() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Returns the maximum length of the playing sequence.
- get_playSeqSignature() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Returns the playing sequence signature.
- get_playSeqSize() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Returns the current length of the playing sequence.
- get_poeCurrent() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the current consumed by the module from Power-over-Ethernet (PoE), in milliamps.
- get_portDiags() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the port state diagnostics (Yocto-IO and Yocto-MaxiIO-V2 only).
- get_portDirection() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the IO direction of all bits (i.e.
- get_portOpenDrain() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the electrical interface for each bit of the port.
- get_portPolarity() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the polarity of all the bits of the port.
- get_portSize() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the number of bits (i.e.
- get_portState() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
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...
- get_portState() - Method in class com.yoctopuce.YoctoAPI.YHubPort
-
Returns the current state of the Yocto-hub port.
- get_position() - Method in class com.yoctopuce.YoctoAPI.YServo
-
Returns the current servo position.
- get_positionAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YServo
-
Returns the servo position at device power up.
- get_power() - Method in class com.yoctopuce.YoctoAPI.YLed
-
Returns the current LED state.
- get_powerControl() - Method in class com.yoctopuce.YoctoAPI.YDualPower
-
Returns the selected power source for module functions that require lots of current.
- get_powerDuration() - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Returns the maximal wake up time (in seconds) before automatically going to sleep.
- get_powerMode() - Method in class com.yoctopuce.YoctoAPI.YPwmPowerSource
-
Returns the selected power source for the PWM on the same device.
- get_powerOutput() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the power supply output switch state.
- get_powerState() - Method in class com.yoctopuce.YoctoAPI.YDualPower
-
Returns the current power source for module functions that require lots of current.
- get_preAmplifier() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the audio pre-amplifier volume, in per cents.
- get_presenceMinTime() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the minimal detection duration before signalling a presence event.
- get_preview() - Method in class com.yoctopuce.YoctoAPI.YDataSet
-
Returns a condensed version of the measures that can
retrieved in this YDataSet, as a list of YMeasure
objects.
- get_primaryDNS() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the IP address of the primary name server to be used by the module.
- get_privateDataStreams() - Method in class com.yoctopuce.YoctoAPI.YDataSet
-
- get_productId() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the USB device identifier of the module.
- get_productName() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the commercial name of the module, as set by the factory.
- get_productNameAndRevision() - Method in class com.yoctopuce.YoctoAPI.YModule
-
- get_productRelease() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the release number of the module hardware, preprogrammed at the factory.
- get_progress() - Method in class com.yoctopuce.YoctoAPI.YDataSet
-
Returns the progress of the downloads of the measures from the data logger,
on a scale from 0 to 100.
- get_progress() - Method in class com.yoctopuce.YoctoAPI.YFirmwareUpdate
-
Returns the progress of the firmware update, on a scale from 0 to 100.
- get_progressMessage() - Method in class com.yoctopuce.YoctoAPI.YFirmwareUpdate
-
Returns the last progress message of the firmware update process.
- get_protocol() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the type of protocol used to send I2C messages, as a string.
- get_protocol() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the type of protocol used over the serial line, as a string.
- get_protocol() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the type of protocol used over the serial line, as a string.
- get_protocolId() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_proximityReportMode() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the parameter (sensor value, presence or pulse count) returned by the get_currentValue
function and callbacks.
- get_pullinSpeed() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the motor speed immediately reachable from stop state, measured in steps per second.
- get_pulseCounter() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the pulse counter value.
- get_pulseCounter() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the pulse counter value.
- get_pulseCounter() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the pulse counter value.
- get_pulseDuration() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the PWM pulse length in milliseconds, as a floating point number.
- get_pulseDuration() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the PWM pulse length in milliseconds, as a floating point number.
- get_pulseTimer() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the timer of the pulses counter (ms).
- get_pulseTimer() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the timer of the pulse counter (ms).
- get_pulseTimer() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the timer of the pulses counter (ms).
- get_pulseTimer() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Returns the number of milliseconds remaining before the relays is returned to idle position
(state A), during a measured pulse generation.
- get_pulseTimer() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the number of milliseconds remaining before the watchdog is returned to idle position
(state A), during a measured pulse generation.
- get_pwmReportMode() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the parameter (frequency/duty cycle, pulse width, edges count) returned by the
get_currentValue function and callbacks.
- get_pwmTransition() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
- get_qnh() - Method in class com.yoctopuce.YoctoAPI.YAltitude
-
Returns the barometric pressure adjusted to sea level used to compute
the altitude (QNH).
- get_quality() - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Returns a measure quality estimate, based on measured dispersion.
- get_quaternionW() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
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.
- get_quaternionX() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
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.
- get_quaternionY() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
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.
- get_quaternionZ() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
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.
- get_range() - Method in class com.yoctopuce.YoctoAPI.YServo
-
Returns the current range of use of the servo.
- get_rangeFinderMode() - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Returns the range finder running mode.
- get_rawValue() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the current measured input value as-is (between 0 and 4095, included).
- get_readiness() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the current established working mode of the network interface.
- get_realDuration() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
- get_realStartTimeUTC() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns the start time of the data stream, relative to the Jan 1, 1970.
- get_rebootCountdown() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the remaining number of seconds before the module restarts, or zero when no
reboot has been scheduled.
- get_recipient() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_recordedData(double, double) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Retrieves a DataSet object holding historical data for this
sensor, for a specified time interval.
- get_recording() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns the current activation state of the data logger.
- get_relHum() - Method in class com.yoctopuce.YoctoAPI.YHumidity
-
Returns the current relative humidity, in per cents.
- get_remoteAddress() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the MAC-48 address of the remote device to connect to.
- get_remoteName() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the bluetooth name the remote device, if found on the bluetooth network.
- get_removalMinTime() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the minimal detection duration before signalling a removal event.
- get_reportFrequency() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the timed value notification frequency, or "OFF" if timed
value notifications are disabled for this function.
- get_requiredChildCount() - Method in class com.yoctopuce.YoctoAPI.YDaisyChain
-
Returns the number of child nodes expected in normal conditions.
- get_resolution() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the resolution of the measured values.
- get_rgbColor() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Returns the current RGB color of the LED.
- get_rgbColorArray(int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns a list on 24bit RGB color values with the current colors displayed on
the RGB LEDs.
- get_rgbColorArrayAtPowerOn(int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns a list on 24bit RGB color values with the RGB LEDs startup colors.
- get_rgbColorAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Returns the configured color to be displayed when the module is turned on.
- get_rgbColorBuffer(int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns a binary buffer with content from the LED RGB buffer, as is.
- get_rgbMove() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
- get_roll() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Returns the estimated roll angle, based on the integration of
gyroscopic measures combined with acceleration and
magnetic field measurements.
- get_router() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the IP address of the router on the device subnet (default gateway).
- get_rowCount() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns the number of data rows present in this stream.
- get_rtcTime() - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
- get_runIndex() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns the run index of the data stream.
- get_running() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the watchdog running state.
- get_rxCount() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the total number of bytes received since last reset.
- get_rxCount() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the total number of bytes received since last reset.
- get_rxCount() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the total number of bytes received since last reset.
- get_rxMsgCount() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the total number of messages received since last reset.
- get_rxMsgCount() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the total number of messages received since last reset.
- get_rxMsgCount() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the total number of messages received since last reset.
- get_satCount() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the count of visible satellites.
- get_secondaryDNS() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the IP address of the secondary name server to be used by the module.
- get_security() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns the security algorithm used by the selected wireless network.
- get_security() - Method in class com.yoctopuce.YoctoAPI.YWlanRecord
-
Returns the security algorithm used by the wireless network.
- get_sender() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_sensitivity() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the sensibility for the input (between 1 and 1000) for triggering user callbacks.
- get_sensorState() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
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.
- get_sensorType() - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
Returns the temperature sensor type.
- get_serialMode() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the serial port communication parameters, as a string such as
"9600,8N1".
- get_serialNumber() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Returns the serial number of the module, as set by the factory.
- get_serialNumber() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the serial number of the module, as set by the factory.
- get_shiftSampling() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns true when the SDI line phase is shifted with regards to the SDO line.
- get_shutdownCountdown() - Method in class com.yoctopuce.YoctoAPI.YOsControl
-
Returns the remaining number of seconds before the OS shutdown, or zero when no
shutdown has been scheduled.
- get_signal() - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Returns the detected input signal level.
- get_signal() - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Returns the detected output current level.
- get_signalBias() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the electric signal bias for zero shift adjustment.
- get_signalRange() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the electric signal range used by the sensor.
- get_signalSampling() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the electric signal sampling method to use.
- get_signalStrength() - Method in class com.yoctopuce.YoctoAPI.YCellRecord
-
- get_signalUnit() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the measuring unit of the electrical signal used by the sensor.
- get_signalUnit() - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
Returns the measuring unit of the electrical signal used by the sensor.
- get_signalValue() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the current value of the electrical signal measured by the sensor.
- get_signalValue() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the current value of signal measured by the proximity sensor.
- get_signalValue() - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
Returns the current value of the electrical signal measured by the sensor.
- get_size() - Method in class com.yoctopuce.YoctoAPI.YFileRecord
-
Returns the size of the file in bytes.
- get_sleepCountdown() - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Returns the delay before the next sleep period.
- get_slot() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_slotsBitmap() - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
- get_slotsCount() - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Returns the total number of message storage slots on the SIM card.
- get_slotsInUse() - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Returns the number of message storage slots currently in use.
- get_smsc() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_speed() - Method in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
Returns the increments frequency, in Hz.
- get_speed() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns current motor speed, measured in steps per second.
- get_spiMode() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the SPI port communication parameters, as a string such as
"125000,0,msb".
- get_ssid() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns the wireless network name (SSID).
- get_ssid() - Method in class com.yoctopuce.YoctoAPI.YWlanRecord
-
Returns the name of the wireless network (SSID).
- get_ssPolarity() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the SS line polarity.
- get_starterTime() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the duration (in ms) during which the motor is driven at low frequency to help
it start up.
- get_startTime() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns the relative start time of the data stream, measured in seconds.
- get_startTimeUTC() - Method in class com.yoctopuce.YoctoAPI.YDataSet
-
Returns the start time of the dataset, relative to the Jan 1, 1970.
- get_startTimeUTC() - Method in class com.yoctopuce.YoctoAPI.YDataStream
-
Returns the start time of the data stream, relative to the Jan 1, 1970.
- get_startTimeUTC() - Method in class com.yoctopuce.YoctoAPI.YMeasure
-
Returns the start time of the measure, relative to the Jan 1, 1970 UTC
(Unix timestamp).
- get_startTimeUTC_asDate() - Method in class com.yoctopuce.YoctoAPI.YMeasure
-
- get_startupJob() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the job file to use when the device is powered on.
- get_startupJob() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the job file to use when the device is powered on.
- get_startupJob() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the job file to use when the device is powered on.
- get_startupSeq() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the name of the sequence to play when the displayed is powered on.
- get_state() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Returns the state of the relays (A for the idle position, B for the active position).
- get_state() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the state of the watchdog (A for the idle position, B for the active position).
- get_stateAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Returns the state of the relays at device startup (A for the idle position, B for the active
position, UNCHANGED for no change).
- get_stateAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the state of the watchdog at device startup (A for the idle position, B for the active
position, UNCHANGED for no change).
- get_stepping() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the stepping mode used to drive the motor.
- get_stepPos() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the current logical motor position, measured in steps.
- get_subDevices() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns a list of all the modules that are plugged into the current module.
- get_subnetMask() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the subnet mask currently used by the device.
- get_summary() - Method in class com.yoctopuce.YoctoAPI.YDataSet
-
Returns an YMeasure object which summarizes the whole
DataSet.
- get_tCurrRun() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the torque regulation current when the motor is running, measured in mA.
- get_tCurrStop() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the torque regulation current when the motor is stopped, measured in mA.
- get_technology() - Method in class com.yoctopuce.YoctoAPI.YAltitude
-
Returns the technology used by the sesnor to compute
altitude.
- get_tempAvgAdaptRatio() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the averaged temperature update rate, in per mille.
- get_tempAvgAdaptRatio() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the averaged temperature update rate, in per mille.
- get_tempChgAdaptRatio() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the temperature change update rate, in per mille.
- get_tempChgAdaptRatio() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the temperature change update rate, in per mille.
- get_textData() - Method in class com.yoctopuce.YoctoAPI.YSms
-
Returns the content of the message.
- get_time() - Method in class com.yoctopuce.YoctoAPI.YSnoopingRecord
-
- get_timeFrame() - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Returns the time frame used to measure the distance and estimate the measure
reliability.
- get_timeSet() - Method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Returns true if the clock has been set, and false otherwise.
- get_timestamp() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_timeUTC() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns the Unix timestamp for current UTC time, if known.
- get_timingAdvance() - Method in class com.yoctopuce.YoctoAPI.YCellRecord
-
- get_triggerDelay() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the waiting duration before a reset is automatically triggered by the watchdog, in milliseconds.
- get_triggerDuration() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the duration of resets caused by the watchdog, in milliseconds.
- get_txCount() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the total number of bytes transmitted since last reset.
- get_txCount() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the total number of bytes transmitted since last reset.
- get_txCount() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the total number of bytes transmitted since last reset.
- get_txMsgCount() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the total number of messages send since last reset.
- get_txMsgCount() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the total number of messages send since last reset.
- get_txMsgCount() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the total number of messages send since last reset.
- get_unicodeData() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_unit() - Method in class com.yoctopuce.YoctoAPI.YDataSet
-
Returns the measuring unit for the measured value.
- get_unit() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the measuring unit for the measure.
- get_unixTime() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current time in Unix format (number of
seconds elapsed since Jan 1st, 1970).
- get_unixTime() - Method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Returns the current time in Unix format (number of elapsed seconds since Jan 1st, 1970).
- get_upTime() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the number of milliseconds spent since the module was powered on.
- get_url() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the URL used to access the module.
- get_usage() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns the percentage of datalogger memory in use.
- get_usbCurrent() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the current consumed by the module on the USB bus, in milli-amps.
- get_userData() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Returns the value of the userData attribute, as previously stored using method
set_userData.
- get_userData() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_userDataHeader() - Method in class com.yoctopuce.YoctoAPI.YSms
-
- get_userPassword() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns a hash string if a password has been set for "user" user,
or an empty string otherwise.
- get_userVar() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the value previously stored in this attribute.
- get_utcOffset() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the number of seconds between current time and UTC time (time zone).
- get_utcOffset() - Method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Returns the number of seconds between current time and UTC time (time zone).
- get_valueRange() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the physical value range measured by the sensor.
- get_vInt() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the internal voltage, in V.
- get_voltage() - Method in class com.yoctopuce.YoctoAPI.YPowerOutput
-
Returns the voltage on the power output featured by the module.
- get_voltageAtStartUp() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the selected voltage set point at device startup, in V.
- get_voltageAtStartUp() - Method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
Returns the selected voltage output at device startup, in V.
- get_voltageLevel() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the voltage level used on the serial line.
- get_voltageLevel() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the voltage level used on the serial line.
- get_voltageSense() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the output voltage control point.
- get_voltageSetPoint() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the voltage set point, in V.
- get_voltageTransition() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
- get_voltageTransition() - Method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
- get_volume() - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Returns audio input gain, in per cents.
- get_volume() - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Returns audio output volume, in per cents.
- get_volume() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the connected headset volume, in per cents.
- get_volume() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Returns the volume of the signal sent to the buzzer/speaker.
- get_volumeRange() - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Returns the supported volume range.
- get_volumeRange() - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Returns the supported volume range.
- get_wakeUpReason() - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Returns the latest wake up reason.
- get_wakeUpState() - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Returns the current state of the monitor.
- get_weekDays() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the days of the week scheduled for wake up.
- get_wlanConfig() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
- get_wlanState() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns the current state of the wireless interface.
- get_wwwWatchdogDelay() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the allowed downtime of the WWW link (in seconds) before triggering an automated
reboot to try to recover Internet connectivity.
- get_xValue() - Method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Returns the X component of the acceleration, as a floating point number.
- get_xValue() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Returns the angular velocity around the X axis of the device, as a floating point number.
- get_xValue() - Method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Returns the X component of the magnetic field, as a floating point number.
- get_yValue() - Method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Returns the Y component of the acceleration, as a floating point number.
- get_yValue() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Returns the angular velocity around the Y axis of the device, as a floating point number.
- get_yValue() - Method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Returns the Y component of the magnetic field, as a floating point number.
- get_zeroTracking() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the zero tracking threshold value.
- get_zeroTracking() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the zero tracking threshold value.
- get_zValue() - Method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Returns the Z component of the acceleration, as a floating point number.
- get_zValue() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Returns the angular velocity around the Z axis of the device, as a floating point number.
- get_zValue() - Method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Returns the Z component of the magnetic field, as a floating point number.
- getAbcPeriod() - Method in class com.yoctopuce.YoctoAPI.YCarbonDioxide
-
Returns the Automatic Baseline Calibration period, in hours.
- getAbsHum() - Method in class com.yoctopuce.YoctoAPI.YHumidity
-
Returns the current absolute humidity, in grams per cubic meter of air.
- getActiveLedCount() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns the number of LEDs currently handled by the device.
- getAdminPassword() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns a hash string if a password has been set for user "admin",
or an empty string otherwise.
- getAdvertisedValue() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Returns a short string representing the current state of the function.
- getAdvMode() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the measuring mode used for the advertised value pushed to the parent hub.
- getAirplaneMode() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns true if the airplane mode is active (radio turned off).
- GetAllBootLoaders() - Static method in class com.yoctopuce.YoctoAPI.YFirmwareUpdate
-
Returns a list of all the modules in "firmware update" mode.
- GetAllBootLoadersInContext(YAPIContext) - Static method in class com.yoctopuce.YoctoAPI.YFirmwareUpdate
-
Returns a list of all the modules in "firmware update" mode.
- getAltitude() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current altitude.
- getAnalogCalibration() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Tells if a calibration process is currently ongoing.
- GetAPIVersion() - Static method in class com.yoctopuce.YoctoAPI.YAPI
-
Returns the version identifier for the Yoctopuce library in use.
- GetAPIVersion() - Static method in class com.yoctopuce.YoctoAPI.YAPIContext
-
Returns the version identifier for the Yoctopuce library in use.
- getAPIVersion() - Static method in class com.yoctopuce.YoctoAPI.YJniWrapper
-
- getApn() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the Access Point Name (APN) to be used, if needed.
- getApnSecret() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns an opaque string if APN authentication parameters have been configured
in the device, or an empty string otherwise.
- getAutoStart() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns the default activation state of the data logger on power up.
- getAutoStart() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the watchdog running state at module power on.
- getAuxSignal() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the current value of the signal generated on the auxiliary output.
- getBandwidth() - Method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- getBandwidth() - Method in class com.yoctopuce.YoctoAPI.YCompass
-
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- getBandwidth() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- getBandwidth() - Method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- getBandwidth() - Method in class com.yoctopuce.YoctoAPI.YTilt
-
Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- getBaudRate() - Method in class com.yoctopuce.YoctoAPI.YHubPort
-
Returns the current baud rate used by this Yocto-hub port, in kbps.
- getBeacon() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the state of the localization beacon.
- getBeaconDriven() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns true if the data logger is synchronised with the localization beacon.
- getBearing() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Returns the reference bearing used by the compass.
- getBlinking() - Method in class com.yoctopuce.YoctoAPI.YLed
-
Returns the current LED signaling mode.
- getBlinkSeqMaxCount() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns the maximum number of sequences that the device can handle.
- getBlinkSeqMaxSize() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Returns the maximum length of the blinking sequence.
- getBlinkSeqMaxSize() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns the maximum length of sequences.
- getBlinkSeqSignature() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Return the blinking sequence signature.
- getBlinkSeqSize() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Returns the current length of the blinking sequence.
- getBootloaders() - Static method in class com.yoctopuce.YoctoAPI.YJniWrapper
-
- getBrakingForce() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the braking force applied to the motor, as a percentage.
- getBrightness() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the luminosity of the module informative LEDs (from 0 to 100).
- getBynZone(int) - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- GetCacheValidity() - Static method in class com.yoctopuce.YoctoAPI.YAPI
-
Returns the validity period of the data loaded by the library.
- GetCacheValidity() - Method in class com.yoctopuce.YoctoAPI.YAPIContext
-
Returns the validity period of the data loaded by the library.
- getCalibratedValue() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the current calibrated input value (between 0 and 1000, included).
- getCalibrationMax() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the maximal value measured during the calibration (between 0 and 4095, included).
- getCalibrationMin() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the minimal value measured during the calibration (between 0 and 4095, included).
- getCallbackCredentials() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns a hashed version of the notification callback credentials if set,
or an empty string otherwise.
- getCallbackEncoding() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the encoding standard to use for representing notification values.
- getCallbackInitialDelay() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the initial waiting time before first callback notifications, in seconds.
- getCallbackMaxDelay() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the waiting time between two HTTP callbacks when there is nothing new.
- getCallbackMethod() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the HTTP method used to notify callbacks for significant state changes.
- getCallbackMinDelay() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the minimum waiting time between two HTTP callbacks, in seconds.
- getCallbackSchedule() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the HTTP callback schedule strategy, as a text string.
- getCallbackUrl() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the callback URL to notify of significant state changes.
- getCellCount() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the number of load cells in use.
- getCellIdentifier() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the unique identifier of the cellular antenna in use: MCC, MNC, LAC and Cell ID.
- getCellOperator() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the name of the cell operator currently in use.
- getCellType() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Active cellular connection type.
- getChannel() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns the 802.11 channel currently used, or 0 when the selected network has not been found.
- getChildCount() - Method in class com.yoctopuce.YoctoAPI.YDaisyChain
-
Returns the number of child nodes currently detected.
- getCompensation() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the current current thermal compensation value.
- getCompensation() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the current current thermal compensation value.
- getCompTempAvg() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the current averaged temperature, used for thermal compensation.
- getCompTempAvg() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the current averaged temperature, used for thermal compensation.
- getCompTempChg() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the current temperature variation, used for thermal compensation.
- getCompTempChg() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the current temperature variation, used for thermal compensation.
- getConstellation() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the the satellites constellation used to compute
positioning data.
- getCoordSystem() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the representation system used for positioning data.
- getCosPhi() - Method in class com.yoctopuce.YoctoAPI.YPower
-
Returns the power factor (the ratio between the real power consumed,
measured in W, and the apparent power provided, measured in VA).
- getCountdown() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Returns the number of milliseconds remaining before a pulse (delayedPulse() call)
When there is no scheduled pulse, returns zero.
- getCountdown() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the number of milliseconds remaining before a pulse (delayedPulse() call)
When there is no scheduled pulse, returns zero.
- getCurrent() - Method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Returns the loop current set point in mA.
- getCurrentAtStartUp() - Method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Returns the current in the loop at device startup, in mA.
- getCurrentAtStartUp() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the selected current limit at device startup, in mA.
- getCurrentJob() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the name of the job file currently in use.
- getCurrentJob() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the name of the job file currently in use.
- getCurrentJob() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the name of the job file currently in use.
- getCurrentLimit() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the current limit, in mA.
- getCurrentRawValue() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the uncalibrated, unrounded raw value returned by the
sensor, in the specified unit, as a floating point number.
- getCurrentRunIndex() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns the current run number, corresponding to the number of times the module was
powered on with the dataLogger enabled at some point.
- getCurrentTemperature() - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Returns the current sensor temperature, as a floating point number.
- getCurrentValue() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the current value of the measure, in the specified unit, as a floating point number.
- getCurrentVoltage() - Method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
Returns the output voltage set point, in V.
- getCutOffVoltage() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the threshold voltage under which the controller automatically switches to error state
and prevents further current draw.
- getDaisyState() - Method in class com.yoctopuce.YoctoAPI.YDaisyChain
-
Returns the state of the daisy-link between modules.
- getData(Integer, Integer) - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Internal function to retrieve datalogger memory
- getData() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getDataReceived() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the number of bytes received so far.
- getDataSent() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the number of bytes sent so far.
- getDateTime() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current time in the form "YYYY/MM/DD hh:mm:ss".
- getDateTime() - Method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Returns the current time in the form "YYYY/MM/DD hh:mm:ss".
- getDebouncePeriod() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the shortest expected pulse duration, in ms.
- getDecoding() - Method in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
Returns the current activation state of the quadrature decoder.
- getDefaultPage() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the HTML page to serve for the URL "/"" of the hub.
- getDescription() - Method in class com.yoctopuce.YoctoAPI.YArithmeticSensor
-
Returns a short informative description of the formula.
- getDetectionHysteresis() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the hysteresis used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
- getDetectionThreshold() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the threshold used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
- GetDeviceListValidity() - Static method in class com.yoctopuce.YoctoAPI.YAPI
-
Returns the delay between each forced enumeration of the used YoctoHubs.
- GetDeviceListValidity() - Method in class com.yoctopuce.YoctoAPI.YAPIContext
-
Returns the delay between each forced enumeration of the used YoctoHubs.
- getDiags() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the stepper motor controller diagnostics, as a bitmap.
- getDilution() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current horizontal dilution of precision,
the smaller that number is, the better .
- getDirection() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current move bearing in degrees, zero
is the true (geographic) north.
- getDiscoverable() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the activation state of the multicast announce protocols to allow easy
discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
- getDisplayedText() - Method in class com.yoctopuce.YoctoAPI.YSegmentedDisplay
-
Returns the text currently displayed on the screen.
- getDisplayHeight() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the display height, in pixels.
- getDisplayType() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the display type: monochrome, gray levels or full color.
- getDisplayWidth() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the display width, in pixels.
- getDrivingForce() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the power sent to the motor, as a percentage between -100% and +100%.
- getDutyCycle() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the PWM duty cycle, in per cents.
- getDutyCycle() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the PWM duty cycle, in per cents.
- getDutyCycleAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the PWMs duty cycle at device power on as a floating point number between 0 and 100.
- getEnabled() - Method in class com.yoctopuce.YoctoAPI.YCurrent
-
Returns the activation state of this input.
- getEnabled() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns true if the screen is powered, false otherwise.
- getEnabled() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the activation state of this input.
- getEnabled() - Method in class com.yoctopuce.YoctoAPI.YHubPort
-
Returns true if the Yocto-hub port is powered, false otherwise.
- getEnabled() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the state of the PWMs.
- getEnabled() - Method in class com.yoctopuce.YoctoAPI.YServo
-
Returns the state of the servos.
- getEnabled() - Method in class com.yoctopuce.YoctoAPI.YVoltage
-
Returns the activation state of this input.
- getEnableData() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the condition for enabling IP data services (GPRS).
- getEnabledAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the state of the PWM at device power on.
- getEnabledAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YServo
-
Returns the servo signal generator state at power up.
- getErrCount() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the total number of communication errors detected since last reset.
- getErrCount() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the total number of communication errors detected since last reset.
- getErrCount() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the total number of communication errors detected since last reset.
- getErrorMessage() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
- getErrorType() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
- getExcitation() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the current load cell bridge excitation method.
- getExcitation() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the current load cell bridge excitation method.
- getExtVoltage() - Method in class com.yoctopuce.YoctoAPI.YDualPower
-
Returns the measured voltage on the external power source, in millivolts.
- getFailSafeTimeout() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the delay in milliseconds allowed for the controller to run autonomously without
receiving any instruction from the control process.
- getFilesCount() - Method in class com.yoctopuce.YoctoAPI.YFiles
-
Returns the number of files currently loaded in the filesystem.
- getFirmwareRelease() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getFirmwareRelease() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the version of the firmware embedded in the module.
- getFirmwareReleaseAsInt() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getFirstZoneOfs() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getFLA_nb_zone() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getFLA_total_size() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getFreeSpace() - Method in class com.yoctopuce.YoctoAPI.YFiles
-
Returns the free space for uploading new files to the filesystem, in bytes.
- getFrequency() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Returns the frequency of the signal sent to the buzzer/speaker.
- getFrequency() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the PWM frequency used to control the motor.
- getFrequency() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the PWM frequency in Hz.
- getFrequency() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the PWM frequency in Hz.
- getFriendlyName() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
- getFunctionDescriptor() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
- getFunctionId() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
- getFusionMode() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Returns the BNO055 fusion mode.
- getGlobalState() - Method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
Returns the stepper motor set overall state.
- getGroundSpeed() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current ground speed in Km/h.
- getHardwareId() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
- getHighestValue() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the maximal value observed for the measure since the device was started.
- getHours() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the hours scheduled for wake up.
- getHslColor() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Returns the current HSL color of the LED.
- getHttpPort() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the HTML page to serve for the URL "/"" of the hub.
- getI2cMode() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the SPI port communication parameters, as a string such as
"400kbps,2000ms,NoRestart".
- getI2cVoltageLevel() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the voltage level used on the I2C bus.
- getImsi() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
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.
- getInputVoltage() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the measured input voltage, in V.
- getIpAddress() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the IP address currently in use by the device.
- getIpConfig() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the IP configuration of the network interface.
- getIsFixed() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns TRUE if the receiver has found enough satellites to work.
- getIsPresent() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns true if the input (considered as binary) is active (detection value is smaller than the
specified threshold), and false otherwise.
- getIsPressed() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns true if the input (considered as binary) is active (closed contact), and false otherwise.
- getLastMsg() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the latest message fully received (for Line and Frame protocols).
- getLastMsg() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the latest message fully received (for Line, Frame and Modbus protocols).
- getLastMsg() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the latest message fully received (for Line and Frame protocols).
- getLastTimeApproached() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the number of elapsed milliseconds between the module power on and the last observed
detection (the input contact transitioned from absent to present).
- getLastTimePressed() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
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).
- getLastTimeReleased() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
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).
- getLastTimeRemoved() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the number of elapsed milliseconds between the module power on and the last observed
detection (the input contact transitioned from present to absent).
- getLatitude() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current latitude.
- getLayerCount() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the number of available layers to draw on.
- getLayerHeight() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the height of the layers to draw on, in pixels.
- getLayerWidth() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the width of the layers to draw on, in pixels.
- getLdoTemperature() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the LDO temperature, in Celsius.
- getLedType() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns the RGB LED type currently handled by the device.
- getLinkQuality() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the bluetooth receiver signal strength, in pourcents, or 0 if no connection is established.
- getLinkQuality() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the link quality, expressed in percent.
- getLinkQuality() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns the link quality, expressed in percent.
- getLinkState() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the bluetooth link state.
- getLockedOperator() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
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.
- getLogFrequency() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the datalogger recording frequency for this function, or "OFF"
when measures are not stored in the data logger flash memory.
- getLogicalName() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Returns the logical name of the function.
- getLongitude() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current longitude.
- getLoopPower() - Method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Returns the loop powerstate.
- getLowestValue() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the minimal value observed for the measure since the device was started.
- getLuminosity() - Method in class com.yoctopuce.YoctoAPI.YLed
-
Returns the current LED intensity (in per cent).
- getLuminosity() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the luminosity of the module informative LEDs (from 0 to 100).
- getMacAddress() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the MAC address of the network interface.
- getMagneticHeading() - Method in class com.yoctopuce.YoctoAPI.YCompass
-
Returns the magnetic heading, regardless of the configured bearing.
- getMaintenanceMode() - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Returns true when the device is in maintenance mode.
- getMaxAccel() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the maximal motor acceleration, measured in steps per second^2.
- getMaxLedCount() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Returns the maximum number of LEDs that the device can handle.
- getMaxSensors() - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Returns the maximum configurable sensor count allowed on this device.
- getMaxSpeed() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the maximal motor speed, measured in steps per second.
- getMaxTimeOnStateA() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
- getMaxTimeOnStateA() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
- getMaxTimeOnStateB() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
- getMaxTimeOnStateB() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Retourne the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
- getMeasuredCurrent() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the measured output current, in mA.
- getMeasuredVoltage() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the measured output voltage, in V.
- getMeasureType() - Method in class com.yoctopuce.YoctoAPI.YLightSensor
-
Returns the type of light measure.
- getMessage() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the latest status message from the wireless interface.
- getMessage() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns the latest status message from the wireless interface.
- getMeter() - Method in class com.yoctopuce.YoctoAPI.YPower
-
Returns the energy counter, maintained by the wattmeter by integrating the power consumption over time.
- getMeterTimer() - Method in class com.yoctopuce.YoctoAPI.YPower
-
Returns the elapsed time since last energy counter reset, in seconds.
- getMinutesA() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the minutes in the 00-29 interval of each hour scheduled for wake up.
- getMinutesB() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the minutes in the 30-59 interval of each hour scheduled for wake up.
- getModule() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
- getMonthDays() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the days of the month scheduled for wake up.
- getMonths() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the months scheduled for wake up.
- getMotorState() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the motor working state.
- getMotorStatus() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Return the controller state.
- getMute() - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Returns the state of the mute function.
- getMute() - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Returns the state of the mute function.
- getMute() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the state of the mute function.
- getNAxis() - Method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
Returns the number of synchronized controllers.
- GetNetworkTimeout() - Static method in class com.yoctopuce.YoctoAPI.YAPI
-
Returns the network connection delay for YAPI.RegisterHub() and
YAPI.UpdateDeviceList().
- GetNetworkTimeout() - Method in class com.yoctopuce.YoctoAPI.YAPIContext
-
Returns the network connection delay for YAPI.RegisterHub() and
YAPI.UpdateDeviceList().
- GetNetworkTimeout_internal() - Method in class com.yoctopuce.YoctoAPI.YAPIContext
-
- getNeutral() - Method in class com.yoctopuce.YoctoAPI.YServo
-
Returns the duration in microseconds of a neutral pulse for the servo.
- getNextOccurence() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the date/time (seconds) of the next wake up occurrence.
- getNextWakeUp() - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Returns the next scheduled wake up date/time (UNIX format).
- getNoSignalFor() - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Returns the number of seconds elapsed without detecting a signal.
- getNoSignalFor() - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Returns the number of seconds elapsed without detecting a signal.
- getNSensors() - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Returns the number of sensors to poll.
- getNtpServer() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the IP address of the NTP server to be used by the device.
- getOrientation() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the currently selected display orientation.
- getOutput() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Returns the output state of the relays, when used as a simple switch (single throw).
- getOutput() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the output state of the watchdog, when used as a simple switch (single throw).
- getOutputVoltage() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the voltage source used to drive output bits.
- getOvercurrent() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the overcurrent alert and emergency stop threshold, measured in mA.
- getOverCurrentLimit() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the current threshold (in mA) above which the controller automatically
switches to error state.
- getOwnAddress() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the MAC-48 address of the bluetooth interface, which is unique on the bluetooth network.
- getPairingPin() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
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.
- getPath() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getPduReceived() - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Returns the number of SMS units received so far.
- getPduSent() - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Returns the number of SMS units sent so far.
- getPeriod() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the PWM period in milliseconds.
- getPeriod() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the PWM period in milliseconds.
- getPersistentSettings() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the current state of persistent module settings.
- getPictype() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getPin() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
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.
- getPingInterval() - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the automated connectivity check interval, in seconds.
- getPlaySeqMaxSize() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Returns the maximum length of the playing sequence.
- getPlaySeqSignature() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Returns the playing sequence signature.
- getPlaySeqSize() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Returns the current length of the playing sequence.
- getPoeCurrent() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the current consumed by the module from Power-over-Ethernet (PoE), in milliamps.
- getPortDiags() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the port state diagnostics (Yocto-IO and Yocto-MaxiIO-V2 only).
- getPortDirection() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the IO direction of all bits (i.e.
- getPortOpenDrain() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the electrical interface for each bit of the port.
- getPortPolarity() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the polarity of all the bits of the port.
- getPortSize() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Returns the number of bits (i.e.
- getPortState() - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
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...
- getPortState() - Method in class com.yoctopuce.YoctoAPI.YHubPort
-
Returns the current state of the Yocto-hub port.
- getPosition() - Method in class com.yoctopuce.YoctoAPI.YServo
-
Returns the current servo position.
- getPositionAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YServo
-
Returns the servo position at device power up.
- getPower() - Method in class com.yoctopuce.YoctoAPI.YLed
-
Returns the current LED state.
- getPowerControl() - Method in class com.yoctopuce.YoctoAPI.YDualPower
-
Returns the selected power source for module functions that require lots of current.
- getPowerDuration() - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Returns the maximal wake up time (in seconds) before automatically going to sleep.
- getPowerMode() - Method in class com.yoctopuce.YoctoAPI.YPwmPowerSource
-
Returns the selected power source for the PWM on the same device.
- getPowerOutput() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the power supply output switch state.
- getPowerState() - Method in class com.yoctopuce.YoctoAPI.YDualPower
-
Returns the current power source for module functions that require lots of current.
- getPreAmplifier() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the audio pre-amplifier volume, in per cents.
- getPresenceMinTime() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the minimal detection duration before signalling a presence event.
- getPrimaryDNS() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the IP address of the primary name server to be used by the module.
- getProduct() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getProductId() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the USB device identifier of the module.
- getProductName() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the commercial name of the module, as set by the factory.
- getProductRelease() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the release number of the module hardware, preprogrammed at the factory.
- getProg_version() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getProtocol() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the type of protocol used to send I2C messages, as a string.
- getProtocol() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the type of protocol used over the serial line, as a string.
- getProtocol() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the type of protocol used over the serial line, as a string.
- getProximityReportMode() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the parameter (sensor value, presence or pulse count) returned by the get_currentValue
function and callbacks.
- getPullinSpeed() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the motor speed immediately reachable from stop state, measured in steps per second.
- getPulseCounter() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the pulse counter value.
- getPulseCounter() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the pulse counter value.
- getPulseCounter() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the pulse counter value.
- getPulseDuration() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the PWM pulse length in milliseconds, as a floating point number.
- getPulseDuration() - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Returns the PWM pulse length in milliseconds, as a floating point number.
- getPulseTimer() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the timer of the pulses counter (ms).
- getPulseTimer() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the timer of the pulse counter (ms).
- getPulseTimer() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the timer of the pulses counter (ms).
- getPulseTimer() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Returns the number of milliseconds remaining before the relays is returned to idle position
(state A), during a measured pulse generation.
- getPulseTimer() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the number of milliseconds remaining before the watchdog is returned to idle position
(state A), during a measured pulse generation.
- getPwmReportMode() - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Returns the parameter (frequency/duty cycle, pulse width, edges count) returned by the
get_currentValue function and callbacks.
- getQnh() - Method in class com.yoctopuce.YoctoAPI.YAltitude
-
Returns the barometric pressure adjusted to sea level used to compute
the altitude (QNH).
- getQuality() - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Returns a measure quality estimate, based on measured dispersion.
- getRange() - Method in class com.yoctopuce.YoctoAPI.YServo
-
Returns the current range of use of the servo.
- getRangeFinderMode() - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Returns the range finder running mode.
- getRawValue() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the current measured input value as-is (between 0 and 4095, included).
- getReadiness() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the current established working mode of the network interface.
- getRebootCountdown() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the remaining number of seconds before the module restarts, or zero when no
reboot has been scheduled.
- getRecording() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns the current activation state of the data logger.
- getRelHum() - Method in class com.yoctopuce.YoctoAPI.YHumidity
-
Returns the current relative humidity, in per cents.
- getRemoteAddress() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the MAC-48 address of the remote device to connect to.
- getRemoteName() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the bluetooth name the remote device, if found on the bluetooth network.
- getRemovalMinTime() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the minimal detection duration before signalling a removal event.
- getReportFrequency() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the timed value notification frequency, or "OFF" if timed
value notifications are disabled for this function.
- getRequiredChildCount() - Method in class com.yoctopuce.YoctoAPI.YDaisyChain
-
Returns the number of child nodes expected in normal conditions.
- getResolution() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the resolution of the measured values.
- getRgbColor() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Returns the current RGB color of the LED.
- getRgbColorAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Returns the configured color to be displayed when the module is turned on.
- getROM_nb_zone() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getROM_total_size() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getRouter() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the IP address of the router on the device subnet (default gateway).
- getRunning() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the watchdog running state.
- getRxCount() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the total number of bytes received since last reset.
- getRxCount() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the total number of bytes received since last reset.
- getRxCount() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the total number of bytes received since last reset.
- getRxMsgCount() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the total number of messages received since last reset.
- getRxMsgCount() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the total number of messages received since last reset.
- getRxMsgCount() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the total number of messages received since last reset.
- getSatCount() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the count of visible satellites.
- getSecondaryDNS() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the IP address of the secondary name server to be used by the module.
- getSecurity() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns the security algorithm used by the selected wireless network.
- getSensitivity() - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Returns the sensibility for the input (between 1 and 1000) for triggering user callbacks.
- getSensorState() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
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.
- getSensorType() - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
Returns the temperature sensor type.
- getSerial() - Method in class com.yoctopuce.YoctoAPI.YFirmwareFile
-
- getSerialMode() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the serial port communication parameters, as a string such as
"9600,8N1".
- getSerialNumber() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the serial number of the module, as set by the factory.
- getShiftSampling() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns true when the SDI line phase is shifted with regards to the SDO line.
- getShutdownCountdown() - Method in class com.yoctopuce.YoctoAPI.YOsControl
-
Returns the remaining number of seconds before the OS shutdown, or zero when no
shutdown has been scheduled.
- getSignal() - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Returns the detected input signal level.
- getSignal() - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Returns the detected output current level.
- getSignalBias() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the electric signal bias for zero shift adjustment.
- getSignalRange() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the electric signal range used by the sensor.
- getSignalSampling() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the electric signal sampling method to use.
- getSignalUnit() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the measuring unit of the electrical signal used by the sensor.
- getSignalUnit() - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
Returns the measuring unit of the electrical signal used by the sensor.
- getSignalValue() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the current value of the electrical signal measured by the sensor.
- getSignalValue() - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Returns the current value of signal measured by the proximity sensor.
- getSignalValue() - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
Returns the current value of the electrical signal measured by the sensor.
- getSleepCountdown() - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Returns the delay before the next sleep period.
- getSlotsCount() - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Returns the total number of message storage slots on the SIM card.
- getSlotsInUse() - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Returns the number of message storage slots currently in use.
- getSpeed() - Method in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
Returns the increments frequency, in Hz.
- getSpeed() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns current motor speed, measured in steps per second.
- getSpiMode() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the SPI port communication parameters, as a string such as
"125000,0,msb".
- getSsid() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns the wireless network name (SSID).
- getSsPolarity() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the SS line polarity.
- getStackTraceToString() - Method in exception com.yoctopuce.YoctoAPI.YAPI_Exception
-
- getStarterTime() - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Returns the duration (in ms) during which the motor is driven at low frequency to help
it start up.
- getStartupJob() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the job file to use when the device is powered on.
- getStartupJob() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the job file to use when the device is powered on.
- getStartupJob() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the job file to use when the device is powered on.
- getStartupSeq() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Returns the name of the sequence to play when the displayed is powered on.
- getState() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Returns the state of the relays (A for the idle position, B for the active position).
- getState() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the state of the watchdog (A for the idle position, B for the active position).
- getStateAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Returns the state of the relays at device startup (A for the idle position, B for the active
position, UNCHANGED for no change).
- getStateAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the state of the watchdog at device startup (A for the idle position, B for the active
position, UNCHANGED for no change).
- getStepping() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the stepping mode used to drive the motor.
- getStepPos() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the current logical motor position, measured in steps.
- getSubnetMask() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the subnet mask currently used by the device.
- getTCurrRun() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the torque regulation current when the motor is running, measured in mA.
- getTCurrStop() - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Returns the torque regulation current when the motor is stopped, measured in mA.
- getTechnology() - Method in class com.yoctopuce.YoctoAPI.YAltitude
-
Returns the technology used by the sesnor to compute
altitude.
- getTempAvgAdaptRatio() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the averaged temperature update rate, in per mille.
- getTempAvgAdaptRatio() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the averaged temperature update rate, in per mille.
- getTempChgAdaptRatio() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the temperature change update rate, in per mille.
- getTempChgAdaptRatio() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the temperature change update rate, in per mille.
- getThreadLabel() - Method in interface com.yoctopuce.YoctoAPI.WSHandlerInterface
-
- getThreadLabel() - Method in class com.yoctopuce.YoctoAPI.WSHandlerJEE
-
- GetTickCount() - Static method in class com.yoctopuce.YoctoAPI.YAPI
-
Returns the current value of a monotone millisecond-based time counter.
- GetTickCount() - Static method in class com.yoctopuce.YoctoAPI.YAPIContext
-
Returns the current value of a monotone millisecond-based time counter.
- getTimeFrame() - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Returns the time frame used to measure the distance and estimate the measure
reliability.
- getTimeSet() - Method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Returns true if the clock has been set, and false otherwise.
- getTimeUTC() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns the Unix timestamp for current UTC time, if known.
- getTriggerDelay() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the waiting duration before a reset is automatically triggered by the watchdog, in milliseconds.
- getTriggerDuration() - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Returns the duration of resets caused by the watchdog, in milliseconds.
- getTxCount() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the total number of bytes transmitted since last reset.
- getTxCount() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the total number of bytes transmitted since last reset.
- getTxCount() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the total number of bytes transmitted since last reset.
- getTxMsgCount() - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Returns the total number of messages send since last reset.
- getTxMsgCount() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the total number of messages send since last reset.
- getTxMsgCount() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the total number of messages send since last reset.
- getUnit() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Returns the measuring unit for the measure.
- getUnixTime() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the current time in Unix format (number of
seconds elapsed since Jan 1st, 1970).
- getUnixTime() - Method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Returns the current time in Unix format (number of elapsed seconds since Jan 1st, 1970).
- getUpTime() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the number of milliseconds spent since the module was powered on.
- getUsage() - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Returns the percentage of datalogger memory in use.
- getUsbCurrent() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the current consumed by the module on the USB bus, in milli-amps.
- getUserData() - Method in class com.yoctopuce.YoctoAPI.YFunction
-
- getUserPassword() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns a hash string if a password has been set for "user" user,
or an empty string otherwise.
- getUserVar() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Returns the value previously stored in this attribute.
- getUtcOffset() - Method in class com.yoctopuce.YoctoAPI.YGps
-
Returns the number of seconds between current time and UTC time (time zone).
- getUtcOffset() - Method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Returns the number of seconds between current time and UTC time (time zone).
- getValueRange() - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Returns the physical value range measured by the sensor.
- getVInt() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the internal voltage, in V.
- getVoltage() - Method in class com.yoctopuce.YoctoAPI.YPowerOutput
-
Returns the voltage on the power output featured by the module.
- getVoltageAtStartUp() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the selected voltage set point at device startup, in V.
- getVoltageAtStartUp() - Method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
Returns the selected voltage output at device startup, in V.
- getVoltageLevel() - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Returns the voltage level used on the serial line.
- getVoltageLevel() - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Returns the voltage level used on the serial line.
- getVoltageSense() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the output voltage control point.
- getVoltageSetPoint() - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Returns the voltage set point, in V.
- getVolume() - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Returns audio input gain, in per cents.
- getVolume() - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Returns audio output volume, in per cents.
- getVolume() - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Returns the connected headset volume, in per cents.
- getVolume() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Returns the volume of the signal sent to the buzzer/speaker.
- getVolumeRange() - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Returns the supported volume range.
- getVolumeRange() - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Returns the supported volume range.
- getWakeUpReason() - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Returns the latest wake up reason.
- getWakeUpState() - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Returns the current state of the monitor.
- getWeekDays() - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Returns the days of the week scheduled for wake up.
- getWlanState() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Returns the current state of the wireless interface.
- getWwwWatchdogDelay() - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Returns the allowed downtime of the WWW link (in seconds) before triggering an automated
reboot to try to recover Internet connectivity.
- getXValue() - Method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Returns the X component of the acceleration, as a floating point number.
- getXValue() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Returns the angular velocity around the X axis of the device, as a floating point number.
- getXValue() - Method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Returns the X component of the magnetic field, as a floating point number.
- getYValue() - Method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Returns the Y component of the acceleration, as a floating point number.
- getYValue() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Returns the angular velocity around the Y axis of the device, as a floating point number.
- getYValue() - Method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Returns the Y component of the magnetic field, as a floating point number.
- getZeroTracking() - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Returns the zero tracking threshold value.
- getZeroTracking() - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Returns the zero tracking threshold value.
- getZValue() - Method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Returns the Z component of the acceleration, as a floating point number.
- getZValue() - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Returns the angular velocity around the Z axis of the device, as a floating point number.
- getZValue() - Method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Returns the Z component of the magnetic field, as a floating point number.
- GLOBALSTATE_ABSENT - Static variable in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
invalid globalState value
- GLOBALSTATE_ALERT - Static variable in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
- GLOBALSTATE_BATCH - Static variable in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
- GLOBALSTATE_HI_Z - Static variable in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
- GLOBALSTATE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
- GLOBALSTATE_RUN - Static variable in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
- GLOBALSTATE_STOP - Static variable in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
- GRAVITYCANCELLATION_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YAccelerometer
-
- GRAVITYCANCELLATION_OFF - Static variable in class com.yoctopuce.YoctoAPI.YAccelerometer
-
invalid gravityCancellation value
- GRAVITYCANCELLATION_ON - Static variable in class com.yoctopuce.YoctoAPI.YAccelerometer
-
- GROUNDSPEED_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YGps
-
invalid groundSpeed value
- gsm2str(byte[]) - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
- gsm2unicode(byte[]) - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
- SATCOUNT_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YGps
-
invalid satCount value
- save3DCalibration() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Applies the sensors tridimensional calibration parameters that have just been computed.
- save3DCalibrationV1() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
- save3DCalibrationV2() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
- saveBlinkSeq(int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Saves the definition of a sequence.
- saveLedsConfigAtPowerOn() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Saves the LEDs power-on configuration.
- saveLedsState() - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
- savePlaySeq() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Saves the preprogrammed playing sequence to flash memory.
- saveSequence(String) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Stops recording display commands and saves the sequence into the specified
file on the display internal memory.
- saveToFlash() - Method in class com.yoctopuce.YoctoAPI.YModule
-
Saves current settings in the nonvolatile memory of the module.
- SECONDARYDNS_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YNetwork
-
invalid secondaryDNS value
- SECURITY_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YWireless
-
- SECURITY_OPEN - Static variable in class com.yoctopuce.YoctoAPI.YWireless
-
- SECURITY_UNKNOWN - Static variable in class com.yoctopuce.YoctoAPI.YWireless
-
invalid security value
- SECURITY_WEP - Static variable in class com.yoctopuce.YoctoAPI.YWireless
-
- SECURITY_WPA - Static variable in class com.yoctopuce.YoctoAPI.YWireless
-
- SECURITY_WPA2 - Static variable in class com.yoctopuce.YoctoAPI.YWireless
-
- selectColorPen(int) - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Selects the pen color for all subsequent drawing functions,
including text drawing.
- selectEraser() - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Selects an eraser instead of a pen for all subsequent drawing functions,
except for bitmap copy functions.
- selectFont(String) - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Selects a font to use for the next text drawing functions, by providing the name of the
font file.
- selectGrayPen(int) - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Selects the pen gray level for all subsequent drawing functions,
including text drawing.
- selectJob(String) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Load and start processing the specified job file.
- selectJob(String) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Load and start processing the specified job file.
- selectJob(String) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Load and start processing the specified job file.
- send() - Method in class com.yoctopuce.YoctoAPI.YSms
-
Sends the SMS to the recipient.
- sendBinary(ByteBuffer, boolean) - Method in interface com.yoctopuce.YoctoAPI.WSHandlerInterface
-
- sendBinary(ByteBuffer, boolean) - Method in class com.yoctopuce.YoctoAPI.WSHandlerJEE
-
- sendCommand(String) - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
- sendCommand(String) - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
- sendCommand(String) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
- sendCommand(String) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
- sendCommand(String) - Method in class com.yoctopuce.YoctoAPI.YFiles
-
- sendCommand(String) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
- sendCommand(String) - Method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
- sendCommand(String) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
- sendCommand(String) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
- sendCommand(String) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
- sendFlashMessage(String, String) - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Sends a Flash SMS (class 0 message).
- sendPUK(String, String) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Sends a PUK code to unlock the SIM card after three failed PIN code attempts, and
setup a new PIN into the SIM card.
- sendTextMessage(String, String) - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Sends a regular text SMS, with standard parameters.
- SENSITIVITY_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YAnButton
-
invalid sensitivity value
- SENSORSTATE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YSensor
-
invalid sensorState value
- SENSORTYPE_DIGITAL - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
invalid sensorType value
- SENSORTYPE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_IR - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_PT100_2WIRES - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_PT100_3WIRES - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_PT100_4WIRES - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_RES_INTERNAL - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_RES_LINEAR - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_RES_NTC - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_RES_OHM - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_RES_PT1000 - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_TYPE_E - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_TYPE_J - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_TYPE_K - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_TYPE_N - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_TYPE_R - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_TYPE_S - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SENSORTYPE_TYPE_T - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
- SERIALMODE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YSerialPort
-
invalid serialMode value
- SERIALNUMBER_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YModule
-
invalid serialNumber value
- set_abcPeriod(int) - Method in class com.yoctopuce.YoctoAPI.YCarbonDioxide
-
Changes Automatic Baseline Calibration period, in hours.
- set_activeLedCount(int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Changes the number of LEDs currently handled by the device.
- set_adminPassword(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the password for the "admin" user.
- set_advertisedValue(String) - Method in class com.yoctopuce.YoctoAPI.YFunction
-
- set_advMode(int) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Changes the measuring mode used for the advertised value pushed to the parent hub.
- set_airplaneMode(int) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the activation state of airplane mode (radio turned off).
- set_alertMode(String) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
- set_allSettings(byte[]) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Restores all the settings of the device.
- set_allSettingsAndFiles(byte[]) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Restores all the settings and uploaded files to the module.
- set_alphabet(int) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_analogCalibration(int) - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Starts or stops the calibration process.
- set_apn(String) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the Access Point Name (APN) to be used, if needed.
- set_apnAuth(String, String) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Configure authentication parameters to connect to the APN.
- set_apnSecret(String) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
- set_autoStart(int) - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Changes the default activation state of the data logger on power up.
- set_autoStart(int) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Changes the watchdog running state at module power on.
- set_auxMode(String) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
- set_auxSignal(int) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the value of the signal generated on the auxiliary output.
- set_bandwidth(int) - Method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- set_bandwidth(int) - Method in class com.yoctopuce.YoctoAPI.YCompass
-
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- set_bandwidth(int) - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- set_bandwidth(int) - Method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- set_bandwidth(int) - Method in class com.yoctopuce.YoctoAPI.YTilt
-
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- set_beacon(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Turns on or off the module localization beacon.
- set_beaconDriven(int) - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Changes the type of synchronisation of the data logger.
- set_bearing(double) - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Changes the reference bearing used by the compass.
- set_bitDirection(int, int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Changes the direction of a single bit (i.e.
- set_bitOpenDrain(int, int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Changes the electrical interface of a single bit from the I/O port.
- set_bitPolarity(int, int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Changes the polarity of a single bit from the I/O port.
- set_bitState(int, int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Sets a single bit (i.e.
- set_blinking(int) - Method in class com.yoctopuce.YoctoAPI.YLed
-
Changes the current LED signaling mode.
- set_blinkSeqSpeed(int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Changes the execution speed of a sequence.
- set_blinkSeqStateAtPowerOn(int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Configures a sequence to make it start automatically at device
startup.
- set_brakingForce(double) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes immediately the braking force applied to the motor (in percents).
- set_brightness(int) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Changes the brightness of the display.
- set_calibrationMax(int) - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Changes the maximal calibration value for the input (between 0 and 4095, included), without actually
starting the automated calibration.
- set_calibrationMin(int) - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Changes the minimal calibration value for the input (between 0 and 4095, included), without actually
starting the automated calibration.
- set_calibrationParam(String) - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
- set_calibrationParam(String) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
- set_callbackCredentials(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the credentials required to connect to the callback address.
- set_callbackEncoding(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the encoding standard to use for representing notification values.
- set_callbackInitialDelay(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the initial waiting time before first callback notifications, in seconds.
- set_callbackMaxDelay(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the waiting time between two HTTP callbacks when there is nothing new.
- set_callbackMethod(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the HTTP method used to notify callbacks for significant state changes.
- set_callbackMinDelay(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the minimum waiting time between two HTTP callbacks, in seconds.
- set_callbackSchedule(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the HTTP callback schedule strategy, as a text string.
- set_callbackUrl(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the callback URL to notify significant state changes.
- set_cellCount(int) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Changes the number of load cells in use.
- set_clearHistory(int) - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YArithmeticSensor
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YCarbonDioxide
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YGps
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
- set_command(String) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
- set_constellation(int) - Method in class com.yoctopuce.YoctoAPI.YGps
-
Changes the satellites constellation used to compute
positioning data.
- set_coordSystem(int) - Method in class com.yoctopuce.YoctoAPI.YGps
-
Changes the representation system used for positioning data.
- set_current(double) - Method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Changes the current loop, the valid range is from 3 to 21mA.
- set_currentAtStartUp(double) - Method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Changes the loop current at device start up.
- set_currentAtStartUp(double) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Changes the current limit at device start up.
- set_currentJob(String) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Selects a job file to run immediately.
- set_currentJob(String) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Selects a job file to run immediately.
- set_currentJob(String) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Selects a job file to run immediately.
- set_currentLimit(double) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Changes the current limit, in mA.
- set_currentTransition(String) - Method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
- set_currentValue(double) - Method in class com.yoctopuce.YoctoAPI.YAltitude
-
Changes the current estimated altitude.
- set_currentValue(double) - Method in class com.yoctopuce.YoctoAPI.YLightSensor
-
- set_currentValue(double) - Method in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
Changes the current expected position of the quadrature decoder.
- set_currentVoltage(double) - Method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
Changes the output voltage, in V.
- set_cutOffVoltage(double) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes the threshold voltage under which the controller automatically switches to error state
and prevents further current draw.
- set_dataReceived(int) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the value of the incoming data counter.
- set_dataSent(int) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the value of the outgoing data counter.
- set_dcs(int) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_debouncePeriod(int) - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Changes the shortest expected pulse duration, in ms.
- set_decoding(int) - Method in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
Changes the activation state of the quadrature decoder.
- set_defaultPage(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the default HTML page returned by the hub.
- set_delayedPulseTimer(YRelay.YDelayedPulse) - Method in class com.yoctopuce.YoctoAPI.YRelay
-
- set_delayedPulseTimer(YWatchdog.YDelayedPulse) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
- set_detectionHysteresis(int) - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Changes the hysteresis used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
- set_detectionThreshold(int) - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Changes the threshold used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
- set_discoverable(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the activation state of the multicast announce protocols to allow easy
discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
- set_displayedText(String) - Method in class com.yoctopuce.YoctoAPI.YSegmentedDisplay
-
Changes the text currently displayed on the screen.
- set_displayMode(int) - Method in class com.yoctopuce.YoctoAPI.YSegmentedDisplay
-
- set_drivingForce(double) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes immediately the power sent to the motor.
- set_dutyCycle(double) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Changes the PWM duty cycle, in per cents.
- set_dutyCycleAtPowerOn(double) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Changes the PWM duty cycle at device power on.
- set_enabled(int) - Method in class com.yoctopuce.YoctoAPI.YCurrent
-
Changes the activation state of this input.
- set_enabled(int) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Changes the power state of the display.
- set_enabled(int) - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Changes the activation state of this input.
- set_enabled(int) - Method in class com.yoctopuce.YoctoAPI.YHubPort
-
Changes the activation of the Yocto-hub port.
- set_enabled(int) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Stops or starts the PWM.
- set_enabled(int) - Method in class com.yoctopuce.YoctoAPI.YServo
-
Stops or starts the servo.
- set_enabled(int) - Method in class com.yoctopuce.YoctoAPI.YVoltage
-
Changes the activation state of this input.
- set_enableData(int) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the condition for enabling IP data services (GPRS).
- set_enabledAtPowerOn(int) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Changes the state of the PWM at device power on.
- set_enabledAtPowerOn(int) - Method in class com.yoctopuce.YoctoAPI.YServo
-
Configure the servo signal generator state at power up.
- set_excitation(int) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Changes the current load cell bridge excitation method.
- set_excitation(int) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Changes the current load cell bridge excitation method.
- set_extraSettings(String) - Method in class com.yoctopuce.YoctoAPI.YModule
-
- set_failSafeTimeout(int) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes the delay in milliseconds allowed for the controller to run autonomously without
receiving any instruction from the control process.
- set_frequency(double) - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Changes the frequency of the signal sent to the buzzer.
- set_frequency(double) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes the PWM frequency used to control the motor.
- set_frequency(double) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Changes the PWM frequency.
- set_fusionMode(int) - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Change the BNO055 fusion mode.
- set_gravityCancellation(int) - Method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
- set_hardwareCalibration(String) - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
- set_highestValue(double) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Changes the recorded maximal value observed.
- set_hours(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes the hours when a wake up must take place.
- set_hslColor(int) - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Changes the current color of the LED, using a color HSL.
- set_hslColor(int, int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Changes the current color of consecutive LEDs in the cluster, using a HSL color.
- set_hslColorArray(int, ArrayList<Integer>) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Sends 24bit HSL colors (provided as a list of integers) to the LED HSL buffer, as is.
- set_hslColorAtPowerOn(int, int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Changes the color at device startup of consecutive LEDs in the cluster, using a HSL color.
- set_hslColorBuffer(int, byte[]) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Sends a binary buffer to the LED HSL buffer, as is.
- set_hslMove(YColorLed.YMove) - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
- set_httpPort(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the default HTML page returned by the hub.
- set_i2cMode(String) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Changes the SPI port communication parameters, with a string such as
"400kbps,2000ms".
- set_i2cVoltageLevel(int) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Changes the voltage level used on the I2C bus.
- set_ipConfig(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
- set_ledType(int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Changes the RGB LED type currently handled by the device.
- set_lockedOperator(String) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the name of the cell operator to be used.
- set_logFrequency(String) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Changes the datalogger recording frequency for this function.
- set_logicalName(String) - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Changes the logical name of the function.
- set_lowestValue(double) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Changes the recorded minimal value observed.
- set_luminosity(int) - Method in class com.yoctopuce.YoctoAPI.YLed
-
Changes the current LED intensity (in per cent).
- set_luminosity(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Changes the luminosity of the module informative leds.
- set_maintenanceMode(int) - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Changes the device mode to enable maintenance and to stop sensor polling.
- set_maxAccel(double) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the maximal motor acceleration, measured in steps per second^2.
- set_maxSpeed(double) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the maximal motor speed, measured in steps per second.
- set_maxTimeOnStateA(long) - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
- set_maxTimeOnStateA(long) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
- set_maxTimeOnStateB(long) - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
- set_maxTimeOnStateB(long) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
- set_measureType(int) - Method in class com.yoctopuce.YoctoAPI.YLightSensor
-
Changes the light sensor type used in the device.
- set_meter(double) - Method in class com.yoctopuce.YoctoAPI.YPower
-
- set_minutes(long) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes all the minutes where a wake up must take place.
- set_minutesA(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes the minutes in the 00-29 interval when a wake up must take place.
- set_minutesB(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes the minutes in the 30-59 interval when a wake up must take place.
- set_monthDays(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes the days of the month when a wake up must take place.
- set_months(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes the months when a wake up must take place.
- set_motorStatus(int) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
- set_mountPos(int) - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
- set_mountPosition(YRefFrame.MOUNTPOSITION, YRefFrame.MOUNTORIENTATION) - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Changes the compass and tilt sensor frame of reference.
- set_move(YServo.YMove) - Method in class com.yoctopuce.YoctoAPI.YServo
-
- set_msgClass(int) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_msgRef(int) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_mute(int) - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Changes the state of the mute function.
- set_mute(int) - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Changes the state of the mute function.
- set_mute(int) - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Changes the state of the mute function.
- set_nAxis(int) - Method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
Changes the number of synchronized controllers.
- set_neutral(int) - Method in class com.yoctopuce.YoctoAPI.YServo
-
Changes the duration of the pulse corresponding to the neutral position of the servo.
- set_nextWakeUp(long) - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Changes the days of the week when a wake up must take place.
- set_nSensors(int) - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Changes the number of sensors to poll.
- set_ntcParameters(double, double) - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
Configures NTC thermistor parameters in order to properly compute the temperature from
the measured resistance.
- set_ntpServer(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the IP address of the NTP server to be used by the module.
- set_offsetAvgCompensationTable(ArrayList<Double>, ArrayList<Double>) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Records a weight offset thermal compensation table, in order to automatically correct the
measured weight based on the averaged compensation temperature.
- set_offsetChgCompensationTable(ArrayList<Double>, ArrayList<Double>) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Records a weight offset thermal compensation table, in order to automatically correct the
measured weight based on the variation of temperature.
- set_orientation(int) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Changes the display orientation.
- set_output(int) - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Changes the output state of the relays, when used as a simple switch (single throw).
- set_output(int) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Changes the output state of the watchdog, when used as a simple switch (single throw).
- set_outputVoltage(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Changes the voltage source used to drive output bits.
- set_overcurrent(int) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the overcurrent alert and emergency stop threshold, measured in mA.
- set_overCurrentLimit(int) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes the current threshold (in mA) above which the controller automatically
switches to error state.
- set_pairingPin(String) - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Changes the PIN code used by the module for bluetooth pairing.
- set_parts(ArrayList<YSms>) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_pdu(byte[]) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_pduReceived(int) - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Changes the value of the incoming SMS units counter.
- set_pduSent(int) - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Changes the value of the outgoing SMS units counter.
- set_period(double) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Changes the PWM period in milliseconds.
- set_periodicCallbackSchedule(String, int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Setup periodic HTTP callbacks (simplified function).
- set_persistentSettings(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
- set_pin(String) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the PIN code used by the module to access the SIM card.
- set_pingInterval(int) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the automated connectivity check interval, in seconds.
- set_portDirection(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Changes the IO direction of all bits (i.e.
- set_portOpenDrain(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Changes the electrical interface for each bit of the port.
- set_portPolarity(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
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.
- set_portState(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Changes the state of all digital IO port's channels at once,
the parameter is an integer with each bit representing a channel.
- set_position(int) - Method in class com.yoctopuce.YoctoAPI.YServo
-
Changes immediately the servo driving position.
- set_positionAtPowerOn(int) - Method in class com.yoctopuce.YoctoAPI.YServo
-
Configure the servo position at device power up.
- set_power(int) - Method in class com.yoctopuce.YoctoAPI.YLed
-
Changes the state of the LED.
- set_powerControl(int) - Method in class com.yoctopuce.YoctoAPI.YDualPower
-
Changes the selected power source for module functions that require lots of current.
- set_powerDuration(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Changes the maximal wake up time (seconds) before automatically going to sleep.
- set_powerMode(int) - Method in class com.yoctopuce.YoctoAPI.YPwmPowerSource
-
Changes the PWM power source.
- set_powerOutput(int) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Changes the power supply output switch state.
- set_preAmplifier(int) - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Changes the audio pre-amplifier volume, in per cents.
- set_presenceMinTime(int) - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Changes the minimal detection duration before signalling a presence event.
- set_primaryDNS(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the IP address of the primary name server to be used by the module.
- set_protocol(String) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Changes the type of protocol used to send I2C messages.
- set_protocol(String) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Changes the type of protocol used over the serial line.
- set_protocol(String) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Changes the type of protocol used over the serial line.
- set_protocolId(int) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_proximityReportMode(int) - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Changes the parameter type (sensor value, presence or pulse count) returned by the
get_currentValue function and callbacks.
- set_pullinSpeed(double) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the motor speed immediately reachable from stop state, measured in steps per second.
- set_pulseCounter(long) - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
- set_pulseCounter(long) - Method in class com.yoctopuce.YoctoAPI.YProximity
-
- set_pulseCounter(long) - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
- set_pulseDuration(double) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Changes the PWM pulse length, in milliseconds.
- set_pulseTimer(long) - Method in class com.yoctopuce.YoctoAPI.YRelay
-
- set_pulseTimer(long) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
- set_pwmReportMode(int) - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Changes the parameter type (frequency/duty cycle, pulse width, or edge count) returned by the
get_currentValue function and callbacks.
- set_pwmTransition(String) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
- set_qnh(double) - Method in class com.yoctopuce.YoctoAPI.YAltitude
-
Changes the barometric pressure adjusted to sea level used to compute
the altitude (QNH).
- set_range(int) - Method in class com.yoctopuce.YoctoAPI.YServo
-
Changes the range of use of the servo, specified in per cents.
- set_rangeFinderMode(int) - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Changes the rangefinder running mode, allowing you to put priority on
precision, speed or maximum range.
- set_rebootCountdown(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
- set_received(boolean) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_recipient(String) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_recording(int) - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Changes the activation state of the data logger to start/stop recording data.
- set_remoteAddress(String) - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Changes the MAC-48 address defining which remote device to connect to.
- set_removalMinTime(int) - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Changes the minimal detection duration before signalling a removal event.
- set_reportFrequency(String) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Changes the timed value notification frequency for this function.
- set_requiredChildCount(int) - Method in class com.yoctopuce.YoctoAPI.YDaisyChain
-
Changes the number of child nodes expected in normal conditions.
- set_resolution(double) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Changes the resolution of the measured physical values.
- set_rgbColor(int) - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Changes the current color of the LED, using an RGB color.
- set_rgbColor(int, int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Changes the current color of consecutive LEDs in the cluster, using a RGB color.
- set_rgbColorArray(int, ArrayList<Integer>) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Sends 24bit RGB colors (provided as a list of integers) to the LED RGB buffer, as is.
- set_rgbColorAtPowerOn(int) - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Changes the color that the LED will display by default when the module is turned on.
- set_rgbColorAtPowerOn(int, int, int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Changes the color at device startup of consecutive LEDs in the cluster, using a RGB color.
- set_rgbColorBuffer(int, byte[]) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Sends a binary buffer to the LED RGB buffer, as is.
- set_rgbMove(YColorLed.YMove) - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
- set_RTS(int) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Manually sets the state of the RTS line.
- set_running(int) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Changes the running state of the watchdog.
- set_secondaryDNS(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the IP address of the secondary name server to be used by the module.
- set_sender(String) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_sensitivity(int) - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Changes the sensibility for the input (between 1 and 1000) for triggering user callbacks.
- set_sensorType(int) - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
Changes the temperature sensor type.
- set_serialMode(String) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Changes the serial port communication parameters, with a string such as
"9600,8N1".
- set_shiftSampling(int) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Changes the SDI line sampling shift.
- set_shutdownCountdown(int) - Method in class com.yoctopuce.YoctoAPI.YOsControl
-
- set_signalBias(double) - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Changes the electric signal bias for zero shift adjustment.
- set_signalRange(String) - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Changes the electric signal range used by the sensor.
- set_signalSampling(int) - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Changes the electric signal sampling method to use.
- set_sleepCountdown(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Changes the delay before the next sleep period.
- set_slot(int) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_smsc(String) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_spanAvgCompensationTable(ArrayList<Double>, ArrayList<Double>) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Records a weight span thermal compensation table, in order to automatically correct the
measured weight based on the compensation temperature.
- set_spanChgCompensationTable(ArrayList<Double>, ArrayList<Double>) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Records a weight span thermal compensation table, in order to automatically correct the
measured weight based on the variation of temperature.
- set_spiMode(String) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Changes the SPI port communication parameters, with a string such as
"125000,0,msb".
- set_SS(int) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Manually sets the state of the SS line.
- set_ssPolarity(int) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Changes the SS line polarity.
- set_starterTime(int) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes the duration (in ms) during which the motor is driven at low frequency to help
it start up.
- set_startupJob(String) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Changes the job to use when the device is powered on.
- set_startupJob(String) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Changes the job to use when the device is powered on.
- set_startupJob(String) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Changes the job to use when the device is powered on.
- set_startupSeq(String) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Changes the name of the sequence to play when the displayed is powered on.
- set_state(int) - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Changes the state of the relays (A for the idle position, B for the active position).
- set_state(int) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Changes the state of the watchdog (A for the idle position, B for the active position).
- set_stateAtPowerOn(int) - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Preset the state of the relays at device startup (A for the idle position,
B for the active position, UNCHANGED for no modification).
- set_stateAtPowerOn(int) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Preset the state of the watchdog at device startup (A for the idle position,
B for the active position, UNCHANGED for no modification).
- set_stepping(int) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the stepping mode used to drive the motor.
- set_stepPos(double) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the current logical motor position, measured in steps.
- set_tCurrRun(int) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the torque regulation current when the motor is running, measured in mA.
- set_tCurrStop(int) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the torque regulation current when the motor is stopped, measured in mA.
- set_tempAvgAdaptRatio(double) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Changes the averaged temperature update rate, in per mille.
- set_tempAvgAdaptRatio(double) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Changes the averaged temperature update rate, in per mille.
- set_tempChgAdaptRatio(double) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Changes the temperature change update rate, in per mille.
- set_tempChgAdaptRatio(double) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Changes the temperature change update rate, in per mille.
- set_thermistorResponseTable(ArrayList<Double>, ArrayList<Double>) - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
Records a thermistor response table, in order to interpolate the temperature from
the measured resistance.
- set_timeFrame(long) - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Changes the time frame used to measure the distance and estimate the measure
reliability.
- set_timestamp(String) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_timeUTC(long) - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Changes the current UTC time reference used for recorded data.
- set_triggerDelay(long) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Changes the waiting delay before a reset is triggered by the watchdog, in milliseconds.
- set_triggerDuration(long) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Changes the duration of resets caused by the watchdog, in milliseconds.
- set_unit(String) - Method in class com.yoctopuce.YoctoAPI.YArithmeticSensor
-
Changes the measuring unit for the arithmetic sensor.
- set_unit(String) - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Changes the measuring unit for the measured value.
- set_unit(String) - Method in class com.yoctopuce.YoctoAPI.YHumidity
-
Changes the primary unit for measuring humidity.
- set_unit(String) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Changes the measuring unit for the weight.
- set_unit(String) - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Changes the measuring unit for the measured quantity.
- set_unit(String) - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Changes the measuring unit for the measured range.
- set_unit(String) - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
Changes the measuring unit for the measured temperature.
- set_unit(String) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Changes the measuring unit for the weight.
- set_unixTime(long) - Method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Changes the current time.
- set_userData(Object) - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Stores a user context provided as argument in the userData attribute of the function.
- set_userData(byte[]) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_userDataHeader(byte[]) - Method in class com.yoctopuce.YoctoAPI.YSms
-
- set_userPassword(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the password for the "user" user.
- set_userVar(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Stores a 32 bit value in the device RAM.
- set_utcOffset(int) - Method in class com.yoctopuce.YoctoAPI.YGps
-
Changes the number of seconds between current time and UTC time (time zone).
- set_utcOffset(int) - Method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Changes the number of seconds between current time and UTC time (time zone).
- set_valueRange(String) - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Changes the physical value range measured by the sensor.
- set_voltage(int) - Method in class com.yoctopuce.YoctoAPI.YPowerOutput
-
Changes the voltage on the power output provided by the
module.
- set_voltageAtStartUp(double) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Changes the voltage set point at device start up.
- set_voltageAtStartUp(double) - Method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
Changes the output voltage at device start up.
- set_voltageLevel(int) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Changes the voltage type used on the serial line.
- set_voltageLevel(int) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Changes the voltage type used on the serial line.
- set_voltageSense(int) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Changes the voltage control point.
- set_voltageSetPoint(double) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Changes the voltage set point, in V.
- set_voltageTransition(String) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
- set_voltageTransition(String) - Method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
- set_volume(int) - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Changes audio input gain, in per cents.
- set_volume(int) - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Changes audio output volume, in per cents.
- set_volume(int) - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Changes the connected headset volume, in per cents.
- set_volume(int) - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Changes the volume of the signal sent to the buzzer/speaker.
- set_wakeUpState(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
- set_weekDays(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes the days of the week when a wake up must take place.
- set_wlanConfig(String) - Method in class com.yoctopuce.YoctoAPI.YWireless
-
- set_wwwWatchdogDelay(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the allowed downtime of the WWW link (in seconds) before triggering an automated
reboot to try to recover Internet connectivity.
- set_zeroTracking(double) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Changes the zero tracking threshold value.
- set_zeroTracking(double) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Changes the zero tracking threshold value.
- setAbcPeriod(int) - Method in class com.yoctopuce.YoctoAPI.YCarbonDioxide
-
Changes Automatic Baseline Calibration period, in hours.
- setActiveLedCount(int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Changes the number of LEDs currently handled by the device.
- setAdminPassword(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the password for the "admin" user.
- setAdvMode(int) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Changes the measuring mode used for the advertised value pushed to the parent hub.
- setAirplaneMode(int) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the activation state of airplane mode (radio turned off).
- setAnalogCalibration(int) - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Starts or stops the calibration process.
- setAntialiasingMode(boolean) - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Enables or disables anti-aliasing for drawing oblique lines and circles.
- setApn(String) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Returns the Access Point Name (APN) to be used, if needed.
- setAutoStart(int) - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Changes the default activation state of the data logger on power up.
- setAutoStart(int) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Changes the watchdog running state at module power on.
- setAuxSignal(int) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the value of the signal generated on the auxiliary output.
- setBandwidth(int) - Method in class com.yoctopuce.YoctoAPI.YAccelerometer
-
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- setBandwidth(int) - Method in class com.yoctopuce.YoctoAPI.YCompass
-
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- setBandwidth(int) - Method in class com.yoctopuce.YoctoAPI.YGyro
-
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- setBandwidth(int) - Method in class com.yoctopuce.YoctoAPI.YMagnetometer
-
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- setBandwidth(int) - Method in class com.yoctopuce.YoctoAPI.YTilt
-
Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only).
- setBeacon(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Turns on or off the module localization beacon.
- setBeaconDriven(int) - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Changes the type of synchronisation of the data logger.
- setBearing(double) - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Changes the reference bearing used by the compass.
- setBlinking(int) - Method in class com.yoctopuce.YoctoAPI.YLed
-
Changes the current LED signaling mode.
- setBrakingForce(double) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes immediately the braking force applied to the motor (in percents).
- setBrightness(int) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Changes the brightness of the display.
- SetCacheValidity(long) - Static method in class com.yoctopuce.YoctoAPI.YAPI
-
Change the validity period of the data loaded by the library.
- SetCacheValidity(long) - Method in class com.yoctopuce.YoctoAPI.YAPIContext
-
Change the validity period of the data loaded by the library.
- setCalibrationMax(int) - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Changes the maximal calibration value for the input (between 0 and 4095, included), without actually
starting the automated calibration.
- setCalibrationMin(int) - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Changes the minimal calibration value for the input (between 0 and 4095, included), without actually
starting the automated calibration.
- setCallbackCredentials(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the credentials required to connect to the callback address.
- setCallbackEncoding(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the encoding standard to use for representing notification values.
- setCallbackInitialDelay(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the initial waiting time before first callback notifications, in seconds.
- setCallbackMaxDelay(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the waiting time between two HTTP callbacks when there is nothing new.
- setCallbackMethod(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the HTTP method used to notify callbacks for significant state changes.
- setCallbackMinDelay(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the minimum waiting time between two HTTP callbacks, in seconds.
- setCallbackSchedule(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the HTTP callback schedule strategy, as a text string.
- setCallbackUrl(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the callback URL to notify significant state changes.
- setCellCount(int) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Changes the number of load cells in use.
- setCompensationTable(int, ArrayList<Double>, ArrayList<Double>) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
- setConsoleBackground(int) - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Sets up the background color used by the clearConsole function and by
the console scrolling feature.
- setConsoleMargins(int, int, int, int) - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Sets up display margins for the consoleOut function.
- setConsoleWordWrap(boolean) - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Sets up the wrapping behavior used by the consoleOut function.
- setConstellation(int) - Method in class com.yoctopuce.YoctoAPI.YGps
-
Changes the satellites constellation used to compute
positioning data.
- setCoordSystem(int) - Method in class com.yoctopuce.YoctoAPI.YGps
-
Changes the representation system used for positioning data.
- setCurrent(double) - Method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Changes the current loop, the valid range is from 3 to 21mA.
- setCurrentAtStartUp(double) - Method in class com.yoctopuce.YoctoAPI.YCurrentLoopOutput
-
Changes the loop current at device start up.
- setCurrentAtStartUp(double) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Changes the current limit at device start up.
- setCurrentJob(String) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Selects a job file to run immediately.
- setCurrentJob(String) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Selects a job file to run immediately.
- setCurrentJob(String) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Selects a job file to run immediately.
- setCurrentLimit(double) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Changes the current limit, in mA.
- setCurrentValue(double) - Method in class com.yoctopuce.YoctoAPI.YAltitude
-
Changes the current estimated altitude.
- setCurrentValue(double) - Method in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
Changes the current expected position of the quadrature decoder.
- setCurrentVoltage(double) - Method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
Changes the output voltage, in V.
- setCutOffVoltage(double) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes the threshold voltage under which the controller automatically switches to error state
and prevents further current draw.
- setDataReceived(int) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the value of the incoming data counter.
- setDataSent(int) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the value of the outgoing data counter.
- setDebouncePeriod(int) - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Changes the shortest expected pulse duration, in ms.
- setDecoding(int) - Method in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
Changes the activation state of the quadrature decoder.
- setDefaultPage(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the default HTML page returned by the hub.
- setDetectionHysteresis(int) - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Changes the hysteresis used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
- setDetectionThreshold(int) - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Changes the threshold used to determine the logical state of the proximity sensor, when considered
as a binary input (on/off).
- SetDeviceListValidity(int) - Static method in class com.yoctopuce.YoctoAPI.YAPI
-
Modifies the delay between each forced enumeration of the used YoctoHubs.
- SetDeviceListValidity(int) - Method in class com.yoctopuce.YoctoAPI.YAPIContext
-
Modifies the delay between each forced enumeration of the used YoctoHubs.
- setDiscoverable(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the activation state of the multicast announce protocols to allow easy
discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
- setDisplayedText(String) - Method in class com.yoctopuce.YoctoAPI.YSegmentedDisplay
-
Changes the text currently displayed on the screen.
- setDrivingForce(double) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes immediately the power sent to the motor.
- setDutyCycle(double) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Changes the PWM duty cycle, in per cents.
- setDutyCycleAtPowerOn(double) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Changes the PWM duty cycle at device power on.
- setEnabled(int) - Method in class com.yoctopuce.YoctoAPI.YCurrent
-
Changes the activation state of this input.
- setEnabled(int) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Changes the power state of the display.
- setEnabled(int) - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Changes the activation state of this input.
- setEnabled(int) - Method in class com.yoctopuce.YoctoAPI.YHubPort
-
Changes the activation of the Yocto-hub port.
- setEnabled(int) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Stops or starts the PWM.
- setEnabled(int) - Method in class com.yoctopuce.YoctoAPI.YServo
-
Stops or starts the servo.
- setEnabled(int) - Method in class com.yoctopuce.YoctoAPI.YVoltage
-
Changes the activation state of this input.
- setEnableData(int) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the condition for enabling IP data services (GPRS).
- setEnabledAtPowerOn(int) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Changes the state of the PWM at device power on.
- setEnabledAtPowerOn(int) - Method in class com.yoctopuce.YoctoAPI.YServo
-
Configure the servo signal generator state at power up.
- setExcitation(int) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Changes the current load cell bridge excitation method.
- setExcitation(int) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Changes the current load cell bridge excitation method.
- setFailSafeTimeout(int) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes the delay in milliseconds allowed for the controller to run autonomously without
receiving any instruction from the control process.
- setFrequency(double) - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Changes the frequency of the signal sent to the buzzer.
- setFrequency(double) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes the PWM frequency used to control the motor.
- setFrequency(double) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Changes the PWM frequency.
- setFusionMode(int) - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Change the BNO055 fusion mode.
- setHighestValue(double) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Changes the recorded maximal value observed.
- setHours(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes the hours when a wake up must take place.
- setHslColor(int) - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Changes the current color of the LED, using a color HSL.
- setHttpPort(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the default HTML page returned by the hub.
- setI2cMode(String) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Changes the SPI port communication parameters, with a string such as
"400kbps,2000ms".
- setI2cVoltageLevel(int) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Changes the voltage level used on the I2C bus.
- setLayerPosition(int, int, int) - Method in class com.yoctopuce.YoctoAPI.YDisplayLayer
-
Sets the position of the layer relative to the display upper left corner.
- setLedType(int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Changes the RGB LED type currently handled by the device.
- setLockedOperator(String) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the name of the cell operator to be used.
- setLogFrequency(String) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Changes the datalogger recording frequency for this function.
- setLogicalName(String) - Method in class com.yoctopuce.YoctoAPI.YFunction
-
Changes the logical name of the function.
- setLowestValue(double) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Changes the recorded minimal value observed.
- setLuminosity(int) - Method in class com.yoctopuce.YoctoAPI.YLed
-
Changes the current LED intensity (in per cent).
- setLuminosity(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Changes the luminosity of the module informative leds.
- setMaintenanceMode(int) - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Changes the device mode to enable maintenance and to stop sensor polling.
- setMaxAccel(double) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the maximal motor acceleration, measured in steps per second^2.
- setMaxSpeed(double) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the maximal motor speed, measured in steps per second.
- setMaxTimeOnStateA(long) - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
- setMaxTimeOnStateA(long) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state A before automatically
switching back in to B state.
- setMaxTimeOnStateB(long) - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
- setMaxTimeOnStateB(long) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Sets the maximum time (ms) allowed for $THEFUNCTIONS$ to stay in state B before automatically
switching back in to A state.
- setMeasureType(int) - Method in class com.yoctopuce.YoctoAPI.YLightSensor
-
Changes the light sensor type used in the device.
- setMinutesA(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes the minutes in the 00-29 interval when a wake up must take place.
- setMinutesB(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes the minutes in the 30-59 interval when a wake up must take place.
- setMonthDays(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes the days of the month when a wake up must take place.
- setMonths(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes the months when a wake up must take place.
- setMute(int) - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Changes the state of the mute function.
- setMute(int) - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Changes the state of the mute function.
- setMute(int) - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Changes the state of the mute function.
- setNAxis(int) - Method in class com.yoctopuce.YoctoAPI.YMultiAxisController
-
Changes the number of synchronized controllers.
- SetNetworkTimeout(int) - Static method in class com.yoctopuce.YoctoAPI.YAPI
-
Modifies the network connection delay for YAPI.RegisterHub() and
YAPI.UpdateDeviceList().
- SetNetworkTimeout(int) - Method in class com.yoctopuce.YoctoAPI.YAPIContext
-
Modifies the network connection delay for YAPI.RegisterHub() and
YAPI.UpdateDeviceList().
- SetNetworkTimeout_internal(int) - Method in class com.yoctopuce.YoctoAPI.YAPIContext
-
- setNeutral(int) - Method in class com.yoctopuce.YoctoAPI.YServo
-
Changes the duration of the pulse corresponding to the neutral position of the servo.
- setNextWakeUp(long) - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Changes the days of the week when a wake up must take place.
- setNSensors(int) - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Changes the number of sensors to poll.
- setNtpServer(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the IP address of the NTP server to be used by the module.
- setOrientation(int) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Changes the display orientation.
- setOutput(int) - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Changes the output state of the relays, when used as a simple switch (single throw).
- setOutput(int) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Changes the output state of the watchdog, when used as a simple switch (single throw).
- setOutputVoltage(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Changes the voltage source used to drive output bits.
- setOvercurrent(int) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the overcurrent alert and emergency stop threshold, measured in mA.
- setOverCurrentLimit(int) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes the current threshold (in mA) above which the controller automatically
switches to error state.
- setPairingPin(String) - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Changes the PIN code used by the module for bluetooth pairing.
- setPduReceived(int) - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Changes the value of the incoming SMS units counter.
- setPduSent(int) - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
Changes the value of the outgoing SMS units counter.
- setPeriod(double) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Changes the PWM period in milliseconds.
- setPin(String) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the PIN code used by the module to access the SIM card.
- setPingInterval(int) - Method in class com.yoctopuce.YoctoAPI.YCellular
-
Changes the automated connectivity check interval, in seconds.
- setPortDirection(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Changes the IO direction of all bits (i.e.
- setPortOpenDrain(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Changes the electrical interface for each bit of the port.
- setPortPolarity(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
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.
- setPortState(int) - Method in class com.yoctopuce.YoctoAPI.YDigitalIO
-
Changes the state of all digital IO port's channels at once,
the parameter is an integer with each bit representing a channel.
- setPosition(int) - Method in class com.yoctopuce.YoctoAPI.YServo
-
Changes immediately the servo driving position.
- setPositionAtPowerOn(int) - Method in class com.yoctopuce.YoctoAPI.YServo
-
Configure the servo position at device power up.
- setPower(int) - Method in class com.yoctopuce.YoctoAPI.YLed
-
Changes the state of the LED.
- setPowerControl(int) - Method in class com.yoctopuce.YoctoAPI.YDualPower
-
Changes the selected power source for module functions that require lots of current.
- setPowerDuration(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Changes the maximal wake up time (seconds) before automatically going to sleep.
- setPowerMode(int) - Method in class com.yoctopuce.YoctoAPI.YPwmPowerSource
-
Changes the PWM power source.
- setPowerOutput(int) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Changes the power supply output switch state.
- setPreAmplifier(int) - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Changes the audio pre-amplifier volume, in per cents.
- setPresenceMinTime(int) - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Changes the minimal detection duration before signalling a presence event.
- setPrimaryDNS(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the IP address of the primary name server to be used by the module.
- setProtocol(String) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Changes the type of protocol used to send I2C messages.
- setProtocol(String) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Changes the type of protocol used over the serial line.
- setProtocol(String) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Changes the type of protocol used over the serial line.
- setProximityReportMode(int) - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Changes the parameter type (sensor value, presence or pulse count) returned by the
get_currentValue function and callbacks.
- setPullinSpeed(double) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the motor speed immediately reachable from stop state, measured in steps per second.
- setPulseDuration(double) - Method in class com.yoctopuce.YoctoAPI.YPwmOutput
-
Changes the PWM pulse length, in milliseconds.
- setPwmReportMode(int) - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Changes the parameter type (frequency/duty cycle, pulse width, or edge count) returned by the
get_currentValue function and callbacks.
- setQnh(double) - Method in class com.yoctopuce.YoctoAPI.YAltitude
-
Changes the barometric pressure adjusted to sea level used to compute
the altitude (QNH).
- setRange(int) - Method in class com.yoctopuce.YoctoAPI.YServo
-
Changes the range of use of the servo, specified in per cents.
- setRangeFinderMode(int) - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Changes the rangefinder running mode, allowing you to put priority on
precision, speed or maximum range.
- setRecording(int) - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Changes the activation state of the data logger to start/stop recording data.
- setRemoteAddress(String) - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Changes the MAC-48 address defining which remote device to connect to.
- setRemovalMinTime(int) - Method in class com.yoctopuce.YoctoAPI.YProximity
-
Changes the minimal detection duration before signalling a removal event.
- setReportFrequency(String) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Changes the timed value notification frequency for this function.
- setRequiredChildCount(int) - Method in class com.yoctopuce.YoctoAPI.YDaisyChain
-
Changes the number of child nodes expected in normal conditions.
- setResolution(double) - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Changes the resolution of the measured physical values.
- setRgbColor(int) - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Changes the current color of the LED, using an RGB color.
- setRgbColorAtPowerOn(int) - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Changes the color that the LED will display by default when the module is turned on.
- setRunning(int) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Changes the running state of the watchdog.
- setSecondaryDNS(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the IP address of the secondary name server to be used by the module.
- setSensitivity(int) - Method in class com.yoctopuce.YoctoAPI.YAnButton
-
Changes the sensibility for the input (between 1 and 1000) for triggering user callbacks.
- setSensorType(int) - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
Changes the temperature sensor type.
- setSerialMode(String) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Changes the serial port communication parameters, with a string such as
"9600,8N1".
- setShiftSampling(int) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Changes the SDI line sampling shift.
- setSignalBias(double) - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Changes the electric signal bias for zero shift adjustment.
- setSignalRange(String) - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Changes the electric signal range used by the sensor.
- setSignalSampling(int) - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Changes the electric signal sampling method to use.
- setSleepCountdown(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Changes the delay before the next sleep period.
- setSpiMode(String) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Changes the SPI port communication parameters, with a string such as
"125000,0,msb".
- setSsPolarity(int) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Changes the SS line polarity.
- setStarterTime(int) - Method in class com.yoctopuce.YoctoAPI.YMotor
-
Changes the duration (in ms) during which the motor is driven at low frequency to help
it start up.
- setStartupJob(String) - Method in class com.yoctopuce.YoctoAPI.YI2cPort
-
Changes the job to use when the device is powered on.
- setStartupJob(String) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Changes the job to use when the device is powered on.
- setStartupJob(String) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Changes the job to use when the device is powered on.
- setStartupSeq(String) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Changes the name of the sequence to play when the displayed is powered on.
- setState(int) - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Changes the state of the relays (A for the idle position, B for the active position).
- setState(int) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Changes the state of the watchdog (A for the idle position, B for the active position).
- setStateAtPowerOn(int) - Method in class com.yoctopuce.YoctoAPI.YRelay
-
Preset the state of the relays at device startup (A for the idle position,
B for the active position, UNCHANGED for no modification).
- setStateAtPowerOn(int) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Preset the state of the watchdog at device startup (A for the idle position,
B for the active position, UNCHANGED for no modification).
- setStepping(int) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the stepping mode used to drive the motor.
- setStepPos(double) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the current logical motor position, measured in steps.
- setTCurrRun(int) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the torque regulation current when the motor is running, measured in mA.
- setTCurrStop(int) - Method in class com.yoctopuce.YoctoAPI.YStepperMotor
-
Changes the torque regulation current when the motor is stopped, measured in mA.
- setTempAvgAdaptRatio(double) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Changes the averaged temperature update rate, in per mille.
- setTempAvgAdaptRatio(double) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Changes the averaged temperature update rate, in per mille.
- setTempChgAdaptRatio(double) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Changes the temperature change update rate, in per mille.
- setTempChgAdaptRatio(double) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Changes the temperature change update rate, in per mille.
- SetThreadSpecificMode() - Static method in class com.yoctopuce.YoctoAPI.YAPI
-
- setTimeFrame(long) - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Changes the time frame used to measure the distance and estimate the measure
reliability.
- setTimeUTC(long) - Method in class com.yoctopuce.YoctoAPI.YDataLogger
-
Changes the current UTC time reference used for recorded data.
- setTriggerDelay(long) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Changes the waiting delay before a reset is triggered by the watchdog, in milliseconds.
- setTriggerDuration(long) - Method in class com.yoctopuce.YoctoAPI.YWatchdog
-
Changes the duration of resets caused by the watchdog, in milliseconds.
- setUnit(String) - Method in class com.yoctopuce.YoctoAPI.YArithmeticSensor
-
Changes the measuring unit for the arithmetic sensor.
- setUnit(String) - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Changes the measuring unit for the measured value.
- setUnit(String) - Method in class com.yoctopuce.YoctoAPI.YHumidity
-
Changes the primary unit for measuring humidity.
- setUnit(String) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Changes the measuring unit for the weight.
- setUnit(String) - Method in class com.yoctopuce.YoctoAPI.YPwmInput
-
Changes the measuring unit for the measured quantity.
- setUnit(String) - Method in class com.yoctopuce.YoctoAPI.YRangeFinder
-
Changes the measuring unit for the measured range.
- setUnit(String) - Method in class com.yoctopuce.YoctoAPI.YTemperature
-
Changes the measuring unit for the measured temperature.
- setUnit(String) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Changes the measuring unit for the weight.
- setUnixTime(long) - Method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Changes the current time.
- setupAddress(int) - Method in class com.yoctopuce.YoctoAPI.YMultiSensController
-
Configures the I2C address of the only sensor connected to the device.
- setupSpan(double, double) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Configures the load cells span parameters (stored in the corresponding genericSensors)
so that the current signal corresponds to the specified reference weight.
- setupSpan(double, double) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Configures the load cell span parameters (stored in the corresponding genericSensor)
so that the current signal corresponds to the specified reference weight.
- SetUSBPacketAckMs(int) - Static method in class com.yoctopuce.YoctoAPI.YAPI
-
Enables the acknowledge of every USB packet received by the Yoctopuce library.
- SetUSBPacketAckMs(int) - Method in class com.yoctopuce.YoctoAPI.YAPIContext
-
Enables the acknowledge of every USB packet received by the Yoctopuce library.
- setUserData(Object) - Method in class com.yoctopuce.YoctoAPI.YFunction
-
- setUserPassword(String) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the password for the "user" user.
- setUserVar(int) - Method in class com.yoctopuce.YoctoAPI.YModule
-
Stores a 32 bit value in the device RAM.
- setUtcOffset(int) - Method in class com.yoctopuce.YoctoAPI.YGps
-
Changes the number of seconds between current time and UTC time (time zone).
- setUtcOffset(int) - Method in class com.yoctopuce.YoctoAPI.YRealTimeClock
-
Changes the number of seconds between current time and UTC time (time zone).
- setValueRange(String) - Method in class com.yoctopuce.YoctoAPI.YGenericSensor
-
Changes the physical value range measured by the sensor.
- setVoltage(int) - Method in class com.yoctopuce.YoctoAPI.YPowerOutput
-
Changes the voltage on the power output provided by the
module.
- setVoltageAtStartUp(double) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Changes the voltage set point at device start up.
- setVoltageAtStartUp(double) - Method in class com.yoctopuce.YoctoAPI.YVoltageOutput
-
Changes the output voltage at device start up.
- setVoltageLevel(int) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Changes the voltage type used on the serial line.
- setVoltageLevel(int) - Method in class com.yoctopuce.YoctoAPI.YSpiPort
-
Changes the voltage type used on the serial line.
- setVoltageSense(int) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Changes the voltage control point.
- setVoltageSetPoint(double) - Method in class com.yoctopuce.YoctoAPI.YPowerSupply
-
Changes the voltage set point, in V.
- setVolume(int) - Method in class com.yoctopuce.YoctoAPI.YAudioIn
-
Changes audio input gain, in per cents.
- setVolume(int) - Method in class com.yoctopuce.YoctoAPI.YAudioOut
-
Changes audio output volume, in per cents.
- setVolume(int) - Method in class com.yoctopuce.YoctoAPI.YBluetoothLink
-
Changes the connected headset volume, in per cents.
- setVolume(int) - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Changes the volume of the signal sent to the buzzer/speaker.
- setWeekDays(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpSchedule
-
Changes the days of the week when a wake up must take place.
- setWwwWatchdogDelay(int) - Method in class com.yoctopuce.YoctoAPI.YNetwork
-
Changes the allowed downtime of the WWW link (in seconds) before triggering an automated
reboot to try to recover Internet connectivity.
- setZeroTracking(double) - Method in class com.yoctopuce.YoctoAPI.YMultiCellWeighScale
-
Changes the zero tracking threshold value.
- setZeroTracking(double) - Method in class com.yoctopuce.YoctoAPI.YWeighScale
-
Changes the zero tracking threshold value.
- SHIFTSAMPLING_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YSpiPort
-
- SHIFTSAMPLING_OFF - Static variable in class com.yoctopuce.YoctoAPI.YSpiPort
-
invalid shiftSampling value
- SHIFTSAMPLING_ON - Static variable in class com.yoctopuce.YoctoAPI.YSpiPort
-
- shutdown(int) - Method in class com.yoctopuce.YoctoAPI.YOsControl
-
Schedules an OS shutdown after a given number of seconds.
- SHUTDOWNCOUNTDOWN_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YOsControl
-
invalid shutdownCountdown value
- SIGNAL_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YAudioIn
-
invalid signal value
- SIGNAL_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YAudioOut
-
invalid signal value
- SIGNALBIAS_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YGenericSensor
-
invalid signalBias value
- SIGNALRANGE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YGenericSensor
-
invalid signalRange value
- SIGNALSAMPLING_HIGH_RATE - Static variable in class com.yoctopuce.YoctoAPI.YGenericSensor
-
invalid signalSampling value
- SIGNALSAMPLING_HIGH_RATE_FILTERED - Static variable in class com.yoctopuce.YoctoAPI.YGenericSensor
-
- SIGNALSAMPLING_HIGHEST_RATE - Static variable in class com.yoctopuce.YoctoAPI.YGenericSensor
-
- SIGNALSAMPLING_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YGenericSensor
-
- SIGNALSAMPLING_LOW_NOISE - Static variable in class com.yoctopuce.YoctoAPI.YGenericSensor
-
- SIGNALSAMPLING_LOW_NOISE_FILTERED - Static variable in class com.yoctopuce.YoctoAPI.YGenericSensor
-
- SIGNALUNIT_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YGenericSensor
-
invalid signalUnit value
- SIGNALUNIT_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
invalid signalUnit value
- SIGNALVALUE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YGenericSensor
-
invalid signalValue value
- SIGNALVALUE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YProximity
-
invalid signalValue value
- SIGNALVALUE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YTemperature
-
invalid signalValue value
- SIZE - Static variable in class com.yoctopuce.YoctoAPI.YFirmwareFile.byn_zone
-
- Sleep(long) - Static method in class com.yoctopuce.YoctoAPI.YAPI
-
Pauses the execution flow for a specified duration.
- Sleep(long) - Method in class com.yoctopuce.YoctoAPI.YAPIContext
-
Pauses the execution flow for a specified duration.
- sleep(int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
Goes to sleep until the next wake up condition is met, the
RTC time must have been set before calling this function.
- SLEEPCOUNTDOWN_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
invalid sleepCountdown value
- sleepFor(int, int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
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.
- sleepUntil(int, int) - Method in class com.yoctopuce.YoctoAPI.YWakeUpMonitor
-
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.
- SLOTSBITMAP_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YMessageBox
-
invalid slotsBitmap value
- SLOTSCOUNT_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YMessageBox
-
invalid slotsCount value
- SLOTSINUSE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YMessageBox
-
invalid slotsInUse value
- snoopMessages(int) - Method in class com.yoctopuce.YoctoAPI.YSerialPort
-
Retrieves messages (both direction) in the serial port buffer, starting at current position.
- softAPNetwork(String, String) - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Changes the configuration of the wireless lan interface to create a new wireless
network by emulating a WiFi access point (Soft AP).
- SPEED_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YQuadratureDecoder
-
invalid speed value
- SPEED_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YStepperMotor
-
invalid speed value
- SPIMODE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YSpiPort
-
invalid spiMode value
- SSID_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YWireless
-
invalid ssid value
- SSPOLARITY_ACTIVE_HIGH - Static variable in class com.yoctopuce.YoctoAPI.YSpiPort
-
- SSPOLARITY_ACTIVE_LOW - Static variable in class com.yoctopuce.YoctoAPI.YSpiPort
-
invalid ssPolarity value
- SSPOLARITY_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YSpiPort
-
- start3DCalibration() - Method in class com.yoctopuce.YoctoAPI.YRefFrame
-
Initiates the sensors tridimensional calibration process.
- startBlinkSeq() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Starts the preprogrammed blinking sequence.
- startBlinkSeq(int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Starts a sequence execution: every LED linked to that sequence starts to
run it in a loop.
- startDataLogger() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Starts the data logger on the device.
- STARTERTIME_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YMotor
-
invalid starterTime value
- startNotifications(YUSBHub) - Static method in class com.yoctopuce.YoctoAPI.YJniWrapper
-
- startPlaySeq() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Starts the preprogrammed playing sequence.
- startUpdate() - Method in class com.yoctopuce.YoctoAPI.YFirmwareUpdate
-
Starts the firmware update process.
- STARTUPJOB_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YI2cPort
-
invalid startupJob value
- STARTUPJOB_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YSerialPort
-
invalid startupJob value
- STARTUPJOB_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YSpiPort
-
invalid startupJob value
- STARTUPSEQ_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YDisplay
-
invalid startupSeq value
- startWlanScan() - Method in class com.yoctopuce.YoctoAPI.YWireless
-
Triggers a scan of the wireless frequency and builds the list of available networks.
- STATE_A - Static variable in class com.yoctopuce.YoctoAPI.YRelay
-
invalid state value
- STATE_A - Static variable in class com.yoctopuce.YoctoAPI.YWatchdog
-
invalid state value
- STATE_B - Static variable in class com.yoctopuce.YoctoAPI.YRelay
-
- STATE_B - Static variable in class com.yoctopuce.YoctoAPI.YWatchdog
-
- STATE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YRelay
-
- STATE_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YWatchdog
-
- STATEATPOWERON_A - Static variable in class com.yoctopuce.YoctoAPI.YRelay
-
- STATEATPOWERON_A - Static variable in class com.yoctopuce.YoctoAPI.YWatchdog
-
- STATEATPOWERON_B - Static variable in class com.yoctopuce.YoctoAPI.YRelay
-
- STATEATPOWERON_B - Static variable in class com.yoctopuce.YoctoAPI.YWatchdog
-
- STATEATPOWERON_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YRelay
-
- STATEATPOWERON_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YWatchdog
-
- STATEATPOWERON_UNCHANGED - Static variable in class com.yoctopuce.YoctoAPI.YRelay
-
invalid stateAtPowerOn value
- STATEATPOWERON_UNCHANGED - Static variable in class com.yoctopuce.YoctoAPI.YWatchdog
-
invalid stateAtPowerOn value
- STEPPING_FULLSTEP - Static variable in class com.yoctopuce.YoctoAPI.YStepperMotor
-
- STEPPING_HALFSTEP - Static variable in class com.yoctopuce.YoctoAPI.YStepperMotor
-
- STEPPING_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YStepperMotor
-
- STEPPING_MICROSTEP16 - Static variable in class com.yoctopuce.YoctoAPI.YStepperMotor
-
invalid stepping value
- STEPPING_MICROSTEP4 - Static variable in class com.yoctopuce.YoctoAPI.YStepperMotor
-
- STEPPING_MICROSTEP8 - Static variable in class com.yoctopuce.YoctoAPI.YStepperMotor
-
- STEPPOS_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YStepperMotor
-
invalid stepPos value
- stopBlinkSeq() - Method in class com.yoctopuce.YoctoAPI.YColorLed
-
Stops the preprogrammed blinking sequence.
- stopBlinkSeq(int) - Method in class com.yoctopuce.YoctoAPI.YColorLedCluster
-
Stops a sequence execution.
- stopDataLogger() - Method in class com.yoctopuce.YoctoAPI.YSensor
-
Stops the datalogger on the device.
- stopNotifications() - Static method in class com.yoctopuce.YoctoAPI.YJniWrapper
-
- stopPlaySeq() - Method in class com.yoctopuce.YoctoAPI.YBuzzer
-
Stops the preprogrammed playing sequence and sets the frequency to zero.
- stopSequence() - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Stops immediately any ongoing sequence replay.
- str2gsm(String) - Method in class com.yoctopuce.YoctoAPI.YMessageBox
-
- SUBNETMASK_INVALID - Static variable in class com.yoctopuce.YoctoAPI.YNetwork
-
invalid subnetMask value
- SUCCESS - Static variable in class com.yoctopuce.YoctoAPI.YAPI
-
- swapLayerContent(int, int) - Method in class com.yoctopuce.YoctoAPI.YDisplay
-
Swaps the whole content of two layers.