Colony

/**

 * Copyright (c) 2009 Colony Project

 *

 * Permission is hereby granted, free of charge, to any person

 * obtaining a copy of this software and associated documentation

 * files (the "Software"), to deal in the Software without

 * restriction, including without limitation the rights to use,

 * copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the

 * Software is furnished to do so, subject to the following

 * conditions:

 *

 * The above copyright notice and this permission notice shall be

 * included in all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

 * OTHER DEALINGS IN THE SOFTWARE.

 **/

/**

 * @file wireless_send.c

 * @brief Wireless library send functions

 *

 * Implementation of high level wireless communication.

 * This is the send functions portion of the library.

 *

 * @author Colony Project, CMU Robotics Club

 **/

#include "wl_defs.h"

#include "wireless.h"

// the send functions

/**

 * @addtogroup wireless Wireless

 * @{

 **/

/**

 * The core send function. This will take all possible arguments and send all types of packets.

 * 

 * @param data pointer to the byte array of data to be included in the packet

 * @param length the length of the data array

 * @param group the packet group of the packet

 * @param scope flag for sending global packet, to your current PAN, or to a specific robot

 * @param dest robot ID (for robot to robot packet)

 * @param mode flag for using TCP or UDP

 *

 * @return 0 for OK, or error code (TBD)

 **/

int8_t wl_send(char *data, uint8_t length, uint8_t group, uint8_t scope, uint8_t dest, uint8_t mode) {

  return 0;

}

/**

 * Wrapper for core send function that will send a global packet across the current channel.

 *

 * @param data pointer to the byte array of data to be included in the packet

 * @param length the length of the data array

 * @param group the packet group of the packet

 *

 * @return 0 for OK, or error code (TBD)

 **/

int8_t wl_send_global(char *data, uint8_t length, uint8_t group) {

  return 0;

}

/**

 * Wrapper for core send function that will send a packet across the current channel on the current pan.

 *

 * @param data pointer to the byte array of data to be included in the packet

 * @param length the length of the data array

 * @param group the packet group of the packet

 *

 * @return 0 for OK, or error code (TBD)

 **/

int8_t wl_send_pan(char *data, uint8_t length, uint8_t group) {

  return 0;

}

/**

 * Wrapper for core send function that will send a packet across the current channel to a specific robot. 

 *

 * @param data pointer to the byte array of data to be included in the packet

 * @param length the length of the data array

 * @param group the packet group of the packet 

 * @param dest robot ID (for robot to robot packet)

 * @param mode flag for using TCP or UDP

 *

 * @return 0 for OK, or error code (TBD)

 **/

int8_t wl_send_robot(char *data, uint8_t length, uint8_t group, uint8_t dest, uint8_t mode) {

  return 0;

}

/**

 * Default (i.e. basic) send wrapper.

 *

 * @param data pointer to the byte array of data to be included in the packet

 * @param length the length of the data array

 *

 * @return 0 for OK, or error code (TBD)

 **/

int8_t wl_send_basic(char *data, uint8_t length) {

  return 0;

}

/**

 * acknowledgment error

 * you call this function periodically to check if any of the packets you have sent have been lost

 *

 * note that all other error checking will be handled by library, so your user behavior won't have to worry about it

 *

 * @return an error code (or maybe the # of packets you have lost)

 **/

int8_t wl_ack_error(void) {

  return 0;

}

/**@} **/ //end defgroup

// Define all private functions down here