YNetwork (Yoctopuce Java API 2.1.11632-SNAPSHOT API)

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

```
public class YNetwork
extends YFunction
```
YNetwork Class: network interface control interface, available for instance in the YoctoHub-Ethernet, the YoctoHub-GSM-4G, the YoctoHub-Wireless-SR or the YoctoHub-Wireless-n YNetwork objects provide access to TCP/IP parameters of Yoctopuce devices that include a built-in network interface.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`YNetwork.TimedReportCallback` TimedReportCallback for Network
`static interface`	`YNetwork.UpdateCallback` Deprecated UpdateCallback for Network

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`_adminPassword`
`protected String`	`_callbackCredentials`
`protected int`	`_callbackEncoding`
`protected int`	`_callbackInitialDelay`
`protected int`	`_callbackMaxDelay`
`protected int`	`_callbackMethod`
`protected int`	`_callbackMinDelay`
`protected String`	`_callbackSchedule`
`protected int`	`_callbackTemplate`
`protected String`	`_callbackUrl`
`protected String`	`_currentDNS`
`protected String`	`_defaultPage`
`protected int`	`_discoverable`
`protected int`	`_httpPort`
`protected int`	`_httpsPort`
`protected String`	`_ipAddress`
`protected String`	`_ipConfig`
`protected String`	`_macAddress`
`protected String`	`_ntpServer`
`protected int`	`_poeCurrent`
`protected String`	`_primaryDNS`
`protected int`	`_readiness`
`protected String`	`_router`
`protected String`	`_secondaryDNS`
`protected int`	`_securityMode`
`protected String`	`_subnetMask`
`protected String`	`_userPassword`
`protected YNetwork.UpdateCallback`	`_valueCallbackNetwork`
`protected int`	`_wwwWatchdogDelay`
`static String`	`ADMINPASSWORD_INVALID` invalid adminPassword value
`static String`	`CALLBACKCREDENTIALS_INVALID` invalid callbackCredentials value
`static int`	`CALLBACKENCODING_AZURE`
`static int`	`CALLBACKENCODING_CSV`
`static int`	`CALLBACKENCODING_EMONCMS`
`static int`	`CALLBACKENCODING_FORM` invalid callbackEncoding value
`static int`	`CALLBACKENCODING_INFLUXDB`
`static int`	`CALLBACKENCODING_INFLUXDB_V2`
`static int`	`CALLBACKENCODING_INVALID`
`static int`	`CALLBACKENCODING_JSON`
`static int`	`CALLBACKENCODING_JSON_ARRAY`
`static int`	`CALLBACKENCODING_JSON_NUM`
`static int`	`CALLBACKENCODING_MQTT`
`static int`	`CALLBACKENCODING_PRTG`
`static int`	`CALLBACKENCODING_YOCTO_API`
`static int`	`CALLBACKENCODING_YOCTO_API_JZON`
`static int`	`CALLBACKINITIALDELAY_INVALID` invalid callbackInitialDelay value
`static int`	`CALLBACKMAXDELAY_INVALID` invalid callbackMaxDelay value
`static int`	`CALLBACKMETHOD_GET`
`static int`	`CALLBACKMETHOD_INVALID`
`static int`	`CALLBACKMETHOD_POST` invalid callbackMethod value
`static int`	`CALLBACKMETHOD_PUT`
`static int`	`CALLBACKMINDELAY_INVALID` invalid callbackMinDelay value
`static String`	`CALLBACKSCHEDULE_INVALID` invalid callbackSchedule value
`static int`	`CALLBACKTEMPLATE_INVALID`
`static int`	`CALLBACKTEMPLATE_OFF` invalid callbackTemplate value
`static int`	`CALLBACKTEMPLATE_ON`
`static String`	`CALLBACKURL_INVALID` invalid callbackUrl value
`static String`	`CURRENTDNS_INVALID` invalid currentDNS value
`static String`	`DEFAULTPAGE_INVALID` invalid defaultPage value
`static int`	`DISCOVERABLE_FALSE` invalid discoverable value
`static int`	`DISCOVERABLE_INVALID`
`static int`	`DISCOVERABLE_TRUE`
`static int`	`HTTPPORT_INVALID` invalid httpPort value
`static int`	`HTTPSPORT_INVALID` invalid httpsPort value
`static String`	`IPADDRESS_INVALID` invalid ipAddress value
`static String`	`IPCONFIG_INVALID` invalid ipConfig value
`static String`	`MACADDRESS_INVALID` invalid macAddress value
`static String`	`NTPSERVER_INVALID` invalid ntpServer value
`static int`	`POECURRENT_INVALID` invalid poeCurrent value
`static String`	`PRIMARYDNS_INVALID` invalid primaryDNS value
`static int`	`READINESS_DOWN` invalid readiness value
`static int`	`READINESS_EXISTS`
`static int`	`READINESS_INVALID`
`static int`	`READINESS_LAN_OK`
`static int`	`READINESS_LINKED`
`static int`	`READINESS_WWW_OK`
`static String`	`ROUTER_INVALID` invalid router value
`static String`	`SECONDARYDNS_INVALID` invalid secondaryDNS value
`static int`	`SECURITYMODE_INVALID`
`static int`	`SECURITYMODE_LEGACY`
`static int`	`SECURITYMODE_MIXED`
`static int`	`SECURITYMODE_SECURE`
`static int`	`SECURITYMODE_UNDEFINED` invalid securityMode value
`static String`	`SUBNETMASK_INVALID` invalid subnetMask value
`static String`	`USERPASSWORD_INVALID` invalid userPassword value
`static int`	`WWWWATCHDOGDELAY_INVALID` invalid wwwWatchdogDelay 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 YNetwork(String func)

protected YNetwork(YAPIContext ctx, String func)

