sim900.h

/*
 * This file is part of the SIM900 Arduino Shield library.
 * Copyright (c) 2023 Nathanne Isip
 *
 * 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 SIM900_H
#define SIM900_H
 
#include <Arduino.h>
 
#include "sim900_defs.h"
 
class SIM900 {
private:
    Stream& sim900;
 
    bool hasAPN = false;
 
    void sendCommand(String message);
 
    bool isSuccessCommand();
 
    String getResponse();
 
    String getReturnedMode();
 
    String rawQueryOnLine(uint16_t line);
 
    String queryResult();
 
public:
    SIM900(Stream& _sim900);
 
    bool handshake();
 
    void close();
 
    bool isCardReady();
 
    bool changeCardPin(uint8_t pin);
 
    SIM900Signal signal();
 
    SIM900DialResult dialUp(String number);
 
    SIM900DialResult redialUp();
 
    SIM900DialResult acceptIncomingCall();
 
    bool hangUp();
 
    bool sendSMS(String number, String message);
 
    bool connectAPN(SIM900APN apn);
 
    bool enableGPRS();
 
    SIM900HTTPResponse request(SIM900HTTPRequest request);
 
    SIM900Operator networkOperator();
 
    SIM900CardAccount cardNumber();
 
    SIM900RTC rtc();
 
    bool updateRtc(SIM900RTC config);
 
    bool savePhonebook(uint8_t index, SIM900CardAccount account);
 
    bool deletePhonebook(uint8_t index);
 
    SIM900CardAccount retrievePhonebook(uint8_t index);
 
    SIM900PhonebookCapacity phonebookCapacity();
 
    String manufacturer();
 
    String softwareRelease();
 
    String imei();
 
    String chipModel();
 
    String chipName();
 
    String ipAddress();
};
 
#endif