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

This service provides the ability to manage various 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.

Methods

changeNetwork

Description

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 the future when the support to enterprise networks will be added, this API will be extended 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 Codes Reference

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" }'

Response:


   "returnValue":true
}

connect

Description

Connects 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

Indicates whether to connect to a hidden network. Possible values are: 

  • true - Connect to a hidden network
  • false - Connect to a non-hidden network

Default value: false

storeProfileOptionalBoolean

Indicates whether to store a profile for the network when it is not available (i.e out of range). Possible values are:

  • true - Store a profile 
  • false - Ignore a profile 

Default value: 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 Codes Reference

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 communicate 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"
      }
   }
}'

Response:


   "returnValue":true
}

deleteprofile

Description

Deletes 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 Codes Reference

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}'

Response: 


   "returnValue":true
}

findnetworks

Description

Lists all the available Wi-Fi access points found in the area (from a previous Wi-Fi scan) and lists 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 milliseconds (15 seconds).

Call Returns

Name

Required

Type

Description

foundNetworksRequiredObject: networkInfo

List of found networks.

subscribedRequiredBoolean

Indicates if subscribed to get notifications. Possible values are:

  • 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

Indicates if subscribed to get notifications. Possible values are:

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

Error Codes Reference

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 specify a scan interval.

Example

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

Response: 


   "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

Returns 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

Indicates if subscribed to get notifications. Possible values are:

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

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 to get notifications. Possible values are:

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

Error Codes Reference

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

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

Response:


   "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

Lists 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 Codes Reference

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

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

Response: 


   "returnValue":true,
   "wifiProfile":{ 
      "profileId":777,
      "ssid":"XXX",
      "security":{ 
         "securityType":[ 
            "psk",
            "wps"
         ]
      }
   }
}

getprofilelist

Description

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 Codes Reference

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

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

Response:


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

getstatus

Description

Returns the following: 

  • 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 information 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

subscribeOptionalBoolean

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

statusRequiredString

Indicates the status of the Wi-Fi. Possible values are:

  • serviceEnabled - Wi-Fi is enabled
  • serviceDisabled - Wi-Fi is disabled
  • connectionStateChanged - Wi-Fi connection is established
networkInfoOptionalObject: networkInfo

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

subscribedRequiredBoolean

Indicates if subscribed to get notifications. Possible values are:

  • 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

returnValueRequiredString

Always true in case of subscription response.

statusRequiredString

Indicates the status of the Wi-Fi. Possible values are:

  • serviceEnabled - Wi-Fi is enabled
  • serviceDisabled - Wi-Fi is disabled
  • connectionStateChanged - Wi-Fi connection is established
networkInfoOptionalObject: networkInfo

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

subscribedRequiredBoolean

Indicates if subscribed to get notifications. Possible values are:

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

Error Codes Reference

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.

Example

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

Response:


   "subscribed":false,
   "status":"serviceEnabled",
   "returnValue":true
}

p2p/addservice

Description

This method is used to add a Wi-Fi Direct service.

Parameters

Name

Required

Type

Description

typeRequiredstring

Service type.Valid service types are upnp or bonjour.

descriptionOptionalstring

Description. Required for upnp service type.

queryOptionalstring

Bonjour query. Required for bonjour service type.

responseOptionalstring

Bonjour response. Required for bonjour service type.

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 Codes Reference

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

131Error in addservice

Error in the actual call for adding a service.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/addservice '{"type": "upnp", "description": "printer" }'

