Yoctopuce application programming interface allows you to control the module voltage output. You affect absolute output values or make transitions

Retrieves a voltage source for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

Starts the enumeration of voltage sources currently accessible. Use the method YVSource.nextVSource() to iterate on next voltage sources.

Returns a short text that describes the function in the form TYPE(NAME)=SERIAL.FUNCTIONID. More precisely, TYPE is the type of the function, NAME it the name used for the first access to the function, SERIAL is the serial number of the module if the module is connected or \x22unresolved\x22, and FUNCTIONID is the hardware identifier of the function if the module is connected. For example, this method returns Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 if the module is already connected or Relay(BadCustomeName.relay1)=unresolved if the module has not yet been connected. This method does not trigger any USB or TCP transaction and can therefore be used in a debugger.

Returns the current value of the voltage source (no more than 6 characters).

Returns the error message of the latest error with this function. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns the numerical error code of the latest error with this function. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns true if external power supply voltage is too low.

Returns true if the module is in failure mode. More information can be obtained by testing get_overheat, get_overcurrent etc... When a error condition is met, the output voltage is set to z\xE9ro and cannot be changed until the reset() function is called.

Returns a global identifier of the function in the format MODULE_NAME.FUNCTION_NAME. The returned string uses the logical names of the module and of the function if they are defined, otherwise the serial number of the module and the hardware identifier of the function (for exemple: MyCustomName.relay1)

Returns a unique identifier of type YFUN_DESCR corresponding to the function. This identifier can be used to test if two instances of YFunction reference the same physical function on the same physical device.

Returns the hardware identifier of the function, without reference to the module. For example relay1

Returns the unique hardware identifier of the function in the form SERIAL.FUNCTIONID. The unique hardware identifier is composed of the device serial number and of the hardware identifier of the function. (for example RELAYLO1-123456.relay1)

Returns the logical name of the voltage source.

Gets the YModule object for the device on which the function is located. If the function cannot be located on any module, the returned instance of YModule is not shown as on-line.

Gets the YModule object for the device on which the function is located (asynchronous version). If the function cannot be located on any module, the returned YModule object does not show as on-line. This asynchronous version exists only in Javascript. It uses a callback instead of a return value in order to avoid blocking Firefox javascript VM that does not implement context switching during blocking I/O calls. See the documentation section on asynchronous Javascript calls for more details.

Returns true if the appliance connected to the device is too greedy .

Returns TRUE if the module is overheating.

Returns true if the device is not able to maintaint the requested voltage output .

Returns true if the voltage output is too high regarding the requested voltage .

Returns the measuring unit for the voltage.

Returns the value of the userData attribute, as previously stored using method set_userData. This attribute is never touched directly by the API, and is at disposal of the caller to store a context.

Returns the voltage output command (mV)

Checks if the function is currently reachable, without raising any error. If there is a cached value for the function in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the requested function.

Checks if the function is currently reachable, without raising any error (asynchronous version). If there is a cached value for the function in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the requested function.

This asynchronous version exists only in Javascript. It uses a callback instead of a return value in order to avoid blocking Firefox Javascript VM that does not implement context switching during blocking I/O calls.

Preloads the function cache with a specified validity duration. By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network trafic for instance.

Preloads the function cache with a specified validity duration (asynchronous version). By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network trafic for instance. This asynchronous version exists only in Javascript. It uses a callback instead of a return value in order to avoid blocking Firefox javascript VM that does not implement context switching during blocking I/O calls. See the documentation section on asynchronous Javascript calls for more details.

Continues the enumeration of voltage sources started using yFirstVSource().

Sets device output to a specific volatage, for a specified duration, then brings it automatically to 0V.

Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a null pointer as argument.

Changes the logical name of the voltage source. You can use yCheckLogicalName() prior to this call to make sure that your parameter is valid. Remember to call the saveToFlash() method of the module if the modification must be kept.

Stores a user context provided as argument in the userData attribute of the function. This attribute is never touched by the API, and is at disposal of the caller to store a context.

Tunes the device output voltage (milliVolts).

Performs a smooth move at constant speed toward a given value.

Waits for all pending asynchronous commands on the module to complete, and invoke the user-provided callback function. The callback function can therefore freely issue synchronous or asynchronous commands, without risking to block the Javascript VM.

The YVoc class allows you to read and configure Yoctopuce Volatile Organic Compound sensors. It inherits from YSensor class the core functions to read measurements, to register callback functions, and to access the autonomous datalogger.

Retrieves a Volatile Organic Compound sensor for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the Volatile Organic Compound sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YVoc.isOnline() to test if the Volatile Organic Compound sensor is indeed online at a given time. In case of ambiguity when looking for a Volatile Organic Compound sensor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object\x27s is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Starts the enumeration of Volatile Organic Compound sensors currently accessible. Use the method YVoc.nextVoc() to iterate on next Volatile Organic Compound sensors.

Invalidates the cache. Invalidates the cache of the Volatile Organic Compound sensor attributes. Forces the next call to get_xxx() or loadxxx() to use values that come from the device.

Returns a short text that describes unambiguously the instance of the Volatile Organic Compound sensor in the form TYPE(NAME)=SERIAL.FUNCTIONID. More precisely, TYPE is the type of the function, NAME it the name used for the first access to the function, SERIAL is the serial number of the module if the module is connected or \x22unresolved\x22, and FUNCTIONID is the hardware identifier of the function if the module is connected. For example, this method returns Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 if the module is already connected or Relay(BadCustomeName.relay1)=unresolved if the module has not yet been connected. This method does not trigger any USB or TCP transaction and can therefore be used in a debugger.

Returns the measuring mode used for the advertised value pushed to the parent hub.

Returns the current value of the Volatile Organic Compound sensor (no more than 6 characters).

Returns the uncalibrated, unrounded raw value returned by the sensor, in ppm (vol), as a floating point number.

Returns the current value of the estimated VOC concentration, in ppm (vol), as a floating point number. Note that a get_currentValue() call will *not* start a measure in the device, it will just return the last measure that occurred in the device. Indeed, internally, each Yoctopuce devices is continuously making measurements at a hardware specific frequency.

If continuously calling get_currentValue() leads you to performances issues, then you might consider to switch to callback programming model. Check the \x22advanced programming\x22 chapter in in your device user manual for more information.

Returns the error message of the latest error with the Volatile Organic Compound sensor. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns the numerical error code of the latest error with the Volatile Organic Compound sensor. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns a global identifier of the Volatile Organic Compound sensor in the format MODULE_NAME.FUNCTION_NAME. The returned string uses the logical names of the module and of the Volatile Organic Compound sensor if they are defined, otherwise the serial number of the module and the hardware identifier of the Volatile Organic Compound sensor (for example: MyCustomName.relay1)

Returns the hardware identifier of the Volatile Organic Compound sensor, without reference to the module. For example relay1

Returns the unique hardware identifier of the Volatile Organic Compound sensor in the form SERIAL.FUNCTIONID. The unique hardware identifier is composed of the device serial number and of the hardware identifier of the Volatile Organic Compound sensor (for example RELAYLO1-123456.relay1).

Returns the maximal value observed for the estimated VOC concentration since the device was started. Can be reset to an arbitrary value thanks to set_highestValue().

Returns the datalogger recording frequency for this function, or \x22OFF\x22 when measures are not stored in the data logger flash memory.

Returns the logical name of the Volatile Organic Compound sensor.

Returns the minimal value observed for the estimated VOC concentration since the device was started. Can be reset to an arbitrary value thanks to set_lowestValue().

Returns the timed value notification frequency, or \x22OFF\x22 if timed value notifications are disabled for this function.

Returns the resolution of the measured values. The resolution corresponds to the numerical precision of the measures, which is not always the same as the actual precision of the sensor. Remember to call the saveToFlash() method of the module if the modification must be kept.

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.

Returns the measuring unit for the estimated VOC concentration.

Checks if the Volatile Organic Compound sensor is currently reachable, without raising any error. If there is a cached value for the Volatile Organic Compound sensor in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the Volatile Organic Compound sensor.

Checks if the Volatile Organic Compound sensor is currently reachable, without raising any error (asynchronous version). If there is a cached value for the Volatile Organic Compound sensor in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the requested function.

This asynchronous version exists only in Javascript. It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine.

Preloads the Volatile Organic Compound sensor cache with a specified validity duration. By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