Constructors
Modifier	Constructor and Description
`protected`	`YNetwork(String func)`
`protected`	`YNetwork(YAPIContext ctx, String func)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`_invokeValueCallback(String value)`
`protected void`	`_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)`
`int`	`callbackLogin(String username, String password)` Connects to the notification callback and saves the credentials required to log into it.
`static YNetwork`	`FindNetwork(String func)` Retrieves a network interface for a given identifier.
`static YNetwork`	`FindNetworkInContext(YAPIContext yctx, String func)` Retrieves a network interface for a given identifier in a YAPI context.
`static YNetwork`	`FirstNetwork()` Starts the enumeration of network interfaces currently accessible.
`static YNetwork`	`FirstNetworkInContext(YAPIContext yctx)` Starts the enumeration of network interfaces currently accessible.
`String`	`get_adminPassword()` Returns a hash string if a password has been set for user "admin", or an empty string otherwise.
`String`	`get_callbackCredentials()` Returns a hashed version of the notification callback credentials if set, or an empty string otherwise.
`int`	`get_callbackEncoding()` Returns the encoding standard to use for representing notification values.
`int`	`get_callbackInitialDelay()` Returns the initial waiting time before first callback notifications, in seconds.
`int`	`get_callbackMaxDelay()` Returns the waiting time between two HTTP callbacks when there is nothing new.
`int`	`get_callbackMethod()` Returns the HTTP method used to notify callbacks for significant state changes.
`int`	`get_callbackMinDelay()` Returns the minimum waiting time between two HTTP callbacks, in seconds.
`String`	`get_callbackSchedule()` Returns the HTTP callback schedule strategy, as a text string.
`int`	`get_callbackTemplate()` Returns the activation state of the custom template file to customize callback format.
`String`	`get_callbackUrl()` Returns the callback URL to notify of significant state changes.
`String`	`get_currentDNS()` Returns the IP address of the DNS server currently used by the device.
`String`	`get_defaultPage()` Returns the HTML page to serve for the URL "/"" of the hub.
`int`	`get_discoverable()` Returns the activation state of the multicast announce protocols to allow easy discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
`int`	`get_httpPort()` Returns the TCP port used to serve the hub web UI.
`int`	`get_httpsPort()` Returns the secure TCP port used to serve the hub web UI.
`String`	`get_ipAddress()` Returns the IP address currently in use by the device.
`String`	`get_ipConfig()` Returns the IP configuration of the network interface.
`String`	`get_macAddress()` Returns the MAC address of the network interface.
`String`	`get_ntpServer()` Returns the IP address of the NTP server to be used by the device.
`int`	`get_poeCurrent()` Returns the current consumed by the module from Power-over-Ethernet (PoE), in milliamps.
`String`	`get_primaryDNS()` Returns the IP address of the primary name server to be used by the module.
`int`	`get_readiness()` Returns the current established working mode of the network interface.
`String`	`get_router()` Returns the IP address of the router on the device subnet (default gateway).
`String`	`get_secondaryDNS()` Returns the IP address of the secondary name server to be used by the module.
`int`	`get_securityMode()` Returns the security level chosen to prevent unauthorized access to the server.
`String`	`get_subnetMask()` Returns the subnet mask currently used by the device.
`String`	`get_userPassword()` Returns a hash string if a password has been set for "user" user, or an empty string otherwise.
`int`	`get_wwwWatchdogDelay()` Returns the allowed downtime of the WWW link (in seconds) before triggering an automated reboot to try to recover Internet connectivity.
`String`	`getAdminPassword()` Returns a hash string if a password has been set for user "admin", or an empty string otherwise.
`String`	`getCallbackCredentials()` Returns a hashed version of the notification callback credentials if set, or an empty string otherwise.
`int`	`getCallbackEncoding()` Returns the encoding standard to use for representing notification values.
`int`	`getCallbackInitialDelay()` Returns the initial waiting time before first callback notifications, in seconds.
`int`	`getCallbackMaxDelay()` Returns the waiting time between two HTTP callbacks when there is nothing new.
`int`	`getCallbackMethod()` Returns the HTTP method used to notify callbacks for significant state changes.
`int`	`getCallbackMinDelay()` Returns the minimum waiting time between two HTTP callbacks, in seconds.
`String`	`getCallbackSchedule()` Returns the HTTP callback schedule strategy, as a text string.
`int`	`getCallbackTemplate()` Returns the activation state of the custom template file to customize callback format.
`String`	`getCallbackUrl()` Returns the callback URL to notify of significant state changes.
`String`	`getCurrentDNS()` Returns the IP address of the DNS server currently used by the device.
`String`	`getDefaultPage()` Returns the HTML page to serve for the URL "/"" of the hub.
`int`	`getDiscoverable()` Returns the activation state of the multicast announce protocols to allow easy discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
`int`	`getHttpPort()` Returns the TCP port used to serve the hub web UI.
`int`	`getHttpsPort()` Returns the secure TCP port used to serve the hub web UI.
`String`	`getIpAddress()` Returns the IP address currently in use by the device.
`String`	`getIpConfig()` Returns the IP configuration of the network interface.
`String`	`getMacAddress()` Returns the MAC address of the network interface.
`String`	`getNtpServer()` Returns the IP address of the NTP server to be used by the device.
`int`	`getPoeCurrent()` Returns the current consumed by the module from Power-over-Ethernet (PoE), in milliamps.
`String`	`getPrimaryDNS()` Returns the IP address of the primary name server to be used by the module.
`int`	`getReadiness()` Returns the current established working mode of the network interface.
`String`	`getRouter()` Returns the IP address of the router on the device subnet (default gateway).
`String`	`getSecondaryDNS()` Returns the IP address of the secondary name server to be used by the module.
`int`	`getSecurityMode()` Returns the security level chosen to prevent unauthorized access to the server.
`String`	`getSubnetMask()` Returns the subnet mask currently used by the device.
`String`	`getUserPassword()` Returns a hash string if a password has been set for "user" user, or an empty string otherwise.
`int`	`getWwwWatchdogDelay()` Returns the allowed downtime of the WWW link (in seconds) before triggering an automated reboot to try to recover Internet connectivity.
`YNetwork`	`nextNetwork()` Continues the enumeration of network interfaces started using yFirstNetwork().
`String`	`ping(String host)` Pings host to test the network connectivity.
`int`	`registerValueCallback(YNetwork.UpdateCallback callback)` Registers the callback function that is invoked on every change of advertised value.
`int`	`set_adminPassword(String newval)` Changes the password for the "admin" user.
`int`	`set_callbackCredentials(String newval)` Changes the credentials required to connect to the callback address.
`int`	`set_callbackEncoding(int newval)` Changes the encoding standard to use for representing notification values.
`int`	`set_callbackInitialDelay(int newval)` Changes the initial waiting time before first callback notifications, in seconds.
`int`	`set_callbackMaxDelay(int newval)` Changes the waiting time between two HTTP callbacks when there is nothing new.
`int`	`set_callbackMethod(int newval)` Changes the HTTP method used to notify callbacks for significant state changes.
`int`	`set_callbackMinDelay(int newval)` Changes the minimum waiting time between two HTTP callbacks, in seconds.
`int`	`set_callbackSchedule(String newval)` Changes the HTTP callback schedule strategy, as a text string.
`int`	`set_callbackTemplate(int newval)` Enable the use of a template file to customize callbacks format.
`int`	`set_callbackUrl(String newval)` Changes the callback URL to notify significant state changes.
`int`	`set_defaultPage(String newval)` Changes the default HTML page returned by the hub.
`int`	`set_discoverable(int newval)` Changes the activation state of the multicast announce protocols to allow easy discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
`int`	`set_httpPort(int newval)` Changes the the TCP port used to serve the hub web UI.
`int`	`set_httpsPort(int newval)` Changes the secure TCP port used to serve the hub web UI.
`int`	`set_ipConfig(String newval)`
`int`	`set_ntpServer(String newval)` Changes the IP address of the NTP server to be used by the module.
`int`	`set_periodicCallbackSchedule(String interval, int offset)` Set up periodic HTTP callbacks (simplified function).
`int`	`set_primaryDNS(String newval)` Changes the IP address of the primary name server to be used by the module.
`int`	`set_secondaryDNS(String newval)` Changes the IP address of the secondary name server to be used by the module.
`int`	`set_securityMode(int newval)` Changes the security level used to prevent unauthorized access to the server.
`int`	`set_userPassword(String newval)` Changes the password for the "user" user.
`int`	`set_wwwWatchdogDelay(int newval)` Changes the allowed downtime of the WWW link (in seconds) before triggering an automated reboot to try to recover Internet connectivity.
`int`	`setAdminPassword(String newval)` Changes the password for the "admin" user.
`int`	`setCallbackCredentials(String newval)` Changes the credentials required to connect to the callback address.
`int`	`setCallbackEncoding(int newval)` Changes the encoding standard to use for representing notification values.
`int`	`setCallbackInitialDelay(int newval)` Changes the initial waiting time before first callback notifications, in seconds.
`int`	`setCallbackMaxDelay(int newval)` Changes the waiting time between two HTTP callbacks when there is nothing new.
`int`	`setCallbackMethod(int newval)` Changes the HTTP method used to notify callbacks for significant state changes.
`int`	`setCallbackMinDelay(int newval)` Changes the minimum waiting time between two HTTP callbacks, in seconds.
`int`	`setCallbackSchedule(String newval)` Changes the HTTP callback schedule strategy, as a text string.
`int`	`setCallbackTemplate(int newval)` Enable the use of a template file to customize callbacks format.
`int`	`setCallbackUrl(String newval)` Changes the callback URL to notify significant state changes.
`int`	`setDefaultPage(String newval)` Changes the default HTML page returned by the hub.
`int`	`setDiscoverable(int newval)` Changes the activation state of the multicast announce protocols to allow easy discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
`int`	`setHttpPort(int newval)` Changes the the TCP port used to serve the hub web UI.
`int`	`setHttpsPort(int newval)` Changes the secure TCP port used to serve the hub web UI.
`int`	`setNtpServer(String newval)` Changes the IP address of the NTP server to be used by the module.
`int`	`setPrimaryDNS(String newval)` Changes the IP address of the primary name server to be used by the module.
`int`	`setSecondaryDNS(String newval)` Changes the IP address of the secondary name server to be used by the module.
`int`	`setSecurityMode(int newval)` Changes the security level used to prevent unauthorized access to the server.
`int`	`setUserPassword(String newval)` Changes the password for the "user" user.
`int`	`setWwwWatchdogDelay(int newval)` Changes the allowed downtime of the WWW link (in seconds) before triggering an automated reboot to try to recover Internet connectivity.
`int`	`triggerCallback()` Trigger an HTTP callback quickly.
`int`	`useDHCP(String fallbackIpAddr, int fallbackSubnetMaskLen, String fallbackRouter)` Changes the configuration of the network interface to enable the use of an IP address received from a DHCP server.
`int`	`useDHCPauto()` Changes the configuration of the network interface to enable the use of an IP address received from a DHCP server.
`int`	`useStaticIP(String ipAddress, int subnetMaskLen, String router)` Changes the configuration of the network interface to use a static IP address.

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_hardwareId, get_logicalName, get_module, get_serialNumber, 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
  - READINESS_DOWN
```
public static final int READINESS_DOWN
```
    invalid readiness value
    
    See Also:
    
    Constant Field Values
  - READINESS_EXISTS
```
public static final int READINESS_EXISTS
```
    See Also:
    
    Constant Field Values
  - READINESS_LINKED
```
public static final int READINESS_LINKED
```
    See Also:
    
    Constant Field Values
  - READINESS_LAN_OK
```
public static final int READINESS_LAN_OK
```
    See Also:
    
    Constant Field Values
  - READINESS_WWW_OK
```
public static final int READINESS_WWW_OK
```
    See Also:
    
    Constant Field Values
  - READINESS_INVALID
```
public static final int READINESS_INVALID
```
    See Also:
    
    Constant Field Values
  - MACADDRESS_INVALID
```
public static final String MACADDRESS_INVALID
```
    invalid macAddress value
    
    See Also:
    
    Constant Field Values
  - IPADDRESS_INVALID
```
public static final String IPADDRESS_INVALID
```
    invalid ipAddress value
    
    See Also:
    
    Constant Field Values
  - SUBNETMASK_INVALID
```
public static final String SUBNETMASK_INVALID
```
    invalid subnetMask value
    
    See Also:
    
    Constant Field Values
  - ROUTER_INVALID
```
public static final String ROUTER_INVALID
```
    invalid router value
    
    See Also:
    
    Constant Field Values
  - CURRENTDNS_INVALID
```
public static final String CURRENTDNS_INVALID
```
    invalid currentDNS value
    
    See Also:
    
    Constant Field Values
  - IPCONFIG_INVALID
```
public static final String IPCONFIG_INVALID
```
    invalid ipConfig value
    
    See Also:
    
    Constant Field Values
  - PRIMARYDNS_INVALID
```
public static final String PRIMARYDNS_INVALID
```
    invalid primaryDNS value
    
    See Also:
    
    Constant Field Values
  - SECONDARYDNS_INVALID
```
public static final String SECONDARYDNS_INVALID
```
    invalid secondaryDNS value
    
    See Also:
    
    Constant Field Values
  - NTPSERVER_INVALID
```
public static final String NTPSERVER_INVALID
```
    invalid ntpServer value
    
    See Also:
    
    Constant Field Values
  - USERPASSWORD_INVALID
```
public static final String USERPASSWORD_INVALID
```
    invalid userPassword value
    
    See Also:
    
    Constant Field Values
  - ADMINPASSWORD_INVALID
```
public static final String ADMINPASSWORD_INVALID
```
    invalid adminPassword value
    
    See Also:
    
    Constant Field Values
  - HTTPPORT_INVALID
```
public static final int HTTPPORT_INVALID
```
    invalid httpPort value
    
    See Also:
    
    Constant Field Values
  - HTTPSPORT_INVALID
```
public static final int HTTPSPORT_INVALID
```
    invalid httpsPort value
    
    See Also:
    
    Constant Field Values
  - SECURITYMODE_UNDEFINED
```
public static final int SECURITYMODE_UNDEFINED
```
    invalid securityMode value
    
    See Also:
    
    Constant Field Values
  - SECURITYMODE_LEGACY
```
public static final int SECURITYMODE_LEGACY
```
    See Also:
    
    Constant Field Values
  - SECURITYMODE_MIXED
```
public static final int SECURITYMODE_MIXED
```
    See Also:
    
    Constant Field Values
  - SECURITYMODE_SECURE
```
public static final int SECURITYMODE_SECURE
```
    See Also:
    
    Constant Field Values
  - SECURITYMODE_INVALID
```
public static final int SECURITYMODE_INVALID
```
    See Also:
    
    Constant Field Values
  - DEFAULTPAGE_INVALID
```
public static final String DEFAULTPAGE_INVALID
```
    invalid defaultPage value
    
    See Also:
    
    Constant Field Values
  - DISCOVERABLE_FALSE
```
public static final int DISCOVERABLE_FALSE
```
    invalid discoverable value
    
    See Also:
    
    Constant Field Values
  - DISCOVERABLE_TRUE
```
public static final int DISCOVERABLE_TRUE
```
    See Also:
    
    Constant Field Values
  - DISCOVERABLE_INVALID
```
public static final int DISCOVERABLE_INVALID
```
    See Also:
    
    Constant Field Values
  - WWWWATCHDOGDELAY_INVALID
```
public static final int WWWWATCHDOGDELAY_INVALID
```
    invalid wwwWatchdogDelay value
    
    See Also:
    
    Constant Field Values
  - CALLBACKURL_INVALID
```
public static final String CALLBACKURL_INVALID
```
    invalid callbackUrl value
    
    See Also:
    
    Constant Field Values
  - CALLBACKMETHOD_POST
```
public static final int CALLBACKMETHOD_POST
```
    invalid callbackMethod value
    
    See Also:
    
    Constant Field Values
  - CALLBACKMETHOD_GET
```
public static final int CALLBACKMETHOD_GET
```
    See Also:
    
    Constant Field Values
  - CALLBACKMETHOD_PUT
```
public static final int CALLBACKMETHOD_PUT
```
    See Also:
    
    Constant Field Values
  - CALLBACKMETHOD_INVALID
```
public static final int CALLBACKMETHOD_INVALID
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_FORM
```
public static final int CALLBACKENCODING_FORM
```
    invalid callbackEncoding value
    
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_JSON
```
public static final int CALLBACKENCODING_JSON
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_JSON_ARRAY
```
public static final int CALLBACKENCODING_JSON_ARRAY
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_CSV
```
public static final int CALLBACKENCODING_CSV
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_YOCTO_API
```
public static final int CALLBACKENCODING_YOCTO_API
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_JSON_NUM
```
public static final int CALLBACKENCODING_JSON_NUM
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_EMONCMS
```
public static final int CALLBACKENCODING_EMONCMS
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_AZURE
```
public static final int CALLBACKENCODING_AZURE
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_INFLUXDB
```
public static final int CALLBACKENCODING_INFLUXDB
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_MQTT
```
public static final int CALLBACKENCODING_MQTT
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_YOCTO_API_JZON
```
public static final int CALLBACKENCODING_YOCTO_API_JZON
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_PRTG
```
public static final int CALLBACKENCODING_PRTG
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_INFLUXDB_V2
```
public static final int CALLBACKENCODING_INFLUXDB_V2
```
    See Also:
    
    Constant Field Values
  - CALLBACKENCODING_INVALID
```
public static final int CALLBACKENCODING_INVALID
```
    See Also:
    
    Constant Field Values
  - CALLBACKTEMPLATE_OFF
```
public static final int CALLBACKTEMPLATE_OFF
```
    invalid callbackTemplate value
    
    See Also:
    
    Constant Field Values
  - CALLBACKTEMPLATE_ON
```
public static final int CALLBACKTEMPLATE_ON
```
    See Also:
    
    Constant Field Values
  - CALLBACKTEMPLATE_INVALID
```
public static final int CALLBACKTEMPLATE_INVALID
```
    See Also:
    
    Constant Field Values
  - CALLBACKCREDENTIALS_INVALID
```
public static final String CALLBACKCREDENTIALS_INVALID
```
    invalid callbackCredentials value
    
    See Also:
    
    Constant Field Values
  - CALLBACKINITIALDELAY_INVALID
```
public static final int CALLBACKINITIALDELAY_INVALID
```
    invalid callbackInitialDelay value
    
    See Also:
    
    Constant Field Values
  - CALLBACKSCHEDULE_INVALID
```
public static final String CALLBACKSCHEDULE_INVALID
```
    invalid callbackSchedule value
    
    See Also:
    
    Constant Field Values
  - CALLBACKMINDELAY_INVALID
```
public static final int CALLBACKMINDELAY_INVALID
```
    invalid callbackMinDelay value
    
    See Also:
    
    Constant Field Values
  - CALLBACKMAXDELAY_INVALID
```
public static final int CALLBACKMAXDELAY_INVALID
```
    invalid callbackMaxDelay value
    
    See Also:
    
    Constant Field Values
  - POECURRENT_INVALID
```
public static final int POECURRENT_INVALID
```
    invalid poeCurrent value
    
    See Also:
    
    Constant Field Values
  - _readiness
```
protected int _readiness
```
  - _macAddress
```
protected String _macAddress
```
  - _ipAddress
```
protected String _ipAddress
```
  - _subnetMask
```
protected String _subnetMask
```
  - _router
```
protected String _router
```
  - _currentDNS
```
protected String _currentDNS
```
  - _ipConfig
```
protected String _ipConfig
```
  - _primaryDNS
```
protected String _primaryDNS
```
  - _secondaryDNS
```
protected String _secondaryDNS
```
  - _ntpServer
```
protected String _ntpServer
```
  - _userPassword
```
protected String _userPassword
```
  - _adminPassword
```
protected String _adminPassword
```
  - _httpPort
```
protected int _httpPort
```
  - _httpsPort
```
protected int _httpsPort
```
  - _securityMode
```
protected int _securityMode
```
  - _defaultPage
```
protected String _defaultPage
```
  - _discoverable
```
protected int _discoverable
```
  - _wwwWatchdogDelay
```
protected int _wwwWatchdogDelay
```
  - _callbackUrl
```
protected String _callbackUrl
```
  - _callbackMethod
```
protected int _callbackMethod
```
  - _callbackEncoding
```
protected int _callbackEncoding
```
  - _callbackTemplate
```
protected int _callbackTemplate
```
  - _callbackCredentials
```
protected String _callbackCredentials
```
  - _callbackInitialDelay
```
protected int _callbackInitialDelay
```
  - _callbackSchedule
```
protected String _callbackSchedule
```
  - _callbackMinDelay
```
protected int _callbackMinDelay
```
  - _callbackMaxDelay
```
protected int _callbackMaxDelay
```
  - _poeCurrent
```
protected int _poeCurrent
```
  - _valueCallbackNetwork
```
protected YNetwork.UpdateCallback _valueCallbackNetwork
```
- Constructor Detail
  - YNetwork
```
protected YNetwork(YAPIContext ctx,
                   String func)