{

       "returnValue": true,

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/addservice '{"type": "upnp", "description": "printer" }'

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/cancel

Description

This method  is used to cancel any ongoing Wi-Fi direct connection attempts. If there is no ongoing connection attempt then this method does nothing.

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. 

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 Codes Reference

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

133Error in cancelling P2P connection

Error in cancelling the current ongoing Wi-Fi direct connection.

Example

Example response for a successful call:

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

{

       "returnValue": true

}

 

Example response for a failed call:

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

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/connect

Description

This method is used to connect to a given Wi-Fi direct peer.

Parameters

Name

Required

Type

Description

peerAddressRequiredstring

Device address of the peer to connect.

wpsInfoRequiredObject: wpsInfo

WPS information for peer connection.

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 Codes Reference

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.

111Peer not found

The peer we are trying to connect to is not present in the list of scanned peers.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

117Peer still in association state

We might have tried to connect to this peer in the past, and that's why its still in association state. We should wait for some more time before trying to connect again.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/connect '{"peerAddress": "02:fc:ef:a0:d0:4a","wpsInfo":{"wps":true}}'

{

       "returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/connect '{"peerAddress": "02:fc:ef:a0:d0:4a","wpsInfo":{"wps":true}}'

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/creategroup

Description

This method is used to create an autonomous Wi-Fi direct group.

Parameters

Name

Required

Type

Description

ssidRequiredstringSSID of group to create.
passPhraseRequiredstring

Passphrase for connecting to this group. A valid passphrase should have 8 to 63 characters.

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 Codes Reference

Error Code

Error Text

Error Description

1Unknown error

Some error in creating the new group.

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/creategroup '{"ssid": "group1", "passPhrase": "1234" }'

{

       "returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/creategroup '{"ssid": "group1", "passPhrase": "1234" }'

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/deleteprofile

Description

This method is used to delete a persistent profile for a specific MAC address or all profiles and also disconnect the peer(s) if connected.

Parameters

Name

Required

Type

Description

deviceAddressRequiredstringDevice address or 'all' to delete all existing profiles.

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 Codes Reference

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

119Error in disconnecting group

In case all profiles need to be deleted, we need to disconnect the whole group. This error indicates an error in disconnecting the group.

134Error in deleting profile

Error in deleting the single profile for the deviceAddress specified in this method call.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/deleteprofile '{"deviceAddress": "all" }'

{

       "returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/deleteprofile '{"deviceAddress": "all" }'

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/deleteservice

Description

This method is used to delete a Wi-Fi Direct service.

Parameters

Name

Required

Type

Description

typeRequiredstring

Service type. Valid service types are upnp or bonjour.

descriptionOptionalstring

Description. Required for upnp service type.

queryOptionalstring

Bonjour query. Required for bonjour service type.

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 Codes Reference

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

132Error in deleteservice

Error in the actual call for deleting the service.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/deleteservice '{"type": "upnp", "description": "printer" }'

{

       "returnValue": true,

}

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/deleteservice '{"type": "upnp", "description": "printer" }'

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/disconnect

Description

This method is used to disconnect the given Wi-Fi direct peer.

Parameters

Name

Required

Type

Description

peerAddressRequiredstring

Device address of the peer to disconnect.

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 Codes Reference

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.

111Peer not found

The peer we are trying to disconnect is not present in the list of scanned peers.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

118Not connected

We are not connected to the peer we are trying to disconnect.

119Error in disconnecting group

Error in disconnecting the group the connected peers are part of.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/disconnect '{"peerAddress": "02:fc:ef:a0:d0:4a"}'

{

"returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/disconnect '{"peerAddress": "02:fc:ef:a0:d0:4a"}'

{

"errorCode": 5,

"returnValue": false,

"errorText": "WiFi technology unavailable"

}

p2p/disconnectgroup

Description

 This method is used to disconnect a P2P group.

Parameters

Name

Required

Type

Description

ssidRequiredstringName of the group to disconnect.

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 Codes Reference

Error Code

Error Text

Error Description

1Unknown error

Error in disconnecting the group.

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

121Group not found

The group with the given ssid was not found.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/disconnectgroup '{"ssid": "group1"}'

{

       "returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/disconnectgroup '{"ssid": "group1"}'

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/findservice

Description

This method is used to find all the Wi-Fi Direct services or a specific service based on a service type. Peer-to-peer must be enabled for this method to work. Once this method is executed the response will be sent to the subscribers of the getpeers method.

Parameters

Name

Required

Type

Description

typeRequiredstring

Service type. Valid service types are upnp or bonjour.

addressOptionalstring

A peer to search. If omitted then search for all peers.

versionOptionalnumber

Version number. Required for upnp service type.

descriptionOptionalstring

Description. Required for upnp service type.

queryOptionalstring

Bonjour query. Required for bonjour service type.

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 Codes Reference

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

130Error in findservice

Error in the actual call for finding services.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/findservice '{"type": "upnp", "description": "", "version": 10 }'

{

       "returnValue": true

}

 

Or

 

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/findservice '{"type": "bonjour", "query": "" }'

{

       "returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/findservice '{"type": "upnp", "description": "", "version": 10 }'

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/getdevicename

Description

This method is used to get the device name used for Wi-Fi direct communication, which appears as the peer name for this device on the other neighbouring Wi-Fi direct devices.

Parameters

None

Call Returns

Name

Required

Type

Description

deviceNameRequiredstringThe P2P device name.
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 Codes Reference

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.

122Device name not set

There is no name set for this peer, should call the setdevicename method to set the name.

Example

Example response for a successful call:

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

{

       "returnValue": true,

       "deviceName": "[LG] webOS TV WEBOS1"

}

 

Example response for a failed call:

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

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/getgrouppeers

Description

This method is used to get the list of peers for an existing Wi-Fi direct group.

Parameters

Name

Required

Type

Description

ssidRequiredstringName of the group.

Call Returns

Name

Required

Type

Description

peersRequiredObject: WifiPeerInfo

An array of Wi-Fi Peer Info objects. If there are no peers found then this array will be empty.

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 Codes Reference

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

121Group not found

Group with the given ssid was not found.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/getgrouppeers '{"ssid": "DIRECT-vG-[LG] webOS TV WEBOS1"}'

{

"peers": [

{

"peerInfo": {

"connected": true,

"configMethod": 128,

"deviceAddress": "02:fc:ef:a0:d0:4a",

"peerIp": "192.168.16.2",

"deviceName": "Test Test's G3",

"groupOwner": false,

"wfdInfo": {

"wfdSessionAvail": true,

"wfdCpSupport": true,

"wfdDeviceType": "source",

"wfdRtspPort": 8554

},

"signalLevel": 76

}

}

],

"returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/getgrouppeers '{"ssid": "DIRECT-vG-[LG] webOS TV WEBOS1

{

"errorCode": 5,

"returnValue": false,

"errorText": "WiFi technology unavailable"

}

p2p/getgroups

Description

This method is used to get information about all Wi-Fi Direct groups. Callers can subscribe to this method to be notified of any changes in the list of groups.

Parameters

Name

Required

Type

Description

subscribeOptionalboolean

To be notified if a group is added, set subscribe to true.

To be notified if a group is deleted, set subscribe to false.

The default value of subscribe is false.

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. 

groupsRequiredObject: WifiGroupInfo

Array of objects containing information on Wi-Fi Direct groups.

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.

Subscription Returns

Name

Required

Type

Description

returnValueRequiredbooleanAlways true.
groupsRequiredObject: WifiGroupInfo

Array of objects containing information on Wi-Fi Direct groups.

Error Codes Reference

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

Example

Example response for a successful call:

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

{

"subscribed": false,

"returnValue": true,

"groups": [

{

"groupInfo": {

"owner": true,

"ssid": "DIRECT-vG-[LG] webOS TV WEBOS1",

"tethering": false,

"persistent": true

}

}

]

}

 

Example response for a failed call:

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

{

"errorCode": 5,

"returnValue": false,

"errorText": "WiFi technology unavailable"

}

p2p/getpeers

Description

This method is used to get information about the Wi-Fi Direct peers. Callers can subscribe to this method to be notified of changes in the list of neighboring peers.

Parameters

Name

Required

Type

Description

subscribeOptionalboolean

Subscribe and get notified of the changes in the list of peers found. Possible values are:

  • true - Subscribe for changes. 
  • false - Not subscribed. 

Default value: false

scanOptionalBoolean

Indicates if a new scan is to be triggered. Possible values are:

  • true - Runs an active scan. 
  • false - Avoids an active scan.

Default value: true

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.
subscribedRequiredboolean

Indicates if subscribed to get notifications. Possible values are:

  • true - Subscribed for changes.
  • false - Not subscribed.
peersRequiredObject: peerInfo

Array of objects containing information about the available peers.

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.

Note: The returnValue is always true.

peersRequiredObject: peerInfo

Array of objects containing information on Wi-Fi Direct peers.

Error Codes Reference

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

Example

Example response for a successful call:

# luna-send -i -f luna://com.webos.service.wifi/p2p/getpeers '{"subscribe":true}'

Returns:

{
    "subscribed": true,
    "peers": [
        {
            "peerInfo": {
                "connected": true,
                "configMethod": 4488,
                "deviceAddress": "02:90:4c:a7:86:cf",
                "peerIp": "192.168.49.10",
                "deviceName": "870s",
                "groupOwner": false,
                "deviceType": "phone",
                "signalLevel": 100
            }
        }
    ],
    "returnValue": true
}

p2p/getstate

Description

 This method is used to get the current state of Wi-Fi direct connection on this device.

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. 

P2PRequiredstring

If P2P is enabled then this value is enabled, otherwise it is disabled.

listenStateRequiredstring

If listening for incoming connections is enabled then this value is enabled , otherwise disabled.

persistentModeRequiredstring

If persistent state is enabled  then this value enabled" , "disabled" otherwise.

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 Codes Reference

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 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/p2p/getstate '{}'

{

"P2P": "enabled",

"listenState": "disabled",

"returnValue": true,

"persistentMode": "disabled"

}

 

Example response for a failed call:

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

{

"errorCode": 5,

"returnValue": false,

"errorText": "WiFi technology unavailable"

}

p2p/getp2prequests

Description

This method is used to subscribe the caller for notifications of the incoming Wi-Fi direct connection requests.

Parameters

Name

Required

Type

Description

subscribeRequiredboolean

Subscribe to be notified about any incoming Wi-Fi direct connections. Possible values are:

  • true - Subscribe for changes.
  • false - Not subscribed. 

Default value: false

Note: Setting subscribe to false will be a no-op , since nothing will be done by this method then.

Call Returns

Name

Required

Type

Description

subscribedRequiredboolean

Indicates if subscribed to get notifications. Possible values are:

  • 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.

deviceTypeOptionalString

Type of the remote device that initiates incoming p2p connection.

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.

Note: Always true in case of subscription response.

deviceAddressRequiredstringPeer address.
signalNameRequiredstringSignal name.
wpsTypeRequiredstring

Wi-Fi Protected setup type. Possible values are:

  • pbc
  • keypad
  • display
wpsPinOptionalstring

The PIN for Wi-Fi protected setup if the wpsType argument is display.

groupOwnerOptionalstringIndicates if the local endpoint is the owner of the group.
deviceNameRequiredString

Name of the remote device that initiates incoming p2p connection.

deviceTypeRequiredString

Type of the remote device that initiates incoming p2p connection.

Error Codes Reference

Error Code

Error Text

Error Description

129Subscription is mandatory

Error if the subscribe parameter is set to false.

Example

# luna-send -i -f luna://com.webos.service.wifi/p2p/getp2p/requests '{"subscribe":true}'

Returns:
{
    "subscribed": true,
    "returnValue": true
}

Subscription returns:
{
    "wpsType": "pbc",
    "signalName": "P2PGONegRequested",
    "subscribed": true,
    "deviceAddress": "be:f5:ac:e0:ec:31",
    "returnValue": true,
    "deviceName": "G2b",
    "deviceType": "phone"
}

p2p/getwifidisplayinfo

Description

This method is used to gets the Wi-Fi display parameters.

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. 

enabledRequiredboolean

true if Wi-Fi Display feature is enabled, false otherwise.

deviceTypeOptionalstring

Device type. One of the following: source, primary-sink, secondary-sink, or dual-role.

wfdSessionAvailableOptionalboolean

true if Wi-Fi Direct Session is enabled, false otherwise.

wfdRtspPortOptionalnumberSession management control port.
wfdCpSupportOptionalboolean

true if Content Protection using HDCP System 2.0/2.1 enabled, false otherwise.

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 Codes Reference

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.

Example

Example response for a successful call:

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

{

"wfdSessionAvail": true,

"wfdDeviceType": "primary-sink",

"wfdCpSupport": true,

"returnValue": true,

"wfdRtspPort": 7236,

"enabled": true

}

 

Example response for a failed call:

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

{

"errorCode": 5,

"returnValue": false,

"errorText": "WiFi technology unavailable"

}

p2p/invite

Description

This method is used to invite a Wi-Fi direct peer to the group to which this device belongs.

Parameters

Name

Required

Type

Description

peerAddressRequiredstringDevice address of the peer to invite.

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 Codes Reference

Error Code

Error Text

Error Description

1Unknown error

Some unknown error in inviting the remote peer.

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.

111Peer not found

The peer we are trying to connect to is not present in the list of scanned peers.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

120No active group found

We are not part of any group, so cannot invite another peer.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/invite '{"peerAddress": "5a:a2:b5:fa:18:b7" }'

{

       "returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/invite '{"peerAddress": "5a:a2:b5:fa:18:b7" }'

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/rejectpeer

Description

Reject a connection attempt from a peer (specified with a device address). This is a mechanism to reject a pending GO Negotiation with a peer and request to automatically block any further connection or discovery of the peer.

Parameters

Name

Required

Type

Description

peerAddressRequiredString

Device address of the peer to reject the connection attempt from.

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 Codes Reference

Error Code

Error Text

Error Description

4Connman service unavailable

webos-connman-adapter is unable to communicate with the connman daemon.

5WiFi technology unavailable

Error when the Wi-Fi technology is unavailable.

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

111Peer not found

The peer we are trying to reject the connection attempt from is not present in the list of scanned peers.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

171Error in rejecting peer

Fail to reject the connection request from peer.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/rejectpeer '{"peerAddress": "02:fc:ef:a0:d0:4a"}'

{

       "returnValue": true

}

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/rejectpeer '{"peerAddress": "02:fc:ef:a0:d0:4a"}'

{

       "errorCode": 114,

       "returnValue": false,

       "errorText": "P2P is not enabled"

}

p2p/setdevicename

Description

This method is used to set the device name for the Wi-Fi direct communication. This name appears as peer name for this device on other neighboring Wi-Fi direct devices.

Parameters

Name

Required

Type

Description

deviceNameRequiredstring

Device name to be used.

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 Codes Reference

Error Code

Error Text

Error Description

1Unknown error

Error in setting the device name.

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.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/setdevicename '{"deviceName": "TV1"}'

{

       "returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/setdevicename '{"deviceName": "TV1"}'

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/setlistenchannel

Description

Before any connection can be formed, P2P devices have to find each other. For this they alternately listen and send probe requestswith additional P2P information elements on so-called social channels, which are channels 1, 6 and 11 in the 2.4GHz band. This method can be used to set the desired channel, which by default is channel 11.

Parameters

Name

Required

Type

Description

listenChannelRequiredNumber

Set listen channel. (Default value is 11)

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 Codes Reference

Error Code

Error Text

Error Description

3Invalid Parameters

Error when the parameter listenChannel was not specified in the method call.

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

164Error in changing listen channel

Unable to set the new listen channel.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/setlistenchannel '{"listenChannel" : 6}'

{

       "returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/setlistenchannel '{"listenChannel" : 6}'

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/setlistenparams

Description

Control P2P extended listen parameters like period and interval, which determines the frequency at which the TV is listening for new connections and the time duration for each listen state.

Parameters

Name

Required

Type

Description

periodRequiredNumber

Set the listen state period in ms (Time for which the device will listen each time) Default value is 50 ms.

intervalRequiredNumber

Set the listen state interval in ms (Frequency at whcih the device will listen). Default value is 400 ms.

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 Codes Reference

Error Code

Error Text

Error Description

3Invalid Parameters

Either of the mandatory parameters period or interval was not specified.

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

135Error in setting listen parameters

Unable to set the listen parameters.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/setlistenparams '{"period" : 100, "interval": 500}'

{

       "returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/setlistenparams '{"period" : 100, "interval": 500}'

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/setstate

Description

This method is used to enable/disable the Wi-Fi Direct connection, as well as to set listen and persistent modes.

Parameters

Name

Required

Type

Description

P2POptionalstring

Set to enabled to enable the Wi-Fi direct connection and disabled to disable the Wi-Fi direct connection.

listenStateOptionalstring

Set the Wi-Fi direct listen state to either enabled or disabled.

Enabling listen state will make this device visible on other Wi-Fi direct devices so that it can initiate connection to them.

persistentModeOptionalstring

Set the P2P persistent mode to enabled or disabled.

Enabling persistent mode will save any group created on this device across reboots.

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 Codes Reference

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.

113Error in changing P2P state

Error in enabling/disabling Wi-Fi direct technology.

114P2P disabled, so cannot enable listen state

Error if trying to enable listen state, when Wi-Fi direct is not enabled.

114P2P disabled, so cannot enable persistent mode

Error if trying to enable persistent mode, when Wi-Fi direct is not enabled.

115Error in setting persistent mode

Error in enabling/disabling persistent mode on the device.

116Error in changing listen state

Error in enabling/disabling the listen mode on the device.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/setstate '{"P2P": "enabled", "listenState": "disabled", "persistentMode": "disabled"}'

{

"returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/setstate '{"P2P": "enabled", "listenState": "disabled", "persistentMode": "disabled"}'

{

"errorCode": 5,

"returnValue": false,

"errorText": "WiFi technology unavailable"

}

p2p/settethering

Description

This method is used to enable/disable a group's tethering property.

Parameters

Name

Required

Type

Description

ssidRequiredstring

SSID of the group.

tetheringRequiredboolean

To enable tethering , set tethering to true.

To disable tethering , set tethering to false.

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 Codes Reference

Error Code

Error Text

Error Description

1Unknown error

Error in enabling/disabling tethering.

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.

103Already enabled

Error in case trying to enable tethering, when it is already enabled.

104Already disabled

Error in case trying to disable tethering, when it is already disabled.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

121Group not found

The group with the given ssid was not found.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/settethering '{"ssid": "group1", "tethering": true }'

{

       "returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/settethering '{"deviceAddress": "all" }'

{

       "errorCode": 5,

       "returnValue": false,

       "errorText": "WiFi technology unavailable"

}

p2p/setwifidisplayinfo

Description

This method is used to set the Wi-Fi display parameters.

Parameters

Name

Required

Type

Description

enabledOptionalboolean

Set to true to enable the Wi-Fi Display feature and false to disable.

deviceTypeOptionalstring

Device type. Possible device types are : source, primary-sink, secondary-sink, or dual-role.

sessionAvailableOptionalboolean

Set to true to enable Wi-Fi Direct Session, false to disable.

rtspPortOptionalnumberSession management control port.
cpSupportOptionalboolean

Set to true to enable Content Protection using HDCP System 2.0/2.1 and false to disable.

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 Codes Reference

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.

114P2P is not enabled

Wi-Fi Direct is not enabled on the system.

123Error in changing WFD state

Error in enabling or disabling Wi-Fi display state.

124Invalid value for deviceType (should be one of source/primary-sink/secondary-sink/dual-role

The deviceType parameter should only have one of the following values :

source / primary-sink / secondary sink / dual-role.

125Error in changing WFD device type

Error in changing the device type for Wi-Fi display parameters.

126Error in changing WFD session available bit

Error in changing session available bit for Wi-Fi display parameters.

127Error in changing WFD cp support bit

Error in changing the CP support bit for Wi-Fi display parameters.

128Error in changing WFD rtsp port

Error in changing the RTSP port for Wi-Fi display parameters.

Example

Example response for a successful call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/setwifidisplayinfo '{"enabled": true, "deviceType": "primary-sink", "sessionAvailable": true, "rtspPort": 7236, "cpSupport": false}'

{

"returnValue": true

}

 

Example response for a failed call:

# luna-send -n 1 -f luna://com.webos.service.wifi/p2p/setwifidisplayinfo '{"enabled": true, "deviceType": "primary-sink", "sessionAvailable": true, "rtspPort": 7236, "cpSupport": false}'

{

"errorCode": 5,

"returnValue": false,

"errorText": "WiFi technology unavailable"

}

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

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
errorTextOptionalString

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

errorCodeOptionalNumber

The error code for the failed operation.

Error Codes Reference

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 1: Successful call

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

 

Response:


   "returnValue":true
}

 

Example 2: Failed call

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

 

Response:


   "errorCode":5,
   "returnValue":false,
   "errorText":"WiFi technology unavailable"
}

setstate

Description

Enables or disables Wi-Fi on the system by enabling/disabling the Wi-Fi interface.

Parameters

Name

Required

Type

Description

stateRequiredString

Indicates whether to enable Wi-Fi. Possible values are: 

  • enabled - Enable Wi-Fi
  • disabled - Disable Wi-Fi

Note: Any other value will result in an error.

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 Codes Reference

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

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

Response:


   "returnValue":true
}

tethering/setState

Description

Sets the Wi-Fi tethering state. Wi-Fi tethering can either be enabled or disabled.

At least the ssid field needs to be set before enabling tethering. This can be done either with a separate setState call or within the enable call.

The "ssid", "securityType" and "passPhrase" configuration values are persisted across device reboots.

Note: Although all parameters are optional, at least one parameter needs to be specified.

Parameters

Name

Required

Type

Description

enabledOptionalBoolean

Enable or disable Wi-Fi tethering.

ssidOptionalString

The identifier used as SSID for Wi-Fi tethering. This field cannot be set when Wi-Fi tethering is enabled.

securityTypeOptionalString

The security type to use for authenticating clients. Possible values are

  • open
  • psk

When open is used then the passphrase is cleared. When psk is used a then the passphrase needs to be set before enabling the Wi-Fi tethering.

passPhraseOptionalString

The passphrase used to authenticate the new clients when Wi-Fi tethering is enabled. This field cannot be set when Wi-Fi tethering is enabled. A valid passphrase should have 8 to 63 characters.

timeoutOptionalNumber

A timeout in minutes after which the Wi-Fi tethering is disabled, when no client is connected. Default value is 5 minutes.

channelOptionalString

Channel of the softap to be used for Wi-Fi tethering.

Possible values are 1~11.

Note: If value greater than 11 is set, channel is automatically set to 6.

ipAddressOptionalString

IP address of the SoftAP

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 Codes Reference

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 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 WiFi support.

146Failed to enable tethering mode

Failed to enable Wi-Fi tethering mode because of unmet requirements. Check if fields ssid, passPhrase and securityType are all set to the right values.

147Failed to disable tethering mode

Failed to disable Wi-Fi tethering mode cause for an unknown reason.

149Error in setting tethering passphrase

An error occured while processing the supplied passphrase.

151No passphrase set but required for security type psk

A passphrase must be set for Wi-Fi tethering when security type psk is selected.

152Failed to disable tethering mode through support library

It was not possible to enable Wi-Fi tethering through using the webOS connman adapter support library.

153Not allowed to change securityType while tethering is enabled

When Wi-Fi tethering is enabled it is not allowed to change the security type.

154With security typen open specifying a passphrase is not possible

When security type is set to open it is not possible to set a passphrase in the same call.

155Passphrase doesn't match the requirements

Passpharse does not match the requirements. Must be between 8 and 63 characters long.

156Failed to restore WiFi state after disbling tethering

When Wi-Fi tethering is disabled the previous Wi-Fi state is restored (enabled or disabled) and this error occurs when something during this process fails.

207Error in setting tethering Channel

Error occurred during processing tethering channel.

148Not allowed to change IP Address while tethering is enabled

User is not allowed to change IP address while tethering is already enabled.

Example

Example 1: 

# luna-send -n 1 luna://com.webos.service.wifi/tethering/setState '{ 
   "enabled":true,
   "securityType":"open",
   "ssid":"MyTestAP",
   "timeout":60
}'

 

Response: 


   "returnValue":true
}

 

Example 2: 

# luna-send -n 1 luna://com.webos.service.wifi/tethering/setState '{ 
   "enabled":true,
   "securityType":"psk",
   "passPhrase":"MyTestPassphrase",
   "ssid":"MyTestAP",
   "timeout":60
}'

 

Response: 


   "returnValue":true
}

 

Example 3:

# luna-send -n 1 -f luna://com.webos.service.wifi/tethering/setState '{ 
   "enabled":true,
   "securityType":"psk",
   "passPhrase":"11111111",
   "ssid":"Connect_Me",
   "timeout":60,
   "channel":11,
   "ipAddress":"192.168.6.1"
}'

 

Response:


   "returnValue":true
}

 

Example 4: Failed call

# luna-send -n 1 luna://com.webos.service.wifi/tethering/setState '{"enabled":true, "ssid":"MyTestAP"}'

 

Response: 


   "errorCode":5,
   "returnValue":false,
   "errorText":"WiFi technology unavailable"
}

tethering/getState

Description

Gets the current Wi-Fi tethering state.

Parameters

Name

Required

Type

Description

subscribeOptionalBoolean

Subscribe for notifications when there is a change in the list of found peers. Possible values are:

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

Default value: false

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.

subscribedOptionalBoolean

Returns true to indicate client was successfully subscribed.

enabledRequiredBoolean

Indicates if Wi-Fi tethering is enabled or disabled.

ssidOptionalString

The identifier used as SSID for Wi-Fi tethering. This field cannot be set when Wi-Fi tethering is enabled.

securityTypeOptionalString

The security type to use for authenticating clients. Possible values are

  • open
  • psk

When open is used then the passphrase is cleared. When psk is used a then the passphrase needs to be set before enabling the Wi-Fi tethering.

timeoutRequiredNumber

A timeout in minutes after which the Wi-Fi tethering is disabled, when no client is connected. Default value is 5 minutes.

channelOptionalNumber

Channel of the SoftAP

ipAddressOptionalString

IP address of the SoftAP

Subscription Returns

Name

Required

Type

Description

subscribedRequiredBoolean

True to indicate that the client was successful subscribed.

enabledRequiredBoolean

Indicates if Wi-Fi tethering is enabled or disabled.

ssidRequiredString

The identifier used as SSID for Wi-Fi tethering. This field can't be set when Wi-Fi tethering is enabled.

securityTypeRequiredString

The security type to use for authenticating clients. Possible values are

  • open
  • psk

When open is used, any possible set passPhrase is cleared. When psk is used a passPhrase needs to be set before enabling Wi-Fi tethering.

timeoutRequiredNumber

A timeout in minutes after which the Wi-Fi tethering is disabled, when no client is connected. Default value is 5 minutes.

channelOptionalNumber

Channel of the SoftAP

ipAddressOptionalString

IP address of the SoftAP

Example

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

Response:


   "returnValue":true,
   "channel":11,
   "ipAddress":"192.168.6.4",
   "subscribed":false,
   "ssid":"Connect_Me",
   "enabled":true,
   "securityType":"psk",
   "timeout":60
}

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

Response: 

{
   "errorCode":5,
   "returnValue":false,
   "errorText":"WiFi technology unavailable"
}

tethering/getStationCount

Description

Gets the number of devices that are connected to the signage softAP. 

Parameters

Name

Required

Type

Description

subscribeOptionalBoolean

Subscribe to this method to get notified when a device connects or disconnects from the signage softAP. Possible values are:

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

Default value: false

Call Returns

Name

Required

Type

Description

stationCountRequiredNumber

Number of devices that are connected to the signage softAP.

subscribedRequiredBoolean

Indicates if subscribed to get notified when a device connects or disconnects from the signage softAP. Possible values are:

  • 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.

connectedStationsRequiredString array

MAC addresses of the connected clients.

Subscription Returns

Name

Required

Type

Description

subscribedRequiredBoolean

Returns true to indicate client was successfully subscribed to get notified when a device connects or disconnects from the signage softAP.

stationCountRequiredNumber

Number of devices that are connected to the signage softAP.

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.

connectedStationsRequiredString array

MAC addresses of the connected clients.

Error Codes Reference

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

Indicates that webos-connman-adapter is unable to communicate with the connman daemon.

5WiFi technology unavailable

Indicates that Wi-Fi technology is not available. This can occur due to the following reasons:

  • The wpa-supplicant daemon is not running 
  • connman is not able to communicate with wpa-supplicant
  • The device does not have WiFi support

Example

# luna-send -i -f luna://com.webos.service.wifi/tethering/getStationCount '{"subscribe":true}'

 

Response: 


   "subscribed":true,
   "connectedStations":[ 

   ],
   "returnValue":true,
   "stationCount":0
}


   "subscribed":true,
   "connectedStations":[ 
      "8c:3a:e3:46:ab:7a"
   ],
   "returnValue":true,
   "stationCount":1
}


   "subscribed":true,
   "connectedStations":[ 
      "dc:0b:34:bf:c4:f8",
      "8c:3a:e3:46:ab:7a"
   ],
   "returnValue":true,
   "stationCount":2
}

tethering/setMaxStationCount

Description

Sets the maximum number of stations allowed to connect to the AP.

Parameters

Name

Required

Type

Description

maxStationCountRequiredNumber

Number of stations allowed to connect to the AP.

Range : 1 ~ 254.

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 Codes Reference

Error Code

Error Text

Error Description

3Invalid parameters

Parameter is invalid.

9Could not validate json message against schema

Parameters passed to this method are not following the schema format.

210Not allowed to change the maximum number of stations allowed to connect to the AP while tethering is enabled

Not allowed to change the maximum number of stations allowed to connect to the AP while tethering is enabled

Example

# luna-send -n 1 -f luna://com.webos.service.wifi/tethering/setMaxStationCount '{"maxStationCount" : 1}'

Response:

{
    "returnValue": true
}

tethering/getMaxStationCount

Description

Gets the maximum number of stations allowed to connect to the AP.

Parameters

None

Call Returns

Name

Required

Type

Description

maxStationCountRequiredNumber

Number of stations allowed to connect to the AP.

Range : 1 ~ 254.

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 Codes Reference

Error Code

Error Text

Error Description

1Unknown error

Some error in getting the maximum number of stations allowed to connect to the AP.

Example

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

Response:

{
    "returnValue": true,
    "getMaxStationCount": 2
}

setCountryCode

Description

Sets the current country code of the Wi-Fi adapter. This affects the allowed Wi-Fi channel for both AP (Access Point) and STA (Station) modes.

Format of the country code follows the alpha-2 code of ISO-3166-1.

Parameters

Name

Required

Type

Description

countryCodeRequiredString

Alpha-2 country code. For possible values, see List of ISO 3166 country codes.

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 Codes Reference

Error Code

Error Text

Error Description

9Could not validate json message against schema

Parameters passed to this method are not following the schema format.

Example

# luna-send -n 1 -f luna://com.webos.service.wifi/setCountryCode '{"countryCode":"US"}'

Response: 


   "returnValue":true
}