Preloads the Volatile Organic Compound sensor cache with a specified validity duration (asynchronous version). By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

This asynchronous version exists only in JavaScript. It uses a callback instead of a return value in order to avoid blocking the JavaScript virtual machine.

Continues the enumeration of Volatile Organic Compound sensors started using yFirstVoc(). Caution: You can\x27t make any assumption about the returned Volatile Organic Compound sensors order. If you want to find a specific a Volatile Organic Compound sensor, use Voc.findVoc() and a hardwareID or a logical name.

Changes the measuring mode used for the advertised value pushed to the parent hub. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the logical name of the Volatile Organic Compound sensor. You can use yCheckLogicalName() prior to this call to make sure that your parameter is valid. Remember to call the saveToFlash() method of the module if the modification must be kept.

The YVoltage class allows you to read and configure Yoctopuce voltage sensors. It inherits from YSensor class the core functions to read measurements, to register callback functions, and to access the autonomous datalogger.

Retrieves a voltage sensor for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the voltage sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YVoltage.isOnline() to test if the voltage sensor is indeed online at a given time. In case of ambiguity when looking for a voltage sensor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object\x27s is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Starts the enumeration of voltage sensors currently accessible. Use the method YVoltage.nextVoltage() to iterate on next voltage sensors.

Invalidates the cache. Invalidates the cache of the voltage sensor attributes. Forces the next call to get_xxx() or loadxxx() to use values that come from the device.

Returns a short text that describes unambiguously the instance of the voltage sensor in the form TYPE(NAME)=SERIAL.FUNCTIONID. More precisely, TYPE is the type of the function, NAME it the name used for the first access to the function, SERIAL is the serial number of the module if the module is connected or \x22unresolved\x22, and FUNCTIONID is the hardware identifier of the function if the module is connected. For example, this method returns Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 if the module is already connected or Relay(BadCustomeName.relay1)=unresolved if the module has not yet been connected. This method does not trigger any USB or TCP transaction and can therefore be used in a debugger.

Returns the measuring mode used for the advertised value pushed to the parent hub.

Returns the current value of the voltage sensor (no more than 6 characters).

Returns the uncalibrated, unrounded raw value returned by the sensor, in Volt, as a floating point number.

Returns the current value of the voltage, in Volt, as a floating point number. Note that a get_currentValue() call will *not* start a measure in the device, it will just return the last measure that occurred in the device. Indeed, internally, each Yoctopuce devices is continuously making measurements at a hardware specific frequency.

If continuously calling get_currentValue() leads you to performances issues, then you might consider to switch to callback programming model. Check the \x22advanced programming\x22 chapter in in your device user manual for more information.

Returns the activation state of this input.

Returns the error message of the latest error with the voltage sensor. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns the numerical error code of the latest error with the voltage sensor. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns a global identifier of the voltage sensor in the format MODULE_NAME.FUNCTION_NAME. The returned string uses the logical names of the module and of the voltage sensor if they are defined, otherwise the serial number of the module and the hardware identifier of the voltage sensor (for example: MyCustomName.relay1)

Returns the hardware identifier of the voltage sensor, without reference to the module. For example relay1

Returns the unique hardware identifier of the voltage sensor in the form SERIAL.FUNCTIONID. The unique hardware identifier is composed of the device serial number and of the hardware identifier of the voltage sensor (for example RELAYLO1-123456.relay1).

Returns the maximal value observed for the voltage since the device was started. Can be reset to an arbitrary value thanks to set_highestValue().

Returns the datalogger recording frequency for this function, or \x22OFF\x22 when measures are not stored in the data logger flash memory.

Returns the logical name of the voltage sensor.

Returns the minimal value observed for the voltage since the device was started. Can be reset to an arbitrary value thanks to set_lowestValue().

Returns the timed value notification frequency, or \x22OFF\x22 if timed value notifications are disabled for this function.

Returns the resolution of the measured values. The resolution corresponds to the numerical precision of the measures, which is not always the same as the actual precision of the sensor. Remember to call the saveToFlash() method of the module if the modification must be kept.

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.

Returns the measuring unit for the voltage.

Checks if the voltage sensor is currently reachable, without raising any error. If there is a cached value for the voltage sensor in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the voltage sensor.

Checks if the voltage sensor is currently reachable, without raising any error (asynchronous version). If there is a cached value for the voltage sensor in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the requested function.

This asynchronous version exists only in Javascript. It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine.

Preloads the voltage sensor cache with a specified validity duration. By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

Preloads the voltage sensor cache with a specified validity duration (asynchronous version). By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

This asynchronous version exists only in JavaScript. It uses a callback instead of a return value in order to avoid blocking the JavaScript virtual machine.

Continues the enumeration of voltage sensors started using yFirstVoltage(). Caution: You can\x27t make any assumption about the returned voltage sensors order. If you want to find a specific a voltage sensor, use Voltage.findVoltage() and a hardwareID or a logical name.

Changes the measuring mode used for the advertised value pushed to the parent hub. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the activation state of this voltage input. When AC measurements are disabled, the device will always assume a DC signal, and vice-versa. When both AC and DC measurements are active, the device switches between AC and DC mode based on the relative amplitude of variations compared to the average value. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the logical name of the voltage sensor. You can use yCheckLogicalName() prior to this call to make sure that your parameter is valid. Remember to call the saveToFlash() method of the module if the modification must be kept.

The YVoltageOutput class allows you to drive a voltage output.

Retrieves a voltage output for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the voltage output is online at the time it is invoked. The returned object is nevertheless valid. Use the method YVoltageOutput.isOnline() to test if the voltage output is indeed online at a given time. In case of ambiguity when looking for a voltage output by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object\x27s is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Starts the enumeration of voltage outputs currently accessible. Use the method YVoltageOutput.nextVoltageOutput() to iterate on next voltage outputs.

Invalidates the cache. Invalidates the cache of the voltage output attributes. Forces the next call to get_xxx() or loadxxx() to use values that come from the device.

Returns a short text that describes unambiguously the instance of the voltage output in the form TYPE(NAME)=SERIAL.FUNCTIONID. More precisely, TYPE is the type of the function, NAME it the name used for the first access to the function, SERIAL is the serial number of the module if the module is connected or \x22unresolved\x22, and FUNCTIONID is the hardware identifier of the function if the module is connected. For example, this method returns Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 if the module is already connected or Relay(BadCustomeName.relay1)=unresolved if the module has not yet been connected. This method does not trigger any USB or TCP transaction and can therefore be used in a debugger.

Returns the current value of the voltage output (no more than 6 characters).

Returns the output voltage set point, in V.

Returns the error message of the latest error with the voltage output. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns the numerical error code of the latest error with the voltage output. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns a global identifier of the voltage output in the format MODULE_NAME.FUNCTION_NAME. The returned string uses the logical names of the module and of the voltage output if they are defined, otherwise the serial number of the module and the hardware identifier of the voltage output (for example: MyCustomName.relay1)

Returns the hardware identifier of the voltage output, without reference to the module. For example relay1

Returns the unique hardware identifier of the voltage output in the form SERIAL.FUNCTIONID. The unique hardware identifier is composed of the device serial number and of the hardware identifier of the voltage output (for example RELAYLO1-123456.relay1).

Returns the logical name of the voltage output.

Returns the selected voltage output at device startup, in V.

Checks if the voltage output is currently reachable, without raising any error. If there is a cached value for the voltage output in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the voltage output.

Checks if the voltage output is currently reachable, without raising any error (asynchronous version). If there is a cached value for the voltage output in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the requested function.

This asynchronous version exists only in Javascript. It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine.

Preloads the voltage output cache with a specified validity duration. By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

Preloads the voltage output cache with a specified validity duration (asynchronous version). By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

This asynchronous version exists only in JavaScript. It uses a callback instead of a return value in order to avoid blocking the JavaScript virtual machine.

Continues the enumeration of voltage outputs started using yFirstVoltageOutput(). Caution: You can\x27t make any assumption about the returned voltage outputs order. If you want to find a specific a voltage output, use VoltageOutput.findVoltageOutput() and a hardwareID or a logical name.

Changes the output voltage, in V. Valid range is from 0 to 10V.

Changes the logical name of the voltage output. You can use yCheckLogicalName() prior to this call to make sure that your parameter is valid. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the output voltage at device start up. Remember to call the matching module saveToFlash() method, otherwise this call has no effect.

