Clone this repo:
  1. f086c65 virtual-usb-printer: Adding a README file by David Valleau · 4 hours ago master
  2. 65c04c8 virtual-usb-printer: Adding ability to write received files by David Valleau · 4 days ago
  3. 928c153 Adding UsbDescriptors class to group descriptors and simplify UsbPrinter by David Valleau · 6 days ago
  4. 1b82f5f Adding main program with gyp build configuration by David Valleau · 14 days ago
  5. 46c3f41 Adding SmartBuffer class used for packing socket messages by David Valleau · 5 weeks ago factory-octopus-11512.B stabilize-11554.B stabilize-atlas-11512.6.B stabilize-atlas-11512.B stabilize-atlas.11448.B

Virtual USB Printer

Virtual USB Printer provides a server which can be used with USBIP in order to emulate a USB printing device and bind it to the system as if it were physically connected to a USB port.

Virtual USB Printer supports both regular USB printers as well as IPP-over-USB devices.

Motivation

This project was created in order to make on-device tests which check for any regressions in the native USB printing system.

Requirements

  • USBIP - userspace program for binding virtual device to system
  • USBIP kernel modules:
    • CONFIG_USBIP_CORE
    • CONFIG_USBIP_VHCI_HCD
  • Linux Kernel v4.14 - USBIP currently only works on this kernel version

In order to actually “connect” the virtual printer to the system the USBIP program is used.

USBIP is typically used to export real USB devices over a network so that other systems on the network can bind them and treat them as connected devices.

For the purposes of the virtual printer, only the client portion of USBIP is required so that the virtual device can be bound to the system.

How to Use

Run the virtual-usb-printer program:

virtual-usb-printer --descriptors_path=<path>

(Optional) Check the list of exported printers with USBIP:

usbip list -r localhost

Should return something like this:

Exportable USB devices
======================
 - localhost
        1-1: Canon, Inc. : unknown product (04a9:27e8)
           : /sys/devices/pci0000:00/0000:00:01.2/usb1/1-1
           : (Defined at Interface level) (00/00/00)
           : 0 - Printer / Printer Bidirectional (07/01/02)

Bind the virtual printer to the system:

usbip attach -r localhost -b 1-1

Once the device has been attached it should appear in the list of connected USB devices (lsusb), and can be used with the native printing system in Chrome OS.

Configuration

The printer's USB descriptors and defined IPP attributes can be configured using a JSON file and are loaded at run-time using command line flags. Example configurations can be found in the config/ directory.

The configuration files can be loaded with the following flags:

  • --descriptors_path - full path to the JSON file which defines the USB descriptors
  • --attributes_path - full path to the JSON file which defines the supported IPP attributes
    • Only needed for IPP-over-USB printer configurations
  • --record_doc_path - full path to the file used to record documents received from print jobs