forked from rockowitz/rockowitz.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
583 lines (447 loc) · 19.1 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="ddcutil (formerly ddctool) is a Linux utility for reading and changing monitor settings such as brightness and color levels. ddcutil primarily uses DDC/CI (Display Data Channel Command Interface) to communicate with monitors implementing MCCS (Monitor Control Command Set) over I2C. Alternatively, there is support for monitors (such as Eizo Coloredge) that implement MCCS using a USB connection.">
<meta name="author" content="Sanford Rockowitz">
<title>ddcutil Documentation</title>
<link rel="shortcut icon" href="./img/favicon.ico">
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="./css/theme.css" type="text/css" />
<link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="./css/highlight.css">
<script>
// Current page data
var mkdocs_page_name = "None";
var mkdocs_page_input_path = "index.md";
var mkdocs_page_url = "/";
</script>
<script src="./js/jquery-2.1.1.min.js"></script>
<script src="./js/modernizr-2.8.3.min.js"></script>
<script type="text/javascript" src="./js/highlight.pack.js"></script>
<script src="./js/theme.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href="." class="icon icon-home"> ddcutil Documentation</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li>
<li class="toctree-l1 current">
<a class="current" href=".">Overview</a>
<ul>
<li class="toctree-l3"><a href="#ddcutil">ddcutil</a></li>
<li><a class="toctree-l4" href="#announcements">Announcements</a></li>
<li><a class="toctree-l4" href="#introduction">Introduction</a></li>
<li><a class="toctree-l4" href="#command-overview">Command Overview</a></li>
<li><a class="toctree-l4" href="#installing-ddcutil-from-prebuilt-packages">Installing ddcutil From Prebuilt Packages</a></li>
<li><a class="toctree-l4" href="#ddcutil-configuration">ddcutil Configuration</a></li>
<li><a class="toctree-l4" href="#installation-diagnostics">Installation Diagnostics</a></li>
<li><a class="toctree-l4" href="#additional-topics">Additional Topics</a></li>
<li><a class="toctree-l4" href="#author">Author</a></li>
</ul>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="mccs_background/">Monitor Control Command Set</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="cmdargs/">Command Arguments</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="cmd_output/">Command Output Examples</a>
</li>
<li>
<li>
<ul class="subnav">
<li><span>Examples</span></li>
<li class="toctree-l1 ">
<a class="" href="vcpinfo_output/">ddcutil vcpinfo example</a>
</li>
<li class="toctree-l1 ">
<a class="" href="detect_verbose_output/">ddcutil detect example</a>
</li>
<li class="toctree-l1 ">
<a class="" href="cap_u3011_verbose_output/">ddcutil capabilities example</a>
</li>
<li class="toctree-l1 ">
<a class="" href="getvcp_known_u3011_output/">ddcutil getvcp example</a>
</li>
</ul>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="colormgt/">Color Management</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="tuning/">Instrumentation and Tuning</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="table_features/">Table Type Features</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="usb/">USB Connected Monitors</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="building/">Building From Source</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="i2c_permissions/">Device Permissions</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="kernel_module/">Kernel Module Configuration</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="nvidia/">Special Nvidia Driver Settings</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="adl/">AMD fglrx Driver</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="virtual_machines/">Virtual Machines</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="raspberry/">Raspberry Pi</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="ddccontrol/">Comparison with ddccontrol</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="monitor_notes/">Notes on specific monitors</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="api_main/">APIs</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="faq/">Frequently Asked Questions</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="prior_announcements/">Announcement History</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="release_notes/">Release Notes</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="todo/">Future Tasks</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="feedback/">Feedback</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="bibliography/">References</a>
</li>
<li>
<li>
<li class="toctree-l1 ">
<a class="" href="acknowledgements/">Acknowledgements</a>
</li>
<li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href=".">ddcutil Documentation</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".">Docs</a> »</li>
<li>Overview</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/rockowitz/ddcutil" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h1 id="ddcutil">ddcutil</h1>
<h2 id="announcements">Announcements</h2>
<p>01 Febrary 2017</p>
<p>Release 0.7.2 fixes a critical bug in release 0.7.1 where insufficient privileges on a /dev/i2c-n device causes program termination.
Additionally there are minor improvements to diagnostic output. </p>
<p>For a complete list of changes and bug fixes, see <a href="release_notes/">Release Notes</a>.
Prior annoucnements can be found <a href="prior_announcements/">here</a>.</p>
<p>27 January 2017</p>
<p>Release 0.7.1 is a maintenance release. There is no need to install it unless you are experiencing problems.</p>
<p>This release introduces the following features:</p>
<ul>
<li>Command option <strong><em>--force-slave-address</em></strong> causes <strong>ddcutil</strong> to attempt to take control of slave addresses
on the I2C bus even if they are in use by another driver. This may aid in certain situations where monitors on
an I2C bus are not properly detected. See <a href="tuning/#force_slave">Instrumentation and Tuning</a>)</li>
</ul>
<p>For a complete list of changes and bug fixes, see <a href="release_notes/">Release Notes</a>.
Prior annoucnements can be found <a href="prior_announcements/">here</a>.</p>
<h2 id="introduction">Introduction</h2>
<p><strong>ddcutil</strong> is a Linux program for querying and changing monitor settings, such as
brightness and color levels. </p>
<p><strong>ddcutil</strong> primarily uses DDC/CI (Display Data Channel Command Interface) to communicate with monitors implementing MCCS
(Monitor Control Command Set) over I2C. Normally, the video driver for the
monitor exposes the I2C channel as devices named /dev/i2c-n. Alternatively, there is support for monitors (such as Eizo ColorEdge displays) that implement MCCS using a USB connection. See <a href="usb/">USB Connected Monitors</a>. </p>
<p>A particular use case for <strong>ddcutil</strong> is as part of color profile management. Monitor
calibration is relative to the monitor color settings currently in effect,
e.g. red gain. ddcutil allows color related settings to be saved at the time
a monitor is calibrated, and then restored when the calibration is applied.</p>
<p>Restrictions:<br />
-<strong>ddcutil</strong> does not support laptop displays, which are controlled using a special API, not I2C. <br />
- Nvidia's proprietary video driver may require special configuration. See
<a href="nvidia/">Special Nvidia Driver Settings</a>. <br />
- Operation with AMD's proprietary video driver fglrx requires a
specially built version of <strong>ddcutil</strong>. See <a href="adl/">Building with ADL Support</a>.<br />
- Reading and writing <strong><em>Table</em></strong> type features is implemented but untested. See <a href="table_features/">Table Features</a> </p>
<h2 id="command-overview">Command Overview</h2>
<p><strong>ddcutil</strong> is a command line program. (A GUI user interface is planned.) <strong>ddcutil</strong> implements
the following subcommands:</p>
<table>
<thead>
<tr>
<th>Subcommand</th>
<th>Function</th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td>detect</td>
<td>report monitors detected</td>
<td></td>
</tr>
<tr>
<td>capabilities</td>
<td>report a monitor's capabilities string</td>
<td></td>
</tr>
<tr>
<td>vcpinfo (feature-code-or-group)</td>
<td>list VCP features codes that ddcutil knows how to interpret</td>
<td></td>
</tr>
<tr>
<td>getvcp feature-code-or-group</td>
<td>report a single VCP feature value, or a group of values</td>
<td></td>
</tr>
<tr>
<td>setvcp feature-code new-value</td>
<td>set a single VCP feature value</td>
<td></td>
</tr>
<tr>
<td>dumpvcp filename</td>
<td>save color related VCP feature values to a file</td>
<td></td>
</tr>
<tr>
<td>loadvcp filename</td>
<td>restore color related VCP feature values from a file</td>
<td></td>
</tr>
<tr>
<td>environment</td>
<td>explore the ddcutil installation environment (other than USB)</td>
<td></td>
</tr>
<tr>
<td>usbenv</td>
<td>explore USB aspects of the ddcutil installation environment</td>
<td></td>
</tr>
<tr>
<td>probe</td>
<td>explore the capabilities string and probe the features of a single monitor</td>
<td></td>
</tr>
<tr>
<td>interrogate</td>
<td>collect maximal information for problem diagnosis</td>
<td></td>
</tr>
<tr>
<td>chkusbmon /dev/hiddevN</td>
<td>used by udev rules to test if a USB device represents a monitor</td>
<td></td>
</tr>
</tbody>
</table>
<p>There is an extensive set of options for tailoring ddcutil operation.
Some are described in this documentation. For a full list of options and detailed documentation for each command,
use the <strong>--help</strong> option or
see the man page:</p>
<pre><code>ddcutil --help
man 1 ddcutil
</code></pre>
<h3 id="monitor-selection">Monitor Selection</h3>
<p>If more than one monitor is attached, the desired monitor can be specified
using any of the following options:</p>
<pre><code>--display <display number>
--bus <i2c bus number>
--adl <iAdapterNumber>.<iDisplayNumber>
--usb <usb bus number>.<usb device number>
--edid <256 character hex string>
--mfg <mfg code> --model <model name> and/or --sn <serial number>
</code></pre>
<p>Notes:<br />
- Monitors under control of AMD's proprietary driver (fglrx) are selected by
adapter number and display number. These numbers are specified on the --adl
option separated by a period, e.g. "--adlno 1.0"<br />
- Any combination of manufacturer code, model name and serial number can be used together to identify a monitor.
The first monitor to satisfy all the specified criteria is selected.
(This behavior differs from releases prior to 0.7 where model name and serial number had to be specified together.)</p>
<p>To see a list of all attached monitors and their associated identifiers:</p>
<pre><code>ddcutil detect
</code></pre>
<h3 id="examples">Examples</h3>
<ul>
<li><a href="vcpinfo_output/">ddcutil vcpinfo</a></li>
<li><a href="detect_verbose_output/">ddcutil detect</a></li>
<li><a href="cap_u3011_verbose_output/">ddcutil capabilities</a></li>
<li><a href="getvcp_known_u3011_output/">ddcutil getvcp</a></li>
</ul>
<h2 id="installing-ddcutil-from-prebuilt-packages">Installing ddcutil From Prebuilt Packages</h2>
<p>Packages for recent Debian, Fedoray, openSUSE, and Ubuntu releases are available for download from the openSUSE Build Service.
Unfortunately, there's not one clean link for downloading OBS packages, so here are several.<br />
- <a href="http://software.opensuse.org/download.html?project=home%3Arockowitz&package=ddcutil">Add repository and download package ddcutil</a>.
This is all you will need if just installing the command line version of ddcutil.<br />
- <a href="http://software.opensuse.org/search?utf8=%E2%9C%93&q=ddcutil&search_devel=true&baseproject=ALL">All ddcutil packages</a>
Packages for both the command line and shared library version of <strong>ddcutil</strong>. Note that the development package is named
<strong>libddcutil-devel</strong> on RPM based distributions (SUSE, Fedora) and <strong>libddcutil-dev</strong> on dpkg based distributions (Debian, Ubuntu).<br />
- <a href="http://download.opensuse.org/repositories/home:/rockowitz/">File system view</a> </p>
<p>For Ubuntu xenial, there's a <a href="https://launchpad.net/~rockowitz/+archive/ubuntu/ddcutil">PPA</a>.
To use it, add the following lines to /etc/apt/sources.list:</p>
<pre><code>deb http://ppa.launchpad.net/rockowitz/ddcutil/ubuntu xenial main
deb-src http://ppa.launchpad.net/rockowitz/ddcutil/ubuntu xenial main
</code></pre>
<p>For other distributions, or if using AMD's proprietary fglrx driver, ddcutil must be <a href="building/">built from source</a>.</p>
<h2 id="ddcutil-configuration"><strong>ddcutil</strong> Configuration</h2>
<p>DDC/CI communication must be enabled on the monitor. This setting can only be changed using the monitor's on screen display.</p>
<p><strong>ddcutil</strong> users require write permission to /dev/i2c-* devices. See <a href="i2c_permissions/">/dev/i2c Permissions</a></p>
<p>If using an open source video driver, kernel module i2c-dev must be loaded. See <a href="kernel_module/">Kernel Module Configuration</a></p>
<p>If using Nvidia's proprietary video driver, special settings may be necessary. See <a href="nvidia/">Special Nvidia Driver Settings</a></p>
<h2 id="installation-diagnostics">Installation Diagnostics</h2>
<p>If ddcutil installs successfully but execution fails, command <code>ddcutil environment</code>
can be used to probe the I2C environment and may provide clues as to the problem.
For USB connected monitors, use command <code>ddcutil usbenvironment</code>.</p>
<h2 id="additional-topics">Additional Topics</h2>
<ul>
<li>
<p><a href="mccs_background/">Monitor Control Command Set</a></p>
</li>
<li>
<p><a href="tuning/">Instrumentation and Tuning</a></p>
</li>
<li>
<p><a href="building/">Building From Source</a></p>
</li>
<li>
<p><a href="adl/">AMD fglrx Driver</a></p>
</li>
<li>
<p><a href="virtual_machines/">Virtual Machines</a></p>
</li>
<li>
<p><a href="ddccontrol/">Comparison with ddccontrol</a></p>
</li>
<li>
<p><a href="todo/">Future Tasks</a></p>
</li>
<li>
<p><a href="feedback/">Feedback</a></p>
</li>
<li>
<p><a href="api_main/">APIs</a></p>
</li>
<li>
<p><a href="bibliography/">References</a></p>
</li>
<li>
<p><a href="acknowledgements/">Acknowledgements</a></p>
</li>
</ul>
<h2 id="author">Author</h2>
<p>Sanford Rockowitz <a href="mailto:rockowitz@minsoft.com">rockowitz@minsoft.com</a></p>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="mccs_background/" class="btn btn-neutral float-right" title="Monitor Control Command Set">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a href="https://github.com/rockowitz/ddcutil" class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span style="margin-left: 15px"><a href="mccs_background/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
</body>
</html>
<!--
MkDocs version : 0.15.3
Build Date UTC : 2017-02-01 13:48:47.427919
-->