001/**
002 * Copyright (c) 2014 Digi International Inc.,
003 * All rights not expressly granted are reserved.
004 *
005 * This Source Code Form is subject to the terms of the Mozilla Public
006 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
007 * You can obtain one at http://mozilla.org/MPL/2.0/.
008 *
009 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
010 * =======================================================================
011 */
012package com.digi.xbee.api.models;
013
014import com.digi.xbee.api.packet.common.RemoteATCommandPacket;
015
016/**
017 * This class lists all the possible options that can be set while transmitting
018 * a remote AT Command.
019 * 
020 * <p>These options are usually set as a bitfield meaning that the options 
021 * can be combined using the '|' operand.</p>
022 * 
023 * @see RemoteATCommandPacket
024 */
025public class RemoteATCommandOptions {
026        
027        /**
028         * No special transmit options (value: {@value}).
029         */
030        public final static int OPTION_NONE = 0x00;
031        
032        /**
033         * Disables ACK (value: {@value}).
034         */
035        public final static int OPTION_DISABLE_ACK = 0x01;
036        
037        /**
038         * Applies changes in the remote device (value: {@value}).
039         * 
040         * <p>If this option is not set, AC command must be sent before changes 
041         * will take effect.</p>
042         */
043        public final static int OPTION_APPLY_CHANGES = 0x02;
044        
045        /**
046         * Uses the extended transmission timeout (value: {@value}).
047         * 
048         * <p>Setting the extended timeout bit causes the stack to set the extended 
049         * transmission timeout for the destination address.</p>
050         * 
051         * <p>Only valid for ZigBee XBee protocol.</p>
052         */
053        public final static int OPTION_EXTENDED_TIMEOUT = 0x40;
054}