1CEC-CTL(1) User Commands CEC-CTL(1)
2
6 cec-ctl - An application to control cec devices
7
9 cec-ctl [-h] [-d <dev>] [many other options]
10
12 The cec-ctl tool is used to control cec devices. It is able to control
13 almost any aspect of such devices covering the full CEC API.
14
17 -d, --device <dev>
18 Use device <dev> as the CEC device. If <dev> is a number, then
19 /dev/cec<dev> is used.
20 -v, --verbose
22 Turn on verbose reporting.
23 -w, --wall-clock
25 Show timestamps as wall-clock time. This also turns on verbose
26 reporting.
27 -h, --help
29 Prints the help message.
30 -p, --phys-addr <addr>
32 Use this physical address. The address can be a number (e.g. 0
33 or 0x11b1) or formatted as a.b.c.d where each component is a hex
34 value from 0-f (e.g. 0.0.0.0 or 1.1.b.1).
35 -o, --osd-name <name>
37 Use this OSD name. The maximum length is 14 characters.
38 -V, --vendor-id <id>
40 Use this vendor ID. The vendor ID is a number from 0x0 to
41 0xffffff.
42 -l, --logical-address
44 Show first configured logical address or nothing if the device
45 is unconfigured. Useful for scripts, e.g.: la=`cec-ctl -s -l`
46 -L, --logical-addresses
48 Show all configured logical addresses or nothing if the device
49 is unconfigured. Useful for scripts, e.g.: las=`cec-ctl -s -L`
50 -C, --clear
52 Clear all logical addresses, leaving the CEC device unconfig‐
53 ured.
54 -n, --no-reply
56 By default when sending a CEC message that expects a reply this
57 utility will wait for that reply. With this option it will just
58 send it without waiting for the reply. This option applies to
59 the messages following this option. It acts as a toggle, so
60 after you specify it a second time then the following messages
61 will wait for a reply again.
62 -N, --non-blocking
64 Transmit messages in non-blocking mode.
65 -t, --to <la>
67 Send the message to the given logical address (0-15).
68 -f, --from <la>
70 Send message from the given logical address. It is only neces‐
71 sary to use this option if multiple logical addresses are
72 claimed. By default the first assigned logical address will be
73 used.
74 -r, --show-raw
76 Show the raw CEC message in hex.
77 -s, --skip-info
79 Skip the Driver Info output section.
80 -S, --show-topology
82 Show the CEC topology, detecting which other CEC devices are on
83 the CEC bus.
84 -P, --poll
86 Send a poll message.
87 -T, --trace
89 Trace all called ioctls. Useful for debugging.
90 --cec-version-1.4
92 Use CEC Version 1.4 instead of 2.0 (the default).
93 --allow-unreg-fallback
95 Allow fallback to Unregistered if all logical addresses are
96 claimed. By default the adapter will remain unconfigured.
97 --no-rc-passthrough
99 Disable the RC passthrough. By default remote control CEC mes‐
100 sages are passed on as input keystrokes (the
101 CEC_LOG_ADDRS_FL_ALLOW_RC_PASSTHRU flag is set when calling the
102 CEC_ADAP_S_LOG_ADDRS ioctl), but this can be blocked by using
103 this option.
104 --reply-to-followers
106 The reply will be sent to followers as well. By default the
107 reply will only go to the follower that initiated the CEC mes‐
108 sage. But if you have other followers running as well, then by
109 giving this option they will also receive the reply.
110 --timeout <ms>
112 Set the reply timeout in milliseconds (default is 1000 ms).
113 --list-ui-commands
115 List all UI commands that can be used with option --con‐
116 trol-pressed.
117 --tv Configure the CEC adapter as a TV.
119 --record
121 Configure the CEC adapter as a recording and playback device.
122 --tuner
124 Configure the CEC adapter as a tuner device.
125 --playback
127 Configure the CEC adapter as a playback device.
128 --audio
130 Configure the CEC adapter as an audio system device.
131 --processor
133 Configure the CEC adapter as a processor device.
134 --switch
136 Configure the CEC adapter as a pure CEC switch.
137 --cdc-only
139 Configure the CEC adapter as a CDC-only device.
140 --unregistered
142 Configure the CEC adapter as an unregistered device.
143 --feat-record-tv-screen Signal the Record TV Screen feature.
144 --feat-set-osd-string
146 Signal the Set OSD String feature.
147 --feat-deck-control
149 Signal the Deck Control feature.
150 --feat-set-audio-rate
152 Signal the Set Audio Rate feature.
153 --feat-sink-has-arc-tx
155 Signal the sink ARC Tx feature.
156 --feat-source-has-arc-rx
158 Signal the source ARC Rx feature.
159 --rc-tv-profile-1
161 Signal RC TV Profile 1.
162 --rc-tv-profile-2
164 Signal RC TV Profile 2.
165 --rc-tv-profile-3
167 Signal RC TV Profile 3.
168 --rc-tv-profile-4
170 Signal RC TV Profile 4.
171 --rc-src-dev-root
173 Signal that the RC source has a Dev Root Menu.
174 --rc-src-dev-setup
176 Signal that the RC source has a Dev Setup Menu.
177 --rc-src-contents
179 Signal that the RC source has a Contents Menu.
180 --rc-src-media-top
182 Signal that the RC source has a Media Top Menu.
183 --rc-src-media-context
185 Signal that the RC source has a Media Context Menu.
186 -m, --monitor
188 Start monitoring CEC traffic. This will monitor broadcast mes‐
189 sages, messages directed to this CEC adapter and messages trans‐
190 mitted by this CEC adapter. Directed messages between other CEC
191 devices are not monitored. This option requires root.
192 -M, --monitor-all
194 Start monitoring all CEC traffic. This will monitor all CEC mes‐
195 sages, including directed messages between other CEC devices.
196 This option requires root. Not all CEC devices support this
197 monitoring mode. It will fallback to regular monitoring mode if
198 it is not supported.
199 --monitor-pin
201 Start monitoring and analyzing the low-level CEC pin transi‐
202 tions. This is only possible if the device has the CEC_CAP_MONI‐
203 TOR_PIN capability. This option requires root. When in pin mon‐
204 itoring mode all 0->1 and 1->0 CEC pin transitions are monitored
205 and analysed. This is effectively a cheap CEC bus analyzer.
206 --monitor-time <secs>
208 Monitor for the given number of seconds, then exit. The default
209 (0) is to monitor forever.
210 --ignore <la>,<opcode>
212 Ignore messages from logical address <la> and opcode <opcode>
213 when monitoring. "all" can be used for <la> or <opcode> to
214 match all logical addresses or opcodes. To ignore poll messages
215 use "poll" as <opcode>.
216 --store-pin <to>
218 Store the CEC pin events to the given file. This can be read and
219 analyzed later via the --analyze-pin option. Use - to write to
220 stdout instead of to a file.
221 --analyze-pin <from>
223 Read and analyze the CEC pin events from the given file. Use -
224 to read from stdin instead of from a file.
225 --help-all
227 Prints the help message for all options.
228 --help-audio-rate-control
230 Show help for the Audio Rate Control feature.
231 --help-audio-return-channel-control
233 Show help for the Audio Return Channel Control feature.
234 --help-capability-discovery-and-control
236 Show help for the Capability Discovery and Control feature.
237 --help-deck-control
239 Show help for the Deck Control feature.
240 --help-device-menu-control
242 Show help for the Device Menu Control feature.
243 --help-device-osd-transfer
245 Show help for the Device OSD Transfer feature.
246 --help-dynamic-audio-lipsync
248 Show help for the Dynamic Audio Lipsync feature.
249 --help-htng
251 Show help for the Hospitality Profile Next Generation feature.
252 This is an optional CEC extension for Hotel displays and is not
253 generally available for regular displays. See
254 http://www.htng.org for more information.
255 --help-osd-display
257 Show help for the OSD Display feature.
258 --help-one-touch-play
260 Show help for the One Touch Play feature.
261 --help-one-touch-record
263 Show help for the One Touch Record feature.
264 --help-power-status
266 Show help for the Power Status feature.
267 --help-remote-control-passthrough
269 Show help for the Remote Control Passthrough feature.
270 --help-routing-control
272 Show help for the Routing Control feature.
273 --help-standby
275 Show help for the Standby feature.
276 --help-system-audio-control
278 Show help for the System Audio Control feature.
279 --help-system-information
281 Show help for the System Information feature.
282 --help-timer-programming
284 Show help for the Timer Programming feature.
285 --help-tuner-control
287 Show help for the Tuner Control feature.
288 --help-vendor-specific-commands
290 Show help for the Vendor Specific Commands feature.
291
293 On success, it returns 0. Otherwise, it will return the error code.
294
296 This manual page is a work in progress.
297 Bug reports or questions about this utility should be sent to the
299 linux-media@vger.kernel.org mailinglist.
300v4l-utils 1.16.5 August 2016 CEC-CTL(1)