git.basschouten.com Git - openhab-addons.git/blob

   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.omnilink.internal.handler;
  14
  15 import static com.digitaldan.jomnilinkII.MessageTypes.properties.AuxSensorProperties.SENSOR_TYPE_PROGRAMMABLE_ENERGY_SAVER_MODULE;
  16 import static org.openhab.binding.omnilink.internal.OmnilinkBindingConstants.*;
  17
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.Optional;
  21
  22 import org.eclipse.jdt.annotation.NonNullByDefault;
  23 import org.eclipse.jdt.annotation.Nullable;
  24 import org.openhab.binding.omnilink.internal.discovery.ObjectPropertyRequest;
  25 import org.openhab.binding.omnilink.internal.discovery.ObjectPropertyRequests;
  26 import org.openhab.core.library.types.DecimalType;
  27 import org.openhab.core.library.types.OpenClosedType;
  28 import org.openhab.core.library.types.StringType;
  29 import org.openhab.core.thing.ChannelUID;
  30 import org.openhab.core.thing.Thing;
  31 import org.openhab.core.thing.ThingStatus;
  32 import org.openhab.core.thing.ThingStatusDetail;
  33 import org.openhab.core.types.Command;
  34 import org.openhab.core.types.RefreshType;
  35 import org.openhab.core.types.State;
  36 import org.openhab.core.types.UnDefType;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 import com.digitaldan.jomnilinkII.Message;
  41 import com.digitaldan.jomnilinkII.MessageTypes.CommandMessage;
  42 import com.digitaldan.jomnilinkII.MessageTypes.ObjectStatus;
  43 import com.digitaldan.jomnilinkII.MessageTypes.SecurityCodeValidation;
  44 import com.digitaldan.jomnilinkII.MessageTypes.properties.AreaProperties;
  45 import com.digitaldan.jomnilinkII.MessageTypes.properties.ZoneProperties;
  46 import com.digitaldan.jomnilinkII.MessageTypes.statuses.ExtendedZoneStatus;
  47 import com.digitaldan.jomnilinkII.OmniInvalidResponseException;
  48 import com.digitaldan.jomnilinkII.OmniUnknownMessageTypeException;
  49
  50 /**
  51  * The {@link ZoneHandler} defines some methods that are used to
  52  * interface with an OmniLink Zone. This by extension also defines the
  53  * OmniPro Zone thing that openHAB will be able to pick up and interface with.
  54  *
  55  * @author Craig Hamilton - Initial contribution
  56  */
  57 @NonNullByDefault
  58 public class ZoneHandler extends AbstractOmnilinkStatusHandler<ExtendedZoneStatus> {
  59     private final Logger logger = LoggerFactory.getLogger(ZoneHandler.class);
  60     private final int thingID = getThingNumber();
  61     public @Nullable String number;
  62
  63     public ZoneHandler(Thing thing) {
  64         super(thing);
  65     }
  66
  67     @Override
  68     public void initialize() {
  69         super.initialize();
  70         final OmnilinkBridgeHandler bridgeHandler = getOmnilinkBridgeHandler();
  71         if (bridgeHandler != null) {
  72             updateZoneProperties(bridgeHandler);
  73         } else {
  74             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR,
  75                     "Received null bridge while initializing Zone!");
  76         }
  77     }
  78
  79     private void updateZoneProperties(OmnilinkBridgeHandler bridgeHandler) {
  80         final List<AreaProperties> areas = super.getAreaProperties();
  81         if (areas != null) {
  82             for (AreaProperties areaProperties : areas) {
  83                 int areaFilter = super.bitFilterForArea(areaProperties);
  84
  85                 ObjectPropertyRequest<ZoneProperties> objectPropertyRequest = ObjectPropertyRequest
  86                         .builder(bridgeHandler, ObjectPropertyRequests.ZONE, getThingNumber(), 0).selectNamed()
  87                         .areaFilter(areaFilter).build();
  88
  89                 for (ZoneProperties zoneProperties : objectPropertyRequest) {
  90                     if (zoneProperties.getZoneType() <= SENSOR_TYPE_PROGRAMMABLE_ENERGY_SAVER_MODULE) {
  91                         Map<String, String> properties = editProperties();
  92                         properties.put(THING_PROPERTIES_NAME, zoneProperties.getName());
  93                         properties.put(THING_PROPERTIES_AREA, Integer.toString(areaProperties.getNumber()));
  94                         updateProperties(properties);
  95                     }
  96                 }
  97             }
  98         }
  99     }
 100
 101     @Override
 102     public void handleCommand(ChannelUID channelUID, Command command) {
 103         logger.debug("handleCommand called for channel: {}, command: {}", channelUID, command);
 104         int mode;
 105
 106         if (command instanceof RefreshType) {
 107             retrieveStatus().ifPresentOrElse(this::updateChannels, () -> updateStatus(ThingStatus.OFFLINE,
 108                     ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR, "Received null status update!"));
 109             return;
 110         }
 111
 112         if (!(command instanceof StringType)) {
 113             logger.debug("Invalid command: {}, must be StringType", command);
 114             return;
 115         }
 116
 117         switch (channelUID.getId()) {
 118             case CHANNEL_ZONE_BYPASS:
 119                 mode = CommandMessage.CMD_SECURITY_BYPASS_ZONE;
 120                 break;
 121             case CHANNEL_ZONE_RESTORE:
 122                 mode = CommandMessage.CMD_SECURITY_RESTORE_ZONE;
 123                 break;
 124             default:
 125                 mode = -1;
 126         }
 127         int areaNumber = getAreaNumber();
 128         logger.debug("mode {} on zone {} with code {}", mode, thingID, command.toFullString());
 129         char[] code = command.toFullString().toCharArray();
 130         if (code.length != 4) {
 131             logger.warn("Invalid code length, code must be 4 digits");
 132         } else {
 133             try {
 134                 final OmnilinkBridgeHandler bridge = getOmnilinkBridgeHandler();
 135                 if (bridge != null) {
 136                     SecurityCodeValidation codeValidation = bridge.reqSecurityCodeValidation(areaNumber,
 137                             Character.getNumericValue(code[0]), Character.getNumericValue(code[1]),
 138                             Character.getNumericValue(code[2]), Character.getNumericValue(code[3]));
 139                     /*
 140                      * 0 Invalid code
 141                      * 1 Master
 142                      * 2 Manager
 143                      * 3 User
 144                      */
 145                     logger.debug("User code number: {} level: {}", codeValidation.getCodeNumber(),
 146                             codeValidation.getAuthorityLevel());
 147                     /*
 148                      * Valid user code number are 1-99, 251 is duress code, 0 means code does not exist
 149                      */
 150                     if ((codeValidation.getCodeNumber() > 0 && codeValidation.getCodeNumber() <= 99)
 151                             && codeValidation.getAuthorityLevel() > 0) {
 152                         sendOmnilinkCommand(mode, codeValidation.getCodeNumber(), thingID);
 153                     } else {
 154                         logger.warn("System reported an invalid code");
 155                     }
 156                 } else {
 157                     logger.debug("Received null bridge while sending zone command!");
 158                 }
 159             } catch (OmniInvalidResponseException e) {
 160                 logger.debug("Zone command failed: {}", e.getMessage());
 161             } catch (OmniUnknownMessageTypeException | BridgeOfflineException e) {
 162                 logger.debug("Could not send zone command: {}", e.getMessage());
 163             }
 164         }
 165         // This is a send only channel, so don't store the user code
 166         updateState(channelUID, UnDefType.UNDEF);
 167     }
 168
 169     @Override
 170     protected void updateChannels(ExtendedZoneStatus zoneStatus) {
 171         // 0 Secure. 1 Not ready, 3 Trouble
 172         int current = ((zoneStatus.getStatus() >> 0) & 0x03);
 173         // 0 Secure, 1 Tripped, 2 Reset, but previously tripped
 174         int latched = ((zoneStatus.getStatus() >> 2) & 0x03);
 175         // 0 Disarmed, 1 Armed, 2 Bypass user, 3 Bypass system
 176         int arming = ((zoneStatus.getStatus() >> 4) & 0x03);
 177         State contactState = Integer.valueOf(current).equals(0) ? OpenClosedType.CLOSED : OpenClosedType.OPEN;
 178         logger.debug("handling Zone Status change to state: {}, current: {}, latched: {}, arming: {}", contactState,
 179                 current, latched, arming);
 180         updateState(CHANNEL_ZONE_CONTACT, contactState);
 181         updateState(CHANNEL_ZONE_CURRENT_CONDITION, new DecimalType(current));
 182         updateState(CHANNEL_ZONE_LATCHED_ALARM_STATUS, new DecimalType(latched));
 183         updateState(CHANNEL_ZONE_ARMING_STATUS, new DecimalType(arming));
 184     }
 185
 186     @Override
 187     protected Optional<ExtendedZoneStatus> retrieveStatus() {
 188         try {
 189             final OmnilinkBridgeHandler bridge = getOmnilinkBridgeHandler();
 190             if (bridge != null) {
 191                 ObjectStatus objStatus = bridge.requestObjectStatus(Message.OBJ_TYPE_ZONE, thingID, thingID, true);
 192                 return Optional.of((ExtendedZoneStatus) objStatus.getStatuses()[0]);
 193             } else {
 194                 logger.debug("Received null bridge while updating Zone status!");
 195                 return Optional.empty();
 196             }
 197         } catch (OmniInvalidResponseException | OmniUnknownMessageTypeException | BridgeOfflineException e) {
 198             logger.debug("Received exception while refreshing Zone status: {}", e.getMessage());
 199             return Optional.empty();
 200         }
 201     }
 202 }