com.digi.xbee.api.models.RemoteATCommandOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xbee-java-library Show documentation

There is a newer version: 1.3.2

/**
 * Copyright 2017, Digi International Inc.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, you can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
package com.digi.xbee.api.models;

import com.digi.xbee.api.packet.common.RemoteATCommandPacket;

/**
 * This class lists all the possible options that can be set while transmitting
 * a remote AT Command.
 * 
 * These options are usually set as a bitfield meaning that the options 
 * can be combined using the '|' operand.
 * 
 * @see RemoteATCommandPacket
 */
public class RemoteATCommandOptions {
	
	/**
	 * No special transmit options (value: {@value}).
	 */
	public final static int OPTION_NONE = 0x00;
	
	/**
	 * Disables ACK (value: {@value}).
	 */
	public final static int OPTION_DISABLE_ACK = 0x01;
	
	/**
	 * Applies changes in the remote device (value: {@value}).
	 * 
	 * If this option is not set, AC command must be sent before changes 
	 * will take effect.
	 */
	public final static int OPTION_APPLY_CHANGES = 0x02;
	
	/**
	 * Uses the extended transmission timeout (value: {@value}).
	 * 
	 * Setting the extended timeout bit causes the stack to set the extended 
	 * transmission timeout for the destination address.
	 * 
	 * Only valid for ZigBee XBee protocol.
	 */
	public final static int OPTION_EXTENDED_TIMEOUT = 0x40;
}