gprs.h

/*
 * gprs.h
 * A library for SeeedStudio seeeduino GPRS shield
 *
 * Copyright (c) 2013 seeed technology inc.
 * Author        :   lawliet zou
 * Create Time   :   Dec 2013
 * Change Log    :
 *
 * The MIT License (MIT)
 *
 * 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.
 */

#ifndef __GPRS_H__
#define __GPRS_H__

#include "sim800.h"
// #include "my_memchr.h"
#include <stddef.h>

enum Protocol {
  MODEM_CLOSED = 0,
  MODEM_TCP = 1,
  MODEM_UDP = 2,
};

enum HTTPMethod { HTTP_MODEM_GET = 0, HTTP_MODEM_POST = 1 };

/** GPRS class.
 *  used to realize GPRS communication
 */
#define MESSAGE_LENGTH 20

class GPRS : public SIM800 {
public:
  uint32_t _ip;
  char ip_string[20];
  uint8_t rssi = 99, ber = 99, rssi_normalize = 0;

  /** Create GPRS instance
   *  @param number default phone number during mobile communication
   */
  GPRS(int baudRate = 9600) : SIM800(baudRate){};

  /** initialize GPRS module including SIM card check & signal strength
   *  @returns
   *      0 on success
   *      -1 on error
   */
  int init(void);

  /** Join APN
   *  @return
   *        true Jion APN successfully
   *        false failed to join VPN
   */
  bool join(const char *apn = 0, const char *userName = 0,
            const char *passWord = 0);

  /** parse IP string
   *  @return
   *      ip in hex
   */
  uint32_t str_to_ip(const char *str);

  /** get Ip address
   *  @return
   *       IP string
   */
  char *getIPAddress();

  /** check SIM card' Status
   *  @returns
   *      0 on success
   *      -1 on error
   */
  int checkSIMStatus(void);

  /** check network is OK or not
   *  @returns
   *      0 on success
   *      -1 on error
   */
  int networkCheck(void);

  /** send text SMS
   *  @param  *number phone number which SMS will be send to
   *  @param  *data   message that will be send to
   *  @returns
   *      0 on success
   *      -1 on error
   */
  int sendSMS(char *number, char *data);

  /** read SMS if getting a SMS message
   *  @param  buffer  buffer that get from GPRS module(when getting a SMS, GPRS
   * module will return a buffer array)
   *  @param  message buffer used to get SMS message
   *  @param  check   whether to check phone number(we may only want to read SMS
   * from specified phone number)
   *  @returns
   *      0 on success
   *      -1 on error
   */
  int readSMS(int messageIndex, char *message, int length);

  /** delete SMS message on SIM card
   *  @param  index   the index number which SMS message will be delete
   *  @returns
   *      0 on success
   *      -1 on error
   */
  int deleteSMS(int index);

  /** call someone
   *  @param  number  the phone number which you want to call
   *  @returns
   *      0 on success
   *      -1 on error
   */
  int callUp(char *number);

  /** auto answer if coming a call
   *  @returns
   *      0 on success
   *      -1 on error
   */
  int answer(void);

  /** build TCP connect
   *  @param  ip  ip address which will connect to
   *  @param  port    TCP server' port number
   *  @returns
   *      0 on success
   *      -1 on error
   */
  int connectTCP(const char *ip, int port);

  /** send data to TCP server
   *  @param  data    data that will be send to TCP server
   *  @returns
   *      0 on success
   *      -1 on error
   */
  int sendTCPData(char *data);

  /** close TCP connection
   *  @returns
   *      0 on success
   *      -1 on error
   */
  int closeTCP(void);

  /** close TCP service
   *  @returns
   *      0 on success
   *      -1 on error
   */
  int shutTCP(void);

  int gprsModemSetup(const uint8_t isWaitingDevice);
  int gprsSendSms(const char *aSenderNumber, const char *aMessage);

  /**
   * Get signal quality
   * @method getSignalQuality
   * @param  rssi             rssi level (0-31,99)
   * @param  ber              ber level (0-7,99)
   * @return                  0=OK, -1=ERROR
   */
  // int getSignalQuality(uint8_t *rssi, uint8_t *ber);
  int getSignalQuality();

  int gprsCloseConnection();
  int gprsOpenConnection(const char *apn, const char *user, const char *pwd);
  int gprsCheckIfAlreadyOpened();
  int gprsCheckNetworkIsRegistered();
  int gprsSendData(const uint8_t method, const char *aurl, const char *adata,
                   const uint8_t max_out_len, char *arespon_out);
  int gprsTerminateHTTPConnection();
  // int modemSendCommandWaitReply(const char *aCmd, const char *aResponExit,
  //                               const uint32_t aTimeoutMax, const char
  //                               aLenOut,
  //                               char *aResponOut);
};
#endif