YModule (Yoctopuce Java API 2.1.11632-SNAPSHOT API)

java.lang.Object
- com.yoctopuce.YoctoAPI.YFunction
- - com.yoctopuce.YoctoAPI.YModule

```
public class YModule
extends YFunction
```
YModule Class: Global parameters control interface for all Yoctopuce devices The YModule class can be used with all Yoctopuce USB devices. It can be used to control the module global parameters, and to enumerate the functions provided by each module.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`YModule.BeaconCallback`
`static interface`	`YModule.ConfigChangeCallback`
`static interface`	`YModule.LogCallback`
`static interface`	`YModule.TimedReportCallback` TimedReportCallback for Module
`static interface`	`YModule.UpdateCallback` Deprecated UpdateCallback for Module

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`_beacon`
`protected YModule.BeaconCallback`	`_beaconCallback`
`protected YModule.ConfigChangeCallback`	`_confChangeCallback`
`protected String`	`_firmwareRelease`
`protected YModule.LogCallback`	`_logCallback`
`protected int`	`_luminosity`
`protected int`	`_persistentSettings`
`protected int`	`_productId`
`protected String`	`_productName`
`protected int`	`_productRelease`
`protected int`	`_rebootCountdown`
`protected String`	`_serialNumber`
`protected long`	`_upTime`
`protected int`	`_usbCurrent`
`protected int`	`_userVar`
`protected YModule.UpdateCallback`	`_valueCallbackModule`
`static int`	`BEACON_INVALID`
`static int`	`BEACON_OFF` invalid beacon value
`static int`	`BEACON_ON`
`static String`	`FIRMWARERELEASE_INVALID` invalid firmwareRelease value
`static int`	`LUMINOSITY_INVALID` invalid luminosity value
`static int`	`PERSISTENTSETTINGS_INVALID`
`static int`	`PERSISTENTSETTINGS_LOADED` invalid persistentSettings value
`static int`	`PERSISTENTSETTINGS_MODIFIED`
`static int`	`PERSISTENTSETTINGS_SAVED`
`static int`	`PRODUCTID_INVALID` invalid productId value
`static String`	`PRODUCTNAME_INVALID` invalid productName value
`static int`	`PRODUCTRELEASE_INVALID` invalid productRelease value
`static int`	`REBOOTCOUNTDOWN_INVALID` invalid rebootCountdown value
`static String`	`SERIALNUMBER_INVALID` invalid serialNumber value
`static long`	`UPTIME_INVALID` invalid upTime value
`static int`	`USBCURRENT_INVALID` invalid usbCurrent value
`static int`	`USERVAR_INVALID` invalid userVar value

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction
_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, _yapi, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID

Constructor Summary

Constructors
Modifier Constructor and Description

protected YModule(String func)

protected YModule(YAPIContext yctx, String func)

