com.rapplogic.xbee.api.AtCommand 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.ByteUtils;
import com.rapplogic.xbee.util.IntArrayOutputStream;

/** 
 * API technique to set/query commands
 * 
 * WARNING: Any changes made will not survive a power cycle unless written to memory with WR command
 * According to the manual, the WR command can only be written so many times.. however many that is.
 * 

 * API ID: 0x8
 * 

 * Determining radio type with HV:

 * Byte 1, Part Number

 * x17, XB24 (series 1)

 * x18, XBP24 (series 1)

 * x19, XB24-B (series 2)

 * x1A, XBP24-B (series 2)

 * 
 * XB24-ZB

 * XBP24-ZB

 * @author andrew
 */
public class AtCommand extends XBeeRequest {
	
	private String command;
	private int[] value;
	
//	// common i/o pin settings.  it is up to the developer to ensure the setting is applicable to the pin (e.g. not all pins support analog input)
//	public enum IoSetting {
//		DISABLED (new int[] {0x0}),
//		ANALOG_INPUT (new int[] {0x2}),
//		DIGITAL_INPUT (new int[] {0x3}),
//		DIGITAL_OUTPUT_LOW (new int[] {0x4}),
//		DIGITAL_OUTPUT_HIGH (new int[] {0x5});
//		
//	    private final int[] value;
//	    
//	    IoSetting(int[] value) {
//	        this.value = value;
//	    }
//	}
	
	public AtCommand(String command) {
		this(command, null, DEFAULT_FRAME_ID);
	}
	
	public AtCommand(String command, int value) {
		this(command, new int[] {value}, DEFAULT_FRAME_ID);		
	}

	public AtCommand(String command, int value[]) {
		this(command, value, DEFAULT_FRAME_ID);
	}
	
	/**
	 * Warning: frameId must be > 0 for a response
	 * 
	 * @param command
	 * @param value
	 * @param frameId
	 */
	public AtCommand(String command, int[] value, int frameId) {
		this.command = command;
		this.value = value;
		this.setFrameId(frameId);
	}

	public int[] getFrameData() {
		if (command.length() > 2) {
			throw new IllegalArgumentException("Command should be two characters.  Do not include AT prefix");
		}
		
		IntArrayOutputStream out = new IntArrayOutputStream();
		
		// api id
		out.write(this.getApiId().getValue());
		// frame id
		out.write(this.getFrameId());
		// at command byte 1
		out.write((int) command.substring(0, 1).toCharArray()[0]);
		// at command byte 2
		out.write((int) command.substring(1, 2).toCharArray()[0]);

		// int value is up to four bytes to represent command value
		if (value != null) {
			out.write(value);
		}
		
		return out.getIntArray();
	}

	public ApiId getApiId() {
		return ApiId.AT_COMMAND;
	}
	
	public String getCommand() {
		return command;
	}

	public void setCommand(String command) {
		this.command = command;
	}

	public int[] getValue() {
		return value;
	}

	public void setValue(int[] value) {
		this.value = value;
	}

	public String toString() {
		return super.toString() +
			",command=" + this.command +
			",value=" + (value == null ? "null" : ByteUtils.toBase16(value));
	}
}