```
    Parameters:
    
    func - : functionid
  - YNetwork
```
protected YNetwork(String func)
```
    Parameters:
    
    func - : functionid
- Method Detail
  - _parseAttr
```
protected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
                   throws Exception
```
    Overrides:
    
    _parseAttr in class YFunction
    
    Throws:
    
    Exception
  - get_readiness
```
public int get_readiness()
                  throws YAPI_Exception
```
    Returns the current established working mode of the network interface. Level zero (DOWN_0) means that no hardware link has been detected. Either there is no signal on the network cable, or the selected wireless access point cannot be detected. Level 1 (LIVE_1) is reached when the network is detected, but is not yet connected. For a wireless network, this shows that the requested SSID is present. Level 2 (LINK_2) is reached when the hardware connection is established. For a wired network connection, level 2 means that the cable is attached at both ends. For a connection to a wireless access point, it shows that the security parameters are properly configured. For an ad-hoc wireless connection, it means that there is at least one other device connected on the ad-hoc network. Level 3 (DHCP_3) is reached when an IP address has been obtained using DHCP. Level 4 (DNS_4) is reached when the DNS server is reachable on the network. Level 5 (WWW_5) is reached when global connectivity is demonstrated by properly loading the current time from an NTP server.
    
    Returns:
    
    a value among YNetwork.READINESS_DOWN, YNetwork.READINESS_EXISTS, YNetwork.READINESS_LINKED, YNetwork.READINESS_LAN_OK and YNetwork.READINESS_WWW_OK corresponding to the current established working mode of the network interface
    
    Throws:
    
    YAPI_Exception - on error
  - getReadiness
```
public int getReadiness()
                 throws YAPI_Exception