Constructors
Modifier	Constructor and Description
`protected`	`YModule(String func)`
`protected`	`YModule(YAPIContext yctx, String func)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`_flattenJsonStruct(byte[] jsoncomplex)`
`int`	`_invokeBeaconCallback(int beaconState)`
`int`	`_invokeConfigChangeCallback()`
`int`	`_invokeValueCallback(String value)`
`protected void`	`_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)`
`void`	`_startStopDevLog_internal(String serial, boolean start)`
`void`	`_startStopDevLog(String serial, boolean start)`
`int`	`_tryExec(String url)`
`int`	`addFileToHTTPCallback(String filename)` Adds a file to the uploaded data at the next HTTP callback.
`String`	`calibConvert(String param, String currentFuncValue, String unit_name, String sensorType)`
`int`	`calibOffset(String unit_name)`
`int`	`calibScale(String unit_name, String sensorType)`
`int`	`calibVersion(String cparams)`
`String`	`checkFirmware(String path, boolean onlynew)` Tests whether the byn file is valid for this module.
`byte[]`	`download(String pathname)` Downloads the specified built-in file and returns a binary buffer with its content.
`static YModule`	`FindModule(String func)` Allows you to find a module from its serial number or from its logical name.
`static YModule`	`FindModuleInContext(YAPIContext yctx, String func)` Retrieves a module for a given identifier in a YAPI context.
`static YModule`	`FirstModule()` Starts the enumeration of modules currently accessible.
`static YModule`	`FirstModuleInContext(YAPIContext yctx)` comment from .yc definition
`String`	`functionBaseType(int functionIndex)` Retrieves the base type of the nth function on the module.
`int`	`functionCount()` Returns the number of functions (beside the "module" interface) available on the module.
`String`	`functionId(int functionIndex)` Retrieves the hardware identifier of the nth function on the module.
`String`	`functionName(int functionIndex)` Retrieves the logical name of the nth function on the module.
`String`	`functionType(int functionIndex)` Retrieves the type of the nth function on the module.
`String`	`functionValue(int functionIndex)` Retrieves the advertised value of the nth function on the module.
`byte[]`	`get_allSettings()` Returns all the settings and uploaded files of the module.
`int`	`get_beacon()` Returns the state of the localization beacon.
`String`	`get_firmwareRelease()` Returns the version of the firmware embedded in the module.
`ArrayList<String>`	`get_functionIds(String funType)` Retrieve all hardware identifier that match the type passed in argument.
`String`	`get_hardwareId()` Returns the unique hardware identifier of the module.
`byte[]`	`get_icon2d()` Returns the icon of the module.
`String`	`get_lastLogs()` Returns a string with last logs of the module.
`YModule.LogCallback`	`get_logCallback()`
`int`	`get_luminosity()` Returns the luminosity of the module informative LEDs (from 0 to 100).
`String`	`get_parentHub()` Returns the serial number of the YoctoHub on which this module is connected.
`int`	`get_persistentSettings()` Returns the current state of persistent module settings.
`int`	`get_productId()` Returns the USB device identifier of the module.
`String`	`get_productName()` Returns the commercial name of the module, as set by the factory.
`String`	`get_productNameAndRevision()`
`int`	`get_productRelease()` Returns the release number of the module hardware, preprogrammed at the factory.
`int`	`get_rebootCountdown()` Returns the remaining number of seconds before the module restarts, or zero when no reboot has been scheduled.
`String`	`get_serialNumber()` Returns the serial number of the module, as set by the factory.
`ArrayList<String>`	`get_subDevices()` Returns a list of all the modules that are plugged into the current module.
`long`	`get_upTime()` Returns the number of milliseconds spent since the module was powered on.
`String`	`get_url()` Returns the URL used to access the module.
`int`	`get_usbCurrent()` Returns the current consumed by the module on the USB bus, in milli-amps.
`int`	`get_userVar()` Returns the value previously stored in this attribute.
`int`	`getBeacon()` Returns the state of the localization beacon.
`String`	`getFirmwareRelease()` Returns the version of the firmware embedded in the module.
`int`	`getLuminosity()` Returns the luminosity of the module informative LEDs (from 0 to 100).
`int`	`getPersistentSettings()` Returns the current state of persistent module settings.
`int`	`getProductId()` Returns the USB device identifier of the module.
`String`	`getProductName()` Returns the commercial name of the module, as set by the factory.
`int`	`getProductRelease()` Returns the release number of the module hardware, preprogrammed at the factory.
`int`	`getRebootCountdown()` Returns the remaining number of seconds before the module restarts, or zero when no reboot has been scheduled.
`String`	`getSerialNumber()` Returns the serial number of the module, as set by the factory.
`long`	`getUpTime()` Returns the number of milliseconds spent since the module was powered on.
`int`	`getUsbCurrent()` Returns the current consumed by the module on the USB bus, in milli-amps.
`int`	`getUserVar()` Returns the value previously stored in this attribute.
`boolean`	`hasFunction(String funcId)` Tests if the device includes a specific function.
`int`	`loadThermistorExtra(String funcId, String jsonExtra)`
`int`	`log(String text)` Adds a text message to the device logs.
`YModule`	`nextModule()` Continues the module enumeration started using yFirstModule().
`int`	`reboot(int secBeforeReboot)` Schedules a simple module reboot after the given number of seconds.
`int`	`registerBeaconCallback(YModule.BeaconCallback callback)` Register a callback function, to be called when the localization beacon of the module has been changed.
`int`	`registerConfigChangeCallback(YModule.ConfigChangeCallback callback)` Register a callback function, to be called when a persistent settings in a device configuration has been changed (e.g.
`int`	`registerLogCallback(YModule.LogCallback callback)` Registers a device log callback function.
`int`	`registerValueCallback(YModule.UpdateCallback callback)` Registers the callback function that is invoked on every change of advertised value.
`int`	`revertFromFlash()` Reloads the settings stored in the nonvolatile memory, as when the module is powered on.
`int`	`saveToFlash()` Saves current settings in the nonvolatile memory of the module.
`int`	`set_allSettings(byte[] settings)` Restores all the settings of the device.
`int`	`set_allSettingsAndFiles(byte[] settings)` Restores all the settings and uploaded files to the module.
`int`	`set_beacon(int newval)` Turns on or off the module localization beacon.
`int`	`set_extraSettings(String jsonExtra)`
`int`	`set_luminosity(int newval)` Changes the luminosity of the module informative leds.
`int`	`set_persistentSettings(int newval)`
`int`	`set_rebootCountdown(int newval)`
`int`	`set_userVar(int newval)` Stores a 32 bit value in the device RAM.
`int`	`setBeacon(int newval)` Turns on or off the module localization beacon.
`int`	`setLuminosity(int newval)` Changes the luminosity of the module informative leds.
`int`	`setUserVar(int newval)` Stores a 32 bit value in the device RAM.
`int`	`triggerConfigChangeCallback()` Triggers a configuration change callback, to check if they are supported or not.
`int`	`triggerFirmwareUpdate(int secBeforeReboot)` Schedules a module reboot into special firmware update mode.
`YFirmwareUpdate`	`updateFirmware(String path)` Prepares a firmware update of the module.
`YFirmwareUpdate`	`updateFirmwareEx(String path, boolean force)` Prepares a firmware update of the module.

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction
_AddToCache, _clearDataStreamCache, _decode_json_int, _decode_json_string, _download, _escapeAttr, _FindFromCache, _FindFromCacheInContext, _get_json_path_struct, _get_json_path, _is_valid_pass, _json_get_array, _json_get_key, _json_get_string, _parse, _parserHelper, _setAttr, _throw, _UpdateTimedReportCallbackList, _UpdateValueCallbackList, _upload, _upload, _uploadEx, clearCache, describe, errMessage, errorMessage, errorType, errType, FindFunction, FindFunctionInContext, FirstFunction, FirstFunctionInContext, functionDescriptor, get_advertisedValue, get_errorMessage, get_errorType, get_friendlyName, get_functionDescriptor, get_functionId, get_logicalName, get_module, get_userData, getAdvertisedValue, getErrorMessage, getErrorType, getFriendlyName, getFunctionDescriptor, getFunctionId, getHardwareId, getLogicalName, getModule, getUserData, isOnline, isReadOnly, load, loadAttribute, module, muteValueCallbacks, nextFunction, registerValueCallback, set_advertisedValue, set_logicalName, set_userData, setLogicalName, setUserData, toString, unmuteValueCallbacks, userData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PRODUCTNAME_INVALID
```
public static final String PRODUCTNAME_INVALID
```
    invalid productName value
    
    See Also:
    
    Constant Field Values
  - SERIALNUMBER_INVALID
```
public static final String SERIALNUMBER_INVALID
```
    invalid serialNumber value
    
    See Also:
    
    Constant Field Values
  - PRODUCTID_INVALID
```
public static final int PRODUCTID_INVALID
```
    invalid productId value
    
    See Also:
    
    Constant Field Values
  - PRODUCTRELEASE_INVALID
```
public static final int PRODUCTRELEASE_INVALID
```
    invalid productRelease value
    
    See Also:
    
    Constant Field Values
  - FIRMWARERELEASE_INVALID
```
public static final String FIRMWARERELEASE_INVALID
```
    invalid firmwareRelease value
    
    See Also:
    
    Constant Field Values
  - PERSISTENTSETTINGS_LOADED
```
public static final int PERSISTENTSETTINGS_LOADED
```
    invalid persistentSettings value
    
    See Also:
    
    Constant Field Values
  - PERSISTENTSETTINGS_SAVED
```
public static final int PERSISTENTSETTINGS_SAVED
```
    See Also:
    
    Constant Field Values
  - PERSISTENTSETTINGS_MODIFIED
```
public static final int PERSISTENTSETTINGS_MODIFIED
```
    See Also:
    
    Constant Field Values
  - PERSISTENTSETTINGS_INVALID
```
public static final int PERSISTENTSETTINGS_INVALID
```
    See Also:
    
    Constant Field Values
  - LUMINOSITY_INVALID
```
public static final int LUMINOSITY_INVALID
```
    invalid luminosity value
    
    See Also:
    
    Constant Field Values
  - BEACON_OFF
```
public static final int BEACON_OFF
```
    invalid beacon value
    
    See Also:
    
    Constant Field Values
  - BEACON_ON
```
public static final int BEACON_ON
```
    See Also:
    
    Constant Field Values
  - BEACON_INVALID
```
public static final int BEACON_INVALID
```
    See Also:
    
    Constant Field Values
  - UPTIME_INVALID
```
public static final long UPTIME_INVALID
```
    invalid upTime value
    
    See Also:
    
    Constant Field Values
  - USBCURRENT_INVALID
```
public static final int USBCURRENT_INVALID
```
    invalid usbCurrent value
    
    See Also:
    
    Constant Field Values
  - REBOOTCOUNTDOWN_INVALID
```
public static final int REBOOTCOUNTDOWN_INVALID
```
    invalid rebootCountdown value
    
    See Also:
    
    Constant Field Values
  - USERVAR_INVALID
```
public static final int USERVAR_INVALID
```
    invalid userVar value
    
    See Also:
    
    Constant Field Values
  - _productName
```
protected String _productName
```
  - _serialNumber
```
protected String _serialNumber
```
  - _productId
```
protected int _productId
```
  - _productRelease
```
protected int _productRelease
```
  - _firmwareRelease
```
protected String _firmwareRelease
```
  - _persistentSettings
```
protected int _persistentSettings
```
  - _luminosity
```
protected int _luminosity
```
  - _beacon
```
protected int _beacon
```
  - _upTime
```
protected long _upTime
```
  - _usbCurrent
```
protected int _usbCurrent
```
  - _rebootCountdown
```
protected int _rebootCountdown
```
  - _userVar
```
protected int _userVar
```
  - _valueCallbackModule
```
protected YModule.UpdateCallback _valueCallbackModule
```
  - _logCallback
```
protected YModule.LogCallback _logCallback
```
  - _confChangeCallback
```
protected YModule.ConfigChangeCallback _confChangeCallback
```
  - _beaconCallback
```
protected YModule.BeaconCallback _beaconCallback
```
- Constructor Detail
  - YModule
```
protected YModule(YAPIContext yctx,
                  String func)
