/** ******************************************************************************
* @file me3616.h
* @author 度云未来 DOIOT
* @brief ME3616模块AT指令简易串口驱动
******************************************************************************
* @attention
*
© Copyright (c) 2019 成都度云未来
* All rights reserved.
* 注意:本程序针对cubemx 生成的hal库快速开发
* 环境:keil5.0
* STM32Cube FW_F1 V1.8.0
* 文件版本:2.30
********************************************************************************/
/*硬件复位和开机的引脚宏定义*/
#define PWR_IO_PORT GPIOA
#define RST_IO_PORT GPIOA
#define PWR_IO_PIN GPIO_Pin_0
#define RST_IO_PIN GPIO_Pin_1
#define config_Antiphase_flug 0 /*开机硬件电平反相使能*/
//#define config_TCP_Enable 1 /*使能TCP*/
#define config_Multi_channel_Tcp 0 /*多通道TCP使能*/
#define config_TCP_Enable_heart 0 /*开启TCP心跳*/
#define config_CEREG 0 /*定期TCP网络检查*/
#define config_EPS 0 /*定期网络检查*/
#define config_Check_Rest 0 /*检查和复位*/
#define config_TCP_Enable_Disconn_recon 0 /*打开TCP断线重连*/
//#define config_LMW2M_Enable 0 /*使能LMW2M*/
#define config_ALY_MQTT_Enable 0 /*使能阿里云MQTT[需要对应的固件]*/
#define config_MQTT_Enable 1 /*使能MQTT*/
#define config_CHINESE_LOG 0 /*使能中文log*/
/** -------------------------------调整这里以裁剪程序--------------------------------*/
#define process_fifo_max_s 64 /*处理数据函数所使用的小号缓存*/
#define process_fifo_max_m 64 /*处理数据函数所使用的中号缓存*/
#define process_fifo_max_L 64 /*处理数据函数所使用的大号缓存*/
#define SoftRest_fun 0 /*使能软件开机函数*/
#define GetEPS_fun 1 /*使能EPS函数*/
#define GetCSQ_fun 1 /*使能获取CSQ函数*/
#define GetCCID_fun 1 /*使能获取CCID函数*/
#define Hvertion_data 0 /*使能硬件信息存储栈*/
#define Svertion_data 0 /*使能软件信息存储栈*/
#define MAC_information 0 /*使能MAC信息存储栈*/
#define IMEI_information 1 /*使能IMEI信息存储栈*/
#define ICCID_information 1 /*使能ICCID信息存储栈*/
#define ICCID_ME3616_INFOrmation 1
#define IMEI_ME3616_INFOrmation 1
/** -------------------------------API 注释------------------------------------------------------
* @brief ME3616 用来声明一个句柄,本文件已经默认声明了一个全局句柄为 me3616
*
* 调用 ME3616_Init(); 完成初始化
* TCP
me3616.TCP. TCP的相关类
me3616.TCP.tcp_init(); 创建一个TCP连接
me3616.TCP.tcp_close(); 关闭一个TCP连接
me3616.TCP.send_Str(char*); 发送ascii字符串
me3616.TCP.send_Hex(char*); 发送hex字符串
me3616.POWER(uint8_t flug); 硬件开机 flug =1,阻塞等待开机完成再返回,0,立即返回
me3616.HRST(uint8_t flug); 硬件复位 flug =1,阻塞等待开机完成再返回,0,立即返回
me3616.SRST(uint8_t flug); 软件复位 flug =1,阻塞等待开机完成再返回,0,立即返回
me3616.EPS(); 打印网络状态,并更新一次标志位寄存器
me3616.CSQ(); 打印信号强度,并更新一次标志位寄存器
me3616.CCID(); 打印CCID,并更新一次存储寄存器
me3616.PIN(); 打印PIN状态,并更新一次标志位寄存器
*-------------------------------------------------------------------------------------------------*/
typedef struct
{
#if(config_TCP_Enable)
/*网络状态类*/
uint8_t TCP_State; /*TCP连接状态*/
#if(config_Multi_channel_Tcp)/*多通道使能*/
uint8_t TCP_Socket[5];/*TCP socket 通道*/
uint8_t Mult_socket_state;
#else
uint8_t TCP_Socket;/*TCP socket 通道*/
#endif
uint8_t UDP_State; /*TCP连接状态*/
uint8_t UDP_Socket;/*TCP socket 通道*/
uint8_t Net_init; /*网络连接状态*/
#endif
#if(config_MQTT_Enable)
uint8_t mqtt_id;
uint8_t MQTT_State;
char mqtt_ip[32];
char mqtt_port[6];
#endif
/*硬件类*/
uint8_t pwr; /*开机状态*/
uint8_t rssi; /*信号强度等级*/
uint8_t ber; /*误码率*/
uint8_t eps; /*网络状态*/
uint8_t pin; /*pin状态*/
int dBm; /*精确的网络信号强度*/
#if(ICCID_information)
char iccid[50];
#endif
#if(IMEI_information)
char imei[50];
#endif
char imsi[50];
#if(MAC_information)
char mac[50];
#endif
#if(Hvertion_data)
char Hvertion[50];
#endif
#if(Svertion_data)
char Svertion[50];
#endif
#if(config_LMW2M_Enable)
/*lwm2m的message id*/
char msgid[20];
#endif
}ME3616_state;
typedef struct{
#if(ICCID_information)
_Bool iccid;
#endif
#if(IMEI_information)
_Bool imei;
#endif
_Bool imsi;
#if(MAC_information)
_Bool mac;
#endif
#if(Hvertion_data)
_Bool Hvertion;
#endif
#if(Svertion_data)
_Bool Svertion;
#endif
#if(config_MQTT_Enable)
_Bool mqtt_ip;
_Bool mqtt_port;
#endif
_Bool pwr; /*开机状态*/
_Bool rssi; /*信号强度*/
_Bool ber; /*误码率*/
_Bool eps; /*网络状态*/
_Bool pin; /*pin状态*/
_Bool dBm;
_Bool rest;
#if defined (config_TCP_Enable_Disconnection_reconnection)
_Bool tcp_recon;
#endif
#if(config_LMW2M_Enable)
/*lwm2m的message id*/
_Bool msgid;
#endif
}Flug;
#if(config_TCP_Enable)
typedef struct{
/*发送一个ASCII字符串*/
uint8_t (*SendStr)(char *str);
/*发送一个hex字符串*/
uint8_t (*SendHex)(char *str);
/*开始连接TCP*/
uint8_t (*CreateChannel)(char *port,char *ip);
/*关闭TCP连接*/
uint8_t (*CloseChannel)();
uint8_t (*GetData)(uint8_t data[]);
}TCP;
#endif
typedef struct{
uint8_t (*Connect)();
uint8_t (*SendStr)(char *data);
}LWM2M;
typedef struct{
uint8_t (*Connect)();
uint8_t (*SendStr)(char *data,char *topic);
}ALY_MQTT;
#if(config_MQTT_Enable)
typedef struct{
uint8_t (*SetNet)(char *ip,char *port);
uint8_t (*Connect)(char *_productID,char *_deviceID,char *_secret);
uint8_t (*Sub)(char * topic);
uint8_t (*Pub)(char * topic,char *data, uint32_t len);
}MQTT;
#endif
typedef struct
{
#if(config_LMW2M_Enable)
/*和LWM2M相关操作的句柄*/
LWM2M LWM2M;
#endif
#if(config_TCP_Enable)
/*和TCP相关操作的句柄*/
TCP TCP;
#endif
#if(config_MQTT_Enable)
MQTT MQTT;
#endif
void (*imei_iccid_get)(char *imei, char *iccid);
#if(config_ALY_MQTT_Enable)
ALY_MQTT ALY_MQTT;
#endif
/*全部标志位的句柄*/
ME3616_state State;
/*装载位装载记录的标志位*/
Flug flug;
/*硬件开机函数指针*/
uint8_t (*PowerOn)(uint8_t flug);
/*硬件复位函数指针*/
uint8_t (*HardRest)(uint8_t flug);
#if(SoftRest_fun)
/*软件复位函数指针*/
uint8_t (*SoftRest)(uint8_t flug);
#endif
#if(GetEPS_fun)
/*获取网络状态并打印的函数指针*/
uint8_t (*GetEPS)();
#endif
#if(GetCSQ_fun)
/*获取网络强度并打印的函数指针*/
uint8_t (*GetCSQ)();
#endif
/*获取精确网络强度并打印的函数指针*/
int (*GetCESQ)();
#if(GetCCID_fun)
/*获取CCID的函数指针*/
uint8_t (*GetCCID)();
#endif
/*获取PIN状态的函数指针*/
uint8_t (*GetPIN)();
#if(IMEI_information)
/*获取IMEI状态的函数指针*/
uint8_t (*GetIMEI)();
#endif
#if(Svertion_data)
/*获取软硬件版本*/
uint8_t (*Version)();
#endif
}ME3616;
extern ME3616 me3616;
/** @brief ME3616句柄的构造函数*/
ME3616 * ME3616_Init(void);
#if defined (config_Check_Rest)
uint8_t ME3616_Check_State(void);
#endif
/** @brief ME3616硬件开机,flug=1,阻塞等待,flug=0,立即返回*/
uint8_t ME3616_Power_On(uint8_t flug);
/** @brief ME3616硬件复位,flug=1,阻塞等待,flug=0,立即返回*/
uint8_t ME3616_HARD_Rest(uint8_t flug);
/** @brief ME3616软件复位,flug=1,阻塞等待,flug=0,立即返回*/
uint8_t ME3616_SOFT_Rest(uint8_t flug);
/** @brief 读取网络状态并打印相关数据,会返回模组第二位的状态位*/
uint8_t ME3616_READ_EPS(void);
/** @brief ME3616读取网络信号强度*/
uint8_t ME3616_READ_CSQ(void);
/** @brief ME3616读取精确的网络信号强度* */
int ME3616_READ_CESQ(void);
/** @brief ME3616读取SIM卡的CCID */
uint8_t ME3616_READ_CCID(void);
/** @brief ME3616查询pin状态* @param return 1 为ready,0 其他* */
uint8_t ME3616_READ_PIN(void);
#if(IMEI_information)
/** @brief ME3616查询IMEI状态*/
uint8_t ME3616_READ_IMEI(void);
#endif
/**
* @brief ME3616查询软硬件版本*/
uint8_t ME3616_READ_Revision(void);
void ME3616_IMEI_ICCID_INFO_GET(char *imei, char *iccid);
#if(config_TCP_Enable)
/**
* @brief ME3616关闭一个套接字
* @param socket:套接字的句柄编号
* */
uint8_t ME3616_Close_Socket(uint8_t socket);
/**
* @brief ME3616关闭一个套接字[内部调用]* */
uint8_t Close_TCP_Socket(void);
/** @brief ME3616创建一个套接字*/
uint8_t ME3616_Create_Socket(int IPvX,int TCP_UDP,int protocol);
/** @brief ME3616连接到一个Socket*/
int ME3616_Connect_Socket(uint8_t socket,char *port,char *ip);
/**
* @brief ME3616创建一个TCP连接*/
uint8_t ME3616_Connect_TCP(char *port,char *ip);
/**
* @brief ME3616调用TCP通道发送一条ASCII数据*/
uint8_t ME3616_TCP_SEND_String(char *str);
/**
* @brief ME3616调用TCP通道发送一条十六进制数据*/
uint8_t ME3616_TCP_SEND_Hex(char *str);
/**
* @brief ME3616非透传下的数据进行提纯*/
uint8_t ME3616_TCP_DATA_purification(uint8_t data[]);
#endif
/*-----------------------------------------------------------------------------------*/
/** @brief ME3616创建一个LWM2M协议的object*/
uint8_t ME3616_LWM2M_CREATE(void);
/** @brief ME3616 LWM2M协议发起observe请求 */
uint8_t ME3616_LWM2M_LADD(void);
/**@brief ME3616 LWM2M协议开始连接服务器【这个函数会阻塞较长时间】*/
uint8_t ME3616_LWM2M_OPEN(void);
/**@brief ME3616 LWM2M 去注册*/
uint8_t ME3616_LWM2M_CLOSE(void);
/** @brief ME3616 [LWM2M协议] 删除OneNET instance */
uint8_t ME3616_LWM2M_MIPLDELETE(void);
/** @brief ME3616 [LWM2M协议] 连接ONENET服务器* */
uint8_t ME3616_LWM2M_Connect(void);
/** @brief ME3616 [LWM2M协议] 发送一条数据 */
uint8_t ME3616_LWM2M_Send(char *data);
/** @brief ME3616打印套接字错误码*/
void ESOERR_PRINT(int code);
/*-----------------------------------------------------------------------------------*/
#if (config_ALY_MQTT_Enable)
/** @brief 配置阿里云MQTT三元组*/
uint8_t Configuration_ALY_MQTT(char *ProductKey,char *appdemo,char *DeviceSecret);
/** @brief ME3616 连接阿里云MQTT*/
uint8_t Connect_ALY_MQTT(void);
#endif
/*-----------------------------------------------------------------------------------*/
#if(config_MQTT_Enable)
/** @brief ME3616设置MQTT的服务器端口和ip地址*/
uint8_t MQTT_Set_Net(char *ip,char *port);
/** @brief ME3616使用三元组连接MQTT服务器*/
uint8_t MQTT_Connet(char *_productID,char *_deviceID,char *_secret);
uint8_t MQTT_SUB(char * topic);
uint8_t MQTT_PUB(char * topic,char *data, uint32_t len);
#endif
/*-----------------------------------------------------------------------------------*/
#define ME3616_INFO(fmt,arg...) printf("<<-ME3616 INFO->> [%d]"fmt"\r\n",__LINE__, ##arg)//trace_otp_trace1(uart_msg_send, 4, fmt, ##arg);
//printf("<<-EEPROM-INFO->> "fmt"\n",##arg)
#define ME3616_ERROR(fmt,arg...) printf("<<-ME3616-ERROR->> [%d]"fmt"\r\n",__LINE__, ##arg)
#define ME3616_DEBUG(fmt,arg...) do{\
if(EEPROM_DEBUG_ON)\
printf("<<-ME3616-DEBUG->> [%d]"fmt"\r\n",__LINE__, ##arg);\
}while(0)