xbee_user.h

   1 /*
   2  * Copyright (c) 2014, Olivier MATZ <zer0@droids-corp.org>
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the University of California, Berkeley nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef _XBEE_USER_H_
  29 #define _XBEE_USER_H_
  30
  31 #include <callout.h>
  32 #include <xbee_rxtx.h>
  33
  34 #define XBEE_USER_RETCODE_OK         0
  35 #define XBEE_USER_RETCODE_BAD_FRAME  1
  36 #define XBEE_USER_RETCODE_TIMEOUT    2
  37
  38 /* called when we receive an answer to a query */
  39 typedef int8_t (xbee_user_rx_cb_t)(int8_t code, void *frame,
  40         unsigned len, void *arg);
  41
  42 /* used for timeouts and xbee rx callback */
  43 struct xbee_ctx {
  44         int channel;
  45         char atcmd_query[2]; /* 00 is it's data */
  46         xbee_user_rx_cb_t *rx_cb;
  47         void *arg;
  48         struct callout timeout;
  49 };
  50
  51 //extern cmdline_parse_ctx_t main_ctx;
  52 extern struct xbee_dev *xbee_dev;
  53 extern int xbee_raw;
  54
  55 /* we use a specific structure to send packets. It allows to prepend some
  56  * data in the frame without doing a copy. */
  57 struct xbeeapp_pkt {
  58         char *buf;
  59         unsigned len;
  60         unsigned headroom;
  61         unsigned tailroom;
  62 };
  63
  64 /* Write in a human readable format the content of an atcmd response frame. It
  65  * assumes the frame is valid .*/
  66 void atresp_to_str(char *buf, unsigned buflen, const struct xbee_atresp_hdr *frame,
  67         unsigned len);
  68
  69 /* callback registered to xbee module, called when a xbee frame is received */
  70 int8_t xbeeapp_rx(struct xbee_dev *dev, int channel, int type,
  71         void *frame, unsigned len, void *opaque);
  72
  73 /* Send an AT command to the xbee device. The callback function for the answer
  74  * is given as a parameter */
  75 int xbeeapp_send_atcmd(char *atcmd_str, void *param,
  76         unsigned param_len, xbee_user_rx_cb_t *rx_cb, void *arg);
  77
  78 /* send a message to a peer */
  79 int xbeeapp_send_msg(uint64_t addr, struct xbee_msg *msg,
  80         xbee_user_rx_cb_t *rx_cb, void *arg);
  81
  82 void xbee_stdin_enable(void);
  83 void xbee_stdin_disable(void);
  84
  85 void xbee_load_timeout(struct xbee_ctx *ctx);
  86 void xbee_unload_timeout(struct xbee_ctx *ctx);
  87
  88 void xbee_mainloop(void);
  89
  90 void xbeeapp_init(void);
  91
  92 #endif /* _XBEE_USER_H_ */