```
    Parameters:
    
    func - : functionid
  - YModule
```
protected YModule(String func)
```
- Method Detail
  - functionCount
```
public int functionCount()
                  throws YAPI_Exception
```
    Returns the number of functions (beside the "module" interface) available on the module.
    
    Returns:
    
    the number of functions on the module
    
    Throws:
    
    YAPI_Exception - on error
  - functionId
```
public String functionId(int functionIndex)
                  throws YAPI_Exception
```
    Retrieves the hardware identifier of the nth function on the module.
    
    Parameters:
    
    functionIndex - : the index of the function for which the information is desired, starting at 0 for the first function.
    
    Returns:
    
    a string corresponding to the unambiguous hardware identifier of the requested module function
    
    Throws:
    
    YAPI_Exception - on error
  - functionType
```
public String functionType(int functionIndex)
                    throws YAPI_Exception
```
    Retrieves the type of the nth function on the module. Yoctopuce functions type names match their class names without the Y prefix, for instance Relay, Temperature etc..
    
    Parameters:
    
    functionIndex - : the index of the function for which the information is desired, starting at 0 for the first function.
    
    Returns:
    
    a string corresponding to the type of the function.
    
    Throws:
    
    YAPI_Exception - on error
  - functionBaseType
```
public String functionBaseType(int functionIndex)
                        throws YAPI_Exception
