/**
* Copyright (c) 2010-2016 by the respective copyright holders.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*/
package org.openhab.binding.powermax.internal.message;
import org.openhab.binding.powermax.internal.state.PowerMaxPanelSettings;
import org.openhab.binding.powermax.internal.state.PowerMaxState;
import org.openhab.binding.powermax.internal.state.PowerMaxZoneSettings;
/**
* A class for STATUS message handling
*
* @author Laurent Garnier
* @since 1.9.0
*/
public class PowerMaxStatusMessage extends PowerMaxBaseMessage {
private static final String[] sysStatusTable = new String[] { "Disarmed", "Home Exit Delay", "Away Exit Delay",
"Entry Delay", "Armed Home", "Armed Away", "User Test", "Downloading", "Programming", "Installer",
"Home Bypass", "Away Bypass", "Ready", "Not Ready", "??", "??", "Disarmed Instant",
"Home Instant Exit Delay", "Away Instant Exit Delay", "Entry Delay Instant", "Armed Home Instant",
"Armed Away Instant" };
private static final String[] eventTypeTable = new String[] { "None", "Tamper Alarm", "Tamper Restore", "Open",
"Closed", "Violated (Motion)", "Panic Alarm", "RF Jamming", "Tamper Open", "Communication Failure",
"Line Failure", "Fuse", "Not Active", "Low Battery", "AC Failure", "Fire Alarm", "Emergency",
"Siren Tamper", "Siren Tamper Restore", "Siren Low Battery", "Siren AC Fail" };
/**
* Constructor
*
* @param message
* the received message as a buffer of bytes
*/
public PowerMaxStatusMessage(byte[] message) {
super(message);
}
/**
* {@inheritDoc}
*/
@Override
public PowerMaxState handleMessage() {
super.handleMessage();
PowerMaxState updatedState = new PowerMaxState();
byte[] message = getRawData();
byte eventType = message[3];
if (eventType == 0x02) {
int zoneStatus = (message[4] & 0x000000FF) | ((message[5] << 8) & 0x0000FF00)
| ((message[6] << 16) & 0x00FF0000) | ((message[7] << 24) & 0xFF000000);
int batteryStatus = (message[8] & 0x000000FF) | ((message[9] << 8) & 0x0000FF00)
| ((message[10] << 16) & 0x00FF0000) | ((message[11] << 24) & 0xFF000000);
for (int i = 1; i <= PowerMaxPanelSettings.getThePanelSettings().getNbZones(); i++) {
updatedState.setSensorTripped(i, ((zoneStatus >> (i - 1)) & 0x1) > 0);
updatedState.setSensorLowBattery(i, ((batteryStatus >> (i - 1)) & 0x1) > 0);
}
} else if (eventType == 0x04) {
byte sysStatus = message[4];
byte sysFlags = message[5];
byte eventZone = message[6];
byte zoneEType = message[7];
int x10Status = (message[10] & 0x000000FF) | ((message[11] << 8) & 0x0000FF00);
String zoneETypeStr = ((zoneEType & 0x000000FF) < eventTypeTable.length)
? eventTypeTable[zoneEType & 0x000000FF] : "UNKNOWN";
if (zoneEType == 0x03) {
updatedState.setSensorTripped(eventZone, Boolean.TRUE);
updatedState.setSensorLastTripped(eventZone, System.currentTimeMillis());
} else if (zoneEType == 0x04) {
updatedState.setSensorTripped(eventZone, Boolean.FALSE);
} else if (zoneEType == 0x05) {
PowerMaxZoneSettings zone = PowerMaxPanelSettings.getThePanelSettings().getZoneSettings(eventZone);
if ((zone != null) && zone.getSensorType().equalsIgnoreCase("unknown")) {
zone.setSensorType("Motion");
}
updatedState.setSensorTripped(eventZone, Boolean.TRUE);
updatedState.setSensorLastTripped(eventZone, System.currentTimeMillis());
}
// PGM & X10 devices
for (int i = 0; i < PowerMaxPanelSettings.getThePanelSettings().getNbPGMX10Devices(); i++) {
updatedState.setPGMX10DeviceStatus(i, ((x10Status >> i) & 0x1) > 0);
}
String sysStatusStr = "";
if ((sysFlags & 0x1) == 1) {
sysStatusStr = sysStatusStr + "Ready, ";
updatedState.setReady(true);
} else {
sysStatusStr = sysStatusStr + "Not ready, ";
updatedState.setReady(false);
}
if (((sysFlags >> 1) & 0x1) == 1) {
sysStatusStr = sysStatusStr + "Alert in memory, ";
updatedState.setAlertInMemory(true);
} else {
updatedState.setAlertInMemory(false);
}
if (((sysFlags >> 2) & 0x1) == 1) {
sysStatusStr = sysStatusStr + "Trouble, ";
updatedState.setTrouble(true);
} else {
updatedState.setTrouble(false);
}
if (((sysFlags >> 3) & 0x1) == 1) {
sysStatusStr = sysStatusStr + "Bypass on, ";
updatedState.setBypass(true);
} else {
updatedState.setBypass(false);
for (int i = 1; i <= PowerMaxPanelSettings.getThePanelSettings().getNbZones(); i++) {
updatedState.setSensorBypassed(i, false);
}
}
if (((sysFlags >> 4) & 0x1) == 1) {
sysStatusStr = sysStatusStr + "Last 10 seconds, ";
}
if (((sysFlags >> 5) & 0x1) == 1) {
sysStatusStr = sysStatusStr + zoneETypeStr;
if (eventZone == 0xFF) {
sysStatusStr = sysStatusStr + " from Panel, ";
} else if (eventZone > 0) {
sysStatusStr = sysStatusStr + String.format(" in Zone %d, ", eventZone);
} else {
sysStatusStr = sysStatusStr + ", ";
}
}
if (((sysFlags >> 6) & 0x1) == 1) {
sysStatusStr = sysStatusStr + "Status changed, ";
}
if (((sysFlags >> 7) & 0x1) == 1) {
sysStatusStr = sysStatusStr + "Alarm event, ";
updatedState.setAlarmActive(true);
} else {
updatedState.setAlarmActive(false);
}
sysStatusStr = sysStatusStr.substring(0, sysStatusStr.length() - 2);
String statusStr = ((sysStatus & 0x000000FF) < sysStatusTable.length)
? sysStatusTable[sysStatus & 0x000000FF] : "UNKNOWN";
updatedState.setArmMode(statusStr);
updatedState.setStatusStr(statusStr + ", " + sysStatusStr);
for (int i = 1; i <= PowerMaxPanelSettings.getThePanelSettings().getNbZones(); i++) {
PowerMaxZoneSettings zone = PowerMaxPanelSettings.getThePanelSettings().getZoneSettings(i);
if (zone != null) {
// mode: armed or not: 4=armed home; 5=armed away
int mode = sysStatus & 0x0000000F;
// Zone is shown as armed if
// the sensor type always triggers an alarm
// or the system is armed away (mode = 5)
// or the system is armed home (mode = 4) and the zone is not interior(-follow)
boolean armed = (!zone.getType().equalsIgnoreCase("Non-Alarm") && (zone.isAlwaysInAlarm()
|| (mode == 0x5) || ((mode == 0x4) && !zone.getType().equalsIgnoreCase("Interior-Follow")
&& !zone.getType().equalsIgnoreCase("Interior"))));
updatedState.setSensorArmed(i, armed);
}
}
} else if (eventType == 0x06) {
int zoneBypass = (message[8] & 0x000000FF) | ((message[9] << 8) & 0x0000FF00)
| ((message[10] << 16) & 0x00FF0000) | ((message[11] << 24) & 0xFF000000);
for (int i = 1; i <= PowerMaxPanelSettings.getThePanelSettings().getNbZones(); i++) {
updatedState.setSensorBypassed(i, ((zoneBypass >> (i - 1)) & 0x1) > 0);
}
}
return updatedState;
}
@Override
public String toString() {
String str = super.toString();
byte[] message = getRawData();
byte eventType = message[3];
str += "\n - event type = " + String.format("%02X", eventType);
if (eventType == 0x02) {
int zoneStatus = (message[4] & 0x000000FF) | ((message[5] << 8) & 0x0000FF00)
| ((message[6] << 16) & 0x00FF0000) | ((message[7] << 24) & 0xFF000000);
int batteryStatus = (message[8] & 0x000000FF) | ((message[9] << 8) & 0x0000FF00)
| ((message[10] << 16) & 0x00FF0000) | ((message[11] << 24) & 0xFF000000);
str += "\n - zone status = " + String.format("%08X", zoneStatus);
str += "\n - battery status = " + String.format("%08X", batteryStatus);
} else if (eventType == 0x04) {
byte sysStatus = message[4];
byte sysFlags = message[5];
byte eventZone = message[6];
byte zoneEType = message[7];
int x10Status = (message[10] & 0x000000FF) | ((message[11] << 8) & 0x0000FF00);
String zoneETypeStr = ((zoneEType & 0x000000FF) < eventTypeTable.length)
? eventTypeTable[zoneEType & 0x000000FF] : "UNKNOWN";
str += "\n - system status = " + String.format("%02X", sysStatus);
str += "\n - system flags = " + String.format("%02X", sysFlags);
str += "\n - event zone = " + eventZone;
str += String.format("\n - zone event type = %02X (%s)", zoneEType, zoneETypeStr);
str += "\n - X10 status = " + String.format("%04X", x10Status);
} else if (eventType == 0x06) {
int zoneBypass = (message[8] & 0x000000FF) | ((message[9] << 8) & 0x0000FF00)
| ((message[10] << 16) & 0x00FF0000) | ((message[11] << 24) & 0xFF000000);
str += "\n - zone bypass = " + String.format("%08X", zoneBypass);
}
return str;
}
}