Go to the documentation of this file.
28 #ifndef IOTEXPRESSLINK2_H
29 #define IOTEXPRESSLINK2_H
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
59 #define IOTEXPRESSLINK2_CMD_AT "AT"
60 #define IOTEXPRESSLINK2_CMD_CONNECT "AT+CONNECT"
61 #define IOTEXPRESSLINK2_CMD_CONNECT_CHECK "AT+CONNECT?"
62 #define IOTEXPRESSLINK2_CMD_DISCONNECT "AT+DISCONNECT"
63 #define IOTEXPRESSLINK2_CMD_SLEEP "AT+SLEEP"
64 #define IOTEXPRESSLINK2_CMD_CONFMODE "AT+CONFMODE"
65 #define IOTEXPRESSLINK2_CMD_RESET "AT+RESET"
66 #define IOTEXPRESSLINK2_CMD_FACTORY_RESET "AT+FACTORY_RESET"
67 #define IOTEXPRESSLINK2_CMD_SEND "AT+SEND"
68 #define IOTEXPRESSLINK2_CMD_GET "AT+GET"
69 #define IOTEXPRESSLINK2_CMD_SUBSCRIBE "AT+SUBSCRIBE"
70 #define IOTEXPRESSLINK2_CMD_UNSUBSCRIBE "AT+UNSUBSCRIBE"
71 #define IOTEXPRESSLINK2_CMD_CONF "AT+CONF"
72 #define IOTEXPRESSLINK2_CMD_CONF_CHECK "AT+CONF?"
73 #define IOTEXPRESSLINK2_CMD_EVENT "AT+EVENT?"
74 #define IOTEXPRESSLINK2_CMD_TIME "AT+TIME"
75 #define IOTEXPRESSLINK2_CMD_WHERE "AT+WHERE"
76 #define IOTEXPRESSLINK2_CMD_SEPARATOR " "
77 #define IOTEXPRESSLINK2_CMD_SIGN_EQUAL "="
83 #define IOTEXPRESSLINK2_CONF_KEY_ABOUT "About"
84 #define IOTEXPRESSLINK2_CONF_KEY_VERSION "Version"
85 #define IOTEXPRESSLINK2_CONF_KEY_TECH_SPEC "TechSpec"
86 #define IOTEXPRESSLINK2_CONF_KEY_THING_NAME "ThingName"
87 #define IOTEXPRESSLINK2_CONF_KEY_CERTIFICATE "Certificate"
88 #define IOTEXPRESSLINK2_CONF_KEY_CERTIFICATE_PEM "Certificate pem"
89 #define IOTEXPRESSLINK2_CONF_KEY_CUSTOM_NAME "CustomName"
90 #define IOTEXPRESSLINK2_CONF_KEY_ENDPOINT "Endpoint"
91 #define IOTEXPRESSLINK2_CONF_KEY_ROOT_CA "RootCA"
92 #define IOTEXPRESSLINK2_CONF_KEY_DEFENDER "Defender"
93 #define IOTEXPRESSLINK2_CONF_KEY_HOTA_CERTIFICATE "HOTAcertificate"
94 #define IOTEXPRESSLINK2_CONF_KEY_OTA_CERTIFICATE "OTAcertificate"
95 #define IOTEXPRESSLINK2_CONF_KEY_APN "APN"
96 #define IOTEXPRESSLINK2_CONF_KEY_QOS "QOS"
97 #define IOTEXPRESSLINK2_CONF_KEY_TOPIC "Topic"
103 #define IOTEXPRESSLINK2_RSP_OK "OK"
104 #define IOTEXPRESSLINK2_RSP_ERR "ERR"
110 #define IOTEXPRESSLINK2_EVENT_TIMEOUT 10000ul
111 #define IOTEXPRESSLINK2_CONNECT_TIMEOUT 1000000ul
112 #define IOTEXPRESSLINK2_NORMAL_TIMEOUT 5000ul
118 #define IOTEXPRESSLINK2_POWER_ON_DELAY 15
119 #define IOTEXPRESSLINK2_EMERGENCY_SD_DELAY 25
120 #define IOTEXPRESSLINK2_EMERGENCY_SD_RETRY 5
127 #define IOTEXPRESSLINK2_TX_DRV_BUFFER_SIZE 200
128 #define IOTEXPRESSLINK2_RX_DRV_BUFFER_SIZE 900
146 #define IOTEXPRESSLINK2_MAP_MIKROBUS( cfg, mikrobus ) \
147 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
148 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
149 cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
150 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
151 cfg.wake = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
152 cfg.event = MIKROBUS( mikrobus, MIKROBUS_INT );
354 #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:194
uart_parity_t parity_bit
Definition: iotexpresslink2.h:200
pin_name_t pwr
Definition: iotexpresslink2.h:191
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:197
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:211
digital_in_t event
Definition: iotexpresslink2.h:169
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:185
#define IOTEXPRESSLINK2_RX_DRV_BUFFER_SIZE
Definition: iotexpresslink2.h:128
digital_in_t wake
Definition: iotexpresslink2.h:168
iotexpresslink2_return_value_t
IoT ExpressLink 2 Click return value data.
Definition: iotexpresslink2.h:210
@ IOTEXPRESSLINK2_ERROR_CMD
Definition: iotexpresslink2.h:214
pin_name_t tx_pin
Definition: iotexpresslink2.h:188
#define IOTEXPRESSLINK2_TX_DRV_BUFFER_SIZE
IoT ExpressLink 2 driver buffer size.
Definition: iotexpresslink2.h:127
pin_name_t rx_pin
Definition: iotexpresslink2.h:187
IoT ExpressLink 2 Click context object.
Definition: iotexpresslink2.h:162
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:199
pin_name_t wake
Definition: iotexpresslink2.h:193
@ IOTEXPRESSLINK2_ERROR_TIMEOUT
Definition: iotexpresslink2.h:213
digital_out_t pwr
Definition: iotexpresslink2.h:164
pin_name_t rst
Definition: iotexpresslink2.h:192
uart_t uart
Definition: iotexpresslink2.h:172
@ IOTEXPRESSLINK2_ERROR
Definition: iotexpresslink2.h:212
digital_out_t rst
Definition: iotexpresslink2.h:165
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:201
bool uart_blocking
Definition: iotexpresslink2.h:198