awsiot  2.1.0.0
awsiot.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 AWSIOT_H
29 #define AWSIOT_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 AWSIOT_CMD_AT "AT"
60 #define AWSIOT_CMD_CONNECT "AT+CONNECT"
61 #define AWSIOT_CMD_CONNECT_CHECK "AT+CONNECT?"
62 #define AWSIOT_CMD_DISCONNECT "AT+DISCONNECT"
63 #define AWSIOT_CMD_SLEEP "AT+SLEEP"
64 #define AWSIOT_CMD_CONFMODE "AT+CONFMODE"
65 #define AWSIOT_CMD_RESET "AT+RESET"
66 #define AWSIOT_CMD_FACTORY_RESET "AT+FACTORY_RESET"
67 #define AWSIOT_CMD_SEND "AT+SEND"
68 #define AWSIOT_CMD_GET "AT+GET"
69 #define AWSIOT_CMD_SUBSCRIBE "AT+SUBSCRIBE"
70 #define AWSIOT_CMD_UNSUBSCRIBE "AT+UNSUBSCRIBE"
71 #define AWSIOT_CMD_CONF "AT+CONF"
72 #define AWSIOT_CMD_CONF_CHECK "AT+CONF?"
73 #define AWSIOT_CMD_EVENT "AT+EVENT?"
74 #define AWSIOT_CMD_TIME "AT+TIME"
75 #define AWSIOT_CMD_WHERE "AT+WHERE"
76 #define AWSIOT_CMD_SEPARATOR " "
77 
82 #define AWSIOT_CONF_KEY_ABOUT "About"
83 #define AWSIOT_CONF_KEY_VERSION "Version"
84 #define AWSIOT_CONF_KEY_TECH_SPEC "TechSpec"
85 #define AWSIOT_CONF_KEY_THING_NAME "ThingName"
86 #define AWSIOT_CONF_KEY_CERTIFICATE "Certificate"
87 #define AWSIOT_CONF_KEY_CUSTOM_NAME "CustomName"
88 #define AWSIOT_CONF_KEY_ENDPOINT "Endpoint"
89 #define AWSIOT_CONF_KEY_ROOT_CA "RootCA"
90 #define AWSIOT_CONF_KEY_DEFENDER "Defender"
91 #define AWSIOT_CONF_KEY_HOTA_CERTIFICATE "HOTAcertificate"
92 #define AWSIOT_CONF_KEY_OTA_CERTIFICATE "OTAcertificate"
93 #define AWSIOT_CONF_KEY_SSID "SSID"
94 #define AWSIOT_CONF_KEY_PASSPHRASE "Passphrase"
95 #define AWSIOT_CONF_KEY_APN "APN"
96 #define AWSIOT_CONF_KEY_QOS "QOS"
97 #define AWSIOT_CONF_KEY_TOPIC "Topic"
98 
103 #define AWSIOT_RSP_OK "OK"
104 #define AWSIOT_RSP_ERR "ERR"
105 
111 #define AWSIOT_TX_DRV_BUFFER_SIZE 300
112 #define AWSIOT_RX_DRV_BUFFER_SIZE 300
113  // awsiot_cmd
115 
130 #define AWSIOT_MAP_MIKROBUS( cfg, mikrobus ) \
131  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
132  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
133  cfg.boot = MIKROBUS( mikrobus, MIKROBUS_AN ); \
134  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
135  cfg.event = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
136  cfg.wake = MIKROBUS( mikrobus, MIKROBUS_INT );
137  // awsiot_map // awsiot
140 
145 typedef struct
146 {
147  // Output pins
148  digital_out_t boot;
149  digital_out_t rst;
151  // Input pins
152  digital_in_t event;
153  digital_in_t wake;
155  // Modules
156  uart_t uart;
158  // Buffers
159  uint8_t uart_rx_buffer[ AWSIOT_RX_DRV_BUFFER_SIZE ];
160  uint8_t uart_tx_buffer[ AWSIOT_TX_DRV_BUFFER_SIZE ];
162 } awsiot_t;
163 
168 typedef struct
169 {
170  // Communication gpio pins
171  pin_name_t rx_pin;
172  pin_name_t tx_pin;
174  // Additional gpio pins
175  pin_name_t boot;
176  pin_name_t rst;
177  pin_name_t event;
178  pin_name_t wake;
180  // Static variable
181  uint32_t baud_rate;
183  uart_data_bits_t data_bit;
184  uart_parity_t parity_bit;
185  uart_stop_bits_t stop_bit;
187 } awsiot_cfg_t;
188 
193 typedef enum
194 {
200 
202 
219 
233 err_t awsiot_init ( awsiot_t *ctx, awsiot_cfg_t *cfg );
234 
247 err_t awsiot_generic_write ( awsiot_t *ctx, uint8_t *data_in, uint16_t len );
248 
261 err_t awsiot_generic_read ( awsiot_t *ctx, uint8_t *data_out, uint16_t len );
262 
274 void awsiot_send_cmd ( awsiot_t *ctx, uint8_t *cmd );
275 
285 
295 
305 
315 void awsiot_set_boot_pin ( awsiot_t *ctx, uint8_t state );
316 
326 
335 uint8_t awsiot_get_wake_pin ( awsiot_t *ctx );
336 
337 #ifdef __cplusplus
338 }
339 #endif
340 #endif // AWSIOT_H
341  // awsiot
343 
344 // ------------------------------------------------------------------------ END
awsiot_cfg_t::uart_blocking
bool uart_blocking
Definition: awsiot.h:182
awsiot_cfg_t::boot
pin_name_t boot
Definition: awsiot.h:175
AWSIOT_TX_DRV_BUFFER_SIZE
#define AWSIOT_TX_DRV_BUFFER_SIZE
AWS IoT driver buffer size.
Definition: awsiot.h:111
awsiot_t::wake
digital_in_t wake
Definition: awsiot.h:153
awsiot_generic_write
err_t awsiot_generic_write(awsiot_t *ctx, uint8_t *data_in, uint16_t len)
AWS IoT data writing function.
awsiot_get_wake_pin
uint8_t awsiot_get_wake_pin(awsiot_t *ctx)
AWS IoT get wake pin function.
awsiot_cfg_setup
void awsiot_cfg_setup(awsiot_cfg_t *cfg)
AWS IoT configuration object setup function.
awsiot_cfg_t::tx_pin
pin_name_t tx_pin
Definition: awsiot.h:172
awsiot_generic_read
err_t awsiot_generic_read(awsiot_t *ctx, uint8_t *data_out, uint16_t len)
AWS IoT data reading function.
awsiot_cfg_t::event
pin_name_t event
Definition: awsiot.h:177
awsiot_init
err_t awsiot_init(awsiot_t *ctx, awsiot_cfg_t *cfg)
AWS IoT initialization function.
AWSIOT_ERROR_UNKNOWN
@ AWSIOT_ERROR_UNKNOWN
Definition: awsiot.h:199
awsiot_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: awsiot.h:183
AWSIOT_ERROR_CMD
@ AWSIOT_ERROR_CMD
Definition: awsiot.h:198
awsiot_return_value_t
awsiot_return_value_t
AWS IoT Click return value data.
Definition: awsiot.h:194
AWSIOT_ERROR_TIMEOUT
@ AWSIOT_ERROR_TIMEOUT
Definition: awsiot.h:197
awsiot_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: awsiot.h:185
awsiot_t::event
digital_in_t event
Definition: awsiot.h:152
awsiot_t::boot
digital_out_t boot
Definition: awsiot.h:148
awsiot_t::uart
uart_t uart
Definition: awsiot.h:156
awsiot_cfg_t::wake
pin_name_t wake
Definition: awsiot.h:178
AWSIOT_RX_DRV_BUFFER_SIZE
#define AWSIOT_RX_DRV_BUFFER_SIZE
Definition: awsiot.h:112
awsiot_reset_device
void awsiot_reset_device(awsiot_t *ctx)
AWS IoT reset device function.
awsiot_t
AWS IoT Click context object.
Definition: awsiot.h:146
awsiot_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: awsiot.h:184
awsiot_set_boot_pin
void awsiot_set_boot_pin(awsiot_t *ctx, uint8_t state)
AWS IoT set boot pin function.
AWSIOT_ERROR
@ AWSIOT_ERROR
Definition: awsiot.h:196
awsiot_cfg_t::rst
pin_name_t rst
Definition: awsiot.h:176
awsiot_cfg_t
AWS IoT Click configuration object.
Definition: awsiot.h:169
awsiot_send_cmd
void awsiot_send_cmd(awsiot_t *ctx, uint8_t *cmd)
AWS IoT send cmd function.
awsiot_cfg_t::baud_rate
uint32_t baud_rate
Definition: awsiot.h:181
awsiot_cfg_t::rx_pin
pin_name_t rx_pin
Definition: awsiot.h:171
awsiot_get_event_pin
uint8_t awsiot_get_event_pin(awsiot_t *ctx)
AWS IoT get event pin function.
AWSIOT_OK
@ AWSIOT_OK
Definition: awsiot.h:195
awsiot_t::rst
digital_out_t rst
Definition: awsiot.h:149
awsiot_disable_device
void awsiot_disable_device(awsiot_t *ctx)
AWS IoT disable device function.
awsiot_enable_device
void awsiot_enable_device(awsiot_t *ctx)
AWS IoT enable device function.