2 * Copyright (c) 2010-2021 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
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
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.epsonprojector.internal;
15 import java.time.Duration;
16 import java.util.concurrent.ScheduledExecutorService;
17 import java.util.concurrent.ScheduledFuture;
18 import java.util.concurrent.TimeUnit;
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;
40 * Provide high level interface to Epson projector.
42 * @author Pauli Anttila - Initial contribution
43 * @author Yannick Schaus - Refactoring
44 * @author Michael Lobstein - Improvements for OH3
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,
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 };
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 };
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 };
65 private static final int[] MAP20 = new int[] { 0, 12, 24, 36, 48, 60, 73, 85, 97, 109, 121, 134, 146, 158, 170, 182,
66 195, 207, 219, 231, 243 };
68 private static final int[] MAP18 = new int[] { 0, 13, 26, 40, 53, 67, 80, 94, 107, 121, 134, 148, 161, 175, 188,
71 private static final int[] MAP_COLOR_TEMP = new int[] { 0, 25, 51, 76, 102, 128, 153, 179, 204, 230 };
72 private static final int[] MAP_FLESH_COLOR = new int[] { 0, 36, 73, 109, 146, 182, 219 };
74 private static final int DEFAULT_TIMEOUT = 5 * 1000;
75 private static final int POWER_ON_TIMEOUT = 100 * 1000;
76 private static final int POWER_OFF_TIMEOUT = 130 * 1000;
77 private static final int LAMP_REFRESH_WAIT_MINUTES = 5;
79 private static final String ON = "ON";
80 private static final String ERR = "ERR";
82 private final Logger logger = LoggerFactory.getLogger(EpsonProjectorDevice.class);
84 private @Nullable ScheduledExecutorService scheduler = null;
85 private @Nullable ScheduledFuture<?> timeoutJob;
87 private EpsonProjectorConnector connection;
88 private ExpiringCache<Integer> cachedLampHours = new ExpiringCache<>(Duration.ofMinutes(LAMP_REFRESH_WAIT_MINUTES),
90 private boolean connected = false;
91 private boolean ready = true;
93 public EpsonProjectorDevice(SerialPortManager serialPortManager, EpsonProjectorConfiguration config) {
94 connection = new EpsonProjectorSerialConnector(serialPortManager, config.serialPort);
97 public EpsonProjectorDevice(EpsonProjectorConfiguration config) {
98 connection = new EpsonProjectorTcpConnector(config.host, config.port);
101 public boolean isReady() {
105 public void setScheduler(ScheduledExecutorService scheduler) {
106 this.scheduler = scheduler;
109 private synchronized @Nullable String sendQuery(String query, int timeout)
110 throws EpsonProjectorCommandException, EpsonProjectorException {
111 logger.debug("Query: '{}'", query);
112 String response = connection.sendMessage(query, timeout);
114 if (response.length() == 0) {
115 throw new EpsonProjectorException("No response received");
118 response = response.replace("\r:", "");
119 logger.debug("Response: '{}'", response);
121 if (ERR.equals(response)) {
122 throw new EpsonProjectorCommandException("Error response received for command: " + query);
125 if ("PWR OFF".equals(query) && ":".equals(response)) {
126 // When PWR OFF command is sent, next command can be sent 10 seconds after the colon is received
127 logger.debug("Refusing further commands for 10 seconds to power OFF completion");
129 ScheduledExecutorService scheduler = this.scheduler;
130 if (scheduler != null) {
131 timeoutJob = scheduler.schedule(() -> {
133 }, 10, TimeUnit.SECONDS);
140 private String splitResponse(@Nullable String response)
141 throws EpsonProjectorCommandException, EpsonProjectorException {
142 if (response != null && !"".equals(response)) {
143 String[] pieces = response.split("=");
145 if (pieces.length < 2) {
146 throw new EpsonProjectorCommandException("Invalid response from projector: " + response);
149 return pieces[1].trim();
151 throw new EpsonProjectorException("No response received");
155 protected void sendCommand(String command, int timeout)
156 throws EpsonProjectorCommandException, EpsonProjectorException {
157 sendQuery(command, timeout);
160 protected void sendCommand(String command) throws EpsonProjectorCommandException, EpsonProjectorException {
161 sendCommand(command, DEFAULT_TIMEOUT);
164 protected int queryInt(String query, int timeout, int radix)
165 throws EpsonProjectorCommandException, EpsonProjectorException {
166 String response = sendQuery(query, timeout);
168 String str = splitResponse(response);
170 // if the response has two number groups, get the first one (Aspect Ratio does this)
171 if (str.contains(" ")) {
172 String[] subStr = str.split(" ");
176 return Integer.parseInt(str, radix);
179 protected int queryInt(String query, int timeout) throws EpsonProjectorCommandException, EpsonProjectorException {
180 return queryInt(query, timeout, 10);
183 protected int queryInt(String query) throws EpsonProjectorCommandException, EpsonProjectorException {
184 return queryInt(query, DEFAULT_TIMEOUT, 10);
187 protected int queryHexInt(String query, int timeout)
188 throws EpsonProjectorCommandException, EpsonProjectorException {
189 return queryInt(query, timeout, 16);
192 protected int queryHexInt(String query) throws EpsonProjectorCommandException, EpsonProjectorException {
193 return queryInt(query, DEFAULT_TIMEOUT, 16);
196 protected String queryString(String query) throws EpsonProjectorCommandException, EpsonProjectorException {
197 String response = sendQuery(query, DEFAULT_TIMEOUT);
198 return splitResponse(response);
201 public void connect() throws EpsonProjectorException {
202 connection.connect();
206 public void disconnect() throws EpsonProjectorException {
207 connection.disconnect();
209 ScheduledFuture<?> timeoutJob = this.timeoutJob;
210 if (timeoutJob != null) {
211 timeoutJob.cancel(true);
212 this.timeoutJob = null;
217 public boolean isConnected() {
224 public PowerStatus getPowerStatus() throws EpsonProjectorCommandException, EpsonProjectorException {
225 int val = queryInt("PWR?");
226 return PowerStatus.forValue(val);
229 public void setPower(Switch value) throws EpsonProjectorCommandException, EpsonProjectorException {
230 sendCommand(String.format("PWR %s", value.name()), value == Switch.ON ? POWER_ON_TIMEOUT : POWER_OFF_TIMEOUT);
236 public void sendKeyCode(String value) throws EpsonProjectorCommandException, EpsonProjectorException {
237 sendCommand(String.format("KEY %s", value));
243 public int getVerticalKeystone() throws EpsonProjectorCommandException, EpsonProjectorException {
244 int vkey = queryInt("VKEYSTONE?");
245 for (int i = 0; i < MAP60.length; i++) {
246 if (vkey == MAP60[i]) {
253 public void setVerticalKeystone(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
255 if (value >= 0 && value <= 60) {
256 sendCommand(String.format("VKEYSTONE %d", MAP60[value]));
261 * Horizontal Keystone
263 public int getHorizontalKeystone() throws EpsonProjectorCommandException, EpsonProjectorException {
264 int hkey = queryInt("HKEYSTONE?");
265 for (int i = 0; i < MAP60.length; i++) {
266 if (hkey == MAP60[i]) {
273 public void setHorizontalKeystone(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
275 if (value >= 0 && value <= 60) {
276 sendCommand(String.format("HKEYSTONE %d", MAP60[value]));
284 public Switch getAutoKeystone() throws EpsonProjectorCommandException, EpsonProjectorException {
285 String val = queryString("AUTOKEYSTONE?");
286 return val.equals(ON) ? Switch.ON : Switch.OFF;
289 public void setAutoKeystone(Switch value) throws EpsonProjectorCommandException, EpsonProjectorException {
290 sendCommand(String.format("AUTOKEYSTONE %s", value.name()), DEFAULT_TIMEOUT);
296 public Switch getFreeze() throws EpsonProjectorCommandException, EpsonProjectorException {
297 String val = queryString("FREEZE?");
298 return val.equals(ON) ? Switch.ON : Switch.OFF;
301 public void setFreeze(Switch value) throws EpsonProjectorCommandException, EpsonProjectorException {
302 sendCommand(String.format("FREEZE %s", value.name()), DEFAULT_TIMEOUT);
308 public AspectRatio getAspectRatio() throws EpsonProjectorCommandException, EpsonProjectorException {
309 int val = queryHexInt("ASPECT?");
310 return AspectRatio.forValue(val);
313 public void setAspectRatio(AspectRatio value) throws EpsonProjectorCommandException, EpsonProjectorException {
314 sendCommand(String.format("ASPECT %02X", value.toInt()));
320 public Luminance getLuminance() throws EpsonProjectorCommandException, EpsonProjectorException {
321 int val = queryHexInt("LUMINANCE?");
322 return Luminance.forValue(val);
325 public void setLuminance(Luminance value) throws EpsonProjectorCommandException, EpsonProjectorException {
326 sendCommand(String.format("LUMINANCE %02X", value.toInt()));
332 public String getSource() throws EpsonProjectorCommandException, EpsonProjectorException {
333 return queryString("SOURCE?");
336 public void setSource(String value) throws EpsonProjectorCommandException, EpsonProjectorException {
337 sendCommand(String.format("SOURCE %s", value));
343 public int getBrightness() throws EpsonProjectorCommandException, EpsonProjectorException {
344 int brt = queryInt("BRIGHT?");
345 for (int i = 0; i < MAP48.length; i++) {
346 if (brt == MAP48[i]) {
353 public void setBrightness(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
355 if (value >= 0 && value <= 48) {
356 sendCommand(String.format("BRIGHT %d", MAP48[value]));
363 public int getContrast() throws EpsonProjectorCommandException, EpsonProjectorException {
364 int con = queryInt("CONTRAST?");
365 for (int i = 0; i < MAP48.length; i++) {
366 if (con == MAP48[i]) {
373 public void setContrast(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
375 if (value >= 0 && value <= 48) {
376 sendCommand(String.format("CONTRAST %d", MAP48[value]));
383 public int getDensity() throws EpsonProjectorCommandException, EpsonProjectorException {
384 int den = queryInt("DENSITY?");
385 for (int i = 0; i < MAP64.length; i++) {
386 if (den == MAP64[i]) {
393 public void setDensity(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
395 if (value >= 0 && value <= 64) {
396 sendCommand(String.format("DENSITY %d", MAP64[value]));
403 public int getTint() throws EpsonProjectorCommandException, EpsonProjectorException {
404 int tint = queryInt("TINT?");
405 for (int i = 0; i < MAP64.length; i++) {
406 if (tint == MAP64[i]) {
413 public void setTint(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
415 if (value >= 0 && value <= 64) {
416 sendCommand(String.format("TINT %d", MAP64[value]));
423 public int getColorTemperature() throws EpsonProjectorCommandException, EpsonProjectorException {
424 int ctemp = queryInt("CTEMP?");
425 for (int i = 0; i < MAP_COLOR_TEMP.length; i++) {
426 if (ctemp == MAP_COLOR_TEMP[i]) {
433 public void setColorTemperature(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
434 if (value >= 0 && value <= 9) {
435 sendCommand(String.format("CTEMP %d", MAP_COLOR_TEMP[value]));
442 public int getFleshColor() throws EpsonProjectorCommandException, EpsonProjectorException {
443 int fclr = queryInt("FCOLOR?");
444 for (int i = 0; i < MAP_FLESH_COLOR.length; i++) {
445 if (fclr == MAP_FLESH_COLOR[i]) {
452 public void setFleshColor(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
453 if (value >= 0 && value <= 6) {
454 sendCommand(String.format("FCOLOR %d", MAP_FLESH_COLOR[value]));
461 public ColorMode getColorMode() throws EpsonProjectorCommandException, EpsonProjectorException {
462 int val = queryHexInt("CMODE?");
463 return ColorMode.forValue(val);
466 public void setColorMode(ColorMode value) throws EpsonProjectorCommandException, EpsonProjectorException {
467 sendCommand(String.format("CMODE %02X", value.toInt()));
471 * Horizontal Position
473 public int getHorizontalPosition() throws EpsonProjectorCommandException, EpsonProjectorException {
474 int hpos = queryInt("HPOS?");
475 for (int i = 0; i < MAP49.length; i++) {
476 if (hpos == MAP49[i]) {
483 public void setHorizontalPosition(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
485 if (value >= 0 && value <= 49) {
486 sendCommand(String.format("HPOS %d", MAP49[value]));
493 public int getVerticalPosition() throws EpsonProjectorCommandException, EpsonProjectorException {
494 int vpos = queryInt("VPOS?");
495 for (int i = 0; i < MAP18.length; i++) {
496 if (vpos == MAP18[i]) {
503 public void setVerticalPosition(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
505 if (value >= 0 && value <= 18) {
506 sendCommand(String.format("VPOS %d", MAP18[value]));
513 public Gamma getGamma() throws EpsonProjectorCommandException, EpsonProjectorException {
514 int val = queryHexInt("GAMMA?");
515 return Gamma.forValue(val);
518 public void setGamma(Gamma value) throws EpsonProjectorCommandException, EpsonProjectorException {
519 sendCommand(String.format("GAMMA %02X", value.toInt()));
525 public int getVolume() throws EpsonProjectorCommandException, EpsonProjectorException {
526 int vol = queryInt("VOL?");
527 for (int i = 0; i < MAP20.length; i++) {
528 if (vol == MAP20[i]) {
535 public void setVolume(int value) throws EpsonProjectorCommandException, EpsonProjectorException {
536 if (value >= 0 && value <= 20) {
537 sendCommand(String.format("VOL %d", MAP20[value]));
544 public Switch getMute() throws EpsonProjectorCommandException, EpsonProjectorException {
545 String val = queryString("MUTE?");
546 return val.equals(ON) ? Switch.ON : Switch.OFF;
549 public void setMute(Switch value) throws EpsonProjectorCommandException, EpsonProjectorException {
550 sendCommand(String.format("MUTE %s", value.name()));
556 public Switch getHorizontalReverse() throws EpsonProjectorCommandException, EpsonProjectorException {
557 String val = queryString("HREVERSE?");
558 return val.equals(ON) ? Switch.ON : Switch.OFF;
561 public void setHorizontalReverse(Switch value) throws EpsonProjectorCommandException, EpsonProjectorException {
562 sendCommand(String.format("HREVERSE %s", value.name()));
568 public Switch getVerticalReverse() throws EpsonProjectorCommandException, EpsonProjectorException {
569 String val = queryString("VREVERSE?");
570 return val.equals(ON) ? Switch.ON : Switch.OFF;
573 public void setVerticalReverse(Switch value) throws EpsonProjectorCommandException, EpsonProjectorException {
574 sendCommand(String.format("VREVERSE %s", value.name()));
578 * Background Select for AV Mute
580 public Background getBackground() throws EpsonProjectorCommandException, EpsonProjectorException {
581 int val = queryHexInt("MSEL?");
582 return Background.forValue(val);
585 public void setBackground(Background value) throws EpsonProjectorCommandException, EpsonProjectorException {
586 sendCommand(String.format("MSEL %02X", value.toInt()));
590 * Lamp Time (hours) - get from cache
592 public int getLampTime() throws EpsonProjectorCommandException, EpsonProjectorException {
593 Integer lampHours = cachedLampHours.getValue();
595 if (lampHours != null) {
596 return lampHours.intValue();
598 throw new EpsonProjectorCommandException("cachedLampHours returned null");
605 private @Nullable Integer queryLamp() {
607 return Integer.valueOf(queryInt("LAMP?"));
608 } catch (EpsonProjectorCommandException | EpsonProjectorException e) {
609 logger.debug("Error executing command LAMP?", e);
617 public int getError() throws EpsonProjectorCommandException, EpsonProjectorException {
618 return queryHexInt("ERR?");
622 * Error Code Description
624 public String getErrorString() throws EpsonProjectorCommandException, EpsonProjectorException {
625 int err = queryInt("ERR?");
626 return ErrorMessage.forCode(err);