]> git.basschouten.com Git - openhab-addons.git/blob
6c6277497640fe06bd753e0a57f26bec00f2aba1
[openhab-addons.git] /
1 /**
2  * Copyright (c) 2010-2021 Contributors to the openHAB project
3  *
4  * See the NOTICE file(s) distributed with this work for additional
5  * information.
6  *
7  * This program and the accompanying materials are made available under the
8  * terms of the Eclipse Public License 2.0 which is available at
9  * http://www.eclipse.org/legal/epl-2.0
10  *
11  * SPDX-License-Identifier: EPL-2.0
12  */
13 package org.openhab.binding.epsonprojector.internal;
14
15 import java.time.Duration;
16 import java.util.concurrent.ScheduledExecutorService;
17 import java.util.concurrent.ScheduledFuture;
18 import java.util.concurrent.TimeUnit;
19
20 import org.eclipse.jdt.annotation.NonNullByDefault;
21 import org.eclipse.jdt.annotation.Nullable;
22 import org.openhab.binding.epsonprojector.internal.configuration.EpsonProjectorConfiguration;
23 import org.openhab.binding.epsonprojector.internal.connector.EpsonProjectorConnector;
24 import org.openhab.binding.epsonprojector.internal.connector.EpsonProjectorSerialConnector;
25 import org.openhab.binding.epsonprojector.internal.connector.EpsonProjectorTcpConnector;
26 import org.openhab.binding.epsonprojector.internal.enums.AspectRatio;
27 import org.openhab.binding.epsonprojector.internal.enums.Background;
28 import org.openhab.binding.epsonprojector.internal.enums.ColorMode;
29 import org.openhab.binding.epsonprojector.internal.enums.ErrorMessage;
30 import org.openhab.binding.epsonprojector.internal.enums.Gamma;
31 import org.openhab.binding.epsonprojector.internal.enums.Luminance;
32 import org.openhab.binding.epsonprojector.internal.enums.PowerStatus;
33 import org.openhab.binding.epsonprojector.internal.enums.Switch;
34 import org.openhab.core.cache.ExpiringCache;
35 import org.openhab.core.io.transport.serial.SerialPortManager;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
38
39 /**
40  * Provide high level interface to Epson projector.
41  *
42  * @author Pauli Anttila - Initial contribution
43  * @author Yannick Schaus - Refactoring
44  * @author Michael Lobstein - Improvements for OH3
45  */
46 @NonNullByDefault
47 public class EpsonProjectorDevice {
48     private static final int[] MAP64 = new int[] { 0, 3, 7, 11, 15, 19, 23, 27, 31, 35, 39, 43, 47, 51, 55, 59, 63, 66,
49             70, 74, 78, 82, 86, 90, 94, 98, 102, 106, 110, 114, 118, 122, 126, 129, 133, 137, 141, 145, 149, 153, 157,
50             161, 165, 169, 173, 177, 181, 185, 189, 192, 196, 200, 204, 208, 212, 216, 220, 224, 228, 232, 236, 240,
51             244, 248, 252 };
52
53     private static final int[] MAP60 = new int[] { 0, 4, 8, 12, 16, 20, 25, 29, 33, 37, 41, 46, 50, 54, 58, 62, 67, 71,
54             75, 79, 83, 88, 92, 96, 100, 104, 109, 113, 117, 121, 125, 130, 134, 138, 142, 146, 151, 155, 159, 163, 167,
55             172, 176, 180, 184, 188, 193, 197, 201, 205, 209, 214, 218, 222, 226, 230, 235, 239, 243, 247, 251 };
56
57     private static final int[] MAP49 = new int[] { 0, 5, 10, 15, 20, 25, 30, 35, 40, 46, 51, 56, 61, 66, 71, 76, 81, 87,
58             92, 97, 102, 107, 112, 117, 122, 128, 133, 138, 143, 148, 153, 158, 163, 168, 174, 179, 184, 189, 194, 199,
59             204, 209, 215, 220, 225, 230, 235, 240, 245, 250 };
60
61     private static final int[] MAP48 = new int[] { 0, 5, 10, 15, 20, 26, 31, 36, 41, 47, 52, 57, 62, 67, 73, 78, 83, 88,
62             94, 99, 104, 109, 114, 120, 125, 130, 135, 141, 146, 151, 156, 161, 167, 172, 177, 182, 188, 193, 198, 203,
63             208, 214, 219, 224, 229, 235, 240, 245, 250 };
64
65     private static final int[] MAP40 = new int[] { 0, 6, 12, 18, 24, 31, 37, 43, 49, 56, 62, 68, 74, 81, 87, 93, 99,
66             106, 112, 118, 124, 131, 137, 143, 149, 156, 162, 168, 174, 181, 187, 193, 199, 206, 212, 218, 224, 231,
67             237, 243, 249 };
68
69     private static final int[] MAP20 = new int[] { 0, 12, 24, 36, 48, 60, 73, 85, 97, 109, 121, 134, 146, 158, 170, 182,
70             195, 207, 219, 231, 243 };
71
72     private static final int[] MAP18 = new int[] { 0, 13, 26, 40, 53, 67, 80, 94, 107, 121, 134, 148, 161, 175, 188,
73             202, 215, 229, 242 };
74
75     private static final int[] MAP_COLOR_TEMP = new int[] { 0, 25, 51, 76, 102, 128, 153, 179, 204, 230 };
76     private static final int[] MAP_FLESH_COLOR = new int[] { 0, 36, 73, 109, 146, 182, 219 };
77
78     private static final int DEFAULT_TIMEOUT = 5 * 1000;
79     private static final int POWER_ON_TIMEOUT = 100 * 1000;
80     private static final int POWER_OFF_TIMEOUT = 130 * 1000;
81     private static final int LAMP_REFRESH_WAIT_MINUTES = 5;
82
83     private static final String ON = "ON";
84     private static final String ERR = "ERR";
85     private static final String IMEVENT = "IMEVENT";
86
87     private final Logger logger = LoggerFactory.getLogger(EpsonProjectorDevice.class);
88
89     private @Nullable ScheduledExecutorService scheduler = null;
90     private @Nullable ScheduledFuture<?> timeoutJob;
91
92     private EpsonProjectorConnector connection;
93     private ExpiringCache<Integer> cachedLampHours = new ExpiringCache<>(Duration.ofMinutes(LAMP_REFRESH_WAIT_MINUTES),
94             this::queryLamp);
95     private boolean connected = false;
96     private boolean ready = true;
97
98     public EpsonProjectorDevice(SerialPortManager serialPortManager, EpsonProjectorConfiguration config) {
99         connection = new EpsonProjectorSerialConnector(serialPortManager, config.serialPort);
100     }
101
102     public EpsonProjectorDevice(EpsonProjectorConfiguration config) {
103         connection = new EpsonProjectorTcpConnector(config.host, config.port);
104     }
105
106     public boolean isReady() {
107         return ready;
108     }
109
110     public void setScheduler(ScheduledExecutorService scheduler) {
111         this.scheduler = scheduler;
112     }
113
114     private synchronized @Nullable String sendQuery(String query, int timeout)
115             throws EpsonProjectorCommandException, EpsonProjectorException {
116         logger.debug("Query: '{}'", query);
117         String response = connection.sendMessage(query, timeout);
118
119         if (response.length() == 0) {
120             throw new EpsonProjectorException("No response received");
121         }
122
123         response = response.replace("\r:", "");
124         logger.debug("Response: '{}'", response);
125
126         if (ERR.equals(response) || response.startsWith(IMEVENT)) {
127             throw new EpsonProjectorCommandException("Error response received for command: " + query);
128         }
129
130         if ("PWR OFF".equals(query) && ":".equals(response)) {
131             // When PWR OFF command is sent, next command can be sent 10 seconds after the colon is received
132             logger.debug("Refusing further commands for 10 seconds to power OFF completion");
133             ready = false;
134             ScheduledExecutorService scheduler = this.scheduler;
135             if (scheduler != null) {
136                 timeoutJob = scheduler.schedule(() -> {
137                     ready = true;
138                 }, 10, TimeUnit.SECONDS);
139             }
140         }
141
142         return response;
143     }
144
145     private String splitResponse(@Nullable String response)
146             throws EpsonProjectorCommandException, EpsonProjectorException {
147         if (response != null && !"".equals(response)) {
148             String[] pieces = response.split("=");
149
150             if (pieces.length < 2) {
151                 throw new EpsonProjectorCommandException("Invalid response from projector: " + response);
152             }
153
154             return pieces[1].trim();
155         } else {
156             throw new EpsonProjectorException("No response received");
157         }
158     }
159
160     protected void sendCommand(String command, int timeout)
161             throws EpsonProjectorCommandException, EpsonProjectorException {
162         sendQuery(command, timeout);
163     }
164
165     protected void sendCommand(String command) throws EpsonProjectorCommandException, EpsonProjectorException {
166         sendCommand(command, DEFAULT_TIMEOUT);
167     }
168
169     protected int queryInt(String query, int timeout, int radix)
170             throws EpsonProjectorCommandException, EpsonProjectorException {
171         String response = sendQuery(query, timeout);
172
173         String str = splitResponse(response);
174
175         // if the response has two number groups, get the first one (Aspect Ratio does this)
176         if (str.contains(" ")) {
177             String[] subStr = str.split(" ");
178             str = subStr[0];
179         }
180
181         return Integer.parseInt(str, radix);
182     }
183
184     protected int queryInt(String query, int timeout) throws EpsonProjectorCommandException, EpsonProjectorException {
185         return queryInt(query, timeout, 10);
186     }
187
188     protected int queryInt(String query) throws EpsonProjectorCommandException, EpsonProjectorException {
189         return queryInt(query, DEFAULT_TIMEOUT, 10);
190     }
191
192     protected int queryHexInt(String query, int timeout)
193             throws EpsonProjectorCommandException, EpsonProjectorException {
194         return queryInt(query, timeout, 16);
195     }
196
197     protected int queryHexInt(String query) throws EpsonProjectorCommandException, EpsonProjectorException {
198         return queryInt(query, DEFAULT_TIMEOUT, 16);
199     }
200
201     protected String queryString(String query) throws EpsonProjectorCommandException, EpsonProjectorException {
202         String response = sendQuery(query, DEFAULT_TIMEOUT);
203         return splitResponse(response);
204     }
205
206     public void connect() throws EpsonProjectorException {
207         connection.connect();
208         connected = true;
209     }
210
211     public void disconnect() throws EpsonProjectorException {
212         connection.disconnect();
213         connected = false;
214         ready = true;
215         ScheduledFuture<?> timeoutJob = this.timeoutJob;
216         if (timeoutJob != null) {
217             timeoutJob.cancel(true);
218             this.timeoutJob = null;
219         }
220     }
221
222     public boolean isConnected() {
223         return connected;
224     }
225
226     /*
227      * Power
228      */
229     public PowerStatus getPowerStatus() throws EpsonProjectorCommandException, EpsonProjectorException {
230         int val = queryInt("PWR?");
231         return PowerStatus.forValue(val);
232     }
233
234     public void setPower(Switch value) throws EpsonProjectorCommandException, EpsonProjectorException {
235         sendCommand(String.format("PWR %s", value.name()), value == Switch.ON ? POWER_ON_TIMEOUT : POWER_OFF_TIMEOUT);
236     }
237
238     /*
239      * Key code
240      */
241     public void sendKeyCode(String value) throws EpsonProjectorCommandException, EpsonProjectorException {
242         sendCommand(String.format("KEY %s", value));
243     }
244
245     /*
246      * Vertical Keystone
247      */
248     public int getVerticalKeystone() throws EpsonProjectorCommandException, EpsonProjectorException {
249         int vkey = queryInt("VKEYSTONE?");
250         for (int i = 0; i < MAP60.length; i++) {
251             if (vkey == MAP60[i]) {
252                 return i - 30;
253             }
254         }
255         return 0;
256     }
257
258     public void setVerticalKeystone(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
259         value = value + 30;
260         if (value >= 0 && value <= 60) {
261             sendCommand(String.format("VKEYSTONE %d", MAP60[value]));
262         }
263     }
264
265     /*
266      * Horizontal Keystone
267      */
268     public int getHorizontalKeystone() throws EpsonProjectorCommandException, EpsonProjectorException {
269         int hkey = queryInt("HKEYSTONE?");
270         for (int i = 0; i < MAP60.length; i++) {
271             if (hkey == MAP60[i]) {
272                 return i - 30;
273             }
274         }
275         return 0;
276     }
277
278     public void setHorizontalKeystone(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
279         value = value + 30;
280         if (value >= 0 && value <= 60) {
281             sendCommand(String.format("HKEYSTONE %d", MAP60[value]));
282         }
283     }
284
285     /*
286      * Auto Keystone
287      */
288
289     public Switch getAutoKeystone() throws EpsonProjectorCommandException, EpsonProjectorException {
290         String val = queryString("AUTOKEYSTONE?");
291         return val.equals(ON) ? Switch.ON : Switch.OFF;
292     }
293
294     public void setAutoKeystone(Switch value) throws EpsonProjectorCommandException, EpsonProjectorException {
295         sendCommand(String.format("AUTOKEYSTONE %s", value.name()), DEFAULT_TIMEOUT);
296     }
297
298     /*
299      * Freeze
300      */
301     public Switch getFreeze() throws EpsonProjectorCommandException, EpsonProjectorException {
302         String val = queryString("FREEZE?");
303         return val.equals(ON) ? Switch.ON : Switch.OFF;
304     }
305
306     public void setFreeze(Switch value) throws EpsonProjectorCommandException, EpsonProjectorException {
307         sendCommand(String.format("FREEZE %s", value.name()), DEFAULT_TIMEOUT);
308     }
309
310     /*
311      * Aspect Ratio
312      */
313     public AspectRatio getAspectRatio() throws EpsonProjectorCommandException, EpsonProjectorException {
314         int val = queryHexInt("ASPECT?");
315         return AspectRatio.forValue(val);
316     }
317
318     public void setAspectRatio(AspectRatio value) throws EpsonProjectorCommandException, EpsonProjectorException {
319         sendCommand(String.format("ASPECT %02X", value.toInt()));
320     }
321
322     /*
323      * Luminance
324      */
325     public Luminance getLuminance() throws EpsonProjectorCommandException, EpsonProjectorException {
326         int val = queryHexInt("LUMINANCE?");
327         return Luminance.forValue(val);
328     }
329
330     public void setLuminance(Luminance value) throws EpsonProjectorCommandException, EpsonProjectorException {
331         sendCommand(String.format("LUMINANCE %02X", value.toInt()));
332     }
333
334     /*
335      * Source
336      */
337     public String getSource() throws EpsonProjectorCommandException, EpsonProjectorException {
338         return queryString("SOURCE?");
339     }
340
341     public void setSource(String value) throws EpsonProjectorCommandException, EpsonProjectorException {
342         sendCommand(String.format("SOURCE %s", value));
343     }
344
345     /*
346      * Brightness
347      */
348     public int getBrightness() throws EpsonProjectorCommandException, EpsonProjectorException {
349         int brt = queryInt("BRIGHT?");
350         for (int i = 0; i < MAP48.length; i++) {
351             if (brt == MAP48[i]) {
352                 return i - 24;
353             }
354         }
355         return 0;
356     }
357
358     public void setBrightness(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
359         value = value + 24;
360         if (value >= 0 && value <= 48) {
361             sendCommand(String.format("BRIGHT %d", MAP48[value]));
362         }
363     }
364
365     /*
366      * Contrast
367      */
368     public int getContrast() throws EpsonProjectorCommandException, EpsonProjectorException {
369         int con = queryInt("CONTRAST?");
370         for (int i = 0; i < MAP48.length; i++) {
371             if (con == MAP48[i]) {
372                 return i - 24;
373             }
374         }
375         return 0;
376     }
377
378     public void setContrast(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
379         value = value + 24;
380         if (value >= 0 && value <= 48) {
381             sendCommand(String.format("CONTRAST %d", MAP48[value]));
382         }
383     }
384
385     /*
386      * Density
387      */
388     public int getDensity() throws EpsonProjectorCommandException, EpsonProjectorException {
389         int den = queryInt("DENSITY?");
390         for (int i = 0; i < MAP64.length; i++) {
391             if (den == MAP64[i]) {
392                 return i - 32;
393             }
394         }
395         return 0;
396     }
397
398     public void setDensity(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
399         value = value + 32;
400         if (value >= 0 && value <= 64) {
401             sendCommand(String.format("DENSITY %d", MAP64[value]));
402         }
403     }
404
405     /*
406      * Tint
407      */
408     public int getTint() throws EpsonProjectorCommandException, EpsonProjectorException {
409         int tint = queryInt("TINT?");
410         for (int i = 0; i < MAP64.length; i++) {
411             if (tint == MAP64[i]) {
412                 return i - 32;
413             }
414         }
415         return 0;
416     }
417
418     public void setTint(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
419         value = value + 32;
420         if (value >= 0 && value <= 64) {
421             sendCommand(String.format("TINT %d", MAP64[value]));
422         }
423     }
424
425     /*
426      * Color Temperature
427      */
428     public int getColorTemperature() throws EpsonProjectorCommandException, EpsonProjectorException {
429         int ctemp = queryInt("CTEMP?");
430         for (int i = 0; i < MAP_COLOR_TEMP.length; i++) {
431             if (ctemp == MAP_COLOR_TEMP[i]) {
432                 return i;
433             }
434         }
435         return 0;
436     }
437
438     public void setColorTemperature(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
439         if (value >= 0 && value <= 9) {
440             sendCommand(String.format("CTEMP %d", MAP_COLOR_TEMP[value]));
441         }
442     }
443
444     /*
445      * Flesh Color
446      */
447     public int getFleshColor() throws EpsonProjectorCommandException, EpsonProjectorException {
448         int fclr = queryInt("FCOLOR?");
449         for (int i = 0; i < MAP_FLESH_COLOR.length; i++) {
450             if (fclr == MAP_FLESH_COLOR[i]) {
451                 return i;
452             }
453         }
454         return 0;
455     }
456
457     public void setFleshColor(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
458         if (value >= 0 && value <= 6) {
459             sendCommand(String.format("FCOLOR %d", MAP_FLESH_COLOR[value]));
460         }
461     }
462
463     /*
464      * Color Mode
465      */
466     public ColorMode getColorMode() throws EpsonProjectorCommandException, EpsonProjectorException {
467         int val = queryHexInt("CMODE?");
468         return ColorMode.forValue(val);
469     }
470
471     public void setColorMode(ColorMode value) throws EpsonProjectorCommandException, EpsonProjectorException {
472         sendCommand(String.format("CMODE %02X", value.toInt()));
473     }
474
475     /*
476      * Horizontal Position
477      */
478     public int getHorizontalPosition() throws EpsonProjectorCommandException, EpsonProjectorException {
479         int hpos = queryInt("HPOS?");
480         for (int i = 0; i < MAP49.length; i++) {
481             if (hpos == MAP49[i]) {
482                 return i - 23;
483             }
484         }
485         return 0;
486     }
487
488     public void setHorizontalPosition(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
489         value = value + 23;
490         if (value >= 0 && value <= 49) {
491             sendCommand(String.format("HPOS %d", MAP49[value]));
492         }
493     }
494
495     /*
496      * Vertical Position
497      */
498     public int getVerticalPosition() throws EpsonProjectorCommandException, EpsonProjectorException {
499         int vpos = queryInt("VPOS?");
500         for (int i = 0; i < MAP18.length; i++) {
501             if (vpos == MAP18[i]) {
502                 return i - 8;
503             }
504         }
505         return 0;
506     }
507
508     public void setVerticalPosition(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
509         value = value + 8;
510         if (value >= 0 && value <= 18) {
511             sendCommand(String.format("VPOS %d", MAP18[value]));
512         }
513     }
514
515     /*
516      * Gamma
517      */
518     public Gamma getGamma() throws EpsonProjectorCommandException, EpsonProjectorException {
519         int val = queryHexInt("GAMMA?");
520         return Gamma.forValue(val);
521     }
522
523     public void setGamma(Gamma value) throws EpsonProjectorCommandException, EpsonProjectorException {
524         sendCommand(String.format("GAMMA %02X", value.toInt()));
525     }
526
527     /*
528      * Volume
529      */
530     public int getVolume(int maxVolume) throws EpsonProjectorCommandException, EpsonProjectorException {
531         int vol = this.queryInt("VOL?");
532         switch (maxVolume) {
533             case 20:
534                 return this.getMappingValue(MAP20, vol);
535             case 40:
536                 return this.getMappingValue(MAP40, vol);
537         }
538         return 0;
539     }
540
541     private int getMappingValue(int[] map, int value) {
542         for (int i = 0; i < map.length; i++) {
543             if (value == map[i]) {
544                 return i;
545             }
546         }
547         return 0;
548     }
549
550     public void setVolume(int value, int maxVolume) throws EpsonProjectorCommandException, EpsonProjectorException {
551         if (value >= 0 && value <= maxVolume) {
552             switch (maxVolume) {
553                 case 20:
554                     this.sendCommand(String.format("VOL %d", MAP20[value]));
555                     return;
556                 case 40:
557                     this.sendCommand(String.format("VOL %d", MAP40[value]));
558                     return;
559             }
560         }
561     }
562
563     /*
564      * AV Mute
565      */
566     public Switch getMute() throws EpsonProjectorCommandException, EpsonProjectorException {
567         String val = queryString("MUTE?");
568         return val.equals(ON) ? Switch.ON : Switch.OFF;
569     }
570
571     public void setMute(Switch value) throws EpsonProjectorCommandException, EpsonProjectorException {
572         sendCommand(String.format("MUTE %s", value.name()));
573     }
574
575     /*
576      * Horizontal Reverse
577      */
578     public Switch getHorizontalReverse() throws EpsonProjectorCommandException, EpsonProjectorException {
579         String val = queryString("HREVERSE?");
580         return val.equals(ON) ? Switch.ON : Switch.OFF;
581     }
582
583     public void setHorizontalReverse(Switch value) throws EpsonProjectorCommandException, EpsonProjectorException {
584         sendCommand(String.format("HREVERSE %s", value.name()));
585     }
586
587     /*
588      * Vertical Reverse
589      */
590     public Switch getVerticalReverse() throws EpsonProjectorCommandException, EpsonProjectorException {
591         String val = queryString("VREVERSE?");
592         return val.equals(ON) ? Switch.ON : Switch.OFF;
593     }
594
595     public void setVerticalReverse(Switch value) throws EpsonProjectorCommandException, EpsonProjectorException {
596         sendCommand(String.format("VREVERSE %s", value.name()));
597     }
598
599     /*
600      * Background Select for AV Mute
601      */
602     public Background getBackground() throws EpsonProjectorCommandException, EpsonProjectorException {
603         int val = queryHexInt("MSEL?");
604         return Background.forValue(val);
605     }
606
607     public void setBackground(Background value) throws EpsonProjectorCommandException, EpsonProjectorException {
608         sendCommand(String.format("MSEL %02X", value.toInt()));
609     }
610
611     /*
612      * Lamp Time (hours) - get from cache
613      */
614     public int getLampTime() throws EpsonProjectorCommandException, EpsonProjectorException {
615         Integer lampHours = cachedLampHours.getValue();
616
617         if (lampHours != null) {
618             return lampHours.intValue();
619         } else {
620             throw new EpsonProjectorCommandException("cachedLampHours returned null");
621         }
622     }
623
624     /*
625      * Get Lamp Time
626      */
627     private @Nullable Integer queryLamp() {
628         try {
629             return Integer.valueOf(queryInt("LAMP?"));
630         } catch (EpsonProjectorCommandException | EpsonProjectorException e) {
631             logger.debug("Error executing command LAMP?", e);
632             return null;
633         }
634     }
635
636     /*
637      * Error Code
638      */
639     public int getError() throws EpsonProjectorCommandException, EpsonProjectorException {
640         return queryHexInt("ERR?");
641     }
642
643     /*
644      * Error Code Description
645      */
646     public String getErrorString() throws EpsonProjectorCommandException, EpsonProjectorException {
647         int err = queryInt("ERR?");
648         return ErrorMessage.forCode(err);
649     }
650 }