```
    Retrieves the base type of the nth function on the module. For instance, the base type of all measuring functions is "Sensor".
    
    Parameters:
    
    functionIndex - : the index of the function for which the information is desired, starting at 0 for the first function.
    
    Returns:
    
    a string corresponding to the base type of the function
    
    Throws:
    
    YAPI_Exception - on error
  - functionName
```
public String functionName(int functionIndex)
                    throws YAPI_Exception
```
    Retrieves the logical name of the nth function on the module.
    
    Parameters:
    
    functionIndex - : the index of the function for which the information is desired, starting at 0 for the first function.
    
    Returns:
    
    a string corresponding to the logical name of the requested module function
    
    Throws:
    
    YAPI_Exception - on error
  - functionValue
```
public String functionValue(int functionIndex)
                     throws YAPI_Exception
```
    Retrieves the advertised value of the nth function on the module.
    
    Parameters:
    
    functionIndex - : the index of the function for which the information is desired, starting at 0 for the first function.
    
    Returns:
    
    a short string (up to 6 characters) corresponding to the advertised value of the requested module function
    
    Throws:
    
    YAPI_Exception - on error
  - _startStopDevLog_internal
```
public void _startStopDevLog_internal(String serial,
                                      boolean start)
                               throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - _parseAttr
```
protected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
                   throws Exception
```
    Overrides:
    
    _parseAttr in class YFunction
    
    Throws:
    
    Exception
  - get_productName
```
public String get_productName()
                       throws YAPI_Exception
```
    Returns the commercial name of the module, as set by the factory.
    
    Returns:
    
    a string corresponding to the commercial name of the module, as set by the factory
    
    Throws:
    
    YAPI_Exception - on error
  - getProductName
```
public String getProductName()
                      throws YAPI_Exception
```
    Returns the commercial name of the module, as set by the factory.
    
    Returns:
    
    a string corresponding to the commercial name of the module, as set by the factory
    
    Throws:
    
    YAPI_Exception - on error
  - get_serialNumber
```
public String get_serialNumber()
                        throws YAPI_Exception
```
    Returns the serial number of the module, as set by the factory.
    
    Overrides:
    
    get_serialNumber in class YFunction
    
    Returns:
    
    a string corresponding to the serial number of the module, as set by the factory
    
    Throws:
    
    YAPI_Exception - on error
  - getSerialNumber
```
public String getSerialNumber()
                       throws YAPI_Exception
```
    Returns the serial number of the module, as set by the factory.
    
    Returns:
    
    a string corresponding to the serial number of the module, as set by the factory
    
    Throws:
    
    YAPI_Exception - on error
  - get_productId
```
public int get_productId()
                  throws YAPI_Exception
```
    Returns the USB device identifier of the module.
    
    Returns:
    
    an integer corresponding to the USB device identifier of the module
    
    Throws:
    
    YAPI_Exception - on error
  - getProductId
```
public int getProductId()
                 throws YAPI_Exception
```
    Returns the USB device identifier of the module.
    
    Returns:
    
    an integer corresponding to the USB device identifier of the module
    
    Throws:
    
    YAPI_Exception - on error
  - get_productRelease
```
public int get_productRelease()
                       throws YAPI_Exception
```
    Returns the release number of the module hardware, preprogrammed at the factory. The original hardware release returns value 1, revision B returns value 2, etc.
    
    Returns:
    
    an integer corresponding to the release number of the module hardware, preprogrammed at the factory
    
    Throws:
    
    YAPI_Exception - on error
  - getProductRelease
```
public int getProductRelease()
                      throws YAPI_Exception
```
    Returns the release number of the module hardware, preprogrammed at the factory. The original hardware release returns value 1, revision B returns value 2, etc.
    
    Returns:
    
    an integer corresponding to the release number of the module hardware, preprogrammed at the factory
    
    Throws:
    
    YAPI_Exception - on error
  - get_firmwareRelease
```
public String get_firmwareRelease()
                           throws YAPI_Exception
```
    Returns the version of the firmware embedded in the module.
    
    Returns:
    
    a string corresponding to the version of the firmware embedded in the module
    
    Throws:
    
    YAPI_Exception - on error
  - getFirmwareRelease
```
public String getFirmwareRelease()
                          throws YAPI_Exception
```
    Returns the version of the firmware embedded in the module.
    
    Returns:
    
    a string corresponding to the version of the firmware embedded in the module
    
    Throws:
    
    YAPI_Exception - on error
  - get_persistentSettings