```
    Returns the current established working mode of the network interface. Level zero (DOWN_0) means that no hardware link has been detected. Either there is no signal on the network cable, or the selected wireless access point cannot be detected. Level 1 (LIVE_1) is reached when the network is detected, but is not yet connected. For a wireless network, this shows that the requested SSID is present. Level 2 (LINK_2) is reached when the hardware connection is established. For a wired network connection, level 2 means that the cable is attached at both ends. For a connection to a wireless access point, it shows that the security parameters are properly configured. For an ad-hoc wireless connection, it means that there is at least one other device connected on the ad-hoc network. Level 3 (DHCP_3) is reached when an IP address has been obtained using DHCP. Level 4 (DNS_4) is reached when the DNS server is reachable on the network. Level 5 (WWW_5) is reached when global connectivity is demonstrated by properly loading the current time from an NTP server.
    
    Returns:
    
    a value among YNetwork.READINESS_DOWN, YNetwork.READINESS_EXISTS, YNetwork.READINESS_LINKED, YNetwork.READINESS_LAN_OK and YNetwork.READINESS_WWW_OK corresponding to the current established working mode of the network interface
    
    Throws:
    
    YAPI_Exception - on error
  - get_macAddress
```
public String get_macAddress()
                      throws YAPI_Exception
```
    Returns the MAC address of the network interface. The MAC address is also available on a sticker on the module, in both numeric and barcode forms.
    
    Returns:
    
    a string corresponding to the MAC address of the network interface
    
    Throws:
    
    YAPI_Exception - on error
  - getMacAddress
```
public String getMacAddress()
                     throws YAPI_Exception
```
    Returns the MAC address of the network interface. The MAC address is also available on a sticker on the module, in both numeric and barcode forms.
    
    Returns:
    
    a string corresponding to the MAC address of the network interface
    
    Throws:
    
    YAPI_Exception - on error
  - get_ipAddress
```
public String get_ipAddress()
                     throws YAPI_Exception
```
    Returns the IP address currently in use by the device. The address may have been configured statically, or provided by a DHCP server.
    
    Returns:
    
    a string corresponding to the IP address currently in use by the device
    
    Throws:
    
    YAPI_Exception - on error
  - getIpAddress
```
public String getIpAddress()
                    throws YAPI_Exception
```
    Returns the IP address currently in use by the device. The address may have been configured statically, or provided by a DHCP server.
    
    Returns:
    
    a string corresponding to the IP address currently in use by the device
    
    Throws:
    
    YAPI_Exception - on error
  - get_subnetMask
```
public String get_subnetMask()
                      throws YAPI_Exception
```
    Returns the subnet mask currently used by the device.
    
    Returns:
    
    a string corresponding to the subnet mask currently used by the device
    
    Throws:
    
    YAPI_Exception - on error
  - getSubnetMask
```
public String getSubnetMask()
                     throws YAPI_Exception
```
    Returns the subnet mask currently used by the device.
    
    Returns:
    
    a string corresponding to the subnet mask currently used by the device
    
    Throws:
    
    YAPI_Exception - on error
  - get_router
```
public String get_router()
                  throws YAPI_Exception
```
    Returns the IP address of the router on the device subnet (default gateway).
    
    Returns:
    
    a string corresponding to the IP address of the router on the device subnet (default gateway)
    
    Throws:
    
    YAPI_Exception - on error
  - getRouter
```
public String getRouter()
                 throws YAPI_Exception
```
    Returns the IP address of the router on the device subnet (default gateway).
    
    Returns:
    
    a string corresponding to the IP address of the router on the device subnet (default gateway)
    
    Throws:
    
    YAPI_Exception - on error
  - get_currentDNS
```
public String get_currentDNS()
                      throws YAPI_Exception
```
    Returns the IP address of the DNS server currently used by the device.
    
    Returns:
    
    a string corresponding to the IP address of the DNS server currently used by the device
    
    Throws:
    
    YAPI_Exception - on error
  - getCurrentDNS
```
public String getCurrentDNS()
                     throws YAPI_Exception
```
    Returns the IP address of the DNS server currently used by the device.
    
    Returns:
    
    a string corresponding to the IP address of the DNS server currently used by the device
    
    Throws:
    
    YAPI_Exception - on error
  - get_ipConfig
```
public String get_ipConfig()
                    throws YAPI_Exception
```
    Returns the IP configuration of the network interface. If the network interface is set up to use a static IP address, the string starts with "STATIC:" and is followed by three parameters, separated by "/". The first is the device IP address, followed by the subnet mask length, and finally the router IP address (default gateway). For instance: "STATIC:192.168.1.14/16/192.168.1.1" If the network interface is configured to receive its IP from a DHCP server, the string start with "DHCP:" and is followed by three parameters separated by "/". The first is the fallback IP address, then the fallback subnet mask length and finally the fallback router IP address. These three parameters are used when no DHCP reply is received.
    
    Returns:
    
    a string corresponding to the IP configuration of the network interface
    
    Throws:
    
    YAPI_Exception - on error
  - getIpConfig
```
public String getIpConfig()
                   throws YAPI_Exception
```
    Returns the IP configuration of the network interface. If the network interface is set up to use a static IP address, the string starts with "STATIC:" and is followed by three parameters, separated by "/". The first is the device IP address, followed by the subnet mask length, and finally the router IP address (default gateway). For instance: "STATIC:192.168.1.14/16/192.168.1.1" If the network interface is configured to receive its IP from a DHCP server, the string start with "DHCP:" and is followed by three parameters separated by "/". The first is the fallback IP address, then the fallback subnet mask length and finally the fallback router IP address. These three parameters are used when no DHCP reply is received.
    
    Returns:
    
    a string corresponding to the IP configuration of the network interface
    
    Throws:
    
    YAPI_Exception - on error
  - set_ipConfig
```
public int set_ipConfig(String newval)
                 throws YAPI_Exception
```
    Throws:
    
    YAPI_Exception
  - get_primaryDNS
```
public String get_primaryDNS()
                      throws YAPI_Exception
```
    Returns the IP address of the primary name server to be used by the module.
    
    Returns:
    
    a string corresponding to the IP address of the primary name server to be used by the module
    
    Throws:
    
    YAPI_Exception - on error
  - getPrimaryDNS
```
public String getPrimaryDNS()
                     throws YAPI_Exception
```
    Returns the IP address of the primary name server to be used by the module.
    
    Returns:
    
    a string corresponding to the IP address of the primary name server to be used by the module
    
    Throws:
    
    YAPI_Exception - on error
  - set_primaryDNS
```
public int set_primaryDNS(String newval)
                   throws YAPI_Exception
```
    Changes the IP address of the primary name server to be used by the module. When using DHCP, if a value is specified, it overrides the value received from the DHCP server. Remember to call the saveToFlash() method and then to reboot the module to apply this setting.
    
    Parameters:
    
    newval - : a string corresponding to the IP address of the primary name server to be used by the module
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setPrimaryDNS
```
public int setPrimaryDNS(String newval)
                  throws YAPI_Exception
```
    Changes the IP address of the primary name server to be used by the module. When using DHCP, if a value is specified, it overrides the value received from the DHCP server. Remember to call the saveToFlash() method and then to reboot the module to apply this setting.
    
    Parameters:
    
    newval - : a string corresponding to the IP address of the primary name server to be used by the module
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_secondaryDNS
```
public String get_secondaryDNS()
                        throws YAPI_Exception
```
    Returns the IP address of the secondary name server to be used by the module.
    
    Returns:
    
    a string corresponding to the IP address of the secondary name server to be used by the module
    
    Throws:
    
    YAPI_Exception - on error
  - getSecondaryDNS
```
public String getSecondaryDNS()
                       throws YAPI_Exception
```
    Returns the IP address of the secondary name server to be used by the module.
    
    Returns:
    
    a string corresponding to the IP address of the secondary name server to be used by the module
    
    Throws:
    
    YAPI_Exception - on error
  - set_secondaryDNS
```
public int set_secondaryDNS(String newval)
                     throws YAPI_Exception
```
    Changes the IP address of the secondary name server to be used by the module. When using DHCP, if a value is specified, it overrides the value received from the DHCP server. Remember to call the saveToFlash() method and then to reboot the module to apply this setting.
    
    Parameters:
    
    newval - : a string corresponding to the IP address of the secondary name server to be used by the module
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setSecondaryDNS
```
public int setSecondaryDNS(String newval)
                    throws YAPI_Exception
```
    Changes the IP address of the secondary name server to be used by the module. When using DHCP, if a value is specified, it overrides the value received from the DHCP server. Remember to call the saveToFlash() method and then to reboot the module to apply this setting.
    
    Parameters:
    
    newval - : a string corresponding to the IP address of the secondary name server to be used by the module
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_ntpServer
```
public String get_ntpServer()
                     throws YAPI_Exception
```
    Returns the IP address of the NTP server to be used by the device.
    
    Returns:
    
    a string corresponding to the IP address of the NTP server to be used by the device
    
    Throws:
    
    YAPI_Exception - on error
  - getNtpServer
```
public String getNtpServer()
                    throws YAPI_Exception
