Add a README.asciidoc
[libam7xxx.git] / 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 Schnider:
12 https://github.com/rettichschnidi/acerc11xdrv
13
14 == AM7XXX
15
16 An overview of some AM7XXX chips (AM7211A AM7212 AM7212P AM7318 AM7213D
17 AM7213V) can be found in http://www.actions-micro.com/dpf_psg.pdf
18
19 An example of datasheet illustrating the functionalities of such ICs (AM7531)
20 is at: http://wenku.baidu.com/view/543c8b4d852458fb770b56ee.html
21
22 == Supported devices
23
24 The devices supported by libam7xxx use USB bulk trasfers and a simple packet
25 based protocol to exchange data and commands to and from a host system and the
26 AM7XXX chip.
27
28 Those with USB VendorID ''1de1'' are devices based on Actions Micro/Action Media
29 designs, usually having two modes:
30
31  - USB Mass Storage mode (ProductID: ''1101'')
32  - Generic bulk data transfer mode (ProductID: ''c101'')
33
34 Examples of devices based on AM7XXX are:
35
36   - Acer Series C pico projectors (C20 C110 C112 C120):
37       * http://www.acer.it/ac/it/IT/content/models/projector-c
38       * http://support.acer.com/product/default.aspx?modelId=3888
39     
40   - Philips/SagemCom PicoPix projectors (PPX 1020, PPX 1230, PPX 1430, PPX
41     1630):
42       * http://www.philips.co.uk/c/pocket-projector/179840/cat/
43       * http://www.sagemcom.com/EN/products/image-sound/pico-video-projectors.html
44
45   - CEL-TEC MP-01:
46       * http://www.kabelmanie.cz/miniprojektor-cel-tec-mp-01/
47
48   - Other unbranded projectors:
49       * http://www.dealextreme.com/p/portable-home-office-mini-usb-2-0-lcos-projector-16-9-45019
50
51   - HannSpree Digital picture frames (but it has not been verified yet if
52     those can be actually used as USB displays):
53       * http://europe.hannspree.net/onweb.jsp?prod_no=3333333621&webno=3333333317
54       * http://europe.hannspree.net/onweb.jsp?prod_no=33333337:4&webno=3333333317
55
56 Maybe other devices reported as supporting "Display over USB (DoUSB)" like
57 Acer K330 or some Optoma projectors could be used with this library, but
58 this needs still needs to be verified.