1 This library provides support for the Pulse-Eight USB-CEC adapter.
3 ===============================================================================
5 ===============================================================================
7 libCEC needs the following dependencies in order to work correctly:
9 * cdc-acm support compiled into the kernel or available as module
11 To compile libCEC on Linux, you'll need the following dependencies:
12 * autoconf 2.13 or later
13 * automake 1.11 or later
16 * udev development headers v151 or later
19 To compile, execute the following commands:
21 # ./configure --prefix=/usr
25 ===============================================================================
27 ===============================================================================
29 To compile libCEC on OS-X, you'll need the following dependencies:
30 * autoconf 2.13 or later
31 * automake 1.11 or later
33 * xcode (TODO: version?)
35 To compile, execute the following commands (TODO: please verify):
37 # ./configure --prefix=/usr
41 ===============================================================================
43 ===============================================================================
45 To compile libCEC on Windows, you'll need Visual C++ 2010 or Visual Studio 2010
46 The installer needs the Windows DDK (Driver Development Kit) and Nullsoft's
49 To compile libCEC, follow these instructions:
50 * open /project/libcec.sln with Visual C++ 2010 or Visual Studio 2010.
53 To build an installer on Windows:
54 * download and install the Windows DDK.
55 * download and install NSIS.
56 * go to /project and execute create-installer.cmd to create the installer.
57 * the installer is stored as /project/libCEC-installer.exe
59 ===============================================================================
60 === Debugging / Testing ===
61 ===============================================================================
63 We provide a test client, named cec-client, to debug the device.
64 To check whether the device can be detected, execute the following command:
67 "cec-client -h" shows a list of commands and options that are available.
69 ===============================================================================
71 ===============================================================================
73 We provide a C, C++ and .NET CLR interface to the adapter.
76 * the API can be found in /include/cec.h
77 * an example implementation can be found in /src/testclient/main.cpp
80 * the API can be found in /include/cecc.h
83 * add a reference to LibCecSharp.dll
84 * an example can be found in \src\CecSharpTester\CecSharpClient.cs
86 ===============================================================================
87 === Developers Agreement ===
88 ===============================================================================
90 If you wish to contribute to this project, you must first sign our contributors
91 agreement. Please see http://www.pulse-eight.net/contributors for more