```
    Returns the IP address of the NTP server to be used by the device.
    
    Returns:
    
    a string corresponding to the IP address of the NTP server to be used by the device
    
    Throws:
    
    YAPI_Exception - on error
  - set_ntpServer
```
public int set_ntpServer(String newval)
                  throws YAPI_Exception
```
    Changes the IP address of the NTP server to be used by the module. Use an empty string to restore the factory set address. Remember to call the saveToFlash() method and then to reboot the module to apply this setting.
    
    Parameters:
    
    newval - : a string corresponding to the IP address of the NTP server to be used by the module
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setNtpServer
```
public int setNtpServer(String newval)
                 throws YAPI_Exception
```
    Changes the IP address of the NTP server to be used by the module. Use an empty string to restore the factory set address. Remember to call the saveToFlash() method and then to reboot the module to apply this setting.
    
    Parameters:
    
    newval - : a string corresponding to the IP address of the NTP server to be used by the module
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_userPassword
```
public String get_userPassword()
                        throws YAPI_Exception
```
    Returns a hash string if a password has been set for "user" user, or an empty string otherwise.
    
    Returns:
    
    a string corresponding to a hash string if a password has been set for "user" user, or an empty string otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - getUserPassword
```
public String getUserPassword()
                       throws YAPI_Exception
```
    Returns a hash string if a password has been set for "user" user, or an empty string otherwise.
    
    Returns:
    
    a string corresponding to a hash string if a password has been set for "user" user, or an empty string otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - set_userPassword
```
public int set_userPassword(String newval)
                     throws YAPI_Exception
```
    Changes the password for the "user" user. This password becomes instantly required to perform any use of the module. If the specified value is an empty string, a password is not required anymore. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the password for the "user" user
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setUserPassword
```
public int setUserPassword(String newval)
                    throws YAPI_Exception
```
    Changes the password for the "user" user. This password becomes instantly required to perform any use of the module. If the specified value is an empty string, a password is not required anymore. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the password for the "user" user
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_adminPassword
```
public String get_adminPassword()
                         throws YAPI_Exception
```
    Returns a hash string if a password has been set for user "admin", or an empty string otherwise.
    
    Returns:
    
    a string corresponding to a hash string if a password has been set for user "admin", or an empty string otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - getAdminPassword
```
public String getAdminPassword()
                        throws YAPI_Exception
```
    Returns a hash string if a password has been set for user "admin", or an empty string otherwise.
    
    Returns:
    
    a string corresponding to a hash string if a password has been set for user "admin", or an empty string otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - set_adminPassword
```
public int set_adminPassword(String newval)
                      throws YAPI_Exception
```
    Changes the password for the "admin" user. This password becomes instantly required to perform any change of the module state. If the specified value is an empty string, a password is not required anymore. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the password for the "admin" user
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setAdminPassword
```
public int setAdminPassword(String newval)
                     throws YAPI_Exception
```
    Changes the password for the "admin" user. This password becomes instantly required to perform any change of the module state. If the specified value is an empty string, a password is not required anymore. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the password for the "admin" user
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_httpPort
```
public int get_httpPort()
                 throws YAPI_Exception
```
    Returns the TCP port used to serve the hub web UI.
    
    Returns:
    
    an integer corresponding to the TCP port used to serve the hub web UI
    
    Throws:
    
    YAPI_Exception - on error
  - getHttpPort
```
public int getHttpPort()
                throws YAPI_Exception
```
    Returns the TCP port used to serve the hub web UI.
    
    Returns:
    
    an integer corresponding to the TCP port used to serve the hub web UI
    
    Throws:
    
    YAPI_Exception - on error
  - set_httpPort
```
public int set_httpPort(int newval)
                 throws YAPI_Exception
```
    Changes the the TCP port used to serve the hub web UI. The default value is port 80, which is the default for all Web servers. Regardless of the value set here, the hub will always reply on port 4444, which is used by default by Yoctopuce API library. When you change this parameter, remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the the TCP port used to serve the hub web UI
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setHttpPort
```
public int setHttpPort(int newval)
                throws YAPI_Exception
```
    Changes the the TCP port used to serve the hub web UI. The default value is port 80, which is the default for all Web servers. Regardless of the value set here, the hub will always reply on port 4444, which is used by default by Yoctopuce API library. When you change this parameter, remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the the TCP port used to serve the hub web UI
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_httpsPort
```
public int get_httpsPort()
                  throws YAPI_Exception
```
    Returns the secure TCP port used to serve the hub web UI.
    
    Returns:
    
    an integer corresponding to the secure TCP port used to serve the hub web UI
    
    Throws:
    
    YAPI_Exception - on error
  - getHttpsPort
```
public int getHttpsPort()
                 throws YAPI_Exception
```
    Returns the secure TCP port used to serve the hub web UI.
    
    Returns:
    
    an integer corresponding to the secure TCP port used to serve the hub web UI
    
    Throws:
    
    YAPI_Exception - on error
  - set_httpsPort
```
public int set_httpsPort(int newval)
                  throws YAPI_Exception
```
    Changes the secure TCP port used to serve the hub web UI. The default value is port 4443, which is the default for all Web servers. When you change this parameter, remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the secure TCP port used to serve the hub web UI
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setHttpsPort
```
public int setHttpsPort(int newval)
                 throws YAPI_Exception
```
    Changes the secure TCP port used to serve the hub web UI. The default value is port 4443, which is the default for all Web servers. When you change this parameter, remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the secure TCP port used to serve the hub web UI
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_securityMode
```
public int get_securityMode()
                     throws YAPI_Exception
```
    Returns the security level chosen to prevent unauthorized access to the server.
    
    Returns:
    
    a value among YNetwork.SECURITYMODE_UNDEFINED, YNetwork.SECURITYMODE_LEGACY, YNetwork.SECURITYMODE_MIXED and YNetwork.SECURITYMODE_SECURE corresponding to the security level chosen to prevent unauthorized access to the server
    
    Throws:
    
    YAPI_Exception - on error
  - getSecurityMode
```
public int getSecurityMode()
                    throws YAPI_Exception
```
    Returns the security level chosen to prevent unauthorized access to the server.
    
    Returns:
    
    a value among YNetwork.SECURITYMODE_UNDEFINED, YNetwork.SECURITYMODE_LEGACY, YNetwork.SECURITYMODE_MIXED and YNetwork.SECURITYMODE_SECURE corresponding to the security level chosen to prevent unauthorized access to the server
    
    Throws:
    
    YAPI_Exception - on error
  - set_securityMode
```
public int set_securityMode(int newval)
                     throws YAPI_Exception
```
    Changes the security level used to prevent unauthorized access to the server. The value UNDEFINED causes the security configuration wizard to be displayed the next time you log on to the Web console. The value LEGACY offers unencrypted HTTP access by default, and is designed to provide compatibility with legacy applications that do not handle password or do not support HTTPS. But it should only be used when system security is guaranteed by other means, such as the use of a firewall. The value MIXED requires the configuration of passwords, and allows access via both HTTP (unencrypted) and HTTPS (encrypted), while requiring the Yoctopuce API to be tolerant of certificate characteristics. The value SECURE requires the configuration of passwords and the use of secure communications in all cases. When you change this parameter, remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a value among YNetwork.SECURITYMODE_UNDEFINED, YNetwork.SECURITYMODE_LEGACY, YNetwork.SECURITYMODE_MIXED and YNetwork.SECURITYMODE_SECURE corresponding to the security level used to prevent unauthorized access to the server
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setSecurityMode
```
public int setSecurityMode(int newval)
                    throws YAPI_Exception
```
    Changes the security level used to prevent unauthorized access to the server. The value UNDEFINED causes the security configuration wizard to be displayed the next time you log on to the Web console. The value LEGACY offers unencrypted HTTP access by default, and is designed to provide compatibility with legacy applications that do not handle password or do not support HTTPS. But it should only be used when system security is guaranteed by other means, such as the use of a firewall. The value MIXED requires the configuration of passwords, and allows access via both HTTP (unencrypted) and HTTPS (encrypted), while requiring the Yoctopuce API to be tolerant of certificate characteristics. The value SECURE requires the configuration of passwords and the use of secure communications in all cases. When you change this parameter, remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a value among YNetwork.SECURITYMODE_UNDEFINED, YNetwork.SECURITYMODE_LEGACY, YNetwork.SECURITYMODE_MIXED and YNetwork.SECURITYMODE_SECURE corresponding to the security level used to prevent unauthorized access to the server
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_defaultPage
```
public String get_defaultPage()
                       throws YAPI_Exception
```
    Returns the HTML page to serve for the URL "/"" of the hub.
    
    Returns:
    
    a string corresponding to the HTML page to serve for the URL "/"" of the hub
    
    Throws:
    
    YAPI_Exception - on error
  - getDefaultPage
```
public String getDefaultPage()
                      throws YAPI_Exception
```
    Returns the HTML page to serve for the URL "/"" of the hub.
    
    Returns:
    
    a string corresponding to the HTML page to serve for the URL "/"" of the hub
    
    Throws:
    
    YAPI_Exception - on error
  - set_defaultPage
```
public int set_defaultPage(String newval)
                    throws YAPI_Exception
```
    Changes the default HTML page returned by the hub. If not value are set the hub return "index.html" which is the web interface of the hub. It is possible to change this page for file that has been uploaded on the hub. The maximum filename size is 15 characters. When you change this parameter, remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the default HTML page returned by the hub
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setDefaultPage
```
public int setDefaultPage(String newval)
                   throws YAPI_Exception
