com.webos.service.wifi

API Summary

Manages Wi-Fi connections on a webOS device. It provides an interface to find available Wi-Fi networks and handle connecting and disconnecting the device from those networks.

Overview of the API

(click to expand)

About com.webos.service.wifi API:

This API provides the ability to manage varoius aspects of Wi-Fi connectivity like scanning the Wi-Fi networks, connecting to a network (open/secured/hidden) and managing Wi-Fi profiles.

About webos-connman-adapter daemon:

The webos-connman-adapter is a daemon which acts as the interface between connman (a daemon for managing internet connections) and rest of the webOS world. The webos-connman-adapter communicates to connman via dbus but provides the LS2 interface to all the webOS apps and services to enable them to get all the network related information and manage the connections.

Additional remarks:

Most of the methods under this API require that the connman be running and be able to communicate with the webos-connman-adapter else these methods will return an error.


Open All


changeNetwork

Description

This method allows users to change the properties of already stored Wi-Fi profiles.For non-enterprise networks, only the passphrase can be changed for now. In future when the support to enterprise networks will be added, this API will be extend to change the other properties as well.

Parameters

Name

Required

Type

Description

profileIdRequiredNumber

ID of the profile that needs to be changed.

passKeyRequiredString

The new passkey to be used for the profile.

Call Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
errorCodeOptionalNumber

The error code for the failed operation.

errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Error References

Error Code

Error Text

Error Description

1Unknown error

Some unknown error in changing the passkey.

4Connman service unavailable

Error when webos-connman-adapter is not able to talk to the connman daemon.

5WiFi technology unavailable

Error when the Wi-Fi technology is not available

This could happen either because the wpa-supplicant daemon is not running, connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

105Profile not found

Profile with the given profileId was not found.

Example

# luna-send -n 1 -f luna://com.webos.service.wifi/changeNetwork '{"profileId": 777, "passKey": "4321" }'

{

       "returnValue": true

}


connect

Description

This method is used to connect to a given SSID, which can be an open network requiring no passphrase (i.e no security field in its argument), hidden network(requiring wasCreatedWithJoinOther field set to true in its argument), secure networks (authenticating with the specified passphrase), or enterprise networks(currently supported EAP methods are: PEAP, TLS and TTLS).

​Upon successful connection, the Wi-Fi profile is saved on the system along with its SSID and security details. On the other hand if the connection is unsuccessful but the parameter storeProfile is set to true then the Wi-Fi profile is still saved on the system along with the connman .config file, which enables connman to connect to this network once it is available. To connect to an already known network i.e a saved profile, the profileId parameter should be set. 

 

Parameters

Name

Required

Type

Description

ssidOptionalstring

SSID of the desired network. Required for all connections except when using a known profile (profileId parameter is set).

wasCreatedWithJoinOtherOptionalboolean

To connect to a hidden network, set wasCreatedWithJoinOther to true.

To connect to a non-hidden network, set wasCreatedWithJoinOther to false.

The default value of wasCreatedWithJoinOther is false.

storeProfileOptionalBoolean

To store a profile for the network when it is not available(i.e out of range), set storeProfile to true.

To ignore a profile for the network when it is not available(i.e out of range), set storeProfile to false.

The default value of storeProfile is true.

securityOptionalObject: security

Set to connect to a secured network.

profileIdOptionalnumber

ID of the desired profile, which can be obtained from the getprofilelist call. Required to connect with a known profile.

Call Returns

Name

Required

Type

Description

returnValueRequiredboolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
errorCodeOptionalNumber

The error code for the failed operation.

errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Error References

Error Code

Error Text

Error Description

1Unknown error

Connect failed due to unknown reasons.

3Invalid Parameters

Error when neither the parameter SSID nor profileId was specified in the connect method call.

4Connman service unavailable

Error when webos-connman-adapter is not able to commmunicate to the connman daemon.

5WiFi technology unavailable

Error when the Wi-Fi technology is not available.

This could happen either because the wpa-supplicant daemon is not running, connman is not able to communicate with wpa-supplicant or the device doesn't have Wi-Fi support.

7WiFi switched off

Error when Wi-Fi interface is down.

10The supplied password is incorrect

An invalid key/passphrase was provided.

11Authentication with access point failed

The authentication with the access point failed.

12Login failed

The login failed.

13Could not establish a connection to access point

The association attempt with the selected access point failed.

14Could not retrieve a valid IP address by using DHCP

The DHCP process failed to gather a valid IP address from the access point.

