README.asciidoc

   1 = libam7xxx
   2
   3 libam7xxx is an Open Source library to communicate via USB with projectors and
   4 Digital Picture Frames based on the Actions Micro AM7XXX family if ICs.
   5
   6 libam7xxx makes it possible to use these devices as USB displays on
   7 non-Windows Operating Systems like GNU/Linux or Android/Linux just to name
   8 a few, and on non-PC platforms like for instance mobile phones, tablets or
   9 game consoles.
  10
  11 The first driver supporting these devices was _acerc11xdrv_ from Reto Schneider:
  12 https://github.com/rettichschnidi/acerc11xdrv
  13
  14 Another project with the same purpose is _acerc110_ from Thomas Baquet:
  15 https://github.com/lordblackfox/acerc110
  16
  17 == AM7XXX
  18
  19 An overview of some AM7XXX chips (AM7211A AM7212 AM7212P AM7318 AM7213D
  20 AM7213V) can be found in http://www.actions-micro.com/dpf_psg.pdf
  21
  22 An example of datasheet illustrating the functionalities of such ICs (AM7531)
  23 is at: http://wenku.baidu.com/view/543c8b4d852458fb770b56ee.html
  24
  25 == Supported devices
  26
  27 The devices supported by libam7xxx use USB bulk transfers and a simple packet
  28 based protocol to exchange data and commands to and from a host system and the
  29 AM7XXX chip.
  30
  31 Devices based on Actions Micro/Action Media designs generally use the USB
  32 VendorID +1de1+, and they can have two operational modes:
  33
  34  - USB Mass Storage mode (e.g. ProductID: +1101+)
  35  - Generic bulk data transfer mode, or Display mode (e.g. ProductID: +c101+)
  36
  37 On recent GNU/Linux systems the switch from Mass Storage mode to Display mode
  38 is performed automatically by
  39 http://www.draisberghof.de/usb_modeswitch/[USB_ModeSwitch], or can be done
  40 manually with the command:
  41
  42  $ sudo usb_modeswitch \
  43    --default-vendor 0x1de1 \
  44    --default-product 0x1101 \
  45    --message-content 55534243087052890000000000000cff020000000000000000000000000000
  46
  47 Alternatively, on systems where libusb works but 'usb-modeswitch' is not
  48 easily available, the switch can be performed using the 'am7xxx-modeswitch'
  49 example program from libam7xxx.
  50
  51 Examples of devices based on AM7XXX are:
  52
  53   - Acer Series C pico projectors (C20, C110, C112):
  54       * http://www.acer.it/ac/it/IT/content/models/projector-c
  55       * http://support.acer.com/product/default.aspx?modelId=3888
  56
  57   - Philips/SagemCom PicoPix projectors (PPX 1020, PPX 1230, PPX 1430, PPX
  58     1630, PPX 2055, PPX 2330):
  59       * http://www.philips.co.uk/c/pocket-projector/179840/cat/
  60       * http://www.sagemcom.com/EN/products/image-sound/pico-video-projectors.html
  61
  62   - CEL-TEC MP-01:
  63       * http://www.kabelmanie.cz/miniprojektor-cel-tec-mp-01/
  64
  65   - Top-Height/TEC PP700
  66       * http://www.ishopiwin.com/en/appliances-electronics/electronics/projectors/pico-projector-pp-700.html
  67
  68   - Royaltek PJU-2100:
  69       * http://www.royaltek.com/index.php/pju-2100-pico-projector
  70
  71   - Aiptek PocketCinema T25:
  72       * http://www.aiptek.eu/index.php/en/products/pico-projectors/pocketcinema-t25
  73
  74   - Other unbranded projectors:
  75       * http://www.dealextreme.com/p/portable-home-office-mini-usb-2-0-lcos-projector-16-9-45019
  76
  77   - HannSpree digital picture frames (but it has not been verified yet if
  78     those can be actually used as USB displays):
  79       * http://europe.hannspree.net/onweb.jsp?prod_no=3333333621&webno=3333333317
  80       * http://europe.hannspree.net/onweb.jsp?prod_no=33333337:4&webno=3333333317
  81
  82 Maybe other devices reported as supporting "Display over USB (DoUSB)" like
  83 Acer K330 or some Optoma projectors could be used with this library, but
  84 this needs still needs to be verified.
  85
  86 == Testing libam7xxx on MS Windows
  87
  88 All the needed files below must be in the same location:
  89
  90   - 'MinGW32/dll/libusb-1.0.dll' from
  91     https://github.com/libusb/libusb/releases/download/v1.0.21/libusb-1.0.21.7z
  92
  93   - 'libssp-0.dll' from MinGW;
  94
  95   - all the '*.dll' files in the 'bin/' directory from
  96     https://ffmpeg.zeranoe.com/builds/win32/shared/ffmpeg-3.4.2-win32-shared.zip
  97
  98
  99   - 'am7xxx-modeswitch.exe', 'am7xxx-play.exe', 'libam7xxx.dll' and
 100     'picoproj.exe' which can all be built by following the instructions in the
 101     HACKING.asciidoc document from libam7xxx.
 102
 103 In order to use the device on MS Windows the WinUSB drivers must be installed
 104 for both the mass storage device and the display device:
 105
 106   - Download http://sourceforge.net/projects/libwdi/files/zadig/[Zadig], it is
 107     a tool to install and replace USB devices filter drivers on MS Windows.
 108
 109   - From Zadig, select the USB Mass Storage Device relative to the projector
 110     and replace the +USBSTOR+ driver with the +WinUSB+ one; keep in mind that
 111     from now on the virtual CD-ROM can't be accessed anymore until the
 112     +USBSTOR+ Driver is restored.
 113
 114   - Run 'am7xxx-modeswitch.exe'
 115
 116   - When the new (display) device shows up, run Zadig and install the +WinUSB+
 117     driver for it too.
 118
 119 Now it is possible to run 'picoproj.exe' or 'am7xxx-play.exe' on Windows.