com.rapplogic.xbee.api.wpan.RxBaseResponse Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2008 Andrew Rapp. All rights reserved.
 *  
 * This file is part of XBee-API.
 *  
 * XBee-API is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *  
 * XBee-API is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *  
 * You should have received a copy of the GNU General Public License
 * along with XBee-API.  If not, see .
 */

package com.rapplogic.xbee.api.wpan;

import java.io.IOException;

import com.rapplogic.xbee.api.IPacketParser;
import com.rapplogic.xbee.api.XBeeAddress;
import com.rapplogic.xbee.api.XBeeResponse;
import com.rapplogic.xbee.util.ByteUtils;
import com.rapplogic.xbee.util.IIntInputStream;

/**
 * Series 1 XBee.  Common elements of 16 and 64 bit Address Receive packets
 * 
 * @author andrew
 *
 */
public abstract class RxBaseResponse extends XBeeResponse {

	private XBeeAddress sourceAddress;
	
	private int rssi;
	private int options;
	
	public RxBaseResponse() {

	}

	public int getRssi() {
		return rssi;
	}

	public void setRssi(int rssi) {
		this.rssi = rssi;
	}

	public int getOptions() {
		return options;
	}

	public void setOptions(int options) {
		this.options = options;
	}
	
	public boolean isAddressBroadcast() {
		return ByteUtils.getBit(options, 2);
	}
	
	public boolean isPanBroadcast() {
		return ByteUtils.getBit(options, 3);
	}

	/**
	 * Returns either a XBeeAddress16 or XBeeAddress64
	 * depending on if the packet is configured for 16 or 64 bit addressing.
	 * 
	 * @return
	 */
	public XBeeAddress getSourceAddress() {
		return sourceAddress;
	}
	
	public void setSourceAddress(XBeeAddress sourceAddress) {
		this.sourceAddress = sourceAddress;
	}
	
	protected void parseBase(IPacketParser parser) throws IOException {
		int rssi = parser.read("RSSI");
		
		// rssi is a negative dbm value
		this.setRssi(-rssi);
		
		int options = parser.read("Options");
		
		this.setOptions(options);
	}

	public String toString() {
		return super.toString() + ",sourceAddress=" + this.getSourceAddress() + ",rssi=" + this.getRssi() + ",options=" + this.getOptions() +
			",isAddressBroadcast=" + this.isAddressBroadcast() + ",isPanBroadcast=" + this.isPanBroadcast();
	}
}