Go to the documentation of this file.
28 #ifndef IOTEXPRESSLINK2_H
29 #define IOTEXPRESSLINK2_H
35 #include "mikrosdk_version.h"
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
69 #define IOTEXPRESSLINK2_CMD_AT "AT"
70 #define IOTEXPRESSLINK2_CMD_CONNECT "AT+CONNECT"
71 #define IOTEXPRESSLINK2_CMD_CONNECT_CHECK "AT+CONNECT?"
72 #define IOTEXPRESSLINK2_CMD_DISCONNECT "AT+DISCONNECT"
73 #define IOTEXPRESSLINK2_CMD_SLEEP "AT+SLEEP"
74 #define IOTEXPRESSLINK2_CMD_CONFMODE "AT+CONFMODE"
75 #define IOTEXPRESSLINK2_CMD_RESET "AT+RESET"
76 #define IOTEXPRESSLINK2_CMD_FACTORY_RESET "AT+FACTORY_RESET"
77 #define IOTEXPRESSLINK2_CMD_SEND "AT+SEND"
78 #define IOTEXPRESSLINK2_CMD_GET "AT+GET"
79 #define IOTEXPRESSLINK2_CMD_SUBSCRIBE "AT+SUBSCRIBE"
80 #define IOTEXPRESSLINK2_CMD_UNSUBSCRIBE "AT+UNSUBSCRIBE"
81 #define IOTEXPRESSLINK2_CMD_CONF "AT+CONF"
82 #define IOTEXPRESSLINK2_CMD_CONF_CHECK "AT+CONF?"
83 #define IOTEXPRESSLINK2_CMD_EVENT "AT+EVENT?"
84 #define IOTEXPRESSLINK2_CMD_TIME "AT+TIME"
85 #define IOTEXPRESSLINK2_CMD_WHERE "AT+WHERE"
86 #define IOTEXPRESSLINK2_CMD_SEPARATOR " "
87 #define IOTEXPRESSLINK2_CMD_SIGN_EQUAL "="
93 #define IOTEXPRESSLINK2_CONF_KEY_ABOUT "About"
94 #define IOTEXPRESSLINK2_CONF_KEY_VERSION "Version"
95 #define IOTEXPRESSLINK2_CONF_KEY_TECH_SPEC "TechSpec"
96 #define IOTEXPRESSLINK2_CONF_KEY_THING_NAME "ThingName"
97 #define IOTEXPRESSLINK2_CONF_KEY_CERTIFICATE "Certificate"
98 #define IOTEXPRESSLINK2_CONF_KEY_CERTIFICATE_PEM "Certificate pem"
99 #define IOTEXPRESSLINK2_CONF_KEY_CUSTOM_NAME "CustomName"
100 #define IOTEXPRESSLINK2_CONF_KEY_ENDPOINT "Endpoint"
101 #define IOTEXPRESSLINK2_CONF_KEY_ROOT_CA "RootCA"
102 #define IOTEXPRESSLINK2_CONF_KEY_DEFENDER "Defender"
103 #define IOTEXPRESSLINK2_CONF_KEY_HOTA_CERTIFICATE "HOTAcertificate"
104 #define IOTEXPRESSLINK2_CONF_KEY_OTA_CERTIFICATE "OTAcertificate"
105 #define IOTEXPRESSLINK2_CONF_KEY_APN "APN"
106 #define IOTEXPRESSLINK2_CONF_KEY_QOS "QOS"
107 #define IOTEXPRESSLINK2_CONF_KEY_TOPIC "Topic"
113 #define IOTEXPRESSLINK2_RSP_OK "OK"
114 #define IOTEXPRESSLINK2_RSP_ERR "ERR"
120 #define IOTEXPRESSLINK2_EVENT_TIMEOUT 10000ul
121 #define IOTEXPRESSLINK2_CONNECT_TIMEOUT 1000000ul
122 #define IOTEXPRESSLINK2_NORMAL_TIMEOUT 5000ul
128 #define IOTEXPRESSLINK2_POWER_ON_DELAY 15
129 #define IOTEXPRESSLINK2_EMERGENCY_SD_DELAY 25
130 #define IOTEXPRESSLINK2_EMERGENCY_SD_RETRY 5
137 #define IOTEXPRESSLINK2_TX_DRV_BUFFER_SIZE 200
138 #define IOTEXPRESSLINK2_RX_DRV_BUFFER_SIZE 900
156 #define IOTEXPRESSLINK2_MAP_MIKROBUS( cfg, mikrobus ) \
157 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
158 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
159 cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
160 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
161 cfg.wake = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
162 cfg.event = MIKROBUS( mikrobus, MIKROBUS_INT );
364 #endif // IOTEXPRESSLINK2_H
void iotexpresslink2_send_cmd(iotexpresslink2_t *ctx, uint8_t *cmd)
IoT ExpressLink 2 send cmd function.
void iotexpresslink2_cfg_setup(iotexpresslink2_cfg_t *cfg)
IoT ExpressLink 2 configuration object setup function.
pin_name_t event
Definition: iotexpresslink2.h:204
uart_parity_t parity_bit
Definition: iotexpresslink2.h:210
pin_name_t pwr
Definition: iotexpresslink2.h:201
err_t iotexpresslink2_init(iotexpresslink2_t *ctx, iotexpresslink2_cfg_t *cfg)
IoT ExpressLink 2 initialization function.
uint8_t iotexpresslink2_get_event_pin(iotexpresslink2_t *ctx)
IoT ExpressLink 2 get event pin function.
uint32_t baud_rate
Definition: iotexpresslink2.h:207
err_t iotexpresslink2_generic_read(iotexpresslink2_t *ctx, uint8_t *data_out, uint16_t len)
IoT ExpressLink 2 data reading function.
@ IOTEXPRESSLINK2_OK
Definition: iotexpresslink2.h:221
digital_in_t event
Definition: iotexpresslink2.h:179
void iotexpresslink2_reset_device(iotexpresslink2_t *ctx)
IoT ExpressLink 2 reset device function.
void iotexpresslink2_power_on(iotexpresslink2_t *ctx)
IoT ExpressLink 2 power on function.
IoT ExpressLink 2 Click configuration object.
Definition: iotexpresslink2.h:195
#define IOTEXPRESSLINK2_RX_DRV_BUFFER_SIZE
Definition: iotexpresslink2.h:138
digital_in_t wake
Definition: iotexpresslink2.h:178
iotexpresslink2_return_value_t
IoT ExpressLink 2 Click return value data.
Definition: iotexpresslink2.h:220
@ IOTEXPRESSLINK2_ERROR_CMD
Definition: iotexpresslink2.h:224
pin_name_t tx_pin
Definition: iotexpresslink2.h:198
#define IOTEXPRESSLINK2_TX_DRV_BUFFER_SIZE
IoT ExpressLink 2 driver buffer size.
Definition: iotexpresslink2.h:137
pin_name_t rx_pin
Definition: iotexpresslink2.h:197
IoT ExpressLink 2 Click context object.
Definition: iotexpresslink2.h:172
void iotexpresslink2_set_rst_pin(iotexpresslink2_t *ctx, uint8_t state)
IoT ExpressLink 2 set rst pin function.
uart_data_bits_t data_bit
Definition: iotexpresslink2.h:209
pin_name_t wake
Definition: iotexpresslink2.h:203
@ IOTEXPRESSLINK2_ERROR_TIMEOUT
Definition: iotexpresslink2.h:223
digital_out_t pwr
Definition: iotexpresslink2.h:174
pin_name_t rst
Definition: iotexpresslink2.h:202
uart_t uart
Definition: iotexpresslink2.h:182
@ IOTEXPRESSLINK2_ERROR
Definition: iotexpresslink2.h:222
digital_out_t rst
Definition: iotexpresslink2.h:175
err_t iotexpresslink2_generic_write(iotexpresslink2_t *ctx, uint8_t *data_in, uint16_t len)
IoT ExpressLink 2 data writing function.
uint8_t iotexpresslink2_get_wake_pin(iotexpresslink2_t *ctx)
IoT ExpressLink 2 get wake pin function.
void iotexpresslink2_set_pwr_pin(iotexpresslink2_t *ctx, uint8_t state)
IoT ExpressLink 2 set pwr pin function.
uart_stop_bits_t stop_bit
Definition: iotexpresslink2.h:211
bool uart_blocking
Definition: iotexpresslink2.h:208