```
public int get_persistentSettings()
                           throws YAPI_Exception
```
    Returns the current state of persistent module settings.
    
    Returns:
    
    a value among YModule.PERSISTENTSETTINGS_LOADED, YModule.PERSISTENTSETTINGS_SAVED and YModule.PERSISTENTSETTINGS_MODIFIED corresponding to the current state of persistent module settings
    
    Throws:
    
    YAPI_Exception - on error
  - getPersistentSettings
```
public int getPersistentSettings()
                          throws YAPI_Exception
```
    Returns the current state of persistent module settings.
    
    Returns:
    
    a value among YModule.PERSISTENTSETTINGS_LOADED, YModule.PERSISTENTSETTINGS_SAVED and YModule.PERSISTENTSETTINGS_MODIFIED corresponding to the current state of persistent module settings
    
    Throws:
    
    YAPI_Exception - on error
  - set_persistentSettings
```
public int set_persistentSettings(int newval)
                           throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - get_luminosity
```
public int get_luminosity()
                   throws YAPI_Exception
```
    Returns the luminosity of the module informative LEDs (from 0 to 100).
    
    Returns:
    
    an integer corresponding to the luminosity of the module informative LEDs (from 0 to 100)
    
    Throws:
    
    YAPI_Exception - on error
  - getLuminosity
```
public int getLuminosity()
                  throws YAPI_Exception
```
    Returns the luminosity of the module informative LEDs (from 0 to 100).
    
    Returns:
    
    an integer corresponding to the luminosity of the module informative LEDs (from 0 to 100)
    
    Throws:
    
    YAPI_Exception - on error
  - set_luminosity
```
public int set_luminosity(int newval)
                   throws YAPI_Exception
```
    Changes the luminosity of the module informative leds. The parameter is a value between 0 and 100. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the luminosity of the module informative leds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setLuminosity
```
public int setLuminosity(int newval)
                  throws YAPI_Exception
```
    Changes the luminosity of the module informative leds. The parameter is a value between 0 and 100. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the luminosity of the module informative leds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_beacon
```
public int get_beacon()
               throws YAPI_Exception
```
    Returns the state of the localization beacon.
    
    Returns:
    
    either YModule.BEACON_OFF or YModule.BEACON_ON, according to the state of the localization beacon
    
    Throws:
    
    YAPI_Exception - on error
  - getBeacon
```
public int getBeacon()
              throws YAPI_Exception
```
    Returns the state of the localization beacon.
    
    Returns:
    
    either YModule.BEACON_OFF or YModule.BEACON_ON, according to the state of the localization beacon
    
    Throws:
    
    YAPI_Exception - on error
  - set_beacon
```
public int set_beacon(int newval)
               throws YAPI_Exception
```
    Turns on or off the module localization beacon.
    
    Parameters:
    
    newval - : either YModule.BEACON_OFF or YModule.BEACON_ON
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setBeacon
```
public int setBeacon(int newval)
              throws YAPI_Exception
```
    Turns on or off the module localization beacon.
    
    Parameters:
    
    newval - : either YModule.BEACON_OFF or YModule.BEACON_ON
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_upTime
```
public long get_upTime()
                throws YAPI_Exception
```
    Returns the number of milliseconds spent since the module was powered on.
    
    Returns:
    
    an integer corresponding to the number of milliseconds spent since the module was powered on
    
    Throws:
    
    YAPI_Exception - on error
  - getUpTime
```
public long getUpTime()
               throws YAPI_Exception
```
    Returns the number of milliseconds spent since the module was powered on.
    
    Returns:
    
    an integer corresponding to the number of milliseconds spent since the module was powered on
    
    Throws:
    
    YAPI_Exception - on error
  - get_usbCurrent
```
public int get_usbCurrent()
                   throws YAPI_Exception
```
    Returns the current consumed by the module on the USB bus, in milli-amps.
    
    Returns:
    
    an integer corresponding to the current consumed by the module on the USB bus, in milli-amps
    
    Throws:
    
    YAPI_Exception - on error
  - getUsbCurrent
```
public int getUsbCurrent()
                  throws YAPI_Exception
```
    Returns the current consumed by the module on the USB bus, in milli-amps.
    
    Returns:
    
    an integer corresponding to the current consumed by the module on the USB bus, in milli-amps
    
    Throws:
    
    YAPI_Exception - on error
  - get_rebootCountdown
```
public int get_rebootCountdown()
                        throws YAPI_Exception
```
    Returns the remaining number of seconds before the module restarts, or zero when no reboot has been scheduled.
    
    Returns:
    
    an integer corresponding to the remaining number of seconds before the module restarts, or zero when no reboot has been scheduled
    
    Throws:
    
    YAPI_Exception - on error
  - getRebootCountdown
```
public int getRebootCountdown()
                       throws YAPI_Exception
```
    Returns the remaining number of seconds before the module restarts, or zero when no reboot has been scheduled.
    
    Returns:
    
    an integer corresponding to the remaining number of seconds before the module restarts, or zero when no reboot has been scheduled
    
    Throws:
    
    YAPI_Exception - on error
  - set_rebootCountdown
```
public int set_rebootCountdown(int newval)
                        throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - get_userVar