Performs a smooth transition of output voltage. Any explicit voltage change cancels any ongoing transition process.

The YWakeUpMonitor class handles globally all wake-up sources, as well as automated sleep mode.

Retrieves a wake-up monitor for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the wake-up monitor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YWakeUpMonitor.isOnline() to test if the wake-up monitor is indeed online at a given time. In case of ambiguity when looking for a wake-up monitor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object\x27s is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Starts the enumeration of wake-up monitors currently accessible. Use the method YWakeUpMonitor.nextWakeUpMonitor() to iterate on next wake-up monitors.

Invalidates the cache. Invalidates the cache of the wake-up monitor attributes. Forces the next call to get_xxx() or loadxxx() to use values that come from the device.

Returns a short text that describes unambiguously the instance of the wake-up monitor in the form TYPE(NAME)=SERIAL.FUNCTIONID. More precisely, TYPE is the type of the function, NAME it the name used for the first access to the function, SERIAL is the serial number of the module if the module is connected or \x22unresolved\x22, and FUNCTIONID is the hardware identifier of the function if the module is connected. For example, this method returns Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 if the module is already connected or Relay(BadCustomeName.relay1)=unresolved if the module has not yet been connected. This method does not trigger any USB or TCP transaction and can therefore be used in a debugger.

Returns the current value of the wake-up monitor (no more than 6 characters).

Returns the error message of the latest error with the wake-up monitor. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns the numerical error code of the latest error with the wake-up monitor. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns a global identifier of the wake-up monitor in the format MODULE_NAME.FUNCTION_NAME. The returned string uses the logical names of the module and of the wake-up monitor if they are defined, otherwise the serial number of the module and the hardware identifier of the wake-up monitor (for example: MyCustomName.relay1)

Returns the hardware identifier of the wake-up monitor, without reference to the module. For example relay1

Returns the unique hardware identifier of the wake-up monitor in the form SERIAL.FUNCTIONID. The unique hardware identifier is composed of the device serial number and of the hardware identifier of the wake-up monitor (for example RELAYLO1-123456.relay1).

Returns the logical name of the wake-up monitor.

Returns the next scheduled wake up date/time (UNIX format).

Returns the maximal wake up time (in seconds) before automatically going to sleep.

Returns the delay before the next sleep period.

Returns the latest wake up reason.

Returns the current state of the monitor.

Checks if the wake-up monitor is currently reachable, without raising any error. If there is a cached value for the wake-up monitor in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the wake-up monitor.

Checks if the wake-up monitor is currently reachable, without raising any error (asynchronous version). If there is a cached value for the wake-up monitor in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the requested function.

This asynchronous version exists only in Javascript. It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine.

Preloads the wake-up monitor cache with a specified validity duration. By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

Preloads the wake-up monitor cache with a specified validity duration (asynchronous version). By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

This asynchronous version exists only in JavaScript. It uses a callback instead of a return value in order to avoid blocking the JavaScript virtual machine.

Continues the enumeration of wake-up monitors started using yFirstWakeUpMonitor(). Caution: You can\x27t make any assumption about the returned wake-up monitors order. If you want to find a specific a wake-up monitor, use WakeUpMonitor.findWakeUpMonitor() and a hardwareID or a logical name.

Resets the sleep countdown.

Changes the logical name of the wake-up monitor. You can use yCheckLogicalName() prior to this call to make sure that your parameter is valid. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the days of the week when a wake up must take place.

Changes the maximal wake up time (seconds) before automatically going to sleep. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the delay before the next sleep period.

Goes to sleep until the next wake up condition is met, the RTC time must have been set before calling this function.

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. The count down before sleep can be canceled with resetSleepCountDown.

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. The count down before sleep can be canceled with resetSleepCountDown.

Forces a wake up.

The YWakeUpSchedule class implements a wake up condition. The wake up time is specified as a set of months and/or days and/or hours and/or minutes when the wake up should happen.

Retrieves a wake up schedule for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the wake up schedule is online at the time it is invoked. The returned object is nevertheless valid. Use the method YWakeUpSchedule.isOnline() to test if the wake up schedule is indeed online at a given time. In case of ambiguity when looking for a wake up schedule by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object\x27s is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Starts the enumeration of wake up schedules currently accessible. Use the method YWakeUpSchedule.nextWakeUpSchedule() to iterate on next wake up schedules.

Invalidates the cache. Invalidates the cache of the wake up schedule attributes. Forces the next call to get_xxx() or loadxxx() to use values that come from the device.

Returns a short text that describes unambiguously the instance of the wake up schedule in the form TYPE(NAME)=SERIAL.FUNCTIONID. More precisely, TYPE is the type of the function, NAME it the name used for the first access to the function, SERIAL is the serial number of the module if the module is connected or \x22unresolved\x22, and FUNCTIONID is the hardware identifier of the function if the module is connected. For example, this method returns Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 if the module is already connected or Relay(BadCustomeName.relay1)=unresolved if the module has not yet been connected. This method does not trigger any USB or TCP transaction and can therefore be used in a debugger.

Returns the current value of the wake up schedule (no more than 6 characters).

Returns the error message of the latest error with the wake up schedule. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns the numerical error code of the latest error with the wake up schedule. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns a global identifier of the wake up schedule in the format MODULE_NAME.FUNCTION_NAME. The returned string uses the logical names of the module and of the wake up schedule if they are defined, otherwise the serial number of the module and the hardware identifier of the wake up schedule (for example: MyCustomName.relay1)

Returns the hardware identifier of the wake up schedule, without reference to the module. For example relay1

Returns the unique hardware identifier of the wake up schedule in the form SERIAL.FUNCTIONID. The unique hardware identifier is composed of the device serial number and of the hardware identifier of the wake up schedule (for example RELAYLO1-123456.relay1).

Returns the hours scheduled for wake up.

Returns the logical name of the wake up schedule.

Returns all the minutes of each hour that are scheduled for wake up.

Returns the minutes in the 00-29 interval of each hour scheduled for wake up.

Returns the minutes in the 30-59 interval of each hour scheduled for wake up.

Returns the days of the month scheduled for wake up.

Returns the months scheduled for wake up.

Returns the date/time (seconds) of the next wake up occurrence.

Returns the days of the week scheduled for wake up.

Checks if the wake up schedule is currently reachable, without raising any error. If there is a cached value for the wake up schedule in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the wake up schedule.

Checks if the wake up schedule is currently reachable, without raising any error (asynchronous version). If there is a cached value for the wake up schedule in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the requested function.

This asynchronous version exists only in Javascript. It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine.

Preloads the wake up schedule cache with a specified validity duration. By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

Preloads the wake up schedule cache with a specified validity duration (asynchronous version). By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

This asynchronous version exists only in JavaScript. It uses a callback instead of a return value in order to avoid blocking the JavaScript virtual machine.

Continues the enumeration of wake up schedules started using yFirstWakeUpSchedule(). Caution: You can\x27t make any assumption about the returned wake up schedules order. If you want to find a specific a wake up schedule, use WakeUpSchedule.findWakeUpSchedule() and a hardwareID or a logical name.

Changes the hours when a wake up must take place. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the logical name of the wake up schedule. You can use yCheckLogicalName() prior to this call to make sure that your parameter is valid. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes all the minutes where a wake up must take place.

Changes the minutes in the 00-29 interval when a wake up must take place. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the minutes in the 30-59 interval when a wake up must take place. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the days of the month when a wake up must take place. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the months when a wake up must take place. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the days of the week when a wake up must take place. Remember to call the saveToFlash() method of the module if the modification must be kept.

The YWatchdog class allows you to drive a Yoctopuce watchdog. A watchdog works like a relay, with an extra timer that can automatically trigger a brief power cycle to an appliance after a preset delay, to force this appliance to reset if a problem occurs. During normal use, the watchdog timer is reset periodically by the application to prevent the automated power cycle. Whenever the application dies, the watchdog will automatically trigger the power cycle. The watchdog can also be driven directly with pulse and delayedPulse methods to switch off an appliance for a given duration.

Retrieves a watchdog for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the watchdog is online at the time it is invoked. The returned object is nevertheless valid. Use the method YWatchdog.isOnline() to test if the watchdog is indeed online at a given time. In case of ambiguity when looking for a watchdog by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object\x27s is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Starts the enumeration of watchdog currently accessible. Use the method YWatchdog.nextWatchdog() to iterate on next watchdog.

