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

   1 /**
   2  * Copyright (c) 2010-2024 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.boschshc.internal.discovery;
  14
  15 import java.time.Instant;
  16 import java.util.AbstractMap;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Set;
  20
  21 import org.eclipse.jdt.annotation.NonNullByDefault;
  22 import org.eclipse.jdt.annotation.Nullable;
  23 import org.openhab.binding.boschshc.internal.devices.BoschSHCBindingConstants;
  24 import org.openhab.binding.boschshc.internal.devices.bridge.BridgeHandler;
  25 import org.openhab.binding.boschshc.internal.devices.bridge.dto.Device;
  26 import org.openhab.binding.boschshc.internal.devices.bridge.dto.Room;
  27 import org.openhab.binding.boschshc.internal.devices.bridge.dto.UserDefinedState;
  28 import org.openhab.core.config.discovery.AbstractThingHandlerDiscoveryService;
  29 import org.openhab.core.config.discovery.DiscoveryResultBuilder;
  30 import org.openhab.core.thing.ThingTypeUID;
  31 import org.openhab.core.thing.ThingUID;
  32 import org.openhab.core.thing.binding.ThingHandlerService;
  33 import org.osgi.service.component.annotations.Component;
  34 import org.osgi.service.component.annotations.ServiceScope;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 /**
  39  * The {@link ThingDiscoveryService} is responsible to discover Bosch Smart Home things.
  40  * The paired SHC BridgeHandler is required to get the lists of rooms and devices.
  41  * With this data the openhab things are discovered.
  42  *
  43  * The order to make this work is
  44  * 1. SHC bridge is created, e.v via openhab UI
  45  * 2. Service is instantiated setBridgeHandler of this service is called
  46  * 3. Service is activated
  47  * 4. Service registers itself as discoveryLister at the bridge
  48  * 5. bridge calls startScan after bridge is paired and things can be discovered
  49  *
  50  * @author Gerd Zanker - Initial contribution
  51  */
  52 @Component(scope = ServiceScope.PROTOTYPE, service = ThingHandlerService.class)
  53 @NonNullByDefault
  54 public class ThingDiscoveryService extends AbstractThingHandlerDiscoveryService<BridgeHandler> {
  55     private static final int SEARCH_TIME = 1;
  56
  57     private final Logger logger = LoggerFactory.getLogger(ThingDiscoveryService.class);
  58
  59     protected static final Set<ThingTypeUID> SUPPORTED_THING_TYPES = Set.of(
  60             BoschSHCBindingConstants.THING_TYPE_INWALL_SWITCH, BoschSHCBindingConstants.THING_TYPE_TWINGUARD,
  61             BoschSHCBindingConstants.THING_TYPE_WINDOW_CONTACT, BoschSHCBindingConstants.THING_TYPE_WINDOW_CONTACT_2,
  62             BoschSHCBindingConstants.THING_TYPE_MOTION_DETECTOR, BoschSHCBindingConstants.THING_TYPE_SHUTTER_CONTROL,
  63             BoschSHCBindingConstants.THING_TYPE_THERMOSTAT, BoschSHCBindingConstants.THING_TYPE_CLIMATE_CONTROL,
  64             BoschSHCBindingConstants.THING_TYPE_WALL_THERMOSTAT, BoschSHCBindingConstants.THING_TYPE_CAMERA_360,
  65             BoschSHCBindingConstants.THING_TYPE_CAMERA_EYES,
  66             BoschSHCBindingConstants.THING_TYPE_INTRUSION_DETECTION_SYSTEM,
  67             BoschSHCBindingConstants.THING_TYPE_SMART_PLUG_COMPACT, BoschSHCBindingConstants.THING_TYPE_SMART_BULB,
  68             BoschSHCBindingConstants.THING_TYPE_SMOKE_DETECTOR);
  69
  70     // @formatter:off
  71     public static final Map<String, ThingTypeUID> DEVICEMODEL_TO_THINGTYPE_MAP = Map.ofEntries(
  72             new AbstractMap.SimpleEntry<>("BBL", BoschSHCBindingConstants.THING_TYPE_SHUTTER_CONTROL),
  73             new AbstractMap.SimpleEntry<>("TWINGUARD", BoschSHCBindingConstants.THING_TYPE_TWINGUARD),
  74             new AbstractMap.SimpleEntry<>("BSM", BoschSHCBindingConstants.THING_TYPE_INWALL_SWITCH),
  75             new AbstractMap.SimpleEntry<>("PSM", BoschSHCBindingConstants.THING_TYPE_SMART_PLUG_COMPACT),
  76             new AbstractMap.SimpleEntry<>("PLUG_COMPACT", BoschSHCBindingConstants.THING_TYPE_SMART_PLUG_COMPACT),
  77             new AbstractMap.SimpleEntry<>("CAMERA_360", BoschSHCBindingConstants.THING_TYPE_CAMERA_360),
  78             new AbstractMap.SimpleEntry<>("CAMERA_EYES", BoschSHCBindingConstants.THING_TYPE_CAMERA_EYES),
  79             new AbstractMap.SimpleEntry<>("BWTH", BoschSHCBindingConstants.THING_TYPE_WALL_THERMOSTAT), // wall thermostat
  80             new AbstractMap.SimpleEntry<>("THB", BoschSHCBindingConstants.THING_TYPE_WALL_THERMOSTAT), // wall thermostat with batteries
  81             new AbstractMap.SimpleEntry<>("SD", BoschSHCBindingConstants.THING_TYPE_SMOKE_DETECTOR),
  82             new AbstractMap.SimpleEntry<>("MD", BoschSHCBindingConstants.THING_TYPE_MOTION_DETECTOR),
  83             new AbstractMap.SimpleEntry<>("ROOM_CLIMATE_CONTROL", BoschSHCBindingConstants.THING_TYPE_CLIMATE_CONTROL),
  84             new AbstractMap.SimpleEntry<>("INTRUSION_DETECTION_SYSTEM", BoschSHCBindingConstants.THING_TYPE_INTRUSION_DETECTION_SYSTEM),
  85             new AbstractMap.SimpleEntry<>("HUE_LIGHT", BoschSHCBindingConstants.THING_TYPE_SMART_BULB),
  86             new AbstractMap.SimpleEntry<>("LEDVANCE_LIGHT", BoschSHCBindingConstants.THING_TYPE_SMART_BULB),
  87             new AbstractMap.SimpleEntry<>("SWD", BoschSHCBindingConstants.THING_TYPE_WINDOW_CONTACT),
  88             new AbstractMap.SimpleEntry<>("SWD2", BoschSHCBindingConstants.THING_TYPE_WINDOW_CONTACT_2),
  89             new AbstractMap.SimpleEntry<>("TRV", BoschSHCBindingConstants.THING_TYPE_THERMOSTAT),
  90             new AbstractMap.SimpleEntry<>("WRC2", BoschSHCBindingConstants.THING_TYPE_UNIVERSAL_SWITCH),
  91             new AbstractMap.SimpleEntry<>("SWITCH2", BoschSHCBindingConstants.THING_TYPE_UNIVERSAL_SWITCH_2),
  92             new AbstractMap.SimpleEntry<>("SMOKE_DETECTOR2", BoschSHCBindingConstants.THING_TYPE_SMOKE_DETECTOR_2)
  93 // Future Extension: map deviceModel names to BoschSHC Thing Types when they are supported
  94 //            new AbstractMap.SimpleEntry<>("SMOKE_DETECTION_SYSTEM", BoschSHCBindingConstants.),
  95 //            new AbstractMap.SimpleEntry<>("PRESENCE_SIMULATION_SERVICE", BoschSHCBindingConstants.),
  96 //            new AbstractMap.SimpleEntry<>("VENTILATION_SERVICE", BoschSHCBindingConstants.),
  97 //            new AbstractMap.SimpleEntry<>("HUE_BRIDGE", BoschSHCBindingConstants.)
  98 //            new AbstractMap.SimpleEntry<>("HUE_BRIDGE_MANAGER*", BoschSHCBindingConstants.)
  99 //            new AbstractMap.SimpleEntry<>("HUE_LIGHT_ROOM_CONTROL", BoschSHCBindingConstants.)
 100             );
 101     // @formatter:on
 102
 103     public ThingDiscoveryService() {
 104         super(BridgeHandler.class, SUPPORTED_THING_TYPES, SEARCH_TIME);
 105     }
 106
 107     @Override
 108     public void initialize() {
 109         logger.trace("initialize");
 110         thingHandler.registerDiscoveryListener(this);
 111         super.initialize();
 112     }
 113
 114     @Override
 115     public void dispose() {
 116         super.dispose();
 117         logger.trace("dispose");
 118         removeOlderResults(Instant.now().toEpochMilli(), thingHandler.getThing().getUID());
 119         thingHandler.unregisterDiscoveryListener();
 120
 121         super.deactivate();
 122     }
 123
 124     @Override
 125     protected void startScan() {
 126         try {
 127             doScan();
 128         } catch (InterruptedException e) {
 129             // Restore interrupted state...
 130             Thread.currentThread().interrupt();
 131         }
 132     }
 133
 134     @Override
 135     protected synchronized void stopScan() {
 136         logger.debug("Stop manual scan on bridge {}", thingHandler.getThing().getUID());
 137         super.stopScan();
 138         removeOlderResults(getTimestampOfLastScan(), thingHandler.getThing().getUID());
 139     }
 140
 141     public void doScan() throws InterruptedException {
 142         logger.debug("Start manual scan on bridge {}", thingHandler.getThing().getUID());
 143         // use shcBridgeHandler to getDevices()
 144         List<Room> rooms = thingHandler.getRooms();
 145         logger.debug("SHC has {} rooms", rooms.size());
 146         List<Device> devices = thingHandler.getDevices();
 147         logger.debug("SHC has {} devices", devices.size());
 148         List<UserDefinedState> userStates = thingHandler.getUserStates();
 149         logger.debug("SHC has {} user-defined states", userStates.size());
 150
 151         // Write found devices into openhab.log to support manual configuration
 152         for (Device d : devices) {
 153             logger.debug("Found device: name={} id={}", d.name, d.id);
 154             if (d.deviceServiceIds != null) {
 155                 for (String s : d.deviceServiceIds) {
 156                     logger.debug(".... service: {}", s);
 157                 }
 158             }
 159         }
 160         for (UserDefinedState userState : userStates) {
 161             logger.debug("Found user-defined state: name={} id={} state={}", userState.getName(), userState.getId(),
 162                     userState.isState());
 163         }
 164
 165         addDevices(devices, rooms);
 166         addUserStates(userStates);
 167     }
 168
 169     protected void addUserStates(List<UserDefinedState> userStates) {
 170         for (UserDefinedState userState : userStates) {
 171             addUserState(userState);
 172         }
 173     }
 174
 175     private void addUserState(UserDefinedState userState) {
 176         logger.trace("Discovering user-defined state {}", userState.getName());
 177         logger.trace("- details: id {}, state {}", userState.getId(), userState.isState());
 178
 179         ThingTypeUID thingTypeUID = new ThingTypeUID(BoschSHCBindingConstants.BINDING_ID,
 180                 BoschSHCBindingConstants.THING_TYPE_USER_DEFINED_STATE.getId());
 181
 182         logger.trace("- got thingTypeID '{}' for user-defined state '{}'", thingTypeUID.getId(), userState.getName());
 183
 184         ThingUID thingUID = new ThingUID(thingTypeUID, thingHandler.getThing().getUID(),
 185                 userState.getId().replace(':', '_'));
 186
 187         logger.trace("- got thingUID '{}' for user-defined state: '{}'", thingUID, userState);
 188
 189         DiscoveryResultBuilder discoveryResult = DiscoveryResultBuilder.create(thingUID).withThingType(thingTypeUID)
 190                 .withProperty("id", userState.getId()).withLabel(userState.getName());
 191
 192         discoveryResult.withBridge(thingHandler.getThing().getUID());
 193
 194         thingDiscovered(discoveryResult.build());
 195
 196         logger.debug("Discovered user-defined state '{}' with thingTypeUID={}, thingUID={}, id={}, state={}",
 197                 userState.getName(), thingUID, thingTypeUID, userState.getId(), userState.isState());
 198     }
 199
 200     protected void addDevices(List<Device> devices, List<Room> rooms) {
 201         for (Device device : devices) {
 202             addDevice(device, getRoomNameForDevice(device, rooms));
 203         }
 204     }
 205
 206     protected String getRoomNameForDevice(Device device, List<Room> rooms) {
 207         return rooms.stream().filter(room -> room.id.equals(device.roomId)).findAny().map(r -> r.name).orElse("");
 208     }
 209
 210     protected void addDevice(Device device, String roomName) {
 211         // see startScan for the runtime null check of shcBridgeHandler
 212         logger.trace("Discovering device {}", device.name);
 213         logger.trace("- details: id {}, roomId {}, deviceModel {}", device.id, device.roomId, device.deviceModel);
 214
 215         ThingTypeUID thingTypeUID = getThingTypeUID(device);
 216         if (thingTypeUID == null) {
 217             return;
 218         }
 219
 220         logger.trace("- got thingTypeID '{}' for deviceModel '{}'", thingTypeUID.getId(), device.deviceModel);
 221
 222         ThingUID thingUID = new ThingUID(thingTypeUID, thingHandler.getThing().getUID(), device.id.replace(':', '_'));
 223
 224         logger.trace("- got thingUID '{}' for device: '{}'", thingUID, device);
 225
 226         DiscoveryResultBuilder discoveryResult = DiscoveryResultBuilder.create(thingUID).withThingType(thingTypeUID)
 227                 .withProperty("id", device.id).withLabel(getNiceName(device.name, roomName));
 228         discoveryResult.withBridge(thingHandler.getThing().getUID());
 229         if (!roomName.isEmpty()) {
 230             discoveryResult.withProperty("Location", roomName);
 231         }
 232         thingDiscovered(discoveryResult.build());
 233
 234         logger.debug("Discovered device '{}' with thingTypeUID={}, thingUID={}, id={}, deviceModel={}", device.name,
 235                 thingUID, thingTypeUID, device.id, device.deviceModel);
 236     }
 237
 238     private String getNiceName(String name, String roomName) {
 239         if (!name.startsWith("-")) {
 240             return name;
 241         }
 242
 243         // convert "-IntrusionDetectionSystem-" into "Intrusion Detection System"
 244         // convert "-RoomClimateControl-" into "Room Climate Control myRoomName"
 245         final char[] chars = name.toCharArray();
 246         StringBuilder niceNameBuilder = new StringBuilder(32);
 247         for (int pos = 0; pos < chars.length; pos++) {
 248             // skip "-"
 249             if (chars[pos] == '-') {
 250                 continue;
 251             }
 252             // convert "CamelCase" into "Camel Case", skipping the first Uppercase after the "-"
 253             if (pos > 1 && Character.getType(chars[pos]) == Character.UPPERCASE_LETTER) {
 254                 niceNameBuilder.append(" ");
 255             }
 256             niceNameBuilder.append(chars[pos]);
 257         }
 258         // append roomName for "Room Climate Control", because it appears for each room with a thermostat
 259         if (!roomName.isEmpty() && niceNameBuilder.toString().startsWith("Room Climate Control")) {
 260             niceNameBuilder.append(" ").append(roomName);
 261         }
 262         return niceNameBuilder.toString();
 263     }
 264
 265     protected @Nullable ThingTypeUID getThingTypeUID(Device device) {
 266         @Nullable
 267         ThingTypeUID thingTypeId = DEVICEMODEL_TO_THINGTYPE_MAP.get(device.deviceModel);
 268         if (thingTypeId != null) {
 269             return new ThingTypeUID(BoschSHCBindingConstants.BINDING_ID, thingTypeId.getId());
 270         }
 271         logger.debug("Unknown deviceModel '{}'! Please create a support request issue for this unknown device model.",
 272                 device.deviceModel);
 273         return null;
 274     }
 275 }