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