Skip to content

Commit

Permalink
[nuvo] fixes protocol errors when connecting via an MPS4 (#11511)
Browse files Browse the repository at this point in the history 
Signed-off-by: Brian O'Connell <boc-tothefuture@users.noreply.github.com>

Co-authored-by: Brian O'Connell <boc-tothefuture@users.noreply.github.com>
  • Loading branch information
@boc-tothefuture
boc-tothefuture and boc-tothefuture committed Nov 10, 2021
1 parent c58be80 commit 2a8e9b6
Show file tree
Hide file tree
Showing 4 changed files with 128 additions and 57 deletions.
6 changes: 3 additions & 3 deletions bundles/org.openhab.binding.nuvo/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ The thing has the following configuration parameters:

Some notes:

* The direct connection to the MPS4 server has not been exhaustively tested, please report any issues found.
* The only issue with the MPS4 connection seen thus far is that the setting SxDISPINFO as seen in the advanced rules below does not work.
* If the port is set to 5006 the binding will adjust its protocol to connect to a NuVo via an MPS4 IP connection.
* MPS4 connections do not support SxDISPINFO commands including those outlined in the advanced rules section below.
* If a zone has a maximum volume limit configured by the Nuvo configurator, the volume slider will automatically drop back to that level if set above the configured limit.
* Source display_line1 thru 4 can only be updated on non NuvoNet sources.
* The track_position channel does not update continuously for NuvoNet sources. It only changes when the track changes or playback is paused/unpaused.
Expand Down Expand Up @@ -104,7 +104,7 @@ nuvo:amplifier:myamp "Nuvo WHA" [ serialPort="COM5", numZones=6, clockSync=false
// serial over IP connection
nuvo:amplifier:myamp "Nuvo WHA" [ host="192.168.0.10", port=4444, numZones=6, clockSync=false]
// MPS4 server IP connection (experimental)
// MPS4 server IP connection
nuvo:amplifier:myamp "Nuvo WHA" [ host="192.168.0.10", port=5006, numZones=6, clockSync=false]
```
Expand Down
3 changes: 3 additions & 0 deletions ...ab.binding.nuvo/src/main/java/org/openhab/binding/nuvo/internal/NuvoBindingConstants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,7 @@ public class NuvoBindingConstants {
public static final String NAME_QUOTE = "NAME\"";
public static final String MUTE = "MUTE";
public static final String VOL = "VOL";

// MPS4
public static final String TYPE_PING = "PING";
}
6 changes: 6 additions & 0 deletions ...ing.nuvo/src/main/java/org/openhab/binding/nuvo/internal/communication/NuvoConnector.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ public abstract class NuvoConnector {
private static final String ALL_OFF = "#ALLOFF";
private static final String MUTE = "#MUTE";
private static final String PAGE = "#PAGE";
private static final String PING = "#PING";

private static final byte[] WAKE_STR = "\r".getBytes(StandardCharsets.US_ASCII);

Expand Down Expand Up @@ -304,6 +305,11 @@ public void handleIncomingMessage(byte[] incomingMessage) {
return;
}

if (message.contains(PING)) {
dispatchKeyValue(TYPE_PING, BLANK, BLANK);
return;
}

if (message.contains(VER_STR)) {
// example: #VER"NV-E6G FWv2.66 HWv0"
// split on " and return the version number
Expand Down
170 changes: 116 additions & 54 deletions ...hab.binding.nuvo/src/main/java/org/openhab/binding/nuvo/internal/handler/NuvoHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ public class NuvoHandler extends BaseThingHandler implements NuvoMessageEventLis
private static final long CLOCK_SYNC_INTERVAL_SEC = 3600;
private static final long INITIAL_POLLING_DELAY_SEC = 30;
private static final long INITIAL_CLOCK_SYNC_DELAY_SEC = 10;
private static final long PING_TIMEOUT_SEC = 60;
// spec says wait 50ms, min is 100
private static final long SLEEP_BETWEEN_CMD_MS = 100;
private static final Unit<Time> API_SECOND_UNIT = Units.SECOND;
Expand All @@ -105,6 +106,8 @@ public class NuvoHandler extends BaseThingHandler implements NuvoMessageEventLis
private static final int MIN_EQ = -18;
private static final int MAX_EQ = 18;

private static final int MPS4_PORT = 5006;

private static final Pattern ZONE_PATTERN = Pattern
.compile("^ON,SRC(\\d{1}),(MUTE|VOL\\d{1,2}),DND([0-1]),LOCK([0-1])$");
private static final Pattern DISP_PATTERN = Pattern.compile("^DISPLINE(\\d{1}),\"(.*)\"$");
Expand All @@ -121,6 +124,7 @@ public class NuvoHandler extends BaseThingHandler implements NuvoMessageEventLis
private @Nullable ScheduledFuture<?> reconnectJob;
private @Nullable ScheduledFuture<?> pollingJob;
private @Nullable ScheduledFuture<?> clockSyncJob;
private @Nullable ScheduledFuture<?> pingJob;

private NuvoConnector connector = new NuvoDefaultConnector();
private long lastEventReceived = System.currentTimeMillis();
Expand All @@ -134,6 +138,10 @@ public class NuvoHandler extends BaseThingHandler implements NuvoMessageEventLis
// A tree map that maps the source ids to source labels
TreeMap<String, String> sourceLabels = new TreeMap<String, String>();

// Indicates if there is a need to poll status because of a disconnection used for MPS4 systems
boolean pollStatusNeeded = true;
boolean isMps4 = false;

/**
* Constructor
*/
Expand Down Expand Up @@ -184,6 +192,11 @@ public void initialize() {
return;
}

this.isMps4 = (port != null && port.intValue() == MPS4_PORT);
if (this.isMps4) {
logger.debug("Port set to {} configuring binding for MPS4 compatability", MPS4_PORT);
}

if (numZones != null) {
this.numZones = numZones;
}
Expand All @@ -207,6 +220,7 @@ public void initialize() {

scheduleReconnectJob();
schedulePollingJob();
schedulePingTimeoutJob();
updateStatus(ThingStatus.UNKNOWN);
}

Expand All @@ -215,6 +229,7 @@ public void dispose() {
cancelReconnectJob();
cancelPollingJob();
cancelClockSyncJob();
cancelPingTimeoutJob();
closeConnection();
super.dispose();
}
Expand Down Expand Up @@ -429,6 +444,7 @@ private synchronized void closeConnection() {
if (connector.isConnected()) {
connector.close();
connector.removeEventListener(this);
pollStatusNeeded = true;
logger.debug("closeConnection(): disconnected");
}
}
Expand Down Expand Up @@ -459,6 +475,11 @@ public void onNewMessageEvent(NuvoMessageEvent evt) {
connector.setEssentia(false);
}
break;
case TYPE_PING:
logger.debug("Ping message received- rescheduling ping timeout");
schedulePingTimeoutJob();
// Return here because receiving a ping does not indicate that one can poll
return;
case TYPE_ALLOFF:
activeZones.forEach(zoneNum -> {
updateChannelState(NuvoEnum.valueOf(ZONE + zoneNum), CHANNEL_TYPE_POWER, OFF);
Expand Down Expand Up @@ -555,7 +576,12 @@ public void onNewMessageEvent(NuvoMessageEvent evt) {
break;
default:
logger.debug("onNewMessageEvent: unhandled key {}", key);
break;
// Return here because receiving an unknown message does not indicate that one can poll
return;
}

if (isMps4 && pollStatusNeeded) {
pollStatus();
}
}

Expand All @@ -571,58 +597,10 @@ private void scheduleReconnectJob() {
closeConnection();
String error = null;
if (openConnection()) {
synchronized (sequenceLock) {
try {
long prevUpdateTime = lastEventReceived;

connector.sendCommand(NuvoCommand.GET_CONTROLLER_VERSION);

NuvoEnum.VALID_SOURCES.forEach(source -> {
try {
connector.sendQuery(NuvoEnum.valueOf(source), NuvoCommand.NAME);
Thread.sleep(SLEEP_BETWEEN_CMD_MS);
connector.sendQuery(NuvoEnum.valueOf(source), NuvoCommand.DISPINFO);
Thread.sleep(SLEEP_BETWEEN_CMD_MS);
connector.sendQuery(NuvoEnum.valueOf(source), NuvoCommand.DISPLINE);
Thread.sleep(SLEEP_BETWEEN_CMD_MS);
} catch (NuvoException | InterruptedException e) {
logger.debug("Error Querying Source data: {}", e.getMessage());
}
});

// Query all active zones to get their current status and eq configuration
activeZones.forEach(zoneNum -> {
try {
connector.sendQuery(NuvoEnum.valueOf(ZONE + zoneNum), NuvoCommand.STATUS);
Thread.sleep(SLEEP_BETWEEN_CMD_MS);
connector.sendCfgCommand(NuvoEnum.valueOf(ZONE + zoneNum), NuvoCommand.EQ_QUERY,
BLANK);
Thread.sleep(SLEEP_BETWEEN_CMD_MS);
} catch (NuvoException | InterruptedException e) {
logger.debug("Error Querying Zone data: {}", e.getMessage());
}
});

// prevUpdateTime should have changed if a zone update was received
if (prevUpdateTime == lastEventReceived) {
error = "Controller not responding to status requests";
} else {
List<StateOption> sourceStateOptions = new ArrayList<>();
sourceLabels.keySet().forEach(key -> {
sourceStateOptions.add(new StateOption(key, sourceLabels.get(key)));
});

// Put the source labels on all active zones
activeZones.forEach(zoneNum -> {
stateDescriptionProvider.setStateOptions(new ChannelUID(getThing().getUID(),
ZONE.toLowerCase() + zoneNum + CHANNEL_DELIMIT + CHANNEL_TYPE_SOURCE),
sourceStateOptions);
});
}
} catch (NuvoException e) {
error = "First command after connection failed";
logger.debug("{}: {}", error, e.getMessage());
}
logger.debug("Reconnected");
// Polling status will disconnect from MPS4 on reconnect
if (!isMps4) {
pollStatus();
}
} else {
error = "Reconnection failed";
Expand All @@ -637,6 +615,84 @@ private void scheduleReconnectJob() {
}, 1, RECON_POLLING_INTERVAL_SEC, TimeUnit.SECONDS);
}

/**
* If a ping is not received within ping interval the connection is closed and a reconnect job is scheduled
*/
private void schedulePingTimeoutJob() {
if (isMps4) {
logger.debug("Schedule Ping Timeout job");
cancelPingTimeoutJob();
pingJob = scheduler.schedule(() -> {
closeConnection();
scheduleReconnectJob();
}, PING_TIMEOUT_SEC, TimeUnit.SECONDS);
} else {
logger.debug("Ping Timeout job on valid for MPS4 connections");
}
}

/**
* Cancel the ping timeout job
*/
private void cancelPingTimeoutJob() {
ScheduledFuture<?> pingJob = this.pingJob;
if (pingJob != null) {
pingJob.cancel(true);
this.pingJob = null;
}
}

private void pollStatus() {
pollStatusNeeded = false;
scheduler.submit(() -> {
synchronized (sequenceLock) {
try {
connector.sendCommand(NuvoCommand.GET_CONTROLLER_VERSION);

NuvoEnum.VALID_SOURCES.forEach(source -> {
try {
connector.sendQuery(NuvoEnum.valueOf(source), NuvoCommand.NAME);
Thread.sleep(SLEEP_BETWEEN_CMD_MS);
connector.sendQuery(NuvoEnum.valueOf(source), NuvoCommand.DISPINFO);
Thread.sleep(SLEEP_BETWEEN_CMD_MS);
connector.sendQuery(NuvoEnum.valueOf(source), NuvoCommand.DISPLINE);
Thread.sleep(SLEEP_BETWEEN_CMD_MS);
} catch (NuvoException | InterruptedException e) {
logger.debug("Error Querying Source data: {}", e.getMessage());
}
});

// Query all active zones to get their current status and eq configuration
activeZones.forEach(zoneNum -> {
try {
connector.sendQuery(NuvoEnum.valueOf(ZONE + zoneNum), NuvoCommand.STATUS);
Thread.sleep(SLEEP_BETWEEN_CMD_MS);
connector.sendCfgCommand(NuvoEnum.valueOf(ZONE + zoneNum), NuvoCommand.EQ_QUERY, BLANK);
Thread.sleep(SLEEP_BETWEEN_CMD_MS);
} catch (NuvoException | InterruptedException e) {
logger.debug("Error Querying Zone data: {}", e.getMessage());
}
});

List<StateOption> sourceStateOptions = new ArrayList<>();
sourceLabels.keySet().forEach(key -> {
sourceStateOptions.add(new StateOption(key, sourceLabels.get(key)));
});

// Put the source labels on all active zones
activeZones.forEach(zoneNum -> {
stateDescriptionProvider.setStateOptions(
new ChannelUID(getThing().getUID(),
ZONE.toLowerCase() + zoneNum + CHANNEL_DELIMIT + CHANNEL_TYPE_SOURCE),
sourceStateOptions);
});
} catch (NuvoException e) {
logger.debug("Error polling status from Nuvo: {}", e.getMessage());
}
}
});
}

/**
* Cancel the reconnection job
*/
Expand All @@ -652,9 +708,15 @@ private void cancelReconnectJob() {
* Schedule the polling job
*/
private void schedulePollingJob() {
logger.debug("Schedule polling job");
cancelPollingJob();

if (isMps4) {
logger.debug("MPS4 doesn't support polling");
return;
} else {
logger.debug("Schedule polling job");
}

// when the Nuvo amp is off, this will keep the connection (esp Serial over IP) alive and detect if the
// connection goes down
pollingJob = scheduler.scheduleWithFixedDelay(() -> {
Expand Down

0 comments on commit 2a8e9b6

Please sign in to comment.