com.webos.service.pdm

API Summary

Manages USB devices that are connected to the webOS system.

Main Functions:

Mount/unmount of Mass Storage Class (MSC) USB devices
Format, Fdisk, File system check (FSCK)
Detect USB device

Supported USB Devices

MSC USB device
- Supported file system: Windows compatible file system (FAT, NTFS)
- Supported device type: HDD, Memory Stick, SSD, Memory card
Still image device (Picture Transfer Protocol (PTP) Camera)
Camera
HID & XPAD
USB to Serial

Important Terms

Device - A device that is directly connected to a USB port or hub.
Drive - A device can have multiple drives, where each drive is a partition of a physical storage device.

Overview of the API

Methods

eject

Description

Unmounts all drives of the storage device for safe removal.

Prerequisite: The storage device must be connected.

Parameters

Name	Required	Type	Description
deviceNum	Required	Number	Indicates the unique identifier of the device. It is auto-assigned when the device is connected. Note: Use the getAttachedDeviceStatus() method to get a list of devices and their device numbers.

Name

Required

Type

Description

deviceNum

Required

Number

Indicates the unique identifier of the device. It is auto-assigned when the device is connected.

Note: Use the getAttachedDeviceStatus() method to get a list of devices and their device numbers.

Call Returns

Name

Required

Type

Description

returnValue

Required

boolean

Indicates the status of the operation.

Possible values are:

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

errorCode

Optional

Number

The error code for the failed operation.

errorText

Optional

string

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

Example

# luna-send -n 1 -f luna://com.webos.service.pdm/eject '{
"deviceNum":2
}'

Response:

{
"returnValue": true
}

format

Description

Formats the connected drive.

Parameters

Name	Required	Type	Description
driveName	Required	string	Indicates the information that can identify the drive. Example: sda1
fsType	Optional	string	Indicates the file system type. Possible values are: fat ntfs Default: fat
volumeLabel	Optional	string	Indicates the volume label for the drive. Default: volumeLabel not set

Name

Required

Type

Description

driveName

Required

string

Indicates the information that can identify the drive.

Example: sda1

fsType

Optional

string

Indicates the file system type.

Possible values are:

fat
ntfs

Default: fat

volumeLabel

Optional

string

Indicates the volume label for the drive.

Default: volumeLabel not set

Call Returns

Name

Required

Type

Description

returnValue

Required

boolean

Indicates the status of the operation.

Possible values are:

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

errorCode

Optional

Number

The error code for the failed operation.

errorText

Optional

string

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

Example

# luna-send -n 1 -f luna://com.webos.service.pdm/format '{
   "driveName":"sda",
   "fsType":"fat",
   "volumeLabel":"test"
}'

Response:

{
"returnValue": true
}

# luna-send -n 1 -f luna://com.webos.service.pdm/format '{
"driveName":"sda1"
}'

Response:

{
"returnValue": true
}

fsck

Description

Checks the file system by performing fsck (File System Check) of the corresponding connected drive.

Note: On connecting a USB device with a large number of files, the PDM service prompts for “Check & Repair” and “Open Now”. The fsck() API will do the file system checking when “Check & Repair” is selected.

Parameters

Name	Required	Type	Description
driveName	Required	string	Indicates the information that can identify the drive. Example: sda1

Name

Required

Type

Description

driveName

Required

string

Indicates the information that can identify the drive.

Example: sda1

Call Returns

Name

Required

Type

Description

returnValue

Required

boolean

Indicates the status of the operation.

Possible values are:

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

errorCode

Optional

Number

The error code for the failed operation.

errorText

Optional

string

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

Example

# luna-send -n 1 -f luna://com.webos.service.pdm/fsck '{
"driveName":"sda"
}'

Response:

{
"returnValue":true
}

getAttachedDeviceStatus

Description

Gets the status information of connected device(s).

Parameters

Name	Required	Type	Description
subscribe	Required	boolean	Subscribe to get notified when the device status information changes. Possible values are: true - Subscribe for changes. false - Not subscribed.

Name

Required

Type

Description

Required

boolean

Subscribe to get notified when the device status information changes. Possible values are:

true - Subscribe for changes.
false - Not subscribed.

Call Returns

Name	Required	Type	Description
returnValue	Required	boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	string	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
deviceStatusList	Required	Object: deviceStatusList	An array containing the status information of the device.

Subscription Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
deviceStatusList	Required	Object: deviceStatusList	An array containing the status information of the device.

Example

# luna-send -n 1 -f luna://com.webos.service.pdm/getAttachedDeviceStatus '{ "subscribe" : true }'

Response:

