iotexpresslink  2.1.0.0
iotexpresslink.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef IOTEXPRESSLINK_H
29 #define IOTEXPRESSLINK_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define IOTEXPRESSLINK_CMD_AT "AT"
60 #define IOTEXPRESSLINK_CMD_CONNECT "AT+CONNECT"
61 #define IOTEXPRESSLINK_CMD_CONNECT_CHECK "AT+CONNECT?"
62 #define IOTEXPRESSLINK_CMD_DISCONNECT "AT+DISCONNECT"
63 #define IOTEXPRESSLINK_CMD_SLEEP "AT+SLEEP"
64 #define IOTEXPRESSLINK_CMD_CONFMODE "AT+CONFMODE"
65 #define IOTEXPRESSLINK_CMD_RESET "AT+RESET"
66 #define IOTEXPRESSLINK_CMD_FACTORY_RESET "AT+FACTORY_RESET"
67 #define IOTEXPRESSLINK_CMD_SEND "AT+SEND"
68 #define IOTEXPRESSLINK_CMD_GET "AT+GET"
69 #define IOTEXPRESSLINK_CMD_SUBSCRIBE "AT+SUBSCRIBE"
70 #define IOTEXPRESSLINK_CMD_UNSUBSCRIBE "AT+UNSUBSCRIBE"
71 #define IOTEXPRESSLINK_CMD_CONF "AT+CONF"
72 #define IOTEXPRESSLINK_CMD_CONF_CHECK "AT+CONF?"
73 #define IOTEXPRESSLINK_CMD_EVENT "AT+EVENT?"
74 #define IOTEXPRESSLINK_CMD_TIME "AT+TIME"
75 #define IOTEXPRESSLINK_CMD_WHERE "AT+WHERE"
76 #define IOTEXPRESSLINK_CMD_SEPARATOR " "
77 #define IOTEXPRESSLINK_CMD_SIGN_EQUAL "="
78 
83 #define IOTEXPRESSLINK_CONF_KEY_ABOUT "About"
84 #define IOTEXPRESSLINK_CONF_KEY_VERSION "Version"
85 #define IOTEXPRESSLINK_CONF_KEY_TECH_SPEC "TechSpec"
86 #define IOTEXPRESSLINK_CONF_KEY_THING_NAME "ThingName"
87 #define IOTEXPRESSLINK_CONF_KEY_CERTIFICATE "Certificate"
88 #define IOTEXPRESSLINK_CONF_KEY_CUSTOM_NAME "CustomName"
89 #define IOTEXPRESSLINK_CONF_KEY_ENDPOINT "Endpoint"
90 #define IOTEXPRESSLINK_CONF_KEY_ROOT_CA "RootCA"
91 #define IOTEXPRESSLINK_CONF_KEY_DEFENDER "Defender"
92 #define IOTEXPRESSLINK_CONF_KEY_HOTA_CERTIFICATE "HOTAcertificate"
93 #define IOTEXPRESSLINK_CONF_KEY_OTA_CERTIFICATE "OTAcertificate"
94 #define IOTEXPRESSLINK_CONF_KEY_SSID "SSID"
95 #define IOTEXPRESSLINK_CONF_KEY_PASSPHRASE "Passphrase"
96 #define IOTEXPRESSLINK_CONF_KEY_APN "APN"
97 #define IOTEXPRESSLINK_CONF_KEY_QOS "QOS"
98 #define IOTEXPRESSLINK_CONF_KEY_TOPIC "Topic"
99 
104 #define IOTEXPRESSLINK_RSP_OK "OK"
105 #define IOTEXPRESSLINK_RSP_ERR "ERR"
106 
112 #define IOTEXPRESSLINK_TX_DRV_BUFFER_SIZE 300
113 #define IOTEXPRESSLINK_RX_DRV_BUFFER_SIZE 1000
114  // iotexpresslink_cmd
116 
131 #define IOTEXPRESSLINK_MAP_MIKROBUS( cfg, mikrobus ) \
132  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
133  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
134  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
135  cfg.wake = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
136  cfg.event = MIKROBUS( mikrobus, MIKROBUS_INT );
137  // iotexpresslink_map // iotexpresslink
140 
145 typedef struct
146 {
147  // Output pins
148  digital_out_t rst;
150  // Input pins
151  digital_in_t event;
152  digital_in_t wake;
154  // Modules
155  uart_t uart;
157  // Buffers
158  uint8_t uart_rx_buffer[ IOTEXPRESSLINK_RX_DRV_BUFFER_SIZE ];
159  uint8_t uart_tx_buffer[ IOTEXPRESSLINK_TX_DRV_BUFFER_SIZE ];
162 
167 typedef struct
168 {
169  // Communication gpio pins
170  pin_name_t rx_pin;
171  pin_name_t tx_pin;
173  // Additional gpio pins
174  pin_name_t rst;
175  pin_name_t event;
176  pin_name_t wake;
178  // Static variable
179  uint32_t baud_rate;
181  uart_data_bits_t data_bit;
182  uart_parity_t parity_bit;
183  uart_stop_bits_t stop_bit;
186 
191 typedef enum
192 {
198 
200 
217 
232 
245 err_t iotexpresslink_generic_write ( iotexpresslink_t *ctx, uint8_t *data_in, uint16_t len );
246 
259 err_t iotexpresslink_generic_read ( iotexpresslink_t *ctx, uint8_t *data_out, uint16_t len );
260 
272 void iotexpresslink_send_cmd ( iotexpresslink_t *ctx, uint8_t *cmd );
273 
283 
293 
303 
313 
323 
324 #ifdef __cplusplus
325 }
326 #endif
327 #endif // IOTEXPRESSLINK_H
328  // iotexpresslink
330 
331 // ------------------------------------------------------------------------ END