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
018/**
019 * This class lists all the possible options that have been set while
020 * receiving an XBee packet.
021 * 
022 * <p>The receive options are usually set as a bitfield meaning that the 
023 * options can be combined using the '|' operand.</p>
024 */
025public class XBeeReceiveOptions {
026
027        /**
028         * No special receive options (value: {@value}).
029         */
030        public static final int NONE = 0x00;
031        
032        /**
033         * Packet was acknowledged (value: {@value}).
034         * 
035         * <p>Not valid for Wi-Fi protocol</p>
036         */
037        public static final int PACKET_ACKNOWLEDGED = 0x01;
038        
039        /**
040         * Packet was a broadcast packet (value: {@value}).
041         * 
042         * <p>Not valid for Wi-Fi protocol</p>
043         */
044        public static final int BROADCAST_PACKET = 0x02;
045        
046        /**
047         * Packet encrypted with APS encryption (value: {@value}).
048         * 
049         * <p>Only valid for ZigBee XBee protocol.</p>
050         */
051        public static final int APS_ENCRYPTED = 0x20;
052        
053        /**
054         * Packet was sent from an end device, if known (value: {@value}).
055         * 
056         * <p>Only valid for ZigBee XBee protocol.</p>
057         */
058        public static final int SENT_FROM_END_DEVICE = 0x40;
059}