{
"deviceStatusList":[
{
"deviceNum":0,
"deviceStatus":"NOTHING"
},
{
"deviceNum":1,
"deviceStatus":"EJECTED",
"driveStatusList":[
{
"driveName":"apps",
"driveStatus":"UMOUNT_OK"
}
]
},
{
"deviceNum":2,
"deviceStatus":"NOTHING",
"driveStatusList":[
{
"driveName":"sdb1",
"driveStatus":"MOUNT_OK"
}
]
}
],
"returnValue":true
}

getAttachedNonStorageDeviceList

Description

Gets the status information of connected non-storage device(s).

Parameters

Name	Required	Type	Description
subscribe	Required	boolean	Subscribe to get notified when a device is connected and the list of non-storage device changes. Possible values are: true - Subscribe for changes. false - Not subscribed.
category	Optional	String	Category of non-storage device. Possible values are: Audio Video Net

Name

Required

Type

Description

Required

boolean

Subscribe to get notified when a device is connected and the list of non-storage device changes. Possible values are:

true - Subscribe for changes.
false - Not subscribed.

Call Returns

Name	Required	Type	Description
returnValue	Required	boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	string	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
powerStatus	Required	String	Power-on status of the device. Note: This value always defaults to "normal".
nonStorageDeviceList	Optional	Object: nonStorageDeviceList	An array containing the information about the non-storage device that is currently connected.
videoDeviceList	Optional	Object: videoDeviceList	An array of video device lists connected. Note: Returned only when "category" is "Video".
audioDeviceList	Optional	Object: audioDeviceList	An array of audio device list connected. Note: Returned only when "category" is "Audio".
netDeviceList	Optional	Object: netDeviceList	An array of net device list connected. Note: Returned only when "category" is "Net".

Subscription Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
powerStatus	Required	String	Power-on status of the device. Note: This value always defaults to "normal".
nonStorageDeviceList	Required	Object: nonStorageDeviceList	An array containing the information about the non-storage device that is currently connected.
videoDeviceList	Optional	Object: videoDeviceList	An array of video devices connected. Note: Returned only when "category" is "Video".
audioDeviceList	Optional	Object: audioDeviceList	An array of audio devices connected. Note: Returned only when "category" is "Audio".
netDeviceList	Optional	Object: netDeviceList	An array of net devices connected. Note: Returned only when "category" is "Net".

Example

Example 1: To view all non-storage devices attached

# luna-send -n 1 -f luna://com.webos.service.pdm/getAttachedNonStorageDeviceList '{ "subscribe" : true }'

Response:

{
"powerStatus": "normal",
"nonStorageDeviceList": [
{
"usbPortNum": 255,
"serialNumber": "",
"isPowerOnConnect": false,
"deviceNum": 52,
"deviceSubtype": "usbhid",
"vendorName": "DELL",
"deviceType": "HID",
"productName": "Dell USB Entry Keyboard",
"devSpeed": "LOW"
},
{
"usbPortNum": 2,
"serialNumber": "",
"isPowerOnConnect": false,
"deviceNum": 62,
"deviceSubtype": "usbhid",
"vendorName": "17ef",
"deviceType": "HID",
"productName": "Lenovo Optical USB Mouse",
"devSpeed": "LOW"
}
],
"returnValue": true
}

Example 2: To view all non-storage (video) devices attached

# luna-send -n 1 -f luna://com.webos.service.pdm/getAttachedNonStorageDeviceList '{ "subscribe" : true, "category" : "Video" }'

Response:
{
"powerStatus": "normal",
"videoDeviceList": [
{
"KERNEL": "video0",
"SUBSYSTEM": "video4linux",
"vendorName": "Logitech, Inc.",
"productName": "081b",
"devSpeed": "HIGH"
}
],
"returnValue": true
}

Example 3: To view all non-storage (audio) devices attached

# luna://com.webos.service.pdm/getAttachedNonStorageDeviceList '{ "subscribe" : true, "category" : "Audio" }'

Response:
{
"powerStatus": "normal",
"audioDeviceList": [
{
"cardNumber": 1,
"cardName": "card1",
"cardId": "Wireless",
"usbPortNum": 3,
"devSpeed": "HIGH"
}
],
"returnValue": true
}

Example 4: To view all non-storage (net) devices attached

# luna-send -n 1 -f luna://com.webos.service.pdm/getAttachedNonStorageDeviceList '{ "subscribe" : true, "category" : "Net" }'

