sms.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
 * =======================================================================
 */

#ifndef XBEE_SMS_H
#define XBEE_SMS_H

#include "xbee/platform.h"
#include "xbee/device.h"

#if !XBEE_CELLULAR_ENABLED
   #error "XBEE_CELLULAR_ENABLED must be defined as non-zero " \
      "to use this header."
#endif

XBEE_BEGIN_DECLS

#define XBEE_FRAME_TRANSMIT_SMS                     0x1F

#define XBEE_FRAME_RECEIVE_SMS                      0x9F

#define XBEE_SMS_MAX_PHONE_LENGTH         20
#define XBEE_SMS_MAX_MESSAGE_LENGTH       160

typedef XBEE_PACKED(xbee_frame_transmit_sms_t, {
   uint8_t        frame_type;          
   uint8_t        frame_id;
   uint8_t        options;             
   char           phone[XBEE_SMS_MAX_PHONE_LENGTH];      
   
   char        message[XBEE_SMS_MAX_MESSAGE_LENGTH];
}) xbee_frame_transmit_sms_t;

typedef XBEE_PACKED(xbee_frame_receive_sms_t, {
   uint8_t        frame_type;          
   char           phone[XBEE_SMS_MAX_PHONE_LENGTH];

   char        message[1];
}) xbee_frame_receive_sms_t;

typedef XBEE_PACKED(xbee_header_transmit_sms_t, {
   uint8_t        frame_type;          
   uint8_t        frame_id;
   uint8_t        options;             
   char        phone[XBEE_SMS_MAX_PHONE_LENGTH];
}) xbee_header_transmit_sms_t;

int xbee_sms_send(xbee_dev_t *xbee, const char *phone, const char *message,
   uint16_t options);

// XBEE_SMS_SEND_OPT_xxx values from 0x0001 to 0x0080 reserved for
// xbee_frame_transmit_sms_t.options.
#define XBEE_SMS_SEND_OPT_NO_STATUS    0x8000

int xbee_sms_receive_dump(xbee_dev_t *xbee, const void FAR *raw,
   uint16_t length, void FAR *context);

XBEE_END_DECLS

// If compiling in Dynamic C, automatically #use the appropriate C file.
#ifdef __DC__
   #use "xbee_sms.c"
#endif

#endif