Skip to content

Commit

Permalink
[paradoxalarm] Implement detailed partition state (openhab#14618)
Browse files Browse the repository at this point in the history 
* Implement partition detailed state

---------

Signed-off-by: Konstantin Polihronov <polychronov@gmail.com>
Signed-off-by: querdenker2k <querdenker2k@gmx.de>
  • Loading branch information
@theater @querdenker2k
theater authored and querdenker2k committed Oct 29, 2023
1 parent 09e73ab commit 76bcf00
Show file tree
Hide file tree
Showing 8 changed files with 80 additions and 5 deletions.
10 changes: 9 additions & 1 deletion bundles/org.openhab.binding.paradoxalarm/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ Currently binding supports the following panels: EVO192, EVO48(not tested), EVO9
| Channel | Type | Description |
|--------------------------|---------|-----------------------------------------------------------------------------------------------|
| partitionLabel | String | Label of partition inside Paradox configuration |
| state | String |State of partition (armed, disarmed, in alarm) |
| state | String | Calculated overall state of the partition (Armed, Disarmed, In Alarm) |
| detailedState | String | Calculated detailed state of the partition based on partition state bits (see below table for possible values) |
| additionalState | String | This used to be a channel where all different states were consolidated as semi-colon separated string. With implementation of each state as channel additional states should be no longer used. (deprecated channel) |
| readyToArm | Switch | Partition is Ready to arm |
| inExitDelay | Switch | Partition is in Exit delay |
Expand All @@ -95,6 +96,13 @@ Currently binding supports the following panels: EVO192, EVO48(not tested), EVO9
| allZonesClosed | Contact | All zones in partition are currently closed |
| command | String | Command to be send to partition. Can be (ARM, DISARM, FORCE_ARM, INSTANT_ARM, STAY_ARM, BEEP) |

### Partition detailed state possible values:
| Overall state value | Detailed state value (depending on the sub-state) |
|--------------------------|----------------------------------------------------------------------------------------------|
| InAlarm | Silent Alarm, Audible Alarm, Fire Alarm, In Alarm (if none of the first three) |
| Armed | Away Armed, Stay Armed, NoEntry Armed, Armed (if none of the first three) |
| Disarmed | Disarmed |

### Zone channels:

| Channel | Type | Description |
Expand Down
1 change: 1 addition & 0 deletions ...java/org/openhab/binding/paradoxalarm/internal/handlers/ParadoxAlarmBindingConstants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ public class ParadoxAlarmBindingConstants {

public static final String PARTITION_LABEL_CHANNEL_UID = "label";
public static final String PARTITION_STATE_CHANNEL_UID = "state";
public static final String PARTITION_DETAILED_STATE_CHANNEL_UID = "detailedState";
@Deprecated // After implementation of channels for every possible state, the summarized additional states is no
// longer needed. We'll keep it for backward compatibility
public static final String PARTITION_ADDITIONAL_STATES_CHANNEL_UID = "additionalStates";
Expand Down
1 change: 1 addition & 0 deletions ...main/java/org/openhab/binding/paradoxalarm/internal/handlers/ParadoxPartitionHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ protected void updateEntity() {
if (partition != null) {
updateState(PARTITION_LABEL_CHANNEL_UID, new StringType(partition.getLabel()));
updateState(PARTITION_STATE_CHANNEL_UID, new StringType(partition.getState().getMainState()));
updateState(PARTITION_DETAILED_STATE_CHANNEL_UID, new StringType(partition.getState().getDetailedState()));
updateState(PARTITION_ADDITIONAL_STATES_CHANNEL_UID,
new StringType("Deprecated field. Use direct channels instead"));
updateState(PARTITION_READY_TO_ARM_CHANNEL_UID, booleanToSwitchState(partition.getState().isReadyToArm()));
Expand Down
6 changes: 5 additions & 1 deletion ...paradoxalarm/src/main/java/org/openhab/binding/paradoxalarm/internal/model/Partition.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,11 @@ public PartitionState getState() {

public Partition setState(PartitionState state) {
this.state = state;
logger.debug("Partition {}:\t{}", getLabel(), getState().getMainState());
logger.debug("Partition {} main state:\t{}", getLabel(), getState().getMainState());
if (logger.isTraceEnabled()) {
logger.trace("Partition {} detailed state:\t{}", getLabel(), getState().getDetailedState());
logger.trace("Partition {} full state dump:\t{}", getLabel(), getState());
}
return this;
}

Expand Down
40 changes: 37 additions & 3 deletions ...oxalarm/src/main/java/org/openhab/binding/paradoxalarm/internal/model/PartitionState.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,16 @@
*/
public class PartitionState {

private static final String ARMED = "Armed";
private static final String DISARMED = "Disarmed";
private static final String IN_ALARM = "InAlarm";

private static final String ARMED_IN_NO_ENTRY = "NoEntry Armed";
private static final String ARMED_IN_STAY = "Stay Armed";
private static final String ARMED_IN_AWAY = "Away Armed";
private static final String FIRE_ALARM = "Fire Alarm";
private static final String AUDIBLE_ALARM = "Audible Alarm";
private static final String SILENT_ALARM = "Silent Alarm";
private boolean isArmed;
private boolean isArmedInAway;
private boolean isArmedInStay;
Expand Down Expand Up @@ -47,11 +57,35 @@ public class PartitionState {
private boolean areAllZoneclosed;

public String getMainState() {
if (isInAlarm) {
return "InAlarm";
if (isInAlarm || isInSilentAlarm || isInAudibleAlarm || isInFireAlarm) {
return IN_ALARM;
} else {
return isArmed || isArmedInAway || isArmedInStay || isArmedInNoEntry ? "Armed" : "Disarmed";
return isArmed || isArmedInAway || isArmedInStay || isArmedInNoEntry ? ARMED : DISARMED;
}
}

public String getDetailedState() {
if (isInAlarm) {
if (isInSilentAlarm) {
return SILENT_ALARM;
} else if (isInAudibleAlarm) {
return AUDIBLE_ALARM;
} else if (isInFireAlarm) {
return FIRE_ALARM;
}
return IN_ALARM;
} else if (isArmed) {
if (isArmedInAway) {
return ARMED_IN_AWAY;
} else if (isArmedInStay) {
return ARMED_IN_STAY;
} else if (isArmedInNoEntry) {
return ARMED_IN_NO_ENTRY;
}
return ARMED;
}

return DISARMED;
}

@Override
Expand Down
2 changes: 2 additions & 0 deletions ...s/org.openhab.binding.paradoxalarm/src/main/resources/OH-INF/i18n/paradoxalarm.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ channel-type.paradoxalarm.command.state.option.BYPASS = Bypass
channel-type.paradoxalarm.command.state.option.CLEAR_BYPASS = Clear Bypass
channel-type.paradoxalarm.communicationState.label = Bridge Communication State
channel-type.paradoxalarm.communicationState.description = Status of connection to Paradox system
channel-type.paradoxalarm.detailedState.label = Detailed Partition State
channel-type.paradoxalarm.detailedState.description = The detailed state of partition (contains sub-states like Stay in Armed, Armed no entry, etc)
channel-type.paradoxalarm.forceReady.label = Partition Is Force Ready
channel-type.paradoxalarm.forceReady.description = Partition is Force Ready
channel-type.paradoxalarm.generatedAlarm.label = Generated an Alarm
Expand Down
11 changes: 11 additions & 0 deletions bundles/org.openhab.binding.paradoxalarm/src/main/resources/OH-INF/thing/partition.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<channels>
<channel id="label" typeId="partitionLabel"/>
<channel id="state" typeId="state"/>
<channel id="detailedState" typeId="detailedState"/>
<channel id="additionalStates" typeId="additionalState"/>
<channel id="readyToArm" typeId="readyToArm"/>
<channel id="inExitDelay" typeId="inExitDelay"/>
Expand All @@ -34,6 +35,10 @@
<channel id="command" typeId="command"/>
</channels>

<properties>
<property name="thingTypeVersion">1</property>
</properties>

<config-description>
<parameter name="id" type="integer" min="1" max="8" required="true">
<label>Partition Id</label>
Expand All @@ -59,6 +64,12 @@
<description>State of partition</description>
<state readOnly="true" pattern="%s"/>
</channel-type>
<channel-type id="detailedState">
<item-type>String</item-type>
<label>Detailed Partition State</label>
<description>The detailed state of partition (contains sub-states like Stay in Armed, Armed no entry, etc)</description>
<state readOnly="true" pattern="%s"/>
</channel-type>
<channel-type id="additionalState">
<item-type>String</item-type>
<label>Partition Additional States</label>
Expand Down
14 changes: 14 additions & 0 deletions ...g.openhab.binding.paradoxalarm/src/main/resources/OH-INF/update/partition_type_update.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<update:update-descriptions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:update="https://openhab.org/schemas/update-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/update-description/v1.0.0 https://openhab.org/schemas/update-description-1.0.0.xsd">

<thing-type uid="paradoxalarm:partition">
<instruction-set targetVersion="1">
<add-channel id="detailedState">
<type>paradoxalarm:detailedState</type>
</add-channel>
</instruction-set>
</thing-type>

</update:update-descriptions>

0 comments on commit 76bcf00

Please sign in to comment.