```
    Changes the default HTML page returned by the hub. If not value are set the hub return "index.html" which is the web interface of the hub. It is possible to change this page for file that has been uploaded on the hub. The maximum filename size is 15 characters. When you change this parameter, remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the default HTML page returned by the hub
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_discoverable
```
public int get_discoverable()
                     throws YAPI_Exception
```
    Returns the activation state of the multicast announce protocols to allow easy discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
    
    Returns:
    
    either YNetwork.DISCOVERABLE_FALSE or YNetwork.DISCOVERABLE_TRUE, according to the activation state of the multicast announce protocols to allow easy discovery of the module in the network neighborhood (uPnP/Bonjour protocol)
    
    Throws:
    
    YAPI_Exception - on error
  - getDiscoverable
```
public int getDiscoverable()
                    throws YAPI_Exception
```
    Returns the activation state of the multicast announce protocols to allow easy discovery of the module in the network neighborhood (uPnP/Bonjour protocol).
    
    Returns:
    
    either YNetwork.DISCOVERABLE_FALSE or YNetwork.DISCOVERABLE_TRUE, according to the activation state of the multicast announce protocols to allow easy discovery of the module in the network neighborhood (uPnP/Bonjour protocol)
    
    Throws:
    
    YAPI_Exception - on error
  - set_discoverable
```
public int set_discoverable(int newval)
                     throws YAPI_Exception
```
    Changes the activation state of the multicast announce protocols to allow easy discovery of the module in the network neighborhood (uPnP/Bonjour protocol). Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : either YNetwork.DISCOVERABLE_FALSE or YNetwork.DISCOVERABLE_TRUE, according to the activation state of the multicast announce protocols to allow easy discovery of the module in the network neighborhood (uPnP/Bonjour protocol)
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setDiscoverable
```
public int setDiscoverable(int newval)
                    throws YAPI_Exception
```
    Changes the activation state of the multicast announce protocols to allow easy discovery of the module in the network neighborhood (uPnP/Bonjour protocol). Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : either YNetwork.DISCOVERABLE_FALSE or YNetwork.DISCOVERABLE_TRUE, according to the activation state of the multicast announce protocols to allow easy discovery of the module in the network neighborhood (uPnP/Bonjour protocol)
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_wwwWatchdogDelay
```
public int get_wwwWatchdogDelay()
                         throws YAPI_Exception
```
    Returns the allowed downtime of the WWW link (in seconds) before triggering an automated reboot to try to recover Internet connectivity. A zero value disables automated reboot in case of Internet connectivity loss.
    
    Returns:
    
    an integer corresponding to the allowed downtime of the WWW link (in seconds) before triggering an automated reboot to try to recover Internet connectivity
    
    Throws:
    
    YAPI_Exception - on error
  - getWwwWatchdogDelay
```
public int getWwwWatchdogDelay()
                        throws YAPI_Exception
```
    Returns the allowed downtime of the WWW link (in seconds) before triggering an automated reboot to try to recover Internet connectivity. A zero value disables automated reboot in case of Internet connectivity loss.
    
    Returns:
    
    an integer corresponding to the allowed downtime of the WWW link (in seconds) before triggering an automated reboot to try to recover Internet connectivity
    
    Throws:
    
    YAPI_Exception - on error
  - set_wwwWatchdogDelay
```
public int set_wwwWatchdogDelay(int newval)
                         throws YAPI_Exception
```
    Changes the allowed downtime of the WWW link (in seconds) before triggering an automated reboot to try to recover Internet connectivity. A zero value disables automated reboot in case of Internet connectivity loss. The smallest valid non-zero timeout is 90 seconds. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the allowed downtime of the WWW link (in seconds) before triggering an automated reboot to try to recover Internet connectivity
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setWwwWatchdogDelay
```
public int setWwwWatchdogDelay(int newval)
                        throws YAPI_Exception
```
    Changes the allowed downtime of the WWW link (in seconds) before triggering an automated reboot to try to recover Internet connectivity. A zero value disables automated reboot in case of Internet connectivity loss. The smallest valid non-zero timeout is 90 seconds. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the allowed downtime of the WWW link (in seconds) before triggering an automated reboot to try to recover Internet connectivity
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_callbackUrl
```
public String get_callbackUrl()
                       throws YAPI_Exception
```
    Returns the callback URL to notify of significant state changes.
    
    Returns:
    
    a string corresponding to the callback URL to notify of significant state changes
    
    Throws:
    
    YAPI_Exception - on error
  - getCallbackUrl
```
public String getCallbackUrl()
                      throws YAPI_Exception
```
    Returns the callback URL to notify of significant state changes.
    
    Returns:
    
    a string corresponding to the callback URL to notify of significant state changes
    
    Throws:
    
    YAPI_Exception - on error
  - set_callbackUrl
```
public int set_callbackUrl(String newval)
                    throws YAPI_Exception
```
    Changes the callback URL to notify significant state changes. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the callback URL to notify significant state changes
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCallbackUrl
```
public int setCallbackUrl(String newval)
                   throws YAPI_Exception
```
    Changes the callback URL to notify significant state changes. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the callback URL to notify significant state changes
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_callbackMethod
```
public int get_callbackMethod()
                       throws YAPI_Exception
```
    Returns the HTTP method used to notify callbacks for significant state changes.
    
    Returns:
    
    a value among YNetwork.CALLBACKMETHOD_POST, YNetwork.CALLBACKMETHOD_GET and YNetwork.CALLBACKMETHOD_PUT corresponding to the HTTP method used to notify callbacks for significant state changes
    
    Throws:
    
    YAPI_Exception - on error
  - getCallbackMethod
```
public int getCallbackMethod()
                      throws YAPI_Exception
```
    Returns the HTTP method used to notify callbacks for significant state changes.
    
    Returns:
    
    a value among YNetwork.CALLBACKMETHOD_POST, YNetwork.CALLBACKMETHOD_GET and YNetwork.CALLBACKMETHOD_PUT corresponding to the HTTP method used to notify callbacks for significant state changes
    
    Throws:
    
    YAPI_Exception - on error
  - set_callbackMethod
```
public int set_callbackMethod(int newval)
                       throws YAPI_Exception
```
    Changes the HTTP method used to notify callbacks for significant state changes. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a value among YNetwork.CALLBACKMETHOD_POST, YNetwork.CALLBACKMETHOD_GET and YNetwork.CALLBACKMETHOD_PUT corresponding to the HTTP method used to notify callbacks for significant state changes
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCallbackMethod
```
public int setCallbackMethod(int newval)
                      throws YAPI_Exception
```
    Changes the HTTP method used to notify callbacks for significant state changes. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a value among YNetwork.CALLBACKMETHOD_POST, YNetwork.CALLBACKMETHOD_GET and YNetwork.CALLBACKMETHOD_PUT corresponding to the HTTP method used to notify callbacks for significant state changes
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_callbackEncoding
```
public int get_callbackEncoding()
                         throws YAPI_Exception
```
    Returns the encoding standard to use for representing notification values.
    
    Returns:
    
    a value among YNetwork.CALLBACKENCODING_FORM, YNetwork.CALLBACKENCODING_JSON, YNetwork.CALLBACKENCODING_JSON_ARRAY, YNetwork.CALLBACKENCODING_CSV, YNetwork.CALLBACKENCODING_YOCTO_API, YNetwork.CALLBACKENCODING_JSON_NUM, YNetwork.CALLBACKENCODING_EMONCMS, YNetwork.CALLBACKENCODING_AZURE, YNetwork.CALLBACKENCODING_INFLUXDB, YNetwork.CALLBACKENCODING_MQTT, YNetwork.CALLBACKENCODING_YOCTO_API_JZON, YNetwork.CALLBACKENCODING_PRTG and YNetwork.CALLBACKENCODING_INFLUXDB_V2 corresponding to the encoding standard to use for representing notification values
    
    Throws:
    
    YAPI_Exception - on error
  - getCallbackEncoding
```
public int getCallbackEncoding()
                        throws YAPI_Exception
```
    Returns the encoding standard to use for representing notification values.
    
    Returns:
    
    a value among YNetwork.CALLBACKENCODING_FORM, YNetwork.CALLBACKENCODING_JSON, YNetwork.CALLBACKENCODING_JSON_ARRAY, YNetwork.CALLBACKENCODING_CSV, YNetwork.CALLBACKENCODING_YOCTO_API, YNetwork.CALLBACKENCODING_JSON_NUM, YNetwork.CALLBACKENCODING_EMONCMS, YNetwork.CALLBACKENCODING_AZURE, YNetwork.CALLBACKENCODING_INFLUXDB, YNetwork.CALLBACKENCODING_MQTT, YNetwork.CALLBACKENCODING_YOCTO_API_JZON, YNetwork.CALLBACKENCODING_PRTG and YNetwork.CALLBACKENCODING_INFLUXDB_V2 corresponding to the encoding standard to use for representing notification values
    
    Throws:
    
    YAPI_Exception - on error
  - set_callbackEncoding
```
public int set_callbackEncoding(int newval)
                         throws YAPI_Exception