```
public int get_userVar()
                throws YAPI_Exception
```
    Returns the value previously stored in this attribute. On startup and after a device reboot, the value is always reset to zero.
    
    Returns:
    
    an integer corresponding to the value previously stored in this attribute
    
    Throws:
    
    YAPI_Exception - on error
  - getUserVar
```
public int getUserVar()
               throws YAPI_Exception
```
    Returns the value previously stored in this attribute. On startup and after a device reboot, the value is always reset to zero.
    
    Returns:
    
    an integer corresponding to the value previously stored in this attribute
    
    Throws:
    
    YAPI_Exception - on error
  - set_userVar
```
public int set_userVar(int newval)
                throws YAPI_Exception
```
    Stores a 32 bit value in the device RAM. This attribute is at programmer disposal, should he need to store a state variable. On startup and after a device reboot, the value is always reset to zero.
    
    Parameters:
    
    newval - : an integer
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setUserVar
```
public int setUserVar(int newval)
               throws YAPI_Exception
```
    Stores a 32 bit value in the device RAM. This attribute is at programmer disposal, should he need to store a state variable. On startup and after a device reboot, the value is always reset to zero.
    
    Parameters:
    
    newval - : an integer
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - FindModule
```
public static YModule FindModule(String func)
```
    Allows you to find a module from its serial number or from its logical name. This function does not require that the module is online at the time it is invoked. The returned object is nevertheless valid. Use the method YModule.isOnline() to test if the module is indeed online at a given time. In case of ambiguity when looking for a module 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's is_online() method returns FALSE although you are certain that the device is plugged, make sure that you did call registerHub() at application initialization time.
    
    Parameters:
    
    func - : a string containing either the serial number or the logical name of the desired module
    
    Returns:
    
    a YModule object allowing you to drive the module or get additional information on the module.
  - FindModuleInContext
```
public static YModule FindModuleInContext(YAPIContext yctx,
                                          String func)
```
    Retrieves a module for a given identifier in a YAPI context. The identifier can be specified using several formats:
    - FunctionLogicalName
    - ModuleSerialNumber.FunctionIdentifier
    - ModuleSerialNumber.FunctionLogicalName
    - ModuleLogicalName.FunctionIdentifier
    - ModuleLogicalName.FunctionLogicalName
    This function does not require that the module is online at the time it is invoked. The returned object is nevertheless valid. Use the method YModule.isOnline() to test if the module is indeed online at a given time. In case of ambiguity when looking for a module 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.
    Parameters:
    
    yctx - : a YAPI context
    
    func - : a string that uniquely characterizes the module, for instance MyDevice.module.
    
    Returns:
    
    a YModule object allowing you to drive the module.
  - registerValueCallback
```
public int registerValueCallback(YModule.UpdateCallback callback)
```
    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.
    
    Parameters:
    
    callback - : the callback function to call, or a null pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value.
  - _invokeValueCallback
```
public int _invokeValueCallback(String value)
```
    Overrides:
    
    _invokeValueCallback in class YFunction
  - get_productNameAndRevision
```
public String get_productNameAndRevision()
                                  throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - saveToFlash
```
public int saveToFlash()
                throws YAPI_Exception
```
    Saves current settings in the nonvolatile memory of the module. Warning: the number of allowed save operations during a module life is limited (about 100000 cycles). Do not call this function within a loop.
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - revertFromFlash
```
public int revertFromFlash()
                    throws YAPI_Exception
```
    Reloads the settings stored in the nonvolatile memory, as when the module is powered on.
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - reboot
```
public int reboot(int secBeforeReboot)
           throws YAPI_Exception
```
    Schedules a simple module reboot after the given number of seconds.
    
    Parameters:
    
    secBeforeReboot - : number of seconds before rebooting
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - triggerFirmwareUpdate
```
public int triggerFirmwareUpdate(int secBeforeReboot)
                          throws YAPI_Exception
```
    Schedules a module reboot into special firmware update mode.
    
    Parameters:
    
    secBeforeReboot - : number of seconds before rebooting
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - _startStopDevLog
```
public void _startStopDevLog(String serial,
                             boolean start)
                      throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - registerLogCallback
```
public int registerLogCallback(YModule.LogCallback callback)
                        throws YAPI_Exception
```
    Registers a device log callback function. This callback will be called each time that a module sends a new log message. Mostly useful to debug a Yoctopuce module.
    
    Parameters:
    
    callback - : the callback function to call, or a null pointer. The callback function should take two arguments: the module object that emitted the log message, and the character string containing the log.
    
    Throws:
    
    YAPI_Exception - on error
  - get_logCallback
```
public YModule.LogCallback get_logCallback()
```
  - registerConfigChangeCallback
```
public int registerConfigChangeCallback(YModule.ConfigChangeCallback callback)
```
    Register a callback function, to be called when a persistent settings in a device configuration has been changed (e.g. change of unit, etc).
    
    Parameters:
    
    callback - : a procedure taking a YModule parameter, or null to unregister a previously registered callback.
  - _invokeConfigChangeCallback
```
public int _invokeConfigChangeCallback()
```
  - registerBeaconCallback
