User:Seanlin/USB Manager API: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(→‎Storage: Add event handler 'onAvailableVolumeChange')
(Removing 'storage' type but adding 'keyboard', 'mouse', and 'camera' types.)
Line 8: Line 8:


== Features ==
== Features ==
* Enumerate available USB ports on the current device. So far supported types of USB ports include Storage.
* Enumerate available USB ports on the current device. So far supported types of USB ports include Keyboard, Mouse, Camera.
* Support hot-plug detection on each USB port.
* Support hot-plug detection on each USB port.


Line 36: Line 36:
=== USB Port Interface ===
=== USB Port Interface ===
==== Basic ====
==== Basic ====
   enum USBPortType { "storage" };
   enum USBPortType { "keyboard", "mouse", "camera" };


   interface USBPort : EventTarget {
   interface USBPort : EventTarget {
Line 50: Line 50:


'''type''' of type USBPortType, readonly <br/>
'''type''' of type USBPortType, readonly <br/>
The type of this USB port, value must be defined in the enum of USBPortType. So far only "storage" is supported. (This might be extended in the future.)
The type of this USB port, value must be defined in the enum of USBPortType.


'''connected''' of type boolean, readonly <br/>
'''connected''' of type boolean, readonly <br/>
Line 59: Line 59:
Whenever the hardware detects connection/disconnection, a USBConnectEvent or USBDisconnectEvent against this USB port should be fired.
Whenever the hardware detects connection/disconnection, a USBConnectEvent or USBDisconnectEvent against this USB port should be fired.


==== Storage ====
==== Keyboard ====
''In reality, a specific USB port may have its specific attributes and methods. And our goal is to collect the "common" ones as many as possible. However, with limited information, we will not focus on implementing hardware dependent members in this draft.''
''In reality, a specific USB port may have its specific attributes and methods. And our goal is to collect the "common" ones as many as possible. However, with limited information, we will not focus on implementing hardware dependent members in this draft.''


   interface StorageUSBPort : USBPort {
   interface KeyboardUSBPort : USBPort {
    readonly attribute unsigned long long totalVolume;
     // Possible hardware-dependent attributes.
    readonly attribute unsigned long long availableVolume;
    readonly attribute DOMString fileSystem;
            attribute EventHandler onAvailableVolumeChange;
     // Other possible hardware-dependent attributes.
   };
   };


'''totalVolume''' of type unsigned long long, readonly <br/>
==== Mouse ====
The total volume of the USB storage device.


'''availableVolume''' of type unsigned long long, readonly <br/>
  interface MouseUSBPort : USBPort {
The available volume of the USB storage device.
    // Possible hardware-dependent attributes.
  };


'''fileSystem''' of type DOMString, readonly <br/>
==== Camera ====
The type of the file system, e.g. FAT32, NTFS, etc.


'''onAvailableVolumeChange''' of type EventHandler <br/>
  interface CameraUSBPort : USBPort {
Whenever the hardware detects a change on the available volume, an simple event with the updated available volume against the USB port should be fired.
    // Possible hardware-dependent attributes.
  };


=== USB Port Connect/Disconnect Event Interface ===
=== USB Port Connect/Disconnect Event Interface ===

Revision as of 06:30, 9 December 2014

Goals

Provide DOM API access to the USB ports of devices. With USB Manager API, application developers are able to browse available USB ports of the current device, and detect whether a USB port has connected.

Contributors

Status

This document is merely a public working draft of a potential specification. It has no official standing of any kind and does not represent the support or consensus of any standards organisation.

Features

  • Enumerate available USB ports on the current device. So far supported types of USB ports include Keyboard, Mouse, Camera.
  • Support hot-plug detection on each USB port.

Proposed API

Navigator Interface

 partial interface Navigator {
   readonly attribute USBManager usb;
 };

USBManager Interface

 interface USBManager : EventTarget {
   Promise getUSBPorts ();
   attribute EventHandler onconnect;
   attribute EventHandler ondisconnect;
 };

getUSBPorts
This method makes a request to retrieve all the available USB ports on the device. It returns a new Promise that will be used to notify the caller about the result of the operation, which is an array of USBPort elements.

onconnect of type EventHandler
ondisconnect of type EventHandler
Whenever the hardware detects connection/disconnection, a USBConnectEvent or USBDisconnectEvent against this USB port should be fired.

USB Port Interface

Basic

 enum USBPortType { "keyboard", "mouse", "camera" };

 interface USBPort : EventTarget {
   readonly attribute DOMString id;
   readonly attribute USBPortType type;
   readonly attribute boolean connected;
            attribute EventHandler onconnect;
            attribute EventHandler ondisconnect;
 };

id of type DOMString, readonly
The unique identifier for the represented USB port. It MUST be unique to the application, and persistent between application sessions.

type of type USBPortType, readonly
The type of this USB port, value must be defined in the enum of USBPortType.

connected of type boolean, readonly
True if this USB port is connected, and vice versa.

onconnect of type EventHandler
ondisconnect of type EventHandler
Whenever the hardware detects connection/disconnection, a USBConnectEvent or USBDisconnectEvent against this USB port should be fired.

Keyboard

In reality, a specific USB port may have its specific attributes and methods. And our goal is to collect the "common" ones as many as possible. However, with limited information, we will not focus on implementing hardware dependent members in this draft. 

 interface KeyboardUSBPort : USBPort {
   // Possible hardware-dependent attributes.
 };

Mouse

 interface MouseUSBPort : USBPort {
   // Possible hardware-dependent attributes.
 };

Camera

 interface CameraUSBPort : USBPort {
   // Possible hardware-dependent attributes.
 };

USB Port Connect/Disconnect Event Interface

 interface USBConnectEvent : Event {
   readonly attribute USBPort usbPort;
 };

 interface USBDisconnectEvent : Event {
   readonly attribute USBPort usbPort;
 };

usbPort of type USBPort, readonly
The connected/disconnected USB port.

Examples

Retrieved from "https://wiki.mozilla.org/index.php?title=User:Seanlin/USB_Manager_API&oldid=1039482"