simcom-sim7080.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 metraTec GmbH
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_MODEM_SIMCOM_SIM7080_H
#define ZEPHYR_INCLUDE_DRIVERS_MODEM_SIMCOM_SIM7080_H
 
#include <zephyr/types.h>
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SIM7080_GNSS_DATA_UTC_LEN 20
#define SIM7080_SMS_MAX_LEN 160
 
struct sim7080_gnss_data {
        bool run_status;
        bool fix_status;
        char utc[SIM7080_GNSS_DATA_UTC_LEN];
        int32_t lat;
        int32_t lon;
        int32_t alt;
        uint16_t hdop;
        uint16_t cog;
        uint16_t kmh;
};
 
enum sim7080_sms_stat {
        SIM7080_SMS_STAT_REC_UNREAD = 0,
        SIM7080_SMS_STAT_REC_READ,
        SIM7080_SMS_STAT_STO_UNSENT,
        SIM7080_SMS_STAT_STO_SENT,
        SIM7080_SMS_STAT_ALL,
};
 
enum sim7080_ftp_rc {
        /* Operation finished correctly. */
        SIM7080_FTP_RC_OK = 0,
        /* Session finished. */
        SIM7080_FTP_RC_FINISHED,
        /* An error occurred. */
        SIM7080_FTP_RC_ERROR,
};
 
struct sim7080_sms {
        /* First octet of the sms. */
        uint8_t first_octet;
        /* Message protocol identifier. */
        uint8_t tp_pid;
        /* Status of the sms in memory. */
        enum sim7080_sms_stat stat;
        /* Index of the sms in memory. */
        uint16_t index;
        /* Time the sms was received. */
        struct {
                uint8_t year;
                uint8_t month;
                uint8_t day;
                uint8_t hour;
                uint8_t minute;
                uint8_t second;
                uint8_t timezone;
        } time;
        /* Buffered sms. */
        char data[SIM7080_SMS_MAX_LEN + 1];
        /* Length of the sms in buffer. */
        uint8_t data_len;
};
 
struct sim7080_sms_buffer {
        /* sms structures to read to. */
        struct sim7080_sms *sms;
        /* Number of sms structures. */
        uint8_t nsms;
};
 
int mdm_sim7080_power_on(void);
 
int mdm_sim7080_power_off(void);
 
int mdm_sim7080_start_network(void);
 
int mdm_sim7080_start_gnss(void);
 
int mdm_sim7080_query_gnss(struct sim7080_gnss_data *data);
 
const char *mdm_sim7080_get_manufacturer(void);
 
const char *mdm_sim7080_get_model(void);
 
const char *mdm_sim7080_get_revision(void);
 
const char *mdm_sim7080_get_imei(void);
 
int mdm_sim7080_read_sms(struct sim7080_sms_buffer *buffer);
 
int mdm_sim7080_delete_sms(uint16_t index);
 
int mdm_sim7080_ftp_get_start(const char *server, const char *user, const char *passwd,
                                  const char *file, const char *path);
 
int mdm_sim7080_ftp_get_read(char *dst, size_t *size);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_MODEM_SIMCOM_SIM7080_H */