```
public int registerBeaconCallback(YModule.BeaconCallback callback)
```
    Register a callback function, to be called when the localization beacon of the module has been changed. The callback function should take two arguments: the YModule object of which the beacon has changed, and an integer describing the new beacon state.
    
    Parameters:
    
    callback - : The callback function to call, or null to unregister a previously registered callback.
  - _invokeBeaconCallback
```
public int _invokeBeaconCallback(int beaconState)
```
  - triggerConfigChangeCallback
```
public int triggerConfigChangeCallback()
                                throws YAPI_Exception
```
    Triggers a configuration change callback, to check if they are supported or not.
    
    Throws:
    
    YAPI_Exception
  - checkFirmware
```
public String checkFirmware(String path,
                            boolean onlynew)
                     throws YAPI_Exception
```
    Tests whether the byn file is valid for this module. This method is useful to test if the module needs to be updated. It is possible to pass a directory as argument instead of a file. In this case, this method returns the path of the most recent appropriate .byn file. If the parameter onlynew is true, the function discards firmwares that are older or equal to the installed firmware.
    
    Parameters:
    
    path - : the path of a byn file or a directory that contains byn files
    
    onlynew - : returns only files that are strictly newer
    
    Returns:
    
    the path of the byn file to use or a empty string if no byn files matches the requirement
    
    Throws:
    
    YAPI_Exception - on error
  - updateFirmwareEx
```
public YFirmwareUpdate updateFirmwareEx(String path,
                                        boolean force)
                                 throws YAPI_Exception
```
    Prepares a firmware update of the module. This method returns a YFirmwareUpdate object which handles the firmware update process.
    
    Parameters:
    
    path - : the path of the .byn file to use.
    
    force - : true to force the firmware update even if some prerequisites appear not to be met
    
    Returns:
    
    a YFirmwareUpdate object or NULL on error.
    
    Throws:
    
    YAPI_Exception
  - updateFirmware
```
public YFirmwareUpdate updateFirmware(String path)
                               throws YAPI_Exception
```
    Prepares a firmware update of the module. This method returns a YFirmwareUpdate object which handles the firmware update process.
    
    Parameters:
    
    path - : the path of the .byn file to use.
    
    Returns:
    
    a YFirmwareUpdate object or NULL on error.
    
    Throws:
    
    YAPI_Exception
  - get_allSettings
```
public byte[] get_allSettings()
                       throws YAPI_Exception
```
    Returns all the settings and uploaded files of the module. Useful to backup all the logical names, calibrations parameters, and uploaded files of a device.
    
    Returns:
    
    a binary buffer with all the settings.
    
    Throws:
    
    YAPI_Exception - on error
  - loadThermistorExtra
```
public int loadThermistorExtra(String funcId,
                               String jsonExtra)
                        throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - set_extraSettings
```
public int set_extraSettings(String jsonExtra)
                      throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - set_allSettingsAndFiles
```
public int set_allSettingsAndFiles(byte[] settings)
                            throws YAPI_Exception
```
    Restores all the settings and uploaded files to the module. This method is useful to restore all the logical names and calibrations parameters, uploaded files etc. of a device from a backup. Remember to call the saveToFlash() method of the module if the modifications must be kept.
    
    Parameters:
    
    settings - : a binary buffer with all the settings.
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - hasFunction
```
public boolean hasFunction(String funcId)
                    throws YAPI_Exception
```
    Tests if the device includes a specific function. This method takes a function identifier and returns a boolean.
    
    Parameters:
    
    funcId - : the requested function identifier
    
    Returns:
    
    true if the device has the function identifier
    
    Throws:
    
    YAPI_Exception
  - get_functionIds
```
public ArrayList<String> get_functionIds(String funType)
                                  throws YAPI_Exception
```
    Retrieve all hardware identifier that match the type passed in argument.
    
    Parameters:
    
    funType - : The type of function (Relay, LightSensor, Voltage,...)
    
    Returns:
    
    an array of strings.
    
    Throws:
    
    YAPI_Exception
  - _flattenJsonStruct
```
public byte[] _flattenJsonStruct(byte[] jsoncomplex)
                          throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - calibVersion
```
public int calibVersion(String cparams)
```
  - calibScale
```
public int calibScale(String unit_name,
                      String sensorType)
```
  - calibOffset
```
public int calibOffset(String unit_name)
```
  - calibConvert
```
public String calibConvert(String param,
                           String currentFuncValue,
                           String unit_name,
                           String sensorType)
```
  - _tryExec
```
public int _tryExec(String url)
```
  - set_allSettings
```
public int set_allSettings(byte[] settings)
                    throws YAPI_Exception
```
    Restores all the settings of the device. Useful to restore all the logical names and calibrations parameters of a module from a backup.Remember to call the saveToFlash() method of the module if the modifications must be kept.
    
    Parameters:
    
    settings - : a binary buffer with all the settings.
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - addFileToHTTPCallback
```
public int addFileToHTTPCallback(String filename)
                          throws YAPI_Exception
```
    Adds a file to the uploaded data at the next HTTP callback. This function only affects the next HTTP callback and only works in HTTP callback mode.
    
    Parameters:
    
    filename - : the name of the file to upload at the next HTTP callback
    
    Returns:
    
    nothing.
    
    Throws:
    
    YAPI_Exception
  - get_hardwareId
```
public String get_hardwareId()
                      throws YAPI_Exception