Response:
{
"netDeviceList": [
{
"duplex": "",
"ifindex": "4",
"linkmode": "0",
"address": "50:3e:aa:6d:65:e5",
"vendorName": "TP-LINK",
"productName": "USB 10 100 1000 LAN",
"devSpeed": "HIGH",
"operstate": "down"
}
],
"powerStatus": "normal",
"returnValue": true
}

getAttachedStorageDeviceList

Description

Gets status information of connected storage device(s).

Parameters

Name	Required	Type	Description
subscribe	Required	boolean	Indicates if subscribed to get the notifications. Possible values are: true: Subscribe for notifications. false: Not subscribed.

Name

Required

Type

Description

Required

boolean

Indicates if subscribed to get the notifications.

Possible values are:

true: Subscribe for notifications.
false: Not subscribed.

Call Returns

Name	Required	Type	Description
returnValue	Required	boolean	Indicates the status of the operation. Possible values are: true: Indicates that the operation was successful. false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	string	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
powerStatus	Required	String	Indicates the power-on status of the device. Note: This value always defaults to "normal".
storageDeviceList	Required	Object: storageDeviceList	Indicates an array containing information about the currently connected storage device(s).

Subscription Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
powerStatus	Required	String	Power-on status of the device. Note: This value always defaults to "normal".
storageDeviceList	Required	Object: storageDeviceList	An array containing information about the currently connected storage device(s).

Example

# luna-send -n 1 -f luna://com.webos.service.pdm/getAttachedStorageDeviceList '{ "subscribe" : true }'

Response:

{
"powerStatus":"normal",
"returnValue":true,
"storageDeviceList":[
{
"usbPortNum":2,
"rootPath":"/tmp/usb/sdb",
"storageDriveList":[
{
"isMounted":true,
"volumeLabel":"MX-ES",
"uuid":"1209-3C50",
"driveName":"sdb1",
"driveSize":31190064,
"fsType":"fat",
"mountName":"/tmp/usb/sdb/sdb1"
}
],
"serialNumber":"000000000000000236",
"isPowerOnConnect":false,
"deviceNum":2,
"vendorName":"MX",
"storageType":"FLASH",
"deviceType":"USB_STORAGE",
"productName":"Mass Storage Device",
"devSpeed":"HIGH",
"errorReason":"NOTHING"
}
]
}

getSpaceInfo

Description

Gets the space information of the connected drive.

Note: The drive must be mounted.

Parameters

Name

Required

Type

Description

driveName

Required

string

Information that can identify the drive (e.g. sda1)

directCheck

Optional

boolean

Indicates if PDM needs to newly measure the drive space information at the time of API call. Possible values are:

true - Newly measures the information
false - Returns periodically measured information

Call Returns

Name	Required	Type	Description
returnValue	Required	boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	string	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
spaceInfo	Required	Object: spaceInfo	Information about the drive space.

Example

# luna-send -n 1 -f luna://com.webos.service.pdm/getSpaceInfo '{ "driveName" : "sda" , "directCheck" : true }'

Response:

{
"spaceInfo":{
"usedRate":0,
"freeSize":31116080.000000,
"totalSize":31190064.000000,
"usedSize":73984.000000
},
"returnValue":true
}

isWritableDrive

Description

Checks the file system attribute of the drive and returns whether it is writable.

Parameters

Name	Required	Type	Description
driveName	Required	String	Information that can identify the drive (e.g. sda1)

Call Returns

Name	Required	Type	Description
returnValue	Required	boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	string	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.
isWritable	Required	boolean	Indicates if data can be written on the drive. Possible values are: true - Writable drive false - Cannot be written

Example

# luna-send -n 1 -f luna://com.webos.service.pdm/isWritableDrive '{ "driveName" : "sda" }'

Response:

{
"returnValue":true,
"isWritable":true
}

setVolumeLabel

Description

Sets the volume label of the drive. It is supported only when file system type is FAT.

Parameters

Name	Required	Type	Description
driveName	Required	string	Information that can identify the drive (e.g. sda1)
volumeLabel	Required	string	Volume label for the drive.

Call Returns

Name

Required

Type

Description

returnValue

Required

boolean

Indicates the status of operation. Possible values are:

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

errorCode

Optional

Number

The error code for the failed operation.

errorText

Optional

string

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

Example

# luna-send -n 1 -f luna://com.webos.service.pdm/setVolumeLabel '{ "driveName" : "sda", "volumeLabel" : "webos" }'

Response:

{
"returnValue":true
}

umountAllDrive

Description

Unmounts all drives.

Parameters

None

Call Returns

Name

Required

Type

Description

returnValue

Required

boolean

Indicates the status of operation. Possible values are:

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

errorCode

Optional

Number

The error code for the failed operation.

errorText