Invalidates the cache. Invalidates the cache of the watchdog attributes. Forces the next call to get_xxx() or loadxxx() to use values that come from the device.

Schedules a pulse.

Returns a short text that describes unambiguously the instance of the watchdog in the form TYPE(NAME)=SERIAL.FUNCTIONID. More precisely, TYPE is the type of the function, NAME it the name used for the first access to the function, SERIAL is the serial number of the module if the module is connected or \x22unresolved\x22, and FUNCTIONID is the hardware identifier of the function if the module is connected. For example, this method returns Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 if the module is already connected or Relay(BadCustomeName.relay1)=unresolved if the module has not yet been connected. This method does not trigger any USB or TCP transaction and can therefore be used in a debugger.

Returns the current value of the watchdog (no more than 6 characters).

Returns the watchdog running state at module power on.

Returns the number of milliseconds remaining before a pulse (delayedPulse() call) When there is no scheduled pulse, returns zero.

Returns the error message of the latest error with the watchdog. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns the numerical error code of the latest error with the watchdog. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns a global identifier of the watchdog in the format MODULE_NAME.FUNCTION_NAME. The returned string uses the logical names of the module and of the watchdog if they are defined, otherwise the serial number of the module and the hardware identifier of the watchdog (for example: MyCustomName.relay1)

Returns the hardware identifier of the watchdog, without reference to the module. For example relay1

Returns the unique hardware identifier of the watchdog in the form SERIAL.FUNCTIONID. The unique hardware identifier is composed of the device serial number and of the hardware identifier of the watchdog (for example RELAYLO1-123456.relay1).

Returns the number of seconds spent since the last output power-up event.

Returns the logical name of the watchdog.

Returns the maximum time (ms) allowed for the watchdog to stay in state A before automatically switching back in to B state. Zero means no time limit.

Retourne the maximum time (ms) allowed for the watchdog to stay in state B before automatically switching back in to A state. Zero means no time limit.

Returns the output state of the watchdog, when used as a simple switch (single throw).

Returns the number of milliseconds remaining before the watchdog is returned to idle position (state A), during a measured pulse generation. When there is no ongoing pulse, returns zero.

Returns the watchdog running state.

Returns the state of the watchdog (A for the idle position, B for the active position).

Returns the state of the watchdog at device startup (A for the idle position, B for the active position, UNCHANGED to leave the relay state as is).

Returns the waiting duration before a reset is automatically triggered by the watchdog, in milliseconds.

Returns the duration of resets caused by the watchdog, in milliseconds.

Checks if the watchdog is currently reachable, without raising any error. If there is a cached value for the watchdog in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the watchdog.

Checks if the watchdog is currently reachable, without raising any error (asynchronous version). If there is a cached value for the watchdog in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the requested function.

This asynchronous version exists only in Javascript. It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine.

Preloads the watchdog cache with a specified validity duration. By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

Preloads the watchdog cache with a specified validity duration (asynchronous version). By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

This asynchronous version exists only in JavaScript. It uses a callback instead of a return value in order to avoid blocking the JavaScript virtual machine.

Continues the enumeration of watchdog started using yFirstWatchdog(). Caution: You can\x27t make any assumption about the returned watchdog order. If you want to find a specific a watchdog, use Watchdog.findWatchdog() and a hardwareID or a logical name.

Sets the relay to output B (active) for a specified duration, then brings it automatically back to output A (idle state).

Resets the watchdog. When the watchdog is running, this function must be called on a regular basis to prevent the watchdog to trigger

Changes the watchdog running state at module power on. Remember to call the saveToFlash() method and then to reboot the module to apply this setting.

Changes the logical name of the watchdog. You can use yCheckLogicalName() prior to this call to make sure that your parameter is valid. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the maximum time (ms) allowed for the watchdog to stay in state A before automatically switching back in to B state. Use zero for no time limit. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the maximum time (ms) allowed for the watchdog to stay in state B before automatically switching back in to A state. Use zero for no time limit. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the output state of the watchdog, when used as a simple switch (single throw).

Changes the running state of the watchdog.

Changes the state of the watchdog (A for the idle position, B for the active position).

Changes the state of the watchdog at device startup (A for the idle position, B for the active position, UNCHANGED to leave the relay state as is). Remember to call the matching module saveToFlash() method, otherwise this call will have no effect.

Changes the waiting delay before a reset is triggered by the watchdog, in milliseconds. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the duration of resets caused by the watchdog, in milliseconds. Remember to call the saveToFlash() method of the module if the modification must be kept.

Switch the relay to the opposite state.

The YWeighScale class provides a weight measurement from a ratiometric sensor. It can be used to control the bridge excitation parameters, in order to avoid measure shifts caused by temperature variation in the electronics, and can also automatically apply an additional correction factor based on temperature to compensate for offsets in the load cell itself.

Retrieves a weighing scale sensor for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the weighing scale sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YWeighScale.isOnline() to test if the weighing scale sensor is indeed online at a given time. In case of ambiguity when looking for a weighing scale sensor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object\x27s is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Starts the enumeration of weighing scale sensors currently accessible. Use the method YWeighScale.nextWeighScale() to iterate on next weighing scale sensors.

Invalidates the cache. Invalidates the cache of the weighing scale sensor attributes. Forces the next call to get_xxx() or loadxxx() to use values that come from the device.

Returns a short text that describes unambiguously the instance of the weighing scale sensor in the form TYPE(NAME)=SERIAL.FUNCTIONID. More precisely, TYPE is the type of the function, NAME it the name used for the first access to the function, SERIAL is the serial number of the module if the module is connected or \x22unresolved\x22, and FUNCTIONID is the hardware identifier of the function if the module is connected. For example, this method returns Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 if the module is already connected or Relay(BadCustomeName.relay1)=unresolved if the module has not yet been connected. This method does not trigger any USB or TCP transaction and can therefore be used in a debugger.

Returns the measuring mode used for the advertised value pushed to the parent hub.

Returns the current value of the weighing scale sensor (no more than 6 characters).

Returns the current averaged temperature, used for thermal compensation.

Returns the current temperature variation, used for thermal compensation.

Returns the current current thermal compensation value.

Returns the uncalibrated, unrounded raw value returned by the sensor, in the specified unit, as a floating point number.

Returns the current value of the measure, in the specified unit, as a floating point number. Note that a get_currentValue() call will *not* start a measure in the device, it will just return the last measure that occurred in the device. Indeed, internally, each Yoctopuce devices is continuously making measurements at a hardware specific frequency.

If continuously calling get_currentValue() leads you to performances issues, then you might consider to switch to callback programming model. Check the \x22advanced programming\x22 chapter in in your device user manual for more information.

Returns the error message of the latest error with the weighing scale sensor. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns the numerical error code of the latest error with the weighing scale sensor. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns the current load cell bridge excitation method.

Returns a global identifier of the weighing scale sensor in the format MODULE_NAME.FUNCTION_NAME. The returned string uses the logical names of the module and of the weighing scale sensor if they are defined, otherwise the serial number of the module and the hardware identifier of the weighing scale sensor (for example: MyCustomName.relay1)

Returns the hardware identifier of the weighing scale sensor, without reference to the module. For example relay1

Returns the unique hardware identifier of the weighing scale sensor in the form SERIAL.FUNCTIONID. The unique hardware identifier is composed of the device serial number and of the hardware identifier of the weighing scale sensor (for example RELAYLO1-123456.relay1).

Returns the maximal value observed for the measure since the device was started. Can be reset to an arbitrary value thanks to set_highestValue().

Returns the datalogger recording frequency for this function, or \x22OFF\x22 when measures are not stored in the data logger flash memory.

Returns the logical name of the weighing scale sensor.

Returns the minimal value observed for the measure since the device was started. Can be reset to an arbitrary value thanks to set_lowestValue().

Returns the timed value notification frequency, or \x22OFF\x22 if timed value notifications are disabled for this function.

Returns the resolution of the measured values. The resolution corresponds to the numerical precision of the measures, which is not always the same as the actual precision of the sensor. Remember to call the saveToFlash() method of the module if the modification must be kept.

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.

Returns the averaged temperature update rate, in per mille. The purpose of this adaptation ratio is to model the thermal inertia of the load cell. The averaged temperature is updated every 10 seconds, by applying this adaptation rate to the difference between the measures ambient temperature and the current compensation temperature. The standard rate is 0.2 per mille, and the maximal rate is 65 per mille.

