sim900_defs.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_DEFS_H
#define SIM900_DEFS_H
 
typedef enum _SIM900DialResult {
    SIM900_DIAL_RESULT_NO_DIALTONE,
 
    SIM900_DIAL_RESULT_BUSY,
 
    SIM900_DIAL_RESULT_NO_CARRIER,
 
    SIM900_DIAL_RESULT_NO_ANSWER,
 
    SIM900_DIAL_RESULT_ERROR,
 
    SIM900_DIAL_RESULT_OK
} SIM900DialResult;
 
typedef enum _SIM900OperatorFormat {
    SIM900_OPERATOR_FORMAT_AUTO,
 
    SIM900_OPERATOR_FORMAT_MANUAL,
 
    SIM900_OPERATOR_FORMAT_DEREGISTER,
 
    SIM900_OPERATOR_FORMAT_SET_ONLY,
 
    SIM900_OPERATOR_FORMAT_MANUAL_AUTO
} SIM900OperatorFormat;
 
inline SIM900OperatorFormat intToSIM900OperatorFormat(uint8_t i){
    if(i < SIM900OperatorFormat::SIM900_OPERATOR_FORMAT_AUTO ||
        i > SIM900OperatorFormat::SIM900_OPERATOR_FORMAT_MANUAL_AUTO)
        return SIM900OperatorFormat::SIM900_OPERATOR_FORMAT_AUTO;
 
    return static_cast<SIM900OperatorFormat>(i);
}
 
typedef enum _SIM900OperatorMode {
    SIM900_OPERATOR_MODE_GSM,
 
    SIM900_OPERATOR_MODE_GSM_COMPACT,
 
    SIM900_OPERATOR_MODE_UTRAN,
 
    SIM900_OPERATOR_MODE_GSM_EGPRS,
 
    SIM900_OPERATOR_MODE_UTRAN_HSDPA,
 
    SIM900_OPERATOR_MODE_UTRAN_HSUPA,
 
    SIM900_OPERATOR_MODE_UTRAN_HSDPA_HSUPA,
 
    SIM900_OPERATOR_MODE_E_UTRAN
} SIM900OperatorMode;
 
inline SIM900OperatorMode intToSIM900OperatorMode(int i){
    if(i < SIM900OperatorMode::SIM900_OPERATOR_MODE_GSM ||
        i > SIM900OperatorMode::SIM900_OPERATOR_MODE_E_UTRAN)
        return SIM900OperatorMode::SIM900_OPERATOR_MODE_GSM;
 
    return static_cast<SIM900OperatorMode>(i);
}
 
typedef enum _SIM900CardService {
    SIM900_CARD_SERVICE_ASYNC,
 
    SIM900_CARD_SERVICE_SYNC,
 
    SIM900_CARD_SERVICE_PAD_ACCESS,
 
    SIM900_CARD_SERVICE_PACKET,
 
    SIM900_CARD_SERVICE_VOICE,
 
    SIM900_CARD_SERVICE_FAX
} SIM900CardService;
 
inline SIM900CardService intToSIM900CardService(uint8_t i){
    if(i < SIM900CardService::SIM900_CARD_SERVICE_ASYNC ||
        i > SIM900CardService::SIM900_CARD_SERVICE_FAX)
        return SIM900CardService::SIM900_CARD_SERVICE_ASYNC;
 
    return static_cast<SIM900CardService>(i);
}
 
typedef enum _SIM900PhonebookType {
    SIM900_PHONEBOOK_NATIONAL       = 145,
 
    SIM900_PHONEBOOK_INTERNATIONAL  = 129,
 
    SIM900_PHONEBOOK_UNKNOWN        = 0
} SIM900PhonebookType;
 
typedef struct _SIM900Operator {
    SIM900OperatorMode mode;
 
    SIM900OperatorFormat format;
 
    String name;
} SIM900Operator;
 
typedef struct _SIM900RTC {
    uint8_t day;
    
    uint8_t month;
    
    uint8_t year;
 
    uint8_t hour;
    
    uint8_t minute;
    
    uint8_t second;
 
    int8_t gmt;
} SIM900RTC;
 
typedef struct _SIM900APN {
    String apn;
 
    String username;
 
    String password;
} SIM900APN;
 
typedef struct _SIM900HTTPHeader {
    String key;
 
    String value;
} SIM900HTTPHeader;
 
typedef struct _SIM900HTTPRequest {
    String method;
 
    String data;
 
    String domain;
 
    String resource;
 
    uint8_t status;
 
    uint16_t port;
 
    SIM900HTTPHeader *headers;
 
    uint16_t header_count;
} SIM900HTTPRequest;
 
typedef struct _SIM900HTTPResponse {
    uint16_t status;
 
    SIM900HTTPHeader *headers;
 
    uint16_t header_count;
 
    String data;
} SIM900HTTPResponse;
 
typedef struct _SIM900CardAccount {
    String name;
    
    String number;
 
    uint8_t type;
    
    uint8_t speed;
 
    SIM900PhonebookType numberType;
 
    SIM900CardService service;
} SIM900CardAccount;
 
typedef struct _SIM900PhonebookCapacity {
    String memoryType;
 
    uint8_t used;
 
    uint8_t max;
} SIM900PhonebookCapacity;
 
typedef struct _SIM900Signal {
    uint8_t rssi;
 
    uint8_t bit_error_rate;
} SIM900Signal;
 
#endif