Optional

string

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

Example

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

Response:

{
"returnValue":true
}

Objects

spaceInfo

Information about the drive space.

Name	Required	Type	Description
totalSize	Required	Number (double)	Total Drive Size (KB)
usedSize	Required	Number (double)	Drive size currently in use (KB)
freeSize	Required	Number (double)	Currently Available Drive Size (KB)
usedRate	Required	Number (int32_t)	Current Drive Utilization (%)

nonStorageDeviceList

List of information about the non-storage devices that are currently connected.

Name	Required	Type	Description
usbPortNum	Required	Number	Port number to which the device is connected
serialNumber	Required	String	Serial number of the device product
isPowerOnConnect	Required	Boolean	Indicates whether the device was connected during power on. Possible values are: true - Connected during power on false - Connected after powering on
deviceNum	Required	Number	Number assigned to the connected device
deviceSubtype	Required	String	Sub-type of the device connected. For example: If deviceType is "usb", then deviceSubtype can be "usbhid" etc.
vendorName	Required	String	Name of the device vendor
deviceType	Required	String	Type of the device
productName	Required	String	Name of the device product
devSpeed	Required	String	Speed of the device. Possible values are: LOW HIGH SUPER

videoDeviceList

List of video device(s) connected.

Name	Required	Type	Description
KERNEL	Required	String	Device name
SUBSYSTEM	Required	String	Device driver
vendorName	Required	String	Name of the vendor
productName	Required	String	Name of the product
devSpeed	Required	String	Speed of the device. Possible values are: LOW HIGH SUPER

audioDeviceList

List of audio device(s) connected.

Name	Required	Type	Description
cardNumber	Required	Number	Card number of the audio device
cardName	Required	String	Name of the audio device card
cardId	Required	String	Type of the audio device card
usbPortNum	Required	Number	Port number where the sound device is connected
devSpeed	Required	String	Speed of the sound device. Possible values are: LOW HIGH SUPER

netDeviceList

List of Communication Device Class (CDC) device(s) connected.

Name	Required	Type	Description
operstate	Required	String	State of the device operation
ifindex	Required	String	Network interface index
linkmode	Required	String	Tells whether specified interface is managed and configured by systemd network manager. Possible values are: 0 - LINK_AUTO 1 - LINK_MANUAL 2 - LINK_MODE_UNKNOWN
duplex	Required	String	Bandwidth of the device. Possible values are: uni-directional bi-directional
address	Required	String	Ethernet address of the device connected
vendorName	Required	String	Name of the vendor
productName	Required	String	Name of the product
devSpeed	Required	String	Speed of the device. Possible values are: LOW HIGH SUPER

storageDeviceList

List of information about the storage devices that are currently connected.

Name	Required	Type	Description
usbPortNum	Required	Number	Port number to which the device is connected.
rootPath	Required	String	Root directory path of the device.
storageDriveList	Required	Object: storageDriveList	List of storage drives in the connected storage device.
serialNumber	Required	String	Serial number of the device.
isPowerOnConnect	Required	Boolean	Indicates whether the device was connected during power on. Possible values are: true - Connected during power on. false - Connected after powering on.
deviceNum	Required	Number	Number assigned to the device.
vendorName	Required	String	Name of the vendor.
storageType	Required	String	Type of the storage device.
deviceType	Required	String	Type of the USB device.
productName	Required	String	Name of the product.
devSpeed	Required	String	Speed of the device.
errorReason	Required	String	Describes the status of device mounting. Possible values are: NOTHING - Mount successful NOMOUNTED - Mount unsuccessful UNSUPPORT_FILESYSTEM - File system of the device is unsupported EJECTED - Device ejected NEED_FSCK -Device needs file system checking

storageDriveList

List of the drives in storage devices connected.

Name	Required	Type	Description
isMounted	Required	Boolean	Indicates whether the device is mounted or not. Possible values are: true - Device is mounted false - Device is not mounted
volumeLabel	Required	String	Label set for the drive in the device
uuid	Required	String	Unique SCSI device ID
driveName	Required	String	Name of the drive where mounted
driveSize	Required	Number	Size of the drive
fsType	Required	String	Type of the file system in the drive
mountName	Required	String	Absolute path of the drive in the device where mounted

API Error Codes Reference

Error Code	Error Text	Error Description
1	Parameter error	Parameter error
2	Interface function error	Interface function error
3	Subscribe Error	Subscribe Error
4	SubscriptionAdd Fail	SubscriptionAdd Fail
5	LSSubscriptionAcquire Fail	LSSubscriptionAcquire Fail
6	Json parse error	Json parse error