Returns the temperature change update rate, in per mille. The temperature change is updated every 10 seconds, by applying this adaptation rate to the difference between the measures ambient temperature and the current temperature used for change compensation. The standard rate is 0.6 per mille, and the maximal rate is 65 per mille.

Returns the measuring unit for the measure.

Returns the zero tracking threshold value. When this threshold is larger than zero, any measure under the threshold will automatically be ignored and the zero compensation will be updated.

Checks if the weighing scale sensor is currently reachable, without raising any error. If there is a cached value for the weighing scale sensor in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the weighing scale sensor.

Checks if the weighing scale sensor is currently reachable, without raising any error (asynchronous version). If there is a cached value for the weighing scale sensor in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the requested function.

This asynchronous version exists only in Javascript. It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine.

Preloads the weighing scale sensor cache with a specified validity duration. By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

Retrieves the weight offset thermal compensation table previously configured using the set_offsetAvgCompensationTable function. The weight correction is applied by linear interpolation between specified points.

Retrieves the weight offset thermal compensation table previously configured using the set_offsetChgCompensationTable function. The weight correction is applied by linear interpolation between specified points.

Retrieves the weight span thermal compensation table previously configured using the set_spanAvgCompensationTable function. The weight correction is applied by linear interpolation between specified points.

Retrieves the weight span thermal compensation table previously configured using the set_spanChgCompensationTable function. The weight correction is applied by linear interpolation between specified points.

Preloads the weighing scale sensor cache with a specified validity duration (asynchronous version). By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

This asynchronous version exists only in JavaScript. It uses a callback instead of a return value in order to avoid blocking the JavaScript virtual machine.

Continues the enumeration of weighing scale sensors started using yFirstWeighScale(). Caution: You can\x27t make any assumption about the returned weighing scale sensors order. If you want to find a specific a weighing scale sensor, use WeighScale.findWeighScale() and a hardwareID or a logical name.

Changes the measuring mode used for the advertised value pushed to the parent hub. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the current load cell bridge excitation method. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the logical name of the weighing scale sensor. You can use yCheckLogicalName() prior to this call to make sure that your parameter is valid. Remember to call the saveToFlash() method of the module if the modification must be kept.

Records a weight offset thermal compensation table, in order to automatically correct the measured weight based on the averaged compensation temperature. The weight correction will be applied by linear interpolation between specified points.

Records a weight offset thermal compensation table, in order to automatically correct the measured weight based on the variation of temperature. The weight correction will be applied by linear interpolation between specified points.

Records a weight span thermal compensation table, in order to automatically correct the measured weight based on the compensation temperature. The weight correction will be applied by linear interpolation between specified points.

Records a weight span thermal compensation table, in order to automatically correct the measured weight based on the variation of temperature. The weight correction will be applied by linear interpolation between specified points.

Changes the averaged temperature update rate, in per mille. The purpose of this adaptation ratio is to model the thermal inertia of the load cell. The averaged temperature is updated every 10 seconds, by applying this adaptation rate to the difference between the measures ambient temperature and the current compensation temperature. The standard rate is 0.2 per mille, and the maximal rate is 65 per mille. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the temperature change update rate, in per mille. The temperature change is updated every 10 seconds, by applying this adaptation rate to the difference between the measures ambient temperature and the current temperature used for change compensation. The standard rate is 0.6 per mille, and the maximal rate is 65 per mille. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the measuring unit for the weight. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the zero tracking threshold value. When this threshold is larger than zero, any measure under the threshold will automatically be ignored and the zero compensation will be updated. Remember to call the saveToFlash() method of the module if the modification must be kept.

Configures the load cell span parameters (stored in the corresponding genericSensor) so that the current signal corresponds to the specified reference weight.

Adapts the load cell signal bias (stored in the corresponding genericSensor) so that the current signal corresponds to a zero weight. Remember to call the saveToFlash() method of the module if the modification must be kept.

The YWireless class provides control over wireless network parameters and status for devices that are wireless-enabled. Note that TCP/IP parameters are configured separately, using class YNetwork.

Retrieves a wireless LAN interface for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the wireless LAN interface is online at the time it is invoked. The returned object is nevertheless valid. Use the method YWireless.isOnline() to test if the wireless LAN interface is indeed online at a given time. In case of ambiguity when looking for a wireless LAN interface by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object\x27s is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Starts the enumeration of wireless LAN interfaces currently accessible. Use the method YWireless.nextWireless() to iterate on next wireless LAN interfaces.

Changes the configuration of the wireless lan interface to create an ad-hoc wireless network, without using an access point. On the YoctoHub-Wireless-g and YoctoHub-Wireless-n, you should use softAPNetwork() instead, which emulates an access point (Soft AP) which is more efficient and more widely supported than ad-hoc networks.

When a security key is specified for an ad-hoc network, the network is protected by a WEP40 key (5 characters or 10 hexadecimal digits) or WEP128 key (13 characters or 26 hexadecimal digits). It is recommended to use a well-randomized WEP128 key using 26 hexadecimal digits to maximize security. Remember to call the saveToFlash() method and then to reboot the module to apply this setting.

Invalidates the cache. Invalidates the cache of the wireless LAN interface attributes. Forces the next call to get_xxx() or loadxxx() to use values that come from the device.

Returns a short text that describes unambiguously the instance of the wireless LAN interface in the form TYPE(NAME)=SERIAL.FUNCTIONID. More precisely, TYPE is the type of the function, NAME it the name used for the first access to the function, SERIAL is the serial number of the module if the module is connected or \x22unresolved\x22, and FUNCTIONID is the hardware identifier of the function if the module is connected. For example, this method returns Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 if the module is already connected or Relay(BadCustomeName.relay1)=unresolved if the module has not yet been connected. This method does not trigger any USB or TCP transaction and can therefore be used in a debugger.

Returns the current value of the wireless LAN interface (no more than 6 characters).

Returns the 802.11 channel currently used, or 0 when the selected network has not been found.

Returns a list of YWlanRecord objects that describe detected Wireless networks. This list is not updated when the module is already connected to an access point (infrastructure mode). To force an update of this list, startWlanScan() must be called. Note that an languages without garbage collections, the returned list must be freed by the caller.

Returns the error message of the latest error with the wireless LAN interface. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns the numerical error code of the latest error with the wireless LAN interface. This method is mostly useful when using the Yoctopuce library with exceptions disabled.

Returns a global identifier of the wireless LAN interface in the format MODULE_NAME.FUNCTION_NAME. The returned string uses the logical names of the module and of the wireless LAN interface if they are defined, otherwise the serial number of the module and the hardware identifier of the wireless LAN interface (for example: MyCustomName.relay1)

Returns the hardware identifier of the wireless LAN interface, without reference to the module. For example relay1

Returns the unique hardware identifier of the wireless LAN interface in the form SERIAL.FUNCTIONID. The unique hardware identifier is composed of the device serial number and of the hardware identifier of the wireless LAN interface (for example RELAYLO1-123456.relay1).

Returns the link quality, expressed in percent.

Returns the logical name of the wireless LAN interface.

Returns the latest status message from the wireless interface.

Returns the security algorithm used by the selected wireless network.

Returns the wireless network name (SSID).

Returns the current state of the wireless interface. The state YWireless.WLANSTATE_DOWN means that the network interface is not connected to a network. The state YWireless.WLANSTATE_SCANNING means that the network interface is scanning available frequencies. During this stage, the device is not reachable, and the network settings are not yet applied. The state YWireless.WLANSTATE_CONNECTED means that the network settings have been successfully applied ant that the device is reachable from the wireless network. If the device is configured to use ad-hoc or Soft AP mode, it means that the wireless network is up and that other devices can join the network. The state YWireless.WLANSTATE_REJECTED means that the network interface has not been able to join the requested network. The description of the error can be obtain with the get_message() method.

Checks if the wireless LAN interface is currently reachable, without raising any error. If there is a cached value for the wireless LAN interface in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the wireless LAN interface.

Checks if the wireless LAN interface is currently reachable, without raising any error (asynchronous version). If there is a cached value for the wireless LAN interface in cache, that has not yet expired, the device is considered reachable. No exception is raised if there is an error while trying to contact the device hosting the requested function.

This asynchronous version exists only in Javascript. It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine.

Changes the configuration of the wireless lan interface to connect to an existing access point (infrastructure mode). Remember to call the saveToFlash() method and then to reboot the module to apply this setting.

