CECC-CLIENT(1)

NAME
cecc-client - test client for the libCEC C API

SYNOPSIS
cecc-client [options] [serial-port]

DESCRIPTION
cecc-client connects to a CEC adapter and offers a small interactive command loop. It is the example client for libCEC's plain C interface, and unlike cec-client(1) it does not link against the library at all: it loads libcec.so.8 with dlopen(3) at start up and resolves the libcec_* entry points by name. That makes it the tool of choice for checking that the C ABI and the shared library's SONAME are intact, which is the path every non-C++ binding takes; for day to day use of an adapter see cec-client(1), which offers a great deal more.

If no serial-port is given, the first adapter found by autodetection is used. Any argument that is not recognised as an option is taken to be the port.

Unless -t says otherwise the client registers itself on the bus as a recording device named CEC tester. It does not become the active source on its own; use the as command for that.

OPTIONS

-d, --log-level level
    Set the libCEC log level, as the sum of the levels wanted: 1 error, 2 warning, 4 notice, 8 traffic, 16 debug, 31 all. Values outside 1-31 are rejected with a diagnostic and the default is kept.

-t, --type type
    Register as the given device type: p playback device, r recording device, t tuner, a audio system, x TV. The default is r.

-o, --osd-name name
    Use name as the OSD name shown to other devices on the bus instead of CEC tester.

-p, --port number
    The HDMI port number the adapter is connected to, 1 to 15. Values outside that range are clamped.

-b, --base address
    The logical address of the device the adapter is connected to, as a number.

-r, --rom
    Take the configuration from the adapter's EEPROM rather than from the command line.

-m, --monitor
    Start in monitor-only mode, watching the bus without claiming a logical address or replying to anything.

-i, --info
    Print the libCEC version and library information, then exit.

-l, --list-devices
    List the CEC adapters found on this system, then exit.

-s, --single-command
    Suppress the progress and banner output, so only the result of the command is printed. Intended for scripts.

-c, --command command
    Run a single command from the list below and exit, rather than reading commands from standard input. Implies -s.

-h, --help
    Print a usage summary listing the options and commands, then exit.

COMMANDS
Commands are read from standard input, one per line, and may also be given with -c. Each is matched by prefix, so any longer word starting with one of these is treated as that command.

as  Broadcast an active source message, making this device the active source. With -s the client then waits up to 15 seconds for the switch to complete.

ea  Ask the audio system to turn system audio mode on.

da  Ask the audio system to turn system audio mode off.

gas Print the audio system's audio status, in hexadecimal.

gsam
    Print whether system audio mode is on.

scan
    Scan the bus and print, for every device found, its logical and physical address, vendor, CEC version, OSD name, power status, and whether it is the active source.

q, quit
    Exit.

EXIT STATUS
cecc-client exits 0 on success, and 1 if no adapter could be detected or the adapter could not be opened.

EXAMPLES
Check that the installed shared library can be loaded through the C API and report its version:

    cecc-client -i

List the devices on the bus in a script, printing nothing else:

    cecc-client -s -c scan

SEE ALSO
cec-client(1), pyCecClient(1)

The libCEC API documentation is published at https://pulse-eight.github.io/libcec/.

AUTHOR
libCEC and its C example client are Copyright (C) 2011-2015 Pulse-Eight Limited.

This manual page was written for the Debian project, and may be used by others.