com.rapplogic.xbee.api.RemoteAtRequest 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;

import com.rapplogic.xbee.util.IntArrayOutputStream;

/**
 * Supported by both series 1 (10C8 firmware and later) and series 2.
 * Allows AT commands to be sent to a remote radio.
 * 
 * Warning: this command may not return a response if the remote radio is unreachable.
 * You will need to set your own timeout when waiting for a response from this command,
 * or you may wait forever.
 * 

 * API ID: 0x17
 * 

 * @author andrew
 *
 */
public class RemoteAtRequest extends AtCommand {
	
	private XBeeAddress64 remoteAddr64;
	private XBeeAddress16 remoteAddr16;
	private boolean applyChanges;
	
	/**
	 * Creates a Remote AT request for setting an AT command on a remote XBee
	 * 

	 * Note: When setting a value, you must set applyChanges for the setting to
	 * take effect.  When sending several requests, you can wait until the last
	 * request before setting applyChanges=true.
	 * 

	 * @param frameId
	 * @param remoteAddress64
	 * @param remoteAddress16
	 * @param applyChanges set to true if setting a value or issuing a command that changes the state of the radio (e.g. FR); not applicable to query requests 
	 * @param command two character AT command to set or query
	 * @param value if null then the current setting will be queried
	 */
	public RemoteAtRequest(int frameId, XBeeAddress64 remoteAddress64, XBeeAddress16 remoteAddress16, boolean applyChanges, String command, int[] value) {
		super(command, value);
		this.setFrameId(frameId);
		this.remoteAddr64 = remoteAddress64;
		this.remoteAddr16 = remoteAddress16;
		this.applyChanges = applyChanges;
	}

	public RemoteAtRequest(int frameId, XBeeAddress64 remoteAddress64, XBeeAddress16 remoteAddress16, boolean applyChanges, String command, int value) {
		this(frameId, remoteAddress64, remoteAddress16, applyChanges, command, new int[] {value});
	}
	
	/**
	 * Creates a Remote AT request for querying the current value of an AT command on a remote XBee
	 * 
	 * @param frameId
	 * @param remoteAddress64
	 * @param remoteAddress16
	 * @param applyChanges
	 * @param command
	 */
	public RemoteAtRequest(int frameId, XBeeAddress64 remoteAddress64, XBeeAddress16 remoteAddress16, boolean applyChanges, String command) {
		this(frameId, remoteAddress64, remoteAddress16, applyChanges, command, null);
	}

	/**
	 * Abbreviated Constructor for setting an AT command on a remote XBee.
	 * This defaults to the DEFAULT_FRAME_ID, and true for apply changes
	 * 
	 * @param dest64
	 * @param command
	 * @param value
	 */
	public RemoteAtRequest(XBeeAddress64 dest64, String command, int[] value) {
		// Note: the ZNET broadcast also works for series 1.  We could also use ffff but then that wouldn't work for series 2
		this(XBeeRequest.DEFAULT_FRAME_ID, dest64, XBeeAddress16.ZNET_BROADCAST, true, command, value);
	}

	public RemoteAtRequest(XBeeAddress64 dest64, String command, int value) {
		this(XBeeRequest.DEFAULT_FRAME_ID, dest64, XBeeAddress16.ZNET_BROADCAST, true, command, new int[] {value});
	}
	
	/**
	 * Abbreviated Constructor for querying the value of an AT command on a remote XBee.
	 * This defaults to the DEFAULT_FRAME_ID, and false for apply changes
	 * 
	 * @param dest64
	 * @param command
	 */
	public RemoteAtRequest(XBeeAddress64 dest64, String command) {
		this(dest64, command, null);
		// apply changes doesn't make sense for a query
		this.setApplyChanges(false);
	}

	/**
	 * Creates a Remote AT instance for querying the value of an AT command on a remote XBee, 
	 * by specifying the 16-bit address.  Uses the broadcast address for 64-bit address (00 00 00 00 00 00 ff ff)
	 * 

	 * Defaults are: frame id: 1, applyChanges: false
	 * 
	 * @param dest64
	 * @param command
	 */
	public RemoteAtRequest(XBeeAddress16 dest16, String command) {
		this(dest16, command, null);
		// apply changes doesn't make sense for a query
		this.setApplyChanges(false);
	}

	/**
	 * Creates a Remote AT instance for setting the value of an AT command on a remote XBee, 
	 * by specifying the 16-bit address and value.  Uses the broadcast address for 64-bit address (00 00 00 00 00 00 ff ff)
	 * 
	 * Defaults are: frame id: 1, applyChanges: true
	 * 
	 * @param remoteAddress16
	 * @param command
	 */
	public RemoteAtRequest(XBeeAddress16 remoteAddress16, String command, int[] value) {
		this(XBeeRequest.DEFAULT_FRAME_ID, XBeeAddress64.BROADCAST, remoteAddress16, true, command, value);
	}

	public RemoteAtRequest(XBeeAddress16 remoteAddress16, String command, int value) {
		this(XBeeRequest.DEFAULT_FRAME_ID, XBeeAddress64.BROADCAST, remoteAddress16, true, command, new int[] {value});
	}
	
	public int[] getFrameData() {		
		IntArrayOutputStream out = new IntArrayOutputStream();
		
		// api id
		out.write(this.getApiId().getValue());
		// frame id (arbitrary byte that will be sent back with ack)
		out.write(this.getFrameId());
		
		out.write(remoteAddr64.getAddress());
		
		// 16-bit address
		out.write(remoteAddr16.getAddress());
		
		// TODO S2B remote command options
		// TODO 0x40 is a bit field, ugh
//		0x01 - Disable retries and route repair
//		0x02 - Apply changes.
//		0x20 - Enable APS encryption (if EE=1)
//		0x40 - Use the extended transmission timeout
		
		if (applyChanges) {
			out.write(2);	
		} else {
			// queue changes -- don't forget to send AC command
			out.write(0);
		}
		 
		// command name ascii [1]
		out.write((int) this.getCommand().substring(0, 1).toCharArray()[0]);
		// command name ascii [2]
		out.write((int) this.getCommand().substring(1, 2).toCharArray()[0]);
	
		if (this.getValue() != null) {
			out.write(this.getValue());
		}

		return out.getIntArray();
	}
	
	public ApiId getApiId() {
		return ApiId.REMOTE_AT_REQUEST;
	}
	
	public XBeeAddress64 getRemoteAddr64() {
		return remoteAddr64;
	}

	public void setRemoteAddr64(XBeeAddress64 remoteAddr64) {
		this.remoteAddr64 = remoteAddr64;
	}

	public XBeeAddress16 getRemoteAddr16() {
		return remoteAddr16;
	}

	public void setRemoteAddr16(XBeeAddress16 remoteAddr16) {
		this.remoteAddr16 = remoteAddr16;
	}

	public boolean isApplyChanges() {
		return applyChanges;
	}

	public void setApplyChanges(boolean applyChanges) {
		this.applyChanges = applyChanges;
	}
	
	public String toString() {
		return super.toString() + 
			",remoteAddr64=" + this.remoteAddr64 +
			",remoteAddr16=" + this.remoteAddr16 +
			",applyChanges=" + this.applyChanges;
	}
}