Preloads the wireless LAN interface cache with a specified validity duration. By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

Preloads the wireless LAN interface cache with a specified validity duration (asynchronous version). By default, whenever accessing a device, all function attributes are kept in cache for the standard duration (5 ms). This method can be used to temporarily mark the cache as valid for a longer period, in order to reduce network traffic for instance.

This asynchronous version exists only in JavaScript. It uses a callback instead of a return value in order to avoid blocking the JavaScript virtual machine.

Continues the enumeration of wireless LAN interfaces started using yFirstWireless(). Caution: You can\x27t make any assumption about the returned wireless LAN interfaces order. If you want to find a specific a wireless LAN interface, use Wireless.findWireless() and a hardwareID or a logical name.

Changes the logical name of the wireless LAN interface. You can use yCheckLogicalName() prior to this call to make sure that your parameter is valid. Remember to call the saveToFlash() method of the module if the modification must be kept.

Changes the configuration of the wireless lan interface to create a new wireless network by emulating a WiFi access point (Soft AP). This function can only be used with the YoctoHub-Wireless-g and the YoctoHub-Wireless-n.

On the YoctoHub-Wireless-g, when a security key is specified for a SoftAP network, the network is protected by a WEP40 key (5 characters or 10 hexadecimal digits) or WEP128 key (13 characters or 26 hexadecimal digits). It is recommended to use a well-randomized WEP128 key using 26 hexadecimal digits to maximize security.

On the YoctoHub-Wireless-n, when a security key is specified for a SoftAP network, the network will be protected by WPA2.

Remember to call the saveToFlash() method and then to reboot the module to apply this setting.

Triggers a scan of the wireless frequency and builds the list of available networks. The scan forces a disconnection from the current network. At then end of the process, the the network interface attempts to reconnect to the previous network. During the scan, the wlanState switches to YWireless.WLANSTATE_DOWN, then to YWireless.WLANSTATE_SCANNING. When the scan is completed, get_wlanState() returns either YWireless.WLANSTATE_DOWN or YWireless.WLANSTATE_SCANNING. At this point, the list of detected network can be retrieved with the get_detectedWlans() method.

On failure, throws an exception or returns a negative error code.

YWlanRecord objects are used to describe a wireless network. These objects are used in particular in conjunction with the YWireless class.

Returns the 802.11 b/g/n channel number used by this network.

Returns the quality of the wireless network link, in per cents.

Returns the security algorithm used by the wireless network. If the network implements to security, the value is \x22OPEN\x22.

Returns the name of the wireless network (SSID).

These general functions should be used to initialize and configure the Yoctopuce library. In most cases, a simple call to function yRegisterHub() should be enough. The module-specific functions yFind...() or yFirst...() should then be used to retrieve an object that provides interaction with the module.

Checks if a given string is valid as logical name for a module or a function. A valid logical name has a maximum of 19 characters, all among A..Z, a..z, 0..9, _, and -. If you try to configure a logical name with an incorrect string, the invalid characters are ignored.

Disables the use of exceptions to report runtime errors. When exceptions are disabled, every function returns a specific error value which depends on its type and which is documented in this reference manual.

Re-enables the use of exceptions for runtime error handling. Be aware than when exceptions are enabled, every function that fails triggers an exception. If the exception is not caught by the user code, it either fires the debugger or aborts (i.e. crash) the program. On failure, throws an exception or returns a negative error code.

Waits for all pending communications with Yoctopuce devices to be completed then frees dynamically allocated resources used by the Yoctopuce library.

From an operating system standpoint, it is generally not required to call this function since the OS will automatically free allocated resources once your program is completed. However there are two situations when you may really want to use that function:

- Free all dynamically allocated memory blocks in order to track a memory leak.

- Send commands to devices right before the end of the program. Since commands are sent in an asynchronous way the program could exit before all commands are effectively sent.

You should not call any other library function after calling yFreeAPI(), or your program will crash.