15PIN is missing

There was no pin provided for the WPS pin connection mode.

16Out of range

The selected access point is out of range and no association could be made.

Example

# luna-send -n 1 -f luna://com.webos.service.wifi/connect '{"ssid": "XXX", "security": {"securityType": "psk", "simpleSecurity": {"passKey": "1234"} } }'

{

       "returnValue": true

}


deleteprofile

Description

This method is used to delete the profile with the given profile ID.

Parameters

Name

Required

Type

Description

profileIdRequiredstring

ID of the profile to be deleted.

Call Returns

Name

Required

Type

Description

returnValueRequiredboolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
errorCodeOptionalNumber

The error code for the failed operation.

errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Error References

Error Code

Error Text

Error Description

4Connman service unavailable

Error when webos-connman-adapter is not able to communicate with the connman daemon.

5WiFi technology unavailable

Error when the Wi-Fi technology is not available.

This could happen either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

105Profile not found

Profile with the given profileId was not found.

Example

# luna-send -n 1 -f luna://com.webos.service.wifi/deleteprofile '{"profileId": 777}'

{

       "returnValue": true

}


findnetworks

Description

The findnetworks method lists all the available Wi-Fi access points found in the area (from a previous Wi-Fi scan) and list their details like SSID Name, available Security Types, Signal Strength and Connection Status. Callers can subscribe to this method to be notified of any changes.

As long as there are subscribers to this method, periodic scans will be triggered.

Parameters

Name

Required

Type

Description

subscribeOptionalBoolean

Subscribe for notifications of change in the list of found networks. Possible values are:

  • true - Get notifications
  • false - Notifications are not required

Default value: false

intervalOptionalNumber

Interval in milliseconds which is used to trigger a scan for new networks.

Only the first subscriber is allowed to specify an interval. If any other subscriber provides an interval and error is returned.

The default interval is 15000 miliseconds (15 seconds).

Call Returns

Name

Required

Type

Description

foundNetworksRequiredObject: networkInfo

List of found networks.

subscribedRequiredBoolean

Indicates if subscribed to get notified.

  • true - Subscribed for changes
  • false - Not subscribed
returnValueRequiredBoolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
errorCodeOptionalNumber

The error code for the failed operation.

errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Subscription Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
foundNetworksRequiredObject: networkInfo

List of found networks.

subscribedRequiredBoolean

If the subscription was set for this method, subscribed will contain true.

If the subscription was not set for this method, subscribed will contain false.

Error References

Error Code

Error Text

Error Description

1Unknown error

An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

4Connman service unavailable

Error when webos-connman-adapter is not able to talk to the connman daemon.

5WiFi technology unavailable

Error when the Wi-Fi technology is not available.

This error can occur either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

7WiFi switched off

Error when Wi-Fi interface is down.

108Error in scanning network

Error occurred when trying to scan Wi-Fi interface for networks around.

161Not allowed to specify a scan interval

The client isn't allowed to specifiy a scan interval.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/findnetworks '{"interval": 15000}'

{

"foundNetworks": [

{

"networkInfo": {

"available": true,

"signalLevel": 70,

"signalBars": 3,

"displayName": "XXX",

"supported": true,

"ssid": "xxx",

"availableSecurityTypes": [

"psk",

"wps"

]

}

},

{

"networkInfo": {

"available": true,

"signalLevel": 49,

"signalBars": 1,

"displayName": "XXX2",

"supported": true,

"ssid": "xxx",

"availableSecurityTypes": [

"psk",

"wps"

]

}

}

],

"subscribed": false,

"returnValue": true

}


getNetworks

Description

This method will return a list of available, configured but not available(out of range) networks without triggering an active scan. The users can subscribe to this method to be notified when there is a change in the list of networks found.

Parameters

Name

Required

Type

Description

subscribeOptionalBoolean

Subscribe for notifications of change in the list of found networks. Possible values are:

  • true - Get notifications
  • false - Notifications are not required

Default value: false

Call Returns

Name

Required

Type

Description

foundNetworksRequiredObject array: networkInfo

List of networks found.

returnValueRequiredBoolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
errorCodeOptionalNumber

The error code for the failed operation

errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

subscribedRequiredBoolean

If the subscription was set for this method, subscribed will contain true.

If the subscription was not set for this method, subscribed will contain false.

Subscription Returns

Name

Required

Type

Description

returnValueRequiredBoolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
foundNetworksOptionalObject: networkInfo

List of available and not available networks.

subscribedRequiredBoolean

