/**
* 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.zwave.internal.converter;
import java.util.Map;
import org.openhab.binding.zwave.internal.converter.command.ZWaveCommandConverter;
import org.openhab.binding.zwave.internal.converter.state.BatteryDecimalTypeConverter;
import org.openhab.binding.zwave.internal.converter.state.BatteryPercentTypeConverter;
import org.openhab.binding.zwave.internal.converter.state.ZWaveStateConverter;
import org.openhab.binding.zwave.internal.protocol.SerialMessage;
import org.openhab.binding.zwave.internal.protocol.ZWaveController;
import org.openhab.binding.zwave.internal.protocol.ZWaveNode;
import org.openhab.binding.zwave.internal.protocol.commandclass.ZWaveBatteryCommandClass;
import org.openhab.binding.zwave.internal.protocol.event.ZWaveCommandClassValueEvent;
import org.openhab.core.events.EventPublisher;
import org.openhab.core.items.Item;
import org.openhab.core.types.Command;
import org.openhab.core.types.State;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/***
* ZWaveBatteryConverter class. Converter for communication with the
* {@link ZWaveBatteryCommandClass}. Implements polling of the battery
* status and receiving of battery events.
*
* @author Jan-Willem Spuij
* @since 1.4.0
*/
public class ZWaveBatteryConverter extends ZWaveCommandClassConverter<ZWaveBatteryCommandClass> {
private static final Logger logger = LoggerFactory.getLogger(ZWaveBatteryConverter.class);
private static final int REFRESH_INTERVAL = 3600; // refresh interval in seconds for the battery level;
/**
* Constructor. Creates a new instance of the {@link ZWaveBatteryConverter} class.
*
* @param controller the {@link ZWaveController} to use for sending messages.
* @param eventPublisher the {@link EventPublisher} to use to publish events.
*/
public ZWaveBatteryConverter(ZWaveController controller, EventPublisher eventPublisher) {
super(controller, eventPublisher);
// State and commmand converters used by this converter.
this.addStateConverter(new BatteryDecimalTypeConverter());
this.addStateConverter(new BatteryPercentTypeConverter());
}
/**
* {@inheritDoc}
*/
@Override
public SerialMessage executeRefresh(ZWaveNode node, ZWaveBatteryCommandClass commandClass, int endpointId,
Map<String, String> arguments) {
logger.debug("NODE {}: Generating poll message for {} endpoint {}", node.getNodeId(),
commandClass.getCommandClass().getLabel(), endpointId);
return node.encapsulate(commandClass.getValueMessage(), commandClass, endpointId);
}
/**
* {@inheritDoc}
*/
@Override
public void handleEvent(ZWaveCommandClassValueEvent event, Item item, Map<String, String> arguments) {
ZWaveStateConverter<?, ?> converter = this.getStateConverter(item, event.getValue());
if (converter == null) {
logger.warn("No converter found for item = {}, node = {} endpoint = {}, ignoring event.", item.getName(),
event.getNodeId(), event.getEndpoint());
return;
}
State state = converter.convertFromValueToState(event.getValue());
this.getEventPublisher().postUpdate(item.getName(), state);
}
/**
* {@inheritDoc}
*/
@Override
public void receiveCommand(Item item, Command command, ZWaveNode node, ZWaveBatteryCommandClass commandClass,
int endpointId, Map<String, String> arguments) {
ZWaveCommandConverter<?, ?> converter = this.getCommandConverter(command.getClass());
if (converter == null) {
logger.warn("No converter found for item = {}, node = {} endpoint = {}, ignoring command.", item.getName(),
node.getNodeId(), endpointId);
return;
}
}
/**
* {@inheritDoc}
*/
@Override
int getRefreshInterval() {
return REFRESH_INTERVAL;
}
}