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 <property_WirelessNetworkInterface_ssid>`/:ref:`passphrase <property_WirelessNetworkInterface_passphrase>`). Additionally the provided configuration items can be used to make the settings available to generic property-based frontends.
| › Inherits: | :ref:`NetworkInterface <object_NetworkInterface>` |
|---|
.. hlist:: :columns: 3 * :ref:`availableNetworks <property_WirelessNetworkInterface_availableNetworks>` * :ref:`countryCode <property_WirelessNetworkInterface_countryCode>` * :ref:`countryCodeItem <property_WirelessNetworkInterface_countryCodeItem>` * :ref:`index <property_WirelessNetworkInterface_index>` * :ref:`indexItem <property_WirelessNetworkInterface_indexItem>` * :ref:`passphrase <property_WirelessNetworkInterface_passphrase>` * :ref:`passphraseItem <property_WirelessNetworkInterface_passphraseItem>` * :ref:`ssid <property_WirelessNetworkInterface_ssid>` * :ref:`ssidItem <property_WirelessNetworkInterface_ssidItem>` * :ref:`NetworkInterface.bytesRx <property_NetworkInterface_bytesRx>` * :ref:`NetworkInterface.bytesTx <property_NetworkInterface_bytesTx>` * :ref:`NetworkInterface.dhcpClientIdentifier <property_NetworkInterface_dhcpClientIdentifier>` * :ref:`NetworkInterface.enabled <property_NetworkInterface_enabled>` * :ref:`NetworkInterface.enabledItem <property_NetworkInterface_enabledItem>` * :ref:`NetworkInterface.error <property_NetworkInterface_error>` * :ref:`NetworkInterface.errorString <property_NetworkInterface_errorString>` * :ref:`NetworkInterface.hardwareAddress <property_NetworkInterface_hardwareAddress>` * :ref:`NetworkInterface.hardwareAddressItem <property_NetworkInterface_hardwareAddressItem>` * :ref:`NetworkInterface.hardwareName <property_NetworkInterface_hardwareName>` * :ref:`NetworkInterface.networkAddresses <property_NetworkInterface_networkAddresses>` * :ref:`NetworkInterface.ntp <property_NetworkInterface_ntp>` * :ref:`NetworkInterface.ntpItem <property_NetworkInterface_ntpItem>` * :ref:`NetworkInterface.operationalState <property_NetworkInterface_operationalState>` * :ref:`NetworkInterface.routes <property_NetworkInterface_routes>` * :ref:`NetworkInterface.setupState <property_NetworkInterface_setupState>` * :ref:`NetworkInterface.trafficRx <property_NetworkInterface_trafficRx>` * :ref:`NetworkInterface.trafficTx <property_NetworkInterface_trafficTx>` * :ref:`NetworkInterface.useRoutes <property_NetworkInterface_useRoutes>` * :ref:`NetworkInterface.useRoutesItem <property_NetworkInterface_useRoutesItem>` * :ref:`ConfigurationObject.items <property_ConfigurationObject_items>` * :ref:`ConfigurationObject.name <property_ConfigurationObject_name>` * :ref:`ConfigurationObject.nameItem <property_ConfigurationObject_nameItem>` * :ref:`Object.objectId <property_Object_objectId>` * :ref:`Object.parent <property_Object_parent>`
.. hlist:: :columns: 2 * :ref:`scanAvailableNetworks() <method_WirelessNetworkInterface_scanAvailableNetworks>` * :ref:`NetworkInterface.pollBytesRx() <method_NetworkInterface_pollBytesRx>` * :ref:`NetworkInterface.pollBytesTx() <method_NetworkInterface_pollBytesTx>` * :ref:`NetworkInterface.pollTrafficRx() <method_NetworkInterface_pollTrafficRx>` * :ref:`NetworkInterface.pollTrafficTx() <method_NetworkInterface_pollTrafficTx>` * :ref:`ConfigurationObject.toDataMap() <method_ConfigurationObject_toDataMap>` * :ref:`Object.deserializeProperties() <method_Object_deserializeProperties>` * :ref:`Object.fromJson() <method_Object_fromJson>` * :ref:`Object.serializeProperties() <method_Object_serializeProperties>` * :ref:`Object.toJson() <method_Object_toJson>`
.. hlist:: :columns: 1 * :ref:`NetworkInterface.errorOccurred() <signal_NetworkInterface_errorOccurred>` * :ref:`NetworkInterface.routesDataChanged() <signal_NetworkInterface_routesDataChanged>` * :ref:`ConfigurationObject.aboutToBeUpdated() <signal_ConfigurationObject_aboutToBeUpdated>` * :ref:`ConfigurationObject.itemsDataChanged() <signal_ConfigurationObject_itemsDataChanged>` * :ref:`ConfigurationObject.updated() <signal_ConfigurationObject_updated>` * :ref:`Object.completed() <signal_Object_completed>`
.. hlist:: :columns: 1 * :ref:`Index <enum_WirelessNetworkInterface_Index>` * :ref:`NetworkInterface.DhcpClientIdentifier <enum_NetworkInterface_DhcpClientIdentifier>` * :ref:`NetworkInterface.Error <enum_NetworkInterface_Error>` * :ref:`NetworkInterface.OperationalState <enum_NetworkInterface_OperationalState>` * :ref:`NetworkInterface.SetupState <enum_NetworkInterface_SetupState>`
.. index:: single: 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() <method_WirelessNetworkInterface_scanAvailableNetworks>`.
This property was introduced in InCore 2.5.
| › Type: | List |
|---|---|
| › Signal: | availableNetworksChanged() |
| › Attributes: | Writable |
.. index:: single: 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 |
.. index:: single: countryCodeItem
This property holds an internal :ref:`ConfigurationItem <object_ConfigurationItem>` instance for the :ref:`countryCode <property_WirelessNetworkInterface_countryCode>` property.
| › Type: | :ref:`ConfigurationItem <object_ConfigurationItem>` |
|---|---|
| › Attributes: | Readonly |
.. index:: single: index
This property holds the index of the wireless network interface which to represent and configure through this object instance.
| › Type: | :ref:`Index <enum_WirelessNetworkInterface_Index>` |
|---|---|
| › Default: | :ref:`WirelessNetworkInterface.WirelessNone <enumitem_WirelessNetworkInterface_WirelessNone>` |
| › Signal: | indexChanged() |
| › Attributes: | Writable |
.. index:: single: indexItem
This property holds an internal :ref:`ConfigurationItem <object_ConfigurationItem>` instance for the :ref:`index <property_WirelessNetworkInterface_index>` property.
| › Type: | :ref:`ConfigurationItem <object_ConfigurationItem>` |
|---|---|
| › Attributes: | Readonly |
.. index:: single: 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 <enumitem_NetworkInterface_InvalidConfigurationError>` error will be raised.
| › Type: | String |
|---|---|
| › Signal: | passphraseChanged() |
| › Attributes: | Writable |
.. index:: single: passphraseItem
This property holds an internal :ref:`ConfigurationItem <object_ConfigurationItem>` instance for the :ref:`passphrase <property_WirelessNetworkInterface_passphrase>` property.
| › Type: | :ref:`ConfigurationItem <object_ConfigurationItem>` |
|---|---|
| › Attributes: | Readonly |
.. index:: single: 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 <enumitem_NetworkInterface_InvalidConfigurationError>` error will be raised.
| › Type: | String |
|---|---|
| › Signal: | ssidChanged() |
| › Attributes: | Writable |
.. index:: single: ssidItem
This property holds an internal :ref:`ConfigurationItem <object_ConfigurationItem>` instance for the :ref:`ssid <property_WirelessNetworkInterface_ssid>` property.
| › Type: | :ref:`ConfigurationItem <object_ConfigurationItem>` |
|---|---|
| › Attributes: | Readonly |
.. index:: single: scanAvailableNetworks
This method tells the wireless network interface to scan all available networks. When finished, the :ref:`availableNetworks <property_WirelessNetworkInterface_availableNetworks>` property is updated.
This method was introduced in InCore 2.5.
.. index:: single: Index
This enumeration describes indexes for all supported wireless network interfaces.
.. index:: single: WirelessNetworkInterface.WirelessNone
.. index:: single: WirelessNetworkInterface.Wireless1
.. index:: single: WirelessNetworkInterface.Wireless2
| Name | Value | Description |
|---|---|---|
WirelessNetworkInterface.WirelessNone |
0 |
The object does not represent a valid wireless network interface. |
WirelessNetworkInterface.Wireless1 |
1 |
The object represents the first wireless network interface. |
WirelessNetworkInterface.Wireless2 |
2 |
The object represents the second wireless network interface. |
import InCore.Foundation 2.5
Application {
NetworkConfiguration {
WirelessNetworkInterface {
index: WirelessNetworkInterface.Wireless1
ssid: "inhub"
passphrase: "MyS3cr3tP4ssw0rd"
countryCode: "DE"
onAvailableNetworksChanged: console.log(JSON.stringify(availableNetworks))
}
}
}