Indicates if subscribed.

  • true - Subscribed for changes
  • false - Not subscribed

Error References

Error Code

Error Text

Error Description

1Unknown error

An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

4Connman service unavailable

Error when webos-connman-adapter is not able to communicate with the connman daemon.

5WiFi technology unavailable

Error when the Wi-Fi technology is not available.

This error can occur either because the wpa-supplicant daemon is not running, connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

7WiFi switched off

Error when Wi-Fi interface is down.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/getNetworks '{}'

{

"foundNetworks": [

{

"networkInfo": {

"available": true,

"signalLevel": 70,

"signalBars": 3,

"displayName": "xxx",

"supported": true,

"ssid": "xxx",

"availableSecurityTypes": [

"psk",

"wps"

]

}

},

{

"networkInfo": {

"available": true,

"signalLevel": 49,

"signalBars": 1,

"displayName": "xxx",

"supported": true,

"ssid": "xxx",

"availableSecurityTypes": [

"psk",

"wps"

]

}

}

],

"subscribed": false,

"returnValue": true

}


getprofile

Description

This method is used to list the profile with the given profile ID on the system.

Parameters

Name

Required

Type

Description

profileIdRequiredstring

ID of the profile to be listed.

Call Returns

Name

Required

Type

Description

wifiProfileRequiredObject: wifiProfile

Profile corresponding to the given ID.

returnValueRequiredboolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
errorCodeOptionalNumber

The error code for the failed operation.

errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Error References

Error Code

Error Text

Error Description

1Unknown error

An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

4Connman service unavailable

Error when webos-connman-adapter is not able to communicate with the connman daemon.

5WiFi technology unavailable

Error when the Wi-Fi technology is not available.

This could happen either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

105Profile not found

A profile with the given profileId was not found.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/getprofile '{"profileId": 777}'

{

"returnValue": true,

"wifiProfile": {

"profileId": 777,

"ssid": "XXX",

"security": {

"securityType": [

"psk",

"wps"

]

}

}

}


getprofilelist

Description

This method lists all the stored Wi-Fi profiles on the system.

Parameters

None

Call Returns

Name

Required

Type

Description

profileListRequiredObject: wifiProfile

List of stored profiles.

returnValueRequiredboolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
errorCodeOptionalNumber

The error code for the failed operation.

errorTextOptionalString

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Error References

Error Code

Error Text

Error Description

1Unknown error

An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

4Connman service unavailable

Error when webos-connman-adapter is not able to communicate with the connman daemon.

5WiFi technology unavailable

Error when the Wi-Fi technology is not available.

This could happen either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

 

105Profile not found

There are no stored Wi-Fi profiles on the system.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/getprofilelist '{}'

{

"profileList": [

{

"wifiProfile": {

"profileId": 777,

"ssid": "xxx",

"security": {

"securityType": [

"psk",

"wps"

]

}

}

}

],

"returnValue": true

}


getstatus

Description

The getstatus method returns: 

  • The current status of Wi-Fi connection on the system.
  • If the system is connected to an access point, then the details of the access point.
  • If the service is online, then the IP related infomation like address, gateway, DNS etc.

Callers can subscribe to this method to be notified of any changes in the Wi-Fi connection status. In case there is no subscription, then it will just return the current status once.

 

Parameters

Name

Required

Type

Description

subscribe Optional Boolean

Subscribe for notifications when Wi-Fi connection status changes. Possible values are:

  • true - Get notifications
  • false - Notifications are not required

Default value: false

Call Returns

Name

Required

Type

Description

status Required String

If wifi is enabled, status will contain "serviceEnabled".

If wifi is disabled, status will contain "serviceDisabled".

networkInfo Optional Object: networkInfo

Provides information on the current Wi-Fi network. Appllicable only if the Wi-Fi is connected.

subscribed Required Boolean

If the subscription was set for this method, subscribed will contain true.

If the subscription was not set for this method, subscribed will contain false.

returnValue Required Boolean

Indicates the status of operation. Possible values are:

  • true - Indicates that the operation was successful.
  • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
errorCode Optional Number

The error code for the failed operation.

errorText Optional String

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

Subscription Returns

Name

Required

Type

Description

returnValue Required String

Always true in case of subscription response.

status Required String

If wifi is enabled, status will contain "serviceEnabled".

If wifi is disabled, status will contain "serviceDisabled".

networkInfo Optional Object: networkInfo

Provides information on the current Wi-Fi network. Appllicable only if the Wi-Fi is connected.