```
    Changes the encoding standard to use for representing notification values. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a value among YNetwork.CALLBACKENCODING_FORM, YNetwork.CALLBACKENCODING_JSON, YNetwork.CALLBACKENCODING_JSON_ARRAY, YNetwork.CALLBACKENCODING_CSV, YNetwork.CALLBACKENCODING_YOCTO_API, YNetwork.CALLBACKENCODING_JSON_NUM, YNetwork.CALLBACKENCODING_EMONCMS, YNetwork.CALLBACKENCODING_AZURE, YNetwork.CALLBACKENCODING_INFLUXDB, YNetwork.CALLBACKENCODING_MQTT, YNetwork.CALLBACKENCODING_YOCTO_API_JZON, YNetwork.CALLBACKENCODING_PRTG and YNetwork.CALLBACKENCODING_INFLUXDB_V2 corresponding to the encoding standard to use for representing notification values
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCallbackEncoding
```
public int setCallbackEncoding(int newval)
                        throws YAPI_Exception
```
    Changes the encoding standard to use for representing notification values. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a value among YNetwork.CALLBACKENCODING_FORM, YNetwork.CALLBACKENCODING_JSON, YNetwork.CALLBACKENCODING_JSON_ARRAY, YNetwork.CALLBACKENCODING_CSV, YNetwork.CALLBACKENCODING_YOCTO_API, YNetwork.CALLBACKENCODING_JSON_NUM, YNetwork.CALLBACKENCODING_EMONCMS, YNetwork.CALLBACKENCODING_AZURE, YNetwork.CALLBACKENCODING_INFLUXDB, YNetwork.CALLBACKENCODING_MQTT, YNetwork.CALLBACKENCODING_YOCTO_API_JZON, YNetwork.CALLBACKENCODING_PRTG and YNetwork.CALLBACKENCODING_INFLUXDB_V2 corresponding to the encoding standard to use for representing notification values
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_callbackTemplate
```
public int get_callbackTemplate()
                         throws YAPI_Exception
```
    Returns the activation state of the custom template file to customize callback format. If the custom callback template is disabled, it will be ignored even if present on the YoctoHub.
    
    Returns:
    
    either YNetwork.CALLBACKTEMPLATE_OFF or YNetwork.CALLBACKTEMPLATE_ON, according to the activation state of the custom template file to customize callback format
    
    Throws:
    
    YAPI_Exception - on error
  - getCallbackTemplate
```
public int getCallbackTemplate()
                        throws YAPI_Exception
```
    Returns the activation state of the custom template file to customize callback format. If the custom callback template is disabled, it will be ignored even if present on the YoctoHub.
    
    Returns:
    
    either YNetwork.CALLBACKTEMPLATE_OFF or YNetwork.CALLBACKTEMPLATE_ON, according to the activation state of the custom template file to customize callback format
    
    Throws:
    
    YAPI_Exception - on error
  - set_callbackTemplate
```
public int set_callbackTemplate(int newval)
                         throws YAPI_Exception
```
    Enable the use of a template file to customize callbacks format. When the custom callback template file is enabled, the template file will be loaded for each callback in order to build the data to post to the server. If template file does not exist on the YoctoHub, the callback will fail with an error message indicating the name of the expected template file. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : either YNetwork.CALLBACKTEMPLATE_OFF or YNetwork.CALLBACKTEMPLATE_ON
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCallbackTemplate
```
public int setCallbackTemplate(int newval)
                        throws YAPI_Exception
```
    Enable the use of a template file to customize callbacks format. When the custom callback template file is enabled, the template file will be loaded for each callback in order to build the data to post to the server. If template file does not exist on the YoctoHub, the callback will fail with an error message indicating the name of the expected template file. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : either YNetwork.CALLBACKTEMPLATE_OFF or YNetwork.CALLBACKTEMPLATE_ON
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_callbackCredentials
```
public String get_callbackCredentials()
                               throws YAPI_Exception
```
    Returns a hashed version of the notification callback credentials if set, or an empty string otherwise.
    
    Returns:
    
    a string corresponding to a hashed version of the notification callback credentials if set, or an empty string otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - getCallbackCredentials
```
public String getCallbackCredentials()
                              throws YAPI_Exception
```
    Returns a hashed version of the notification callback credentials if set, or an empty string otherwise.
    
    Returns:
    
    a string corresponding to a hashed version of the notification callback credentials if set, or an empty string otherwise
    
    Throws:
    
    YAPI_Exception - on error
  - set_callbackCredentials
```
public int set_callbackCredentials(String newval)
                            throws YAPI_Exception
```
    Changes the credentials required to connect to the callback address. The credentials must be provided as returned by function get_callbackCredentials, in the form username:hash. The method used to compute the hash varies according to the the authentication scheme implemented by the callback, For Basic authentication, the hash is the MD5 of the string username:password. For Digest authentication, the hash is the MD5 of the string username:realm:password. For a simpler way to configure callback credentials, use function callbackLogin instead. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the credentials required to connect to the callback address
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCallbackCredentials
```
public int setCallbackCredentials(String newval)
                           throws YAPI_Exception
```
    Changes the credentials required to connect to the callback address. The credentials must be provided as returned by function get_callbackCredentials, in the form username:hash. The method used to compute the hash varies according to the the authentication scheme implemented by the callback, For Basic authentication, the hash is the MD5 of the string username:password. For Digest authentication, the hash is the MD5 of the string username:realm:password. For a simpler way to configure callback credentials, use function callbackLogin instead. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the credentials required to connect to the callback address
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - callbackLogin
```
public int callbackLogin(String username,
                         String password)
                  throws YAPI_Exception
```
    Connects to the notification callback and saves the credentials required to log into it. The password is not stored into the module, only a hashed copy of the credentials are saved. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    username - : username required to log to the callback
    
    password - : password required to log to the callback
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_callbackInitialDelay
```
public int get_callbackInitialDelay()
                             throws YAPI_Exception
```
    Returns the initial waiting time before first callback notifications, in seconds.
    
    Returns:
    
    an integer corresponding to the initial waiting time before first callback notifications, in seconds
    
    Throws:
    
    YAPI_Exception - on error
  - getCallbackInitialDelay
```
public int getCallbackInitialDelay()
                            throws YAPI_Exception
```
    Returns the initial waiting time before first callback notifications, in seconds.
    
    Returns:
    
    an integer corresponding to the initial waiting time before first callback notifications, in seconds
    
    Throws:
    
    YAPI_Exception - on error
  - set_callbackInitialDelay
```
public int set_callbackInitialDelay(int newval)
                             throws YAPI_Exception
```
    Changes the initial waiting time before first callback notifications, in seconds. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the initial waiting time before first callback notifications, in seconds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCallbackInitialDelay
```
public int setCallbackInitialDelay(int newval)
                            throws YAPI_Exception
```
    Changes the initial waiting time before first callback notifications, in seconds. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the initial waiting time before first callback notifications, in seconds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_callbackSchedule
```
public String get_callbackSchedule()
                            throws YAPI_Exception
```
    Returns the HTTP callback schedule strategy, as a text string.
    
    Returns:
    
    a string corresponding to the HTTP callback schedule strategy, as a text string
    
    Throws:
    
    YAPI_Exception - on error
  - getCallbackSchedule
```
public String getCallbackSchedule()
                           throws YAPI_Exception
```
    Returns the HTTP callback schedule strategy, as a text string.
    
    Returns:
    
    a string corresponding to the HTTP callback schedule strategy, as a text string
    
    Throws:
    
    YAPI_Exception - on error
  - set_callbackSchedule
```
public int set_callbackSchedule(String newval)
                         throws YAPI_Exception
```
    Changes the HTTP callback schedule strategy, as a text string. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the HTTP callback schedule strategy, as a text string
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCallbackSchedule
```
public int setCallbackSchedule(String newval)
                        throws YAPI_Exception
```
    Changes the HTTP callback schedule strategy, as a text string. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : a string corresponding to the HTTP callback schedule strategy, as a text string
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_callbackMinDelay
```
public int get_callbackMinDelay()
                         throws YAPI_Exception
```
    Returns the minimum waiting time between two HTTP callbacks, in seconds.
    
    Returns:
    
    an integer corresponding to the minimum waiting time between two HTTP callbacks, in seconds
    
    Throws:
    
    YAPI_Exception - on error
  - getCallbackMinDelay
```
public int getCallbackMinDelay()
                        throws YAPI_Exception
```
    Returns the minimum waiting time between two HTTP callbacks, in seconds.
    
    Returns:
    
    an integer corresponding to the minimum waiting time between two HTTP callbacks, in seconds
    
    Throws:
    
    YAPI_Exception - on error
  - set_callbackMinDelay
```
public int set_callbackMinDelay(int newval)
                         throws YAPI_Exception
```
    Changes the minimum waiting time between two HTTP callbacks, in seconds. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the minimum waiting time between two HTTP callbacks, in seconds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCallbackMinDelay
```
public int setCallbackMinDelay(int newval)
                        throws YAPI_Exception
```
    Changes the minimum waiting time between two HTTP callbacks, in seconds. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the minimum waiting time between two HTTP callbacks, in seconds
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_callbackMaxDelay
```
public int get_callbackMaxDelay()
                         throws YAPI_Exception
```
    Returns the waiting time between two HTTP callbacks when there is nothing new.
    
    Returns:
    
    an integer corresponding to the waiting time between two HTTP callbacks when there is nothing new
    
    Throws:
    
    YAPI_Exception - on error
  - getCallbackMaxDelay
```
public int getCallbackMaxDelay()
                        throws YAPI_Exception
