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 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_uart.h"
52 
73 #define IOTEXPRESSLINK_CMD_AT "AT"
74 #define IOTEXPRESSLINK_CMD_CONNECT "AT+CONNECT"
75 #define IOTEXPRESSLINK_CMD_CONNECT_CHECK "AT+CONNECT?"
76 #define IOTEXPRESSLINK_CMD_DISCONNECT "AT+DISCONNECT"
77 #define IOTEXPRESSLINK_CMD_SLEEP "AT+SLEEP"
78 #define IOTEXPRESSLINK_CMD_CONFMODE "AT+CONFMODE"
79 #define IOTEXPRESSLINK_CMD_RESET "AT+RESET"
80 #define IOTEXPRESSLINK_CMD_FACTORY_RESET "AT+FACTORY_RESET"
81 #define IOTEXPRESSLINK_CMD_SEND "AT+SEND"
82 #define IOTEXPRESSLINK_CMD_GET "AT+GET"
83 #define IOTEXPRESSLINK_CMD_SUBSCRIBE "AT+SUBSCRIBE"
84 #define IOTEXPRESSLINK_CMD_UNSUBSCRIBE "AT+UNSUBSCRIBE"
85 #define IOTEXPRESSLINK_CMD_CONF "AT+CONF"
86 #define IOTEXPRESSLINK_CMD_CONF_CHECK "AT+CONF?"
87 #define IOTEXPRESSLINK_CMD_EVENT "AT+EVENT?"
88 #define IOTEXPRESSLINK_CMD_TIME "AT+TIME"
89 #define IOTEXPRESSLINK_CMD_WHERE "AT+WHERE"
90 #define IOTEXPRESSLINK_CMD_SEPARATOR " "
91 #define IOTEXPRESSLINK_CMD_SIGN_EQUAL "="
92 
97 #define IOTEXPRESSLINK_CONF_KEY_ABOUT "About"
98 #define IOTEXPRESSLINK_CONF_KEY_VERSION "Version"
99 #define IOTEXPRESSLINK_CONF_KEY_TECH_SPEC "TechSpec"
100 #define IOTEXPRESSLINK_CONF_KEY_THING_NAME "ThingName"
101 #define IOTEXPRESSLINK_CONF_KEY_CERTIFICATE "Certificate"
102 #define IOTEXPRESSLINK_CONF_KEY_CUSTOM_NAME "CustomName"
103 #define IOTEXPRESSLINK_CONF_KEY_ENDPOINT "Endpoint"
104 #define IOTEXPRESSLINK_CONF_KEY_ROOT_CA "RootCA"
105 #define IOTEXPRESSLINK_CONF_KEY_DEFENDER "Defender"
106 #define IOTEXPRESSLINK_CONF_KEY_HOTA_CERTIFICATE "HOTAcertificate"
107 #define IOTEXPRESSLINK_CONF_KEY_OTA_CERTIFICATE "OTAcertificate"
108 #define IOTEXPRESSLINK_CONF_KEY_SSID "SSID"
109 #define IOTEXPRESSLINK_CONF_KEY_PASSPHRASE "Passphrase"
110 #define IOTEXPRESSLINK_CONF_KEY_APN "APN"
111 #define IOTEXPRESSLINK_CONF_KEY_QOS "QOS"
112 #define IOTEXPRESSLINK_CONF_KEY_TOPIC "Topic"
113 
118 #define IOTEXPRESSLINK_RSP_OK "OK"
119 #define IOTEXPRESSLINK_RSP_ERR "ERR"
120 
126 #define IOTEXPRESSLINK_TX_DRV_BUFFER_SIZE 300
127 #define IOTEXPRESSLINK_RX_DRV_BUFFER_SIZE 1000
128  // iotexpresslink_cmd
130 
145 #define IOTEXPRESSLINK_MAP_MIKROBUS( cfg, mikrobus ) \
146  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
147  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
148  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
149  cfg.wake = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
150  cfg.event = MIKROBUS( mikrobus, MIKROBUS_INT );
151  // iotexpresslink_map // iotexpresslink
154 
159 typedef struct
160 {
161  // Output pins
162  digital_out_t rst;
164  // Input pins
165  digital_in_t event;
166  digital_in_t wake;
168  // Modules
169  uart_t uart;
171  // Buffers
172  uint8_t uart_rx_buffer[ IOTEXPRESSLINK_RX_DRV_BUFFER_SIZE ];
173  uint8_t uart_tx_buffer[ IOTEXPRESSLINK_TX_DRV_BUFFER_SIZE ];
176 
181 typedef struct
182 {
183  // Communication gpio pins
184  pin_name_t rx_pin;
185  pin_name_t tx_pin;
187  // Additional gpio pins
188  pin_name_t rst;
189  pin_name_t event;
190  pin_name_t wake;
192  // Static variable
193  uint32_t baud_rate;
195  uart_data_bits_t data_bit;
196  uart_parity_t parity_bit;
197  uart_stop_bits_t stop_bit;
200 
205 typedef enum
206 {
212 
214 
231 
246 
259 err_t iotexpresslink_generic_write ( iotexpresslink_t *ctx, uint8_t *data_in, uint16_t len );
260 
273 err_t iotexpresslink_generic_read ( iotexpresslink_t *ctx, uint8_t *data_out, uint16_t len );
274 
286 void iotexpresslink_send_cmd ( iotexpresslink_t *ctx, uint8_t *cmd );
287 
297 
307 
317 
327 
337 
338 #ifdef __cplusplus
339 }
340 #endif
341 #endif // IOTEXPRESSLINK_H
342  // iotexpresslink
344 
345 // ------------------------------------------------------------------------ END