subscribed Required Boolean

Indicates if subscribed to get notified.

  • true - Subscribed for changes
  • false - Not subscribed

Error References

Error Code

Error Text

Error Description

1 Unknown error

An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

4 Connman service unavailable

Error when webos-connman-adapter is not able to communicate with the connman daemon.

5 WiFi technology unavailable

Error when the Wi-Fi technology is not available.

This could happen either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/getstatus {}

{

"subscribed": false,

"status": "serviceEnabled",

"returnValue": true

}


scan

Description

The scan method is used to trigger a manual scan for the Wi-Fi networks. It should not be used together with the findnetworks method as using both at the same time will result in errors. This method will trigger a scan and return immediately. Results of the scan are posted to the subscribers of findnetworks and getNetworks.

Parameters

None

Call Returns

Name

Required

Type

Description

returnValueRequiredBoolean
  • If the method succeeds, returnValue will contain true.
  • If the method fails, returnValue will contain false. 

The method may fail because of one the error conditions described in the Error Codes Reference table of this method. See the Error Code Reference table for more information.

errorTextOptionalString

errorText contains the error text if the method fails. The method will return errorText only if it fails.

See the Error Codes Reference of this method for more details.

errorCodeOptionalNumber

errorCode contains the error code if the method fails. The method will return errorCode only if it fails.

See the Error Codes Reference of this method for more details.

Error References

Error Code

Error Text

Error Description

1Unknown error

An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

4Connman service unavailable

Error when webos-connman-adapter is not able to communicate with the connman daemon.

5WiFi technology unavailable

Error when the Wi-Fi technology is not available.

This error can occur because the wpa-supplicant daemon is not running, connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

7WiFi switched off

Error when Wi-Fi interface is down.

108Error in scanning network

Error occurred when trying to scan the Wi-Fi interface for networks.

160Already actively scanning for networks

This error is returned when the scan method is called while clients are subscribed to the findnetworks method.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/scan '{}'