```
    Returns the waiting time between two HTTP callbacks when there is nothing new.
    
    Returns:
    
    an integer corresponding to the waiting time between two HTTP callbacks when there is nothing new
    
    Throws:
    
    YAPI_Exception - on error
  - set_callbackMaxDelay
```
public int set_callbackMaxDelay(int newval)
                         throws YAPI_Exception
```
    Changes the waiting time between two HTTP callbacks when there is nothing new. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the waiting time between two HTTP callbacks when there is nothing new
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - setCallbackMaxDelay
```
public int setCallbackMaxDelay(int newval)
                        throws YAPI_Exception
```
    Changes the waiting time between two HTTP callbacks when there is nothing new. Remember to call the saveToFlash() method of the module if the modification must be kept.
    
    Parameters:
    
    newval - : an integer corresponding to the waiting time between two HTTP callbacks when there is nothing new
    
    Returns:
    
    YAPI.SUCCESS if the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - get_poeCurrent
```
public int get_poeCurrent()
                   throws YAPI_Exception
```
    Returns the current consumed by the module from Power-over-Ethernet (PoE), in milliamps. The current consumption is measured after converting PoE source to 5 Volt, and should never exceed 1800 mA.
    
    Returns:
    
    an integer corresponding to the current consumed by the module from Power-over-Ethernet (PoE), in milliamps
    
    Throws:
    
    YAPI_Exception - on error
  - getPoeCurrent
```
public int getPoeCurrent()
                  throws YAPI_Exception
```
    Returns the current consumed by the module from Power-over-Ethernet (PoE), in milliamps. The current consumption is measured after converting PoE source to 5 Volt, and should never exceed 1800 mA.
    
    Returns:
    
    an integer corresponding to the current consumed by the module from Power-over-Ethernet (PoE), in milliamps
    
    Throws:
    
    YAPI_Exception - on error
  - FindNetwork
```
public static YNetwork FindNetwork(String func)
```
    Retrieves a network 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 network interface is online at the time it is invoked. The returned object is nevertheless valid. Use the method YNetwork.isOnline() to test if the network interface is indeed online at a given time. In case of ambiguity when looking for a network 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's 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.
    Parameters:
    
    func - : a string that uniquely characterizes the network interface, for instance YHUBETH1.network.
    
    Returns:
    
    a YNetwork object allowing you to drive the network interface.
  - FindNetworkInContext
```
public static YNetwork FindNetworkInContext(YAPIContext yctx,
                                            String func)
```
    Retrieves a network interface 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 network interface is online at the time it is invoked. The returned object is nevertheless valid. Use the method YNetwork.isOnline() to test if the network interface is indeed online at a given time. In case of ambiguity when looking for a network 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.
    Parameters:
    
    yctx - : a YAPI context
    
    func - : a string that uniquely characterizes the network interface, for instance YHUBETH1.network.
    
    Returns:
    
    a YNetwork object allowing you to drive the network interface.
  - registerValueCallback
```
public int registerValueCallback(YNetwork.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
  - useDHCP
```
public int useDHCP(String fallbackIpAddr,
                   int fallbackSubnetMaskLen,
                   String fallbackRouter)
            throws YAPI_Exception
```
    Changes the configuration of the network interface to enable the use of an IP address received from a DHCP server. Until an address is received from a DHCP server, the module uses the IP parameters specified to this function. Remember to call the saveToFlash() method and then to reboot the module to apply this setting.
    
    Parameters:
    
    fallbackIpAddr - : fallback IP address, to be used when no DHCP reply is received
    
    fallbackSubnetMaskLen - : fallback subnet mask length when no DHCP reply is received, as an integer (e.g. 24 means 255.255.255.0)
    
    fallbackRouter - : fallback router IP address, to be used when no DHCP reply is received
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - useDHCPauto
```
public int useDHCPauto()
                throws YAPI_Exception
```
    Changes the configuration of the network interface to enable the use of an IP address received from a DHCP server. Until an address is received from a DHCP server, the module uses an IP of the network 169.254.0.0/16 (APIPA). Remember to call the saveToFlash() method and then to reboot the module to apply this setting.
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - useStaticIP
```
public int useStaticIP(String ipAddress,
                       int subnetMaskLen,
                       String router)
                throws YAPI_Exception
```
    Changes the configuration of the network interface to use a static IP address. Remember to call the saveToFlash() method and then to reboot the module to apply this setting.
    
    Parameters:
    
    ipAddress - : device IP address
    
    subnetMaskLen - : subnet mask length, as an integer (e.g. 24 means 255.255.255.0)
    
    router - : router IP address (default gateway)
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - ping
```
public String ping(String host)
            throws YAPI_Exception
```
    Pings host to test the network connectivity. Sends four ICMP ECHO_REQUEST requests from the module to the target host. This method returns a string with the result of the 4 ICMP ECHO_REQUEST requests.
    
    Parameters:
    
    host - : the hostname or the IP address of the target
    
    Returns:
    
    a string with the result of the ping.
    
    Throws:
    
    YAPI_Exception
  - triggerCallback
```
public int triggerCallback()
                    throws YAPI_Exception
```
    Trigger an HTTP callback quickly. This function can even be called within an HTTP callback, in which case the next callback will be triggered 5 seconds after the end of the current callback, regardless if the minimum time between callbacks configured in the device.
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - set_periodicCallbackSchedule
```
public int set_periodicCallbackSchedule(String interval,
                                        int offset)
                                 throws YAPI_Exception
```
    Set up periodic HTTP callbacks (simplified function).
    
    Parameters:
    
    interval - : a string representing the callback periodicity, expressed in seconds, minutes or hours, eg. "60s", "5m", "1h", "48h".
    
    offset - : an integer representing the time offset relative to the period when the callback should occur. For instance, if the periodicity is 24h, an offset of 7 will make the callback occur each day at 7AM.
    
    Returns:
    
    YAPI.SUCCESS when the call succeeds.
    
    Throws:
    
    YAPI_Exception - on error
  - nextNetwork
```
public YNetwork nextNetwork()
```
    Continues the enumeration of network interfaces started using yFirstNetwork(). Caution: You can't make any assumption about the returned network interfaces order. If you want to find a specific a network interface, use Network.findNetwork() and a hardwareID or a logical name.
    
    Returns:
    
    a pointer to a YNetwork object, corresponding to a network interface currently online, or a null pointer if there are no more network interfaces to enumerate.
  - FirstNetwork
```
public static YNetwork FirstNetwork()
```
    Starts the enumeration of network interfaces currently accessible. Use the method YNetwork.nextNetwork() to iterate on next network interfaces.
    
    Returns:
    
    a pointer to a YNetwork object, corresponding to the first network interface currently online, or a null pointer if there are none.
  - FirstNetworkInContext
```
public static YNetwork FirstNetworkInContext(YAPIContext yctx)
```
    Starts the enumeration of network interfaces currently accessible. Use the method YNetwork.nextNetwork() to iterate on next network interfaces.
    
    Parameters:
    
    yctx - : a YAPI context.
    
    Returns:
    
    a pointer to a YNetwork object, corresponding to the first network interface currently online, or a null pointer if there are none.

Class YNetwork

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

READINESS_DOWN

READINESS_EXISTS

READINESS_LINKED

READINESS_LAN_OK

READINESS_WWW_OK

READINESS_INVALID

MACADDRESS_INVALID

IPADDRESS_INVALID

SUBNETMASK_INVALID

ROUTER_INVALID

CURRENTDNS_INVALID

IPCONFIG_INVALID

PRIMARYDNS_INVALID

SECONDARYDNS_INVALID

NTPSERVER_INVALID

USERPASSWORD_INVALID

ADMINPASSWORD_INVALID

HTTPPORT_INVALID

HTTPSPORT_INVALID

SECURITYMODE_UNDEFINED

SECURITYMODE_LEGACY

SECURITYMODE_MIXED

SECURITYMODE_SECURE

SECURITYMODE_INVALID

DEFAULTPAGE_INVALID

DISCOVERABLE_FALSE

DISCOVERABLE_TRUE

DISCOVERABLE_INVALID

WWWWATCHDOGDELAY_INVALID

CALLBACKURL_INVALID

CALLBACKMETHOD_POST

CALLBACKMETHOD_GET

CALLBACKMETHOD_PUT

CALLBACKMETHOD_INVALID

CALLBACKENCODING_FORM

CALLBACKENCODING_JSON

CALLBACKENCODING_JSON_ARRAY

CALLBACKENCODING_CSV

CALLBACKENCODING_YOCTO_API

CALLBACKENCODING_JSON_NUM

CALLBACKENCODING_EMONCMS

CALLBACKENCODING_AZURE

CALLBACKENCODING_INFLUXDB

CALLBACKENCODING_MQTT

CALLBACKENCODING_YOCTO_API_JZON

CALLBACKENCODING_PRTG

CALLBACKENCODING_INFLUXDB_V2

CALLBACKENCODING_INVALID

CALLBACKTEMPLATE_OFF

CALLBACKTEMPLATE_ON

CALLBACKTEMPLATE_INVALID

CALLBACKCREDENTIALS_INVALID

CALLBACKINITIALDELAY_INVALID

CALLBACKSCHEDULE_INVALID

CALLBACKMINDELAY_INVALID

CALLBACKMAXDELAY_INVALID

POECURRENT_INVALID

_readiness

_macAddress

_ipAddress

_subnetMask

_router

_currentDNS

_ipConfig

_primaryDNS

_secondaryDNS

_ntpServer

_userPassword

_adminPassword

_httpPort

_httpsPort