.. _object_WirelessNetworkInterface: :index:`WirelessNetworkInterface` --------------------------------- Description *********** The WirelessNetworkInterface object represents a wireless network interface attached to the device. It provides all required settings to act as a wireless network client (:ref:`ssid `/:ref:`passphrase `). Additionally the provided configuration items can be used to make the settings available to generic property-based frontends. :**› Inherits**: :ref:`NetworkInterface ` Overview ******** Properties ++++++++++ .. hlist:: :columns: 3 * :ref:`availableNetworks ` * :ref:`countryCode ` * :ref:`countryCodeItem ` * :ref:`index ` * :ref:`indexItem ` * :ref:`passphrase ` * :ref:`passphraseItem ` * :ref:`ssid ` * :ref:`ssidItem ` * :ref:`NetworkInterface.bytesRx ` * :ref:`NetworkInterface.bytesTx ` * :ref:`NetworkInterface.dhcpClientIdentifier ` * :ref:`NetworkInterface.enabled ` * :ref:`NetworkInterface.enabledItem ` * :ref:`NetworkInterface.error ` * :ref:`NetworkInterface.errorString ` * :ref:`NetworkInterface.hardwareAddress ` * :ref:`NetworkInterface.hardwareAddressItem ` * :ref:`NetworkInterface.hardwareName ` * :ref:`NetworkInterface.networkAddresses ` * :ref:`NetworkInterface.ntp ` * :ref:`NetworkInterface.ntpItem ` * :ref:`NetworkInterface.operationalState ` * :ref:`NetworkInterface.routes ` * :ref:`NetworkInterface.setupState ` * :ref:`NetworkInterface.trafficRx ` * :ref:`NetworkInterface.trafficTx ` * :ref:`NetworkInterface.useRoutes ` * :ref:`NetworkInterface.useRoutesItem ` * :ref:`ConfigurationObject.items ` * :ref:`ConfigurationObject.name ` * :ref:`ConfigurationObject.nameItem ` * :ref:`Object.objectId ` * :ref:`Object.parent ` Methods +++++++ .. hlist:: :columns: 2 * :ref:`scanAvailableNetworks() ` * :ref:`NetworkInterface.pollBytesRx() ` * :ref:`NetworkInterface.pollBytesTx() ` * :ref:`NetworkInterface.pollTrafficRx() ` * :ref:`NetworkInterface.pollTrafficTx() ` * :ref:`ConfigurationObject.toDataMap() ` * :ref:`Object.deserializeProperties() ` * :ref:`Object.fromJson() ` * :ref:`Object.serializeProperties() ` * :ref:`Object.toJson() ` Signals +++++++ .. hlist:: :columns: 1 * :ref:`NetworkInterface.errorOccurred() ` * :ref:`NetworkInterface.routesDataChanged() ` * :ref:`ConfigurationObject.aboutToBeUpdated() ` * :ref:`ConfigurationObject.itemsDataChanged() ` * :ref:`ConfigurationObject.updated() ` * :ref:`Object.completed() ` Enumerations ++++++++++++ .. hlist:: :columns: 1 * :ref:`Index ` * :ref:`NetworkInterface.DhcpClientIdentifier ` * :ref:`NetworkInterface.Error ` * :ref:`NetworkInterface.OperationalState ` * :ref:`NetworkInterface.SetupState ` Properties ********** .. _property_WirelessNetworkInterface_availableNetworks: .. _signal_WirelessNetworkInterface_availableNetworksChanged: .. index:: single: availableNetworks availableNetworks +++++++++++++++++ This property holds a list with information about all available wireless networks found during the last scan. Every list entry contains several properties including ``ssid``, ``signal``, ``mode``, ``wpa`, ``frequency`` and ``privacy``. Per default this list is updated every 30 s. It's also possible to manually trigger a network scan by calling :ref:`scanAvailableNetworks() `. This property was introduced in InCore 2.5. :**› Type**: List :**› Signal**: availableNetworksChanged() :**› Attributes**: Writable .. _property_WirelessNetworkInterface_countryCode: .. _signal_WirelessNetworkInterface_countryCodeChanged: .. index:: single: countryCode countryCode +++++++++++ This property holds a country code used to set the wireless regulatory domain. This controls which channels, bandwidths and transmission powers are used to comply with the respective national laws. Per default the `world` domain with limited channels and transmission power is used. See `ISO 3166-1 alpha-2 `_ for details and a code list table. :**› Type**: String :**› Signal**: countryCodeChanged() :**› Attributes**: Writable .. _property_WirelessNetworkInterface_countryCodeItem: .. index:: single: countryCodeItem countryCodeItem +++++++++++++++ This property holds an internal :ref:`ConfigurationItem ` instance for the :ref:`countryCode ` property. :**› Type**: :ref:`ConfigurationItem ` :**› Attributes**: Readonly .. _property_WirelessNetworkInterface_index: .. _signal_WirelessNetworkInterface_indexChanged: .. index:: single: index index +++++ This property holds the index of the wireless network interface which to represent and configure through this object instance. :**› Type**: :ref:`Index ` :**› Default**: :ref:`WirelessNetworkInterface.WirelessNone ` :**› Signal**: indexChanged() :**› Attributes**: Writable .. _property_WirelessNetworkInterface_indexItem: .. index:: single: indexItem indexItem +++++++++ This property holds an internal :ref:`ConfigurationItem ` instance for the :ref:`index ` property. :**› Type**: :ref:`ConfigurationItem ` :**› Attributes**: Readonly .. _property_WirelessNetworkInterface_passphrase: .. _signal_WirelessNetworkInterface_passphraseChanged: .. index:: single: passphrase passphrase ++++++++++ This property holds the passphrase (pre-shared key) to use for connecting to the wireless network. The minimum length for WPA/WPA2 passphrases is 8 characters. When setting an invalid passphrase the :ref:`NetworkInterface.InvalidConfigurationError ` error will be raised. :**› Type**: String :**› Signal**: passphraseChanged() :**› Attributes**: Writable .. _property_WirelessNetworkInterface_passphraseItem: .. index:: single: passphraseItem passphraseItem ++++++++++++++ This property holds an internal :ref:`ConfigurationItem ` instance for the :ref:`passphrase ` property. :**› Type**: :ref:`ConfigurationItem ` :**› Attributes**: Readonly .. _property_WirelessNetworkInterface_ssid: .. _signal_WirelessNetworkInterface_ssidChanged: .. index:: single: ssid ssid ++++ This property holds the SSID, i.e. the wireless network name, which to connect to. The maximum length is 31 characters. When setting an invalid SSID the :ref:`NetworkInterface.InvalidConfigurationError ` error will be raised. :**› Type**: String :**› Signal**: ssidChanged() :**› Attributes**: Writable .. _property_WirelessNetworkInterface_ssidItem: .. index:: single: ssidItem ssidItem ++++++++ This property holds an internal :ref:`ConfigurationItem ` instance for the :ref:`ssid ` property. :**› Type**: :ref:`ConfigurationItem ` :**› Attributes**: Readonly Methods ******* .. _method_WirelessNetworkInterface_scanAvailableNetworks: .. index:: single: scanAvailableNetworks scanAvailableNetworks() +++++++++++++++++++++++ This method tells the wireless network interface to scan all available networks. When finished, the :ref:`availableNetworks ` property is updated. This method was introduced in InCore 2.5. Enumerations ************ .. _enum_WirelessNetworkInterface_Index: .. index:: single: Index Index +++++ This enumeration describes indexes for all supported wireless network interfaces. .. index:: single: WirelessNetworkInterface.WirelessNone .. index:: single: WirelessNetworkInterface.Wireless1 .. index:: single: WirelessNetworkInterface.Wireless2 .. list-table:: :widths: auto :header-rows: 1 * - Name - Value - Description .. _enumitem_WirelessNetworkInterface_WirelessNone: * - ``WirelessNetworkInterface.WirelessNone`` - ``0`` - The object does not represent a valid wireless network interface. .. _enumitem_WirelessNetworkInterface_Wireless1: * - ``WirelessNetworkInterface.Wireless1`` - ``1`` - The object represents the first wireless network interface. .. _enumitem_WirelessNetworkInterface_Wireless2: * - ``WirelessNetworkInterface.Wireless2`` - ``2`` - The object represents the second wireless network interface. .. _example_WirelessNetworkInterface: Example ******* .. code-block:: qml import InCore.Foundation 2.5 Application { NetworkConfiguration { WirelessNetworkInterface { index: WirelessNetworkInterface.Wireless1 ssid: "inhub" passphrase: "MyS3cr3tP4ssw0rd" countryCode: "DE" onAvailableNetworksChanged: console.log(JSON.stringify(availableNetworks)) } } }