001/**
002 * Copyright 2017, Digi International Inc.
003 *
004 * This Source Code Form is subject to the terms of the Mozilla Public
005 * License, v. 2.0. If a copy of the MPL was not distributed with this
006 * file, you can obtain one at http://mozilla.org/MPL/2.0/.
007 *
008 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
009 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
010 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
011 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
012 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
013 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
014 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
015 */
016package com.digi.xbee.api.models;
017
018import com.digi.xbee.api.packet.common.RemoteATCommandPacket;
019
020/**
021 * This class lists all the possible options that can be set while transmitting
022 * a remote AT Command.
023 * 
024 * <p>These options are usually set as a bitfield meaning that the options 
025 * can be combined using the '|' operand.</p>
026 * 
027 * @see RemoteATCommandPacket
028 */
029public class RemoteATCommandOptions {
030        
031        /**
032         * No special transmit options (value: {@value}).
033         */
034        public final static int OPTION_NONE = 0x00;
035        
036        /**
037         * Disables ACK (value: {@value}).
038         */
039        public final static int OPTION_DISABLE_ACK = 0x01;
040        
041        /**
042         * Applies changes in the remote device (value: {@value}).
043         * 
044         * <p>If this option is not set, AC command must be sent before changes 
045         * will take effect.</p>
046         */
047        public final static int OPTION_APPLY_CHANGES = 0x02;
048        
049        /**
050         * Uses the extended transmission timeout (value: {@value}).
051         * 
052         * <p>Setting the extended timeout bit causes the stack to set the extended 
053         * transmission timeout for the destination address.</p>
054         * 
055         * <p>Only valid for ZigBee XBee protocol.</p>
056         */
057        public final static int OPTION_EXTENDED_TIMEOUT = 0x40;
058}