```
    Returns the unique hardware identifier of the module. The unique hardware identifier is made of the device serial number followed by string ".module".
    
    Overrides:
    
    get_hardwareId in class YFunction
    
    Returns:
    
    a string that uniquely identifies the module
    
    Throws:
    
    YAPI_Exception - on error
  - download
```
public byte[] download(String pathname)
                throws YAPI_Exception
```
    Downloads the specified built-in file and returns a binary buffer with its content.
    
    Parameters:
    
    pathname - : name of the new file to load
    
    Returns:
    
    a binary buffer with the file content
    
    Throws:
    
    YAPI_Exception - on error
  - get_icon2d
```
public byte[] get_icon2d()
                  throws YAPI_Exception
```
    Returns the icon of the module. The icon is a PNG image and does not exceeds 1536 bytes.
    
    Returns:
    
    a binary buffer with module icon, in png format.
    
    Throws:
    
    YAPI_Exception - on error
  - get_lastLogs
```
public String get_lastLogs()
                    throws YAPI_Exception
```
    Returns a string with last logs of the module. This method return only logs that are still in the module.
    
    Returns:
    
    a string with last logs of the module.
    
    Throws:
    
    YAPI_Exception - on error
  - log
```
public int log(String text)
        throws YAPI_Exception
```
    Adds a text message to the device logs. This function is useful in particular to trace the execution of HTTP callbacks. If a newline is desired after the message, it must be included in the string.
    
    Parameters:
    
    text - : the string to append to the logs.
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_subDevices
```
public ArrayList<String> get_subDevices()
                                 throws YAPI_Exception
```
    Returns a list of all the modules that are plugged into the current module. This method only makes sense when called for a YoctoHub/VirtualHub. Otherwise, an empty array will be returned.
    
    Returns:
    
    an array of strings containing the sub modules.
    
    Throws:
    
    YAPI_Exception
  - get_parentHub
```
public String get_parentHub()
                     throws YAPI_Exception
```
    Returns the serial number of the YoctoHub on which this module is connected. If the module is connected by USB, or if the module is the root YoctoHub, an empty string is returned.
    
    Returns:
    
    a string with the serial number of the YoctoHub or an empty string
    
    Throws:
    
    YAPI_Exception
  - get_url
```
public String get_url()
               throws YAPI_Exception
```
    Returns the URL used to access the module. If the module is connected by USB, the string 'usb' is returned.
    
    Returns:
    
    a string with the URL of the module.
    
    Throws:
    
    YAPI_Exception
  - nextModule
```
public YModule nextModule()
```
    Continues the module enumeration started using yFirstModule(). Caution: You can't make any assumption about the returned modules order. If you want to find a specific module, use Module.findModule() and a hardwareID or a logical name.
    
    Returns:
    
    a pointer to a YModule object, corresponding to the next module found, or a null pointer if there are no more modules to enumerate.
  - FirstModule
```
public static YModule FirstModule()
```
    Starts the enumeration of modules currently accessible. Use the method YModule.nextModule() to iterate on the next modules.
    
    Returns:
    
    a pointer to a YModule object, corresponding to the first module currently online, or a null pointer if there are none.
  - FirstModuleInContext
```
public static YModule FirstModuleInContext(YAPIContext yctx)
```
    comment from .yc definition

Class YModule

Nested Class Summary

Field Summary

Fields inherited from class com.yoctopuce.YoctoAPI.YFunction

Constructor Summary

Method Summary

Methods inherited from class com.yoctopuce.YoctoAPI.YFunction

Methods inherited from class java.lang.Object

Field Detail

PRODUCTNAME_INVALID

SERIALNUMBER_INVALID

PRODUCTID_INVALID

PRODUCTRELEASE_INVALID

FIRMWARERELEASE_INVALID

PERSISTENTSETTINGS_LOADED

PERSISTENTSETTINGS_SAVED

PERSISTENTSETTINGS_MODIFIED

PERSISTENTSETTINGS_INVALID

LUMINOSITY_INVALID

BEACON_OFF

BEACON_ON

BEACON_INVALID

UPTIME_INVALID

USBCURRENT_INVALID

REBOOTCOUNTDOWN_INVALID

USERVAR_INVALID

_productName

_serialNumber

_productId

_productRelease

_firmwareRelease

_persistentSettings

_luminosity

_beacon

_upTime

_usbCurrent

_rebootCountdown

_userVar

_valueCallbackModule

_logCallback

_confChangeCallback

_beaconCallback

Constructor Detail

YModule

YModule

Method Detail

functionCount

functionId

functionType

functionBaseType

functionName

functionValue

_startStopDevLog_internal

_parseAttr

get_productName

getProductName

get_serialNumber

getSerialNumber

get_productId

getProductId

get_productRelease

getProductRelease

get_firmwareRelease

getFirmwareRelease

get_persistentSettings

getPersistentSettings

set_persistentSettings

get_luminosity

getLuminosity

set_luminosity

setLuminosity

get_beacon

getBeacon

set_beacon

setBeacon

get_upTime

getUpTime

get_usbCurrent

getUsbCurrent

get_rebootCountdown