luat_mqtt.h 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. #ifndef LUAT_MQTT_H
  2. #define LUAT_MQTT_H
  3. /**
  4. * @defgroup luatos_MQTT MQTT相关接口
  5. * @{
  6. */
  7. #define MQTT_MSG_RELEASE 0 /**< mqtt 释放资源前回调消息 */
  8. #define MQTT_MSG_TCP_TX_DONE 1 /**< mqtt tcp发送完成*/
  9. #define MQTT_MSG_TIMER_PING 2 /**< mqtt ping前回调消息 */
  10. #define MQTT_MSG_RECONNECT 3 /**< mqtt 重连前回调消息 */
  11. #define MQTT_MSG_CLOSE 4 /**< mqtt 关闭回调消息(不会再重连) */
  12. #define MQTT_ERROR_STATE_SOCKET -1
  13. #define MQTT_ERROR_STATE_DISCONNECT -2
  14. #if defined(CHIP_EC618) || defined(CHIP_EC718)
  15. #define MQTT_RECV_BUF_LEN_MAX (32*1024) ///< MQTT 接收BUFF大小
  16. #else
  17. #define MQTT_RECV_BUF_LEN_MAX 4096 ///< MQTT 接收BUFF大小
  18. #endif
  19. /**
  20. * @brief mqtt状态
  21. */
  22. typedef enum {
  23. MQTT_STATE_DISCONNECT , /**< mqtt 断开 */
  24. MQTT_STATE_SCONNECT , /**< mqtt socket连接中 */
  25. MQTT_STATE_MQTT , /**< mqtt socket已连接 mqtt连接中 */
  26. MQTT_STATE_READY /**< mqtt mqtt已连接 */
  27. }LUAT_MQTT_STATE_E;
  28. /**
  29. * @brief 设置MQTT客户端的配置参数
  30. */
  31. typedef struct{
  32. mqtt_broker_handle_t broker;/**< mqtt broker*/
  33. network_ctrl_t *netc; /**< mqtt netc*/
  34. luat_ip_addr_t ip_addr; /**<mqtt ip*/
  35. char host[192]; /**<mqtt host*/
  36. uint32_t buffer_offset; /**< 用于标识mqtt_packet_buffer当前有多少数据*/
  37. uint32_t rxbuff_size; /**< mqtt_packet_buffer的长度*/
  38. uint8_t *mqtt_packet_buffer;/**< 接收BUFF*/
  39. void* mqtt_cb; /**< mqtt 回调函数*/
  40. int8_t error_state; /**< mqtt 错误状态*/
  41. uint16_t remote_port; /**< 远程端口号*/
  42. uint32_t keepalive; /**< 心跳时长 单位s*/
  43. uint8_t adapter_index; /**< 适配器索引号, 似乎并没有什么用*/
  44. LUAT_MQTT_STATE_E mqtt_state; /**< mqtt状态*/
  45. uint8_t reconnect; /**< mqtt是否重连*/
  46. uint32_t reconnect_time; /**< mqtt重连时间 单位ms*/
  47. void* reconnect_timer; /**< mqtt重连定时器*/
  48. void* ping_timer; /**< mqtt_ping定时器*/
  49. int mqtt_ref; /**< 强制引用自身避免被GC*/
  50. void* userdata; /**< userdata */
  51. }luat_mqtt_ctrl_t;
  52. typedef struct{
  53. uint16_t topic_len;
  54. uint16_t payload_len;
  55. uint8_t data[];
  56. }luat_mqtt_msg_t;
  57. /**
  58. * @brief 设置MQTT服务端服务器信息、加密信息
  59. */
  60. typedef struct luat_mqtt_connopts
  61. {
  62. const char* host;/**< 服务器HOST*/
  63. uint16_t port;/**< 服务器端口*/
  64. uint8_t is_tls;/**< 是否采用tls加密*/
  65. uint8_t is_ipv6;
  66. uint8_t verify;
  67. const char* server_cert;
  68. size_t server_cert_len;
  69. const char* client_cert;
  70. size_t client_cert_len;
  71. const char* client_key;
  72. size_t client_key_len;
  73. const char* client_password;
  74. size_t client_password_len;
  75. }luat_mqtt_connopts_t;
  76. typedef void (*luat_mqtt_cb_t)(luat_mqtt_ctrl_t *luat_mqtt_ctrl, uint16_t event);
  77. /**
  78. *@brief 发起MQTT连接
  79. *@param mqtt_ctrl luatos_mqtt对象实例
  80. *@return 成功为0,其他值失败
  81. */
  82. int luat_mqtt_connect(luat_mqtt_ctrl_t *mqtt_ctrl);
  83. // static int luat_mqtt_msg_cb(luat_mqtt_ctrl_t *mqtt_ctrl);
  84. // int l_mqtt_callback(lua_State *L, void* ptr);
  85. int l_luat_mqtt_msg_cb(luat_mqtt_ctrl_t * ctrl, int arg1, int arg2);
  86. int32_t luat_mqtt_callback(void *data, void *param);
  87. LUAT_RT_RET_TYPE luat_mqtt_timer_callback(LUAT_RT_CB_PARAM);
  88. // int luat_mqtt_read_packet(luat_mqtt_ctrl_t *mqtt_ctrl);
  89. int luat_mqtt_send_packet(void* socket_info, const void* buf, unsigned int count);
  90. /**
  91. *@brief 关闭MQTT连接,如果设置了自动重连,回重新自动连接
  92. *@param mqtt_ctrl luatos_mqtt对象实例
  93. *@return 成功为0,其他值失败
  94. */
  95. void luat_mqtt_close_socket(luat_mqtt_ctrl_t *mqtt_ctrl);
  96. /**
  97. *@brief 获取MQTT连接状态
  98. *@param mqtt_ctrl luatos_mqtt对象实例
  99. *@return LUAT_MQTT_STATE_E
  100. */
  101. LUAT_MQTT_STATE_E luat_mqtt_state_get(luat_mqtt_ctrl_t *mqtt_ctrl);
  102. /**
  103. *@brief 释放MQTT资源,释放后luatos_mqtt对象不可用
  104. *@param mqtt_ctrl luatos_mqtt对象实例
  105. *@return 成功为0,其他值失败
  106. */
  107. void luat_mqtt_release_socket(luat_mqtt_ctrl_t *mqtt_ctrl);
  108. /**
  109. *@brief 初始化luatos_mqtt(初始化MQTT)
  110. *@param mqtt_ctrl luatos_mqtt对象实例
  111. *@param adapter_index 网卡类型(唯一值 NW_ADAPTER_INDEX_LWIP_GPRS)
  112. *@return 成功为0,其他值失败
  113. */
  114. int luat_mqtt_init(luat_mqtt_ctrl_t *mqtt_ctrl, int adapter_index);
  115. /**
  116. *@brief 设置MQTT服务器信息、加密信息函数
  117. *@param mqtt_ctrl luatos_mqtt对象实例
  118. *@param opts 结构体MQTT服务器信息、加密信息函数
  119. *@return 成功为0,其他值失败
  120. */
  121. int luat_mqtt_set_connopts(luat_mqtt_ctrl_t *mqtt_ctrl, luat_mqtt_connopts_t *opts);
  122. /**
  123. *@brief 设置MQTT服务器接收buff大小
  124. *@param mqtt_ctrl luatos_mqtt对象实例
  125. *@param rxbuff_size 接收buff大小
  126. *@return 成功为0,其他值失败
  127. */
  128. int luat_mqtt_set_rxbuff_size(luat_mqtt_ctrl_t *mqtt_ctrl, uint32_t rxbuff_size);
  129. /**
  130. *@brief 设置MQTT服务器信息、加密信息函数
  131. *@param mqtt_ctrl luatos_mqtt对象实例
  132. *@param opts 结构体MQTT服务器信息、加密信息函数
  133. *@return 成功为0,其他值失败
  134. */
  135. /**
  136. *@brief 手动发起重连
  137. *@param mqtt_ctrl luatos_mqtt对象实例
  138. *@return 成功为0,其他值失败
  139. */
  140. int luat_mqtt_reconnect(luat_mqtt_ctrl_t *mqtt_ctrl);
  141. /**
  142. *@brief 发送ping包
  143. *@param mqtt_ctrl luatos_mqtt对象实例
  144. *@return 成功为0,其他值失败
  145. */
  146. int luat_mqtt_ping(luat_mqtt_ctrl_t *mqtt_ctrl);
  147. /**
  148. *@brief 设置遗嘱消息
  149. *@param mqtt_ctrl luatos_mqtt对象实例
  150. *@param topic 遗嘱消息的topic
  151. *@param payload 遗嘱消息的payload
  152. *@param payload_len 遗嘱消息payload的长度
  153. *@param qos 遗嘱消息的qos
  154. *@param retain 遗嘱消息的retain
  155. *@return 成功为0,其他值失败
  156. */
  157. int luat_mqtt_set_will(luat_mqtt_ctrl_t *mqtt_ctrl, const char* topic, const char* payload, size_t payload_len, uint8_t qos, size_t retain);
  158. /**
  159. *@brief 设置MQTT事件回调函数
  160. *@param mqtt_ctrl luatos_mqtt对象实例
  161. *@param mqtt_cb 回调函数
  162. *@return 成功为0,其他值失败
  163. */
  164. int luat_mqtt_set_cb(luat_mqtt_ctrl_t *mqtt_ctrl, luat_mqtt_cb_t mqtt_cb);
  165. /** @}*/
  166. #endif