Returns the version identifier for the Yoctopuce library in use. The version is a string in the form \x22Major.Minor.Build\x22, for instance \x221.01.5535\x22. For languages using an external DLL (for instance C#, VisualBasic or Delphi), the character string includes as well the DLL version, for instance \x221.01.5535 (1.01.5439)\x22.

If you want to verify in your code that the library version is compatible with the version that you have used during development, verify that the major number is strictly equal and that the minor number is greater or equal. The build number is not relevant with respect to the library compatibility.

Returns the current value of a monotone millisecond-based time counter. This counter can be used to compute delays in relation with Yoctopuce devices, which also uses the millisecond as timebase.

Maintains the device-to-library communication channel. If your program includes significant loops, you may want to include a call to this function to make sure that the library takes care of the information pushed by the modules on the communication channels. This is not strictly necessary, but it may improve the reactivity of the library for the following commands.

This function may signal an error in case there is a communication problem while contacting a module.

Initializes the Yoctopuce programming library explicitly. It is not strictly needed to call yInitAPI(), as the library is automatically initialized when calling yRegisterHub() for the first time.

When YAPI.DETECT_NONE is used as detection mode, you must explicitly use yRegisterHub() to point the API to the VirtualHub on which your devices are connected before trying to access them.

Fault-tolerant alternative to yRegisterHub(). This function has the same purpose and same arguments as yRegisterHub(), but does not trigger an error when the selected hub is not available at the time of the function call. This makes it possible to register a network hub independently of the current connectivity, and to try to contact it only when a device is actively needed.

Register a callback function, to be called each time a device is plugged. This callback will be invoked while yUpdateDeviceList is running. You will have to call this function on a regular basis.

Register a callback function, to be called each time a device is unplugged. This callback will be invoked while yUpdateDeviceList is running. You will have to call this function on a regular basis.

Setup the Yoctopuce library to use modules connected on a given machine. Idealy this call will be made once at the begining of your application. The parameter will determine how the API will work. Use the following values:

usb: When the usb keyword is used, the API will work with devices connected directly to the USB bus. Some programming languages such a JavaScript, PHP, and Java don\x27t provide direct access to USB hardware, so usb will not work with these. In this case, use a VirtualHub or a networked YoctoHub (see below).

x.x.x.x or hostname: The API will use the devices connected to the host with the given IP address or hostname. That host can be a regular computer running a VirtualHub, or a networked YoctoHub such as YoctoHub-Ethernet or YoctoHub-Wireless. If you want to use the VirtualHub running on you local computer, use the IP address 127.0.0.1.

callback: that keyword make the API run in \x22HTTP Callback\x22 mode. This a special mode allowing to take control of Yoctopuce devices through a NAT filter when using a VirtualHub or a networked YoctoHub. You only need to configure your hub to call your server script on a regular basis. This mode is currently available for PHP and Node.JS only.

Be aware that only one application can use direct USB access at a given time on a machine. Multiple access would cause conflicts while trying to access the USB modules. In particular, this means that you must stop the VirtualHub software before starting an application that uses direct USB access. The workaround for this limitation is to setup the library to use the VirtualHub rather than direct USB access.

If access control has been activated on the hub, virtual or not, you want to reach, the URL parameter should look like:

http://username:password@address:port

You can call RegisterHub several times to connect to several machines. On the other hand, it is useless and even counterproductive to call RegisterHub with to same address multiple times during the life of the application.\x09\x09

Invoke the specified callback function after a given timeout. This function behaves more or less like Javascript setTimeout, but during the waiting time, it will call yHandleEvents and yUpdateDeviceList periodically, in order to keep the API up-to-date with current devices.

Pauses the execution flow for a specified duration. This function implements a passive waiting loop, meaning that it does not consume CPU cycles significantly. The processor is left available for other threads and processes. During the pause, the library nevertheless reads from time to time information from the Yoctopuce modules by calling yHandleEvents(), in order to stay up-to-date.

This function may signal an error in case there is a communication problem while contacting a module.

Setup the Yoctopuce library to no more use modules connected on a previously registered machine with RegisterHub.

Triggers a (re)detection of connected Yoctopuce modules. The library searches the machines or USB ports previously registered using yRegisterHub(), and invokes any user-defined callback function in case a change in the list of connected devices is detected.

This function can be called as frequently as desired to refresh the device list and to make the application aware of hot-plug events. However, since device detection is quite a heavy process, UpdateDeviceList shouldn\x27t be called more than once every two seconds.

Triggers a (re)detection of connected Yoctopuce modules. The library searches the machines or USB ports previously registered using yRegisterHub(), and invokes any user-defined callback function in case a change in the list of connected devices is detected.

This function can be called as frequently as desired to refresh the device list and to make the application aware of hot-plug events.

This asynchronous version exists only in JavaScript. It uses a callback instead of a return value in order to avoid blocking Firefox JavaScript VM that does not implement context switching during blocking I/O calls.

',endpos))>=endpos){pos+=4;endpos=text.indexOf('0&&text.substr(pos-7,2)!='VI'&&text.substr(endpos+6,2)!='VI'){cname+='Proxy';} rep=''+cname+'';}}else if((key=inside.match(/^y([A-Z][A-Za-z0-9]+).*/))!==null){ident=key[1];key=key[0].substr(1);if(key.match(/(First|Find)[A-Za-z0-9]+.*/)){if(!UseShortcuts)rep=inside.substr(1);}else{if(!UseShortcuts){rep=sub['YAPI_SUCCESS'].replace('SUCCESS',inside.substr(1));if(doc['YAPI'][ident]){rep=''+rep+'';}}else{if(doc['YAPI'][ident]){rep=''+inside+'';}}}}else if((key=inside.match(/^([A-Za-z][A-Za-z0-9]+)(\.|::)([A-Za-z_0-9]+).*/))!==null){cident=key[1].substr(0,1).toUpperCase()+key[1].substr(1);mident=key[3];if(cident.substr(0,4)!='YAPI'&&cident[0]=='Y')cident=cident.substr(1);if(cident.match(/.*Proxy$/))cident=cident.slice(0,-5);if(!UseShortcuts){rep=inside;}else if(mident.match(/(First|Find)[A-Za-z0-9]+.*/)||cident=='YAPI'){rep='y'+mident;} if(doc[cident]&&doc[cident][mident]){rep=''+rep+'';}}else if((key=inside.match(/^(saveToFlash|isOnline).*/))!==null){rep=''+inside+'';} if(rep)text=text.substr(0,pos)+rep+text.substr(endpos);} return text;} function wdg(n){return document.getElementById(n);} function SetPosition(o,x,y){var it=wdg(o);it.style.top=y;it.style.left=x;} function GetPositionX(o){var it=wdg(o);return parseInt(it.style.left);} function GetPositionY(o){var it=wdg(o);return parseInt(it.style.top);} function GetWidth(o){var it=wdg(o);return parseInt(it.style.width);} function GetHeight(o){var it=wdg(o);return parseInt(it.style.height);} function SetHeight(o,h){var it=wdg(o);h=parseInt(h);if(h<0)h=0;it.style.height=h+"px";} function SetWidth(o,w){var it=wdg(o);w=parseInt(w);if(w<0)w=0;it.style.width=parseInt(w)+"px";} function SetLeft(o,l){var it=wdg(o);it.style.left=parseInt(l)+"px";} function SetTop(o,t){var it=wdg(o);it.style.top=parseInt(t)+"px";} function SetSize(o,w,h){var it=wdg(o);w=parseInt(w);if(w<0)w=0;h=parseInt(h);if(h<0)h=0;it.style.width=w;it.style.height=h;} function GetWindowWidth(){return parseInt(document.body.clientWidth);} function GetWindowHeight(){return parseInt(document.body.clientHeight);} function computeWinWH(){WinW=GetWindowWidth()-2;if(WinW<600)WinW=600;WinH=GetWindowHeight()-2;if(WinH<400)WinH=400;} function getInnerHeight(){var D=document;return Math.max(Math.max(D.body.scrollHeight,D.documentElement.scrollHeight),Math.max(D.body.offsetHeight,D.documentElement.offsetHeight),Math.max(D.body.clientHeight,D.documentElement.clientHeight));} function getInnerWidth(){var D=document;return Math.max(Math.max(D.body.scrollWidth,D.documentElement.scrollWidth),Math.max(D.body.offsetWidth,D.documentElement.offsetWidth),Math.max(D.body.clientWidth,D.documentElement.clientWidth));} function onResize(fct){fct();resizeCallBacks[resizeCallBacks.length]=fct;} function windowResized(){computeWinWH() for(var i=0;i=32)&&(ascii<=127)&&(ascii!=34)&&(ascii!=39))str_out=str_out+str_in.charAt(i);else{var hex=ascii.toString(16).toUpperCase();if(hex.length==1)hex='0'+hex;str_out=str_out+String.fromCharCode(92)+'x'+hex;}} return str_out;} function resizeMargin(){SetSize("MarginLayer",marginSize,WinH-110);SetLeft("FunctionsLayer",marginSize);SetSize("FunctionsLayer",WinW-marginSize,WinH-110);} function resizeSeparator(){SetHeight("separatorLayer",WinH-110);} function positionObject(int_x,int_y){this.x=int_x;this.y=int_y;} function GetEventPosition(event){var x,y;if(event.changedTouches){x=event.changedTouches[0].pageX;y=event.changedTouches[0].pageY;} else{x=event.PageX;y=event.PageY;if(!x){x=event.clientX+document.body.scrollLeft;y=event.clientY+document.body.scrollTop;}} return new positionObject(x,y);} function EnableDrag(var_element,onDragMove,onDragEnd){if(document.addEventListener){var_element.addEventListener("mousedown",Drag_start,false);var_element.addEventListener("touchstart",Drag_start,false);} else if(document.attachEvent) var_element.attachEvent("onmousedown",Drag_start);if(onDragMove)var_element.onDragMove=onDragMove;if(onDragEnd)var_element.onDragEnd=onDragEnd;} var LastDraggedObject=null;function DraggedObject(obj_element,obj_elmtInitialPos,obj_mouseInitalPos){this.element=obj_element;this.elmtInitialPos=obj_elmtInitialPos;this.elmtCurrentPos=new positionObject(obj_elmtInitialPos.x,obj_elmtInitialPos.y);this.mouseInitialPos=obj_mouseInitalPos;} function Drag_start(event){if(!event)event=window.event;var source=event.srcElement;if(event.button!=undefined){if((event.button!=1)&&(document.attachEvent))return;if((event.button!=0)&&(document.addEventListener))return;} if(!source)source=this;if(!source)return;var originalsource=source;while(source.tagName!="DIV"){if(source.tagName=="A")return false;source=source.parentNode;} if(event.preventDefault)event.preventDefault();source.style.cursor="col-resize";lastDraggedObject=new DraggedObject(source,new positionObject(parseInt(source.style.left),parseInt(source.style.top)),GetEventPosition(event));if(document.addEventListener){document.addEventListener("mousemove",Drag_mouseCapture,false);document.addEventListener("mouseup",Drag_stopMouseCapture,false);document.addEventListener("touchmove",Drag_mouseCapture,false);document.addEventListener("touchend",Drag_stopMouseCapture,false);} else if(document.attachEvent){document.attachEvent("onmousemove",Drag_mouseCapture);document.attachEvent("onmouseup",Drag_stopMouseCapture);} document.onmouseup=Drag_stopMouseCapture;} function Drag_mouseCapture(event){if(!event)event=window.event;var position=GetEventPosition(event);if(event.preventDefault)event.preventDefault();var x=(lastDraggedObject.elmtInitialPos.x+position.x-lastDraggedObject.mouseInitialPos.x);var y=(lastDraggedObject.elmtInitialPos.y+position.y-lastDraggedObject.mouseInitialPos.y);var iw=getInnerWidth() var ih=getInnerHeight();var w=lastDraggedObject.element.offsetWidth;var h=lastDraggedObject.element.offsetHeight;if(x>iw-w)x=iw-w;if(y>ih-h)y=ih-h;if(x<0)x=0;if(y<0)y=0;var p={x:x,y:y};if(lastDraggedObject.element.onDragMove) lastDraggedObject.element.onDragMove(lastDraggedObject.element,p);lastDraggedObject.elmtCurrentPos.x=p.x;lastDraggedObject.elmtCurrentPos.y=p.y;lastDraggedObject.element.style.left=p.x+"px";lastDraggedObject.element.style.top=p.y+"px";} function Drag_stopMouseCapture(){if(document.removeEventListener){document.removeEventListener("mousemove",Drag_mouseCapture,false);document.removeEventListener("mouseup",Drag_stopMouseCapture,false);document.removeEventListener("touchmove",Drag_mouseCapture,false);document.removeEventListener("touchend",Drag_stopMouseCapture,false);} else if(document.detachEvent){document.detachEvent("onmousemove",Drag_mouseCapture);document.detachEvent("onmouseup",Drag_stopMouseCapture);} if(lastDraggedObject){lastDraggedObject.element.style.cursor='col-resize';if(lastDraggedObject.element.onDragEnd) lastDraggedObject.element.onDragEnd(lastDraggedObject.element,{x:lastDraggedObject.elmtCurrentPos.x,y:lastDraggedObject.elmtCurrentPos.y});} lastDraggedObject=null;} function marginMove(el,pos){pos.y=80;if(pos.x<100)pos.x=100;if(pos.x>WinW-100)pos.x=WinW-100;marginSize=pos.x;resizeMargin()} function proto(clname,m){var funcproto=doc[clname][m].pro;if(isClassMethod(clname,m)){if(UseShortcuts){funcproto=funcproto.replace(m,'y'+m);}else if(doc[clname][m].lib.substr(0,1)=='['&&funcproto.substr(0,1)!='+'){var params=doc[clname][m].par;var methodpos=funcproto.search(m);var endrettype=methodpos;while(endrettype>0&&funcproto.substr(endrettype-1,1)==' ')endrettype--;var newproto="+("+funcproto.substr(0,endrettype)+") "+m;var pos=methodpos+m.length;for(var p in params){pos+=funcproto.slice(pos).search(/[A-Za-z]/);var argpos=pos+funcproto.slice(pos).search('pos&&funcproto.substr(endargtype-1,1)==' ')endargtype--;var endarg=argpos+funcproto.slice(argpos).search(/[,)]/);newproto+=": ("+funcproto.slice(pos,endargtype)+") "+funcproto.slice(argpos,endarg)+" ";pos=endarg;} funcproto=newproto;}} return funcproto} var lastindex_shown="";var lastname_shown=null;function Show(clname,str_name,nohist){if(!clname&&!str_name){wdg("FunctionsLayerInner").innerHTML=NotFound;return;} var fcthtml=NotFound;lastindex_shown=clname;if(clname&&str_name&&doc[clname]&&doc[clname][str_name]){lastname_shown=str_name;var fct=doc[clname][str_name];var funcname=fct.lib.replace('%',clname.toLowerCase());var funcproto=proto(clname,str_name);if(UseShortcuts&&isClassMethod(clname,str_name)){funcname='y'+str_name+'()';} fcthtml=""+funcname+'' +"

"+funcproto+'' +'

'+ApplySub(fct.cmt,clname,str_name);if(fct.par){fcthtml+=""+ParamLabel+'
\n';fcthtml+='' for(var p in fct.par) fcthtml+='\n';fcthtml+='

'+p+'

: '+ApplySub(fct.par[p],clname,str_name)+'

'} if(fct.ret){fcthtml+=""+ReturnLabel+'
\n';fcthtml+='

'+ApplySub(fct.ret,clname,str_name)+'

\n';} if(fct.ext)fcthtml+=ApplySub(fct.ext,clname,str_name);var newstate=clname+'.'+str_name;if(newstate!=history.state&&!nohist){history.pushState(newstate,newstate,'#'+newstate);}} else if(clname&&doc[clname]){fcthtml=""+clname+'
' +"

"+ApplySub(doc[clname][''].syn,clname,str_name)+"

" +(doc[clname][''].inc!=""?"

"+IncludeLabel+"

"+doc[clname][''].inc+"

":"") +"

"+ApplySub(doc[clname][''].cmt,clname,str_name)+"

";var prevmtype='';for(m in doc[clname]){if(m!=''){var funcproto=proto(clname,m);var mtype=MethodType(clname,m);if(prevmtype!=mtype){prevmtype=mtype;fcthtml+=""+MethodTypes[mtype]+"";if(clname!='YAPI'){fcthtml+="

"+MethodExtra[mtype]+"

";}} fcthtml+="

"+funcproto+'
' +""+ApplySub(doc[clname][m].syn,clname,str_name)+'

';}} var newstate=clname;if(newstate!=history.state&&!nohist){history.pushState(newstate,newstate,'#'+newstate);}} wdg("FunctionsLayerInner").innerHTML=fcthtml;setTimeout("wdg('FunctionsLayer').scrollTop=0;",20);} function expand(source,openonly){if(wdg(source.id+"List").style.display==''&&!openonly){wdg(source.id+"List").style.display='none';wdg(source.id).src=plusimage;} else{wdg(source.id+"List").style.display='';wdg(source.id).src=minusimage;}} function ShowFunctions(str_currentclname){var marginhtml="";for(var clname in doc){var icon=plusimage;var onck=" onclick='expand(this";var iclass="expandColapse";var display="none";var methodlist="";for(var method in doc[clname]){if(method!=''){var funcname=doc[clname][method].lib.replace('%',clname.toLowerCase());var mclass=(ShowIcons?MethodType(clname,method):'noicon');if(UseShortcuts&&mclass=='static')funcname='y'+method+'()';methodlist+=""+funcname+'';}} if(methodlist==""){iclass="noExpand";onck=" ony='(";}else if(str_currentclname==clname){icon=minusimage;onck=" onclick='expand(this";display=""} marginhtml+="  ";marginhtml+=""+clname+'
';if(methodlist!="")marginhtml+="

"+methodlist+"

";if(clname=='YAPI'||clname=='FreeAPI')marginhtml+='

---

';} wdg("MarginLayer").innerHTML=marginhtml;} function fctMatch(clname,method,values){var found=new Array() var tosearch=new Array() for(var i=0;i=0;if(!found)found=method.search(expr)>=0;if(!found&&fct.inc){if(!found&&fct.syn)found=fct.syn.search(expr)>=0;if(!found)found=fct.inc.search(expr)>=0;} if(!found&&fct.pro)found=fct.pro.search(expr)>=0;if(fct.par) for(var p in fct.par){if(!found)found=p.search(expr)>=0;if(!found)found=fct.par[p].search(expr)>=0;} if(fct.ret){if(!found)found=fct.ret.search(expr)>=0;} if(!found&&fct.cmt)found=fct.cmt.search(expr)>=0;if(!found&&fct.ext)found=fct.ext.search(expr)>=0;if(!found)return false;} return true;} var searchTimer=null;function doSearch(){searchTimer=null;var value=document.forms['yoctoForm'].elements['search'].value;if(value==''){for(var clname in doc){var container=wdg(clname+"List");for(var method in doc[clname]) if(method!=''){var it=wdg(clname+'.'+method);if(it)it.style.display="block";} wdg(clname).style.visibility='visible';var container=wdg(clname+"List");if(container["originalDisplay"]!=""){wdg(clname+"List").style.display='none';wdg(clname).src=plusimage;} else{wdg(clname+"List").style.display='';wdg(clname).src=minusimage;} container["originalDisplay"]=null;} Show(lastindex_shown,lastname_shown);return;} var firstindex='';var firstname='';qvalue=value;value='';for(var i=0;i1){var words=window.location.hash.substr(1).split('.');var cname=words[0];if(cname!="YAPI"&&cname[0]=='Y')cname=cname.substr(1);if(doc[cname]){defclass=words[0];ShowFunctions(defclass);if(words.length>1&&doc[defclass][words[1]]){defmethod=words[1];var idxwdg=wdg('MarginLayer');var itemwdg=wdg(defclass+'.'+defmethod);var scrollTop=Math.max(itemwdg.offsetTop-(idxwdg.clientHeight>>1),0);setTimeout("wdg('MarginLayer').scrollTop="+scrollTop+";",20);}}else{ShowFunctions();}}else{ShowFunctions();} Show(defclass,defmethod,(arg==='NoH'));} function InitHTMLRef(){wdg('langdt').innerHTML=Language;computeWinWH();onResize(function(){SetWidth("BannerLayer",WinW)});onResize(resizeMargin);onResize(function(){SetWidth("FooterLayer",WinW);SetTop("FooterLayer",WinH-30);});onResize(resizeSeparator);EnableDrag(wdg("separatorLayer"),marginMove,marginMove);if(UseShortcuts!=null){var td=wdg("oosyntax");var widget=' '+AbbrevLabel;td.innerHTML=widget;td.title=AbbrevHint;td.alt=AbbrevHint;} if(Language!='LabVIEW'){var rule='';var types=['int','obj','dbl','str','arr','bool'];for(var i=0;i

	www.yoctopuce.com

2022-10-07