{

    "returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/scan '{}'

{

"errorCode": 5,

"returnValue": false,

"errorText": "WiFi technology unavailable"

}


setstate

Description

The setstate method will simply enable or disable W-iFi on the system by enabling/disabling the Wi-Fi interface.

 

Parameters

Name

Required

Type

Description

stateRequiredString

Set it to "enabled" to enable Wi-Fi.

Set it to "disabled" to disable Wi-Fi.

Any other value will result in an error.

Call Returns

Name

Required

Type

Description

returnValueRequiredBoolean
  • If the method succeeds, returnValue will contain true.
  • If the method fails, returnValue will contain false. 

The method may fail because of one the error conditions described in the Error Codes Reference table of this method. See the Error Code Reference table for more information. 

errorCodeOptionalNumber

errorCode contains the error code if the method fails. The method will return errorCode only if it fails.

See the Error Codes Reference of this method for more details.

errorTextOptionalString

errorText contains the error text if the method fails. The method will return errorText only if it fails.

See the Error Codes Reference of this method for more details.

Error References

Error Code

Error Text

Error Description

4Connman service unavailable

Error when webos-connman-adapter is not able to communicate with the connman daemon.

5WiFi technology unavailable

Error when the Wi-Fi technology is not available.

This could occur either because the wpa-supplicant daemon is not running, connman is not able to communicate with the wpa-supplicant or the device does not have Wi-Fi support.

103Already enabled

Error message when setting the state to enabled if the Wi-Fi is already enabled.

104Already disabled

Error message when setting the state to disabled if the Wi-Fi is already disabled.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/setstate '{"state": "disabled"}'

{

"returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/setstate '{"state": "disabled"}'

{

"errorCode": 5,

"returnValue": false,

"errorText": "WiFi technology unavailable"

}


Objects

wifiProfile

A Wi-Fi profile stores all information for a previously successfully connected wireless network. However, it does not store critical security things like the passphrase.

Example:

"wifiProfile": {
   "profileId": 777,
   "ssid": "xxx",
   "security": { "securityType": [ "psk", "wps" ]
   }
}

Name

Required

Type

Description

ssid Required String

SSID associated with the profile.

profileId Required String

ID string naming the profile (can be used with connect method).

security Required Object: securityType Security type which was used to connect to the network the last time.

security

This object is used to provide security information for establishing a connection.

Example:

"security": {
   "securityType": "psk",
   "simpleSecurity": {"passKey": "1234"}
}

Name

Required

Type

Description

securityType Required String

Connection type. e.g. wep or psk.

simpleSecurity Optional Object: simpleSecurity Security options when using simple security type.
enterpriseSecurity Optional Object: enterpriseSecurity

Different fields to connect to enterprise networks.

networkInfo

Information of each of the networks found by the findNetworks, getNetworks or getstatus method.

Example:

"networkInfo": {
   "available": true,
   "signalLevel": 49,
   "signalBars": 1,
   "displayName": "xxx",
   "supported": true,
   "ssid": "xxx",
   "availableSecurityTypes": [ "psk", "wps" ],
   "connectState": "ipConfigured",
   "bssInfo":[
     { "frequency": 2462,
       "bssid": "EE:94:F6:33:5F:F7",
        "signal": -65 }
  ]
}

Name

Required

Type

Description

ssid Required String

SSID of discovered AP.

availableSecurityTypes Required String array

List of supported security mechanisms.

signalBars Required Number

Coarse indication of signal strength.

available Required Boolean

Indicates if the network is currently available or not.

signalLevel Required Number

Fine indication of signal strength.

ipInfo Optional Object: ipInfo

Only returned for getstatus method.

bssInfo Optional Object array: bssInfo

Radio information on stations associated with this network. Only returned for getNetworks and findNetworks methods, only for in-range wifi networks.

displayName Required String

Displayable name of the network.

The value of this field should be always used to the display the name of the network in the UI. The field ssid should never be used. It is only there to identify the network object and as an argument for several other methods like connect.

In most cases the content is the same as for the ssid field. The content will be different when the SSID the access point sends out is not encoded in UTF-8. In this case the service tries several conversion options to convert the SSID to UTF-8 and the result is the value in this field.

connectState Optional String

Current connection state of the service.

The following values are possible: 

"notAssociated", "associating", "associated", "ipConfigured", "ipFailed".

simpleSecurity

Connection information for a simple connection.

Example:

"simpleSecurity": {
   "passKey": "1234"
}

Name

Required

Type

Description

passKey Required String

Passkey for the network to be connected.

securityType

A list of array types.

Example:

"securityType": [ "open", "psk", "wps" ]

Name

Required

Type

Description

securityType Required String array

Types of security supported.

ipInfo

IP information for the connected network i.e. connected Wi-Fi interface returned as a response from the getstatus method.

Example:

"ipInfo": {
   "interface": "wifi0",
   "ip": "192.168.1.2",
   "subnet": "255.255.255.0",
   "gateway": "192.168.1.1",
   "dns": ["192.168.1.1"]
}

Name

Required

Type

Description

interface Required String

The Wi-Fi interface for the connected network.

ip Required String

IP address of the Wi-Fi interface.

subnet Required String

Subnet for the Wi-Fi interface.

gateway Required String

Gateway address for routing over Wi-Fi interface.

dns Required String array

List of DNS server IP addresses for the Wi-Fi interface.

enterpriseSecurity

Different security fields for connecting to enterprise networks.

Example:

"enterpriseSecurity": {
   "eapType": "tls",
   "identity": "work",
   "passphrase": "1234",
   "caCertFile": "/etc/cert/ca.pem",
   "clientCertFile": "/etc/cert/user.pem",
   "privateKeyFile": "/etc/cert/user.prv",
   "privateKeyPassphrase": "4321"
}

Name

Required

Type

Description

eapType Required String

The authentication method for this connection, which is supported by the AP. Currently supported methods are peap, ttls and tls.

identity Optional String

The name of the user to be authenticated.

passphrase Optional String

Passphrase for authenticating the user.

caCertFile Optional String

The location of server certificate file for authenticating the server.

clientCertFile Optional String

The location of client side X.509 certificate file to authenticate the client.

privateKeyFile Optional String

The location of the private key file to decrypt the client certificate.

privateKeyPassphrase Optional String

Passphrase used to encrypt the private key file.

phase2 Optional String

The inner authentication protocol for authenticating to user databases containing user information.

bssInfo

Information on one station in a Basic Service Set.

Example:

"bssInfo": {
 "frequency": 2462,
 "bssid": "EE:94:F6:33:5F:F7",
 "signal": -65 
}

Name

Required

Type

Description

bssid Required String

Mac address of the wireless station.

frequency Required Number

Station frequency in MHZ

signal Required Number

Station signal strength, DBm. Typical range -100 (weak) ... -10 (strong).


Except as noted, this content is licensed under Creative Commons Attribution 4.0 and sample code is licensed under Apache License 2.0.