getCountryCode

Description

Gets the current country code of the Wi-Fi adapter.

Format of the country code follows the alpha-2 code of ISO-3166-1. 

Parameters

None

Call Returns

Name

Required

Type

Description

countryCodeRequiredString

Current country code of the Wi-Fi adapter. For possible values, see List of ISO 3166 country codes

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.

Example

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

Response: 


   "returnValue":true,
   "countryCode":"US"
}

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

ssidRequiredString

SSID associated with the profile.

profileIdRequiredString

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

securityRequiredObject: securityTypeSecurity 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

securityTypeRequiredString

Connection type. e.g. wep or psk.

simpleSecurityOptionalObject: simpleSecuritySecurity options when using simple security type.
enterpriseSecurityOptionalObject: 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

ssidRequiredString

SSID of discovered AP.

availableSecurityTypesRequiredString array

List of supported security mechanisms.

signalBarsRequiredNumber

Coarse indication of signal strength.

availableRequiredBoolean

Indicates if the network is currently available or not.

signalLevelRequiredNumber

Fine indication of signal strength.

ipInfoOptionalObject: ipInfo

Only returned for getstatus method.

bssInfoOptionalObject array: bssInfo

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

displayNameRequiredString

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.

connectStateOptionalString

Current connection state of the service.

The following values are possible: "notAssociated", "associating", "associated", "ipConfigured", "ipFailed".

