forked from openhab/openhab-core
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[automation] Added group and system triggers to automation component (o…
…penhab#1509) * Added group and system triggers to automation component Signed-off-by: Kai Kreuzer <kai@openhab.org> GitOrigin-RevId: d265e16
- Loading branch information
1 parent
d408434
commit 0566384
Showing
7 changed files
with
620 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
137 changes: 137 additions & 0 deletions
137
.../java/org/openhab/core/automation/internal/module/handler/GroupCommandTriggerHandler.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| /** | ||
| * Copyright (c) 2010-2020 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.core.automation.internal.module.handler; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.Dictionary; | ||
| import java.util.HashMap; | ||
| import java.util.Hashtable; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.openhab.core.automation.Trigger; | ||
| import org.openhab.core.automation.handler.BaseTriggerModuleHandler; | ||
| import org.openhab.core.automation.handler.TriggerHandlerCallback; | ||
| import org.openhab.core.events.Event; | ||
| import org.openhab.core.events.EventFilter; | ||
| import org.openhab.core.events.EventSubscriber; | ||
| import org.openhab.core.items.Item; | ||
| import org.openhab.core.items.ItemRegistry; | ||
| import org.openhab.core.items.events.ItemCommandEvent; | ||
| import org.openhab.core.types.Command; | ||
| import org.osgi.framework.BundleContext; | ||
| import org.osgi.framework.ServiceRegistration; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * This is an ModuleHandler implementation for Triggers which trigger the rule | ||
| * if a member of an item group receives a command. | ||
| * The group name and command value can be set with the configuration. | ||
| * | ||
| * @author Kai Kreuzer - Initial contribution | ||
| */ | ||
| @NonNullByDefault | ||
| public class GroupCommandTriggerHandler extends BaseTriggerModuleHandler implements EventSubscriber, EventFilter { | ||
|
|
||
| private final Logger logger = LoggerFactory.getLogger(GroupCommandTriggerHandler.class); | ||
|
|
||
| private final String groupName; | ||
| private final String command; | ||
| private final String topic; | ||
|
|
||
| private final Set<String> types; | ||
| private final BundleContext bundleContext; | ||
|
|
||
| public static final String MODULE_TYPE_ID = "core.GroupCommandTrigger"; | ||
|
|
||
| private static final String CFG_GROUPNAME = "groupName"; | ||
| private static final String CFG_COMMAND = "command"; | ||
|
|
||
| private ServiceRegistration<?> eventSubscriberRegistration; | ||
| private @Nullable ItemRegistry itemRegistry; | ||
|
|
||
| public GroupCommandTriggerHandler(Trigger module, BundleContext bundleContext) { | ||
| super(module); | ||
| this.groupName = (String) module.getConfiguration().get(CFG_GROUPNAME); | ||
| this.command = (String) module.getConfiguration().get(CFG_COMMAND); | ||
| this.types = Collections.singleton(ItemCommandEvent.TYPE); | ||
| this.bundleContext = bundleContext; | ||
| Dictionary<String, Object> properties = new Hashtable<>(); | ||
| this.topic = "smarthome/items/"; | ||
| properties.put("event.topics", topic); | ||
| eventSubscriberRegistration = this.bundleContext.registerService(EventSubscriber.class.getName(), this, | ||
| properties); | ||
| } | ||
|
|
||
| @Override | ||
| public Set<String> getSubscribedEventTypes() { | ||
| return types; | ||
| } | ||
|
|
||
| @Override | ||
| public @Nullable EventFilter getEventFilter() { | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public void receive(Event event) { | ||
| if (callback instanceof TriggerHandlerCallback) { | ||
| TriggerHandlerCallback cb = (TriggerHandlerCallback) callback; | ||
| logger.trace("Received Event: Source: {} Topic: {} Type: {} Payload: {}", event.getSource(), | ||
| event.getTopic(), event.getType(), event.getPayload()); | ||
| Map<String, Object> values = new HashMap<>(); | ||
| if (event instanceof ItemCommandEvent) { | ||
| ItemCommandEvent icEvent = (ItemCommandEvent) event; | ||
| String itemName = icEvent.getItemName(); | ||
| if (itemRegistry != null) { | ||
| Item item = itemRegistry.get(itemName); | ||
| if (item != null && item.getGroupNames().contains(groupName)) { | ||
| Command command = icEvent.getItemCommand(); | ||
| if (this.command.equals(command.toFullString())) { | ||
| values.put("triggeringItem", item); | ||
| values.put("command", command); | ||
| values.put("event", event); | ||
| cb.triggered(this.module, values); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * do the cleanup: unregistering eventSubscriber... | ||
| */ | ||
| @Override | ||
| public void dispose() { | ||
| super.dispose(); | ||
| eventSubscriberRegistration.unregister(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean apply(Event event) { | ||
| logger.trace("->FILTER: {}", event.getTopic()); | ||
| return event.getTopic().startsWith(topic); | ||
| } | ||
|
|
||
| public void setItemRegistry(ItemRegistry itemRegistry) { | ||
| this.itemRegistry = itemRegistry; | ||
| } | ||
|
|
||
| public void unsetItemRegistry(ItemRegistry itemRegistry) { | ||
| this.itemRegistry = null; | ||
| } | ||
| } |
Oops, something went wrong.