supportedRequiredBoolean

Displays false if found that Wi-Fi supports "ieee8021x" (enterprise security).

Displays true for all other Wi-Fi security types.

simpleSecurity

Connection information for a simple connection.

Example:

"simpleSecurity": {

"passKey": "1234"

}

Name

Required

Type

Description

passKeyRequiredString

Passkey for the network to be connected.

securityType

A list of array types.

Example:

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

Name

Required

Type

Description

securityTypeRequiredString 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

interfaceRequiredString

The Wi-Fi interface for the connected network.

ipRequiredString

IP address of the Wi-Fi interface.

subnetRequiredString

Subnet for the Wi-Fi interface.

gatewayRequiredString

Gateway address for routing over Wi-Fi interface.

dnsRequiredString 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

eapTypeRequiredString

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

identityOptionalString

The name of the user to be authenticated.

passphraseOptionalString

Passphrase for authenticating the user.

caCertFileOptionalString

The location of server certificate file for authenticating the server.

clientCertFileOptionalString

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

privateKeyFileOptionalString

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

privateKeyPassphraseOptionalString

Passphrase used to encrypt the private key file.

phase2OptionalString

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

bssidRequiredString

Mac address of the wireless station.

frequencyRequiredNumber

Station frequency in MHZ

signalRequiredNumber

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

API Error Codes Reference

Error Code

Error Text

Error Description

9Could not validate json message against schema

If the parameters passed to any method are not following the schema format.

3Invalid parameters

One or more parameters supplied were invalid.

Contents