Go to the documentation of this file.
28 #ifndef IOTEXPRESSLINK3_H
29 #define IOTEXPRESSLINK3_H
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
59 #define IOTEXPRESSLINK3_CMD_AT "AT"
60 #define IOTEXPRESSLINK3_CMD_CONNECT "AT+CONNECT"
61 #define IOTEXPRESSLINK3_CMD_CONNECT_CHECK "AT+CONNECT?"
62 #define IOTEXPRESSLINK3_CMD_DISCONNECT "AT+DISCONNECT"
63 #define IOTEXPRESSLINK3_CMD_SLEEP "AT+SLEEP"
64 #define IOTEXPRESSLINK3_CMD_CONFMODE "AT+CONFMODE"
65 #define IOTEXPRESSLINK3_CMD_RESET "AT+RESET"
66 #define IOTEXPRESSLINK3_CMD_FACTORY_RESET "AT+FACTORY_RESET"
67 #define IOTEXPRESSLINK3_CMD_SEND "AT+SEND"
68 #define IOTEXPRESSLINK3_CMD_GET "AT+GET"
69 #define IOTEXPRESSLINK3_CMD_SUBSCRIBE "AT+SUBSCRIBE"
70 #define IOTEXPRESSLINK3_CMD_UNSUBSCRIBE "AT+UNSUBSCRIBE"
71 #define IOTEXPRESSLINK3_CMD_CONF "AT+CONF"
72 #define IOTEXPRESSLINK3_CMD_CONF_CHECK "AT+CONF?"
73 #define IOTEXPRESSLINK3_CMD_EVENT "AT+EVENT?"
74 #define IOTEXPRESSLINK3_CMD_TIME "AT+TIME?"
75 #define IOTEXPRESSLINK3_CMD_WHERE "AT+WHERE?"
76 #define IOTEXPRESSLINK3_CMD_SEPARATOR " "
77 #define IOTEXPRESSLINK3_CMD_SIGN_EQUAL "="
83 #define IOTEXPRESSLINK3_CONF_KEY_ABOUT "About"
84 #define IOTEXPRESSLINK3_CONF_KEY_VERSION "Version"
85 #define IOTEXPRESSLINK3_CONF_KEY_TECH_SPEC "TechSpec"
86 #define IOTEXPRESSLINK3_CONF_KEY_THING_NAME "ThingName"
87 #define IOTEXPRESSLINK3_CONF_KEY_CERTIFICATE "Certificate"
88 #define IOTEXPRESSLINK3_CONF_KEY_CUSTOM_NAME "CustomName"
89 #define IOTEXPRESSLINK3_CONF_KEY_ENDPOINT "Endpoint"
90 #define IOTEXPRESSLINK3_CONF_KEY_ROOT_CA "RootCA"
91 #define IOTEXPRESSLINK3_CONF_KEY_DEFENDER "Defender"
92 #define IOTEXPRESSLINK3_CONF_KEY_HOTA_CERTIFICATE "HOTAcertificate"
93 #define IOTEXPRESSLINK3_CONF_KEY_OTA_CERTIFICATE "OTAcertificate"
94 #define IOTEXPRESSLINK3_CONF_KEY_SSID "SSID"
95 #define IOTEXPRESSLINK3_CONF_KEY_PASSPHRASE "Passphrase"
96 #define IOTEXPRESSLINK3_CONF_KEY_APN "APN"
97 #define IOTEXPRESSLINK3_CONF_KEY_QOS "QOS"
98 #define IOTEXPRESSLINK3_CONF_KEY_TOPIC "Topic"
104 #define IOTEXPRESSLINK3_RSP_OK "OK"
105 #define IOTEXPRESSLINK3_RSP_ERR "ERR"
112 #define IOTEXPRESSLINK3_TX_DRV_BUFFER_SIZE 300
113 #define IOTEXPRESSLINK3_RX_DRV_BUFFER_SIZE 1000
131 #define IOTEXPRESSLINK3_MAP_MIKROBUS( cfg, mikrobus ) \
132 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
133 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
134 cfg.rsn = MIKROBUS( mikrobus, MIKROBUS_AN ); \
135 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
136 cfg.wake = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
137 cfg.event = MIKROBUS( mikrobus, MIKROBUS_INT );
338 #endif // IOTEXPRESSLINK3_H
@ IOTEXPRESSLINK3_ERROR_TIMEOUT
Definition: iotexpresslink3.h:198
err_t iotexpresslink3_generic_read(iotexpresslink3_t *ctx, uint8_t *data_out, uint16_t len)
IoT ExpressLink 3 data reading function.
bool uart_blocking
Definition: iotexpresslink3.h:183
#define IOTEXPRESSLINK3_RX_DRV_BUFFER_SIZE
Definition: iotexpresslink3.h:113
digital_in_t event
Definition: iotexpresslink3.h:152
void iotexpresslink3_disable_device(iotexpresslink3_t *ctx)
IoT ExpressLink 3 disable device function.
iotexpresslink3_return_value_t
IoT ExpressLink 3 Click return value data.
Definition: iotexpresslink3.h:195
uint8_t iotexpresslink3_get_wake_pin(iotexpresslink3_t *ctx)
IoT ExpressLink 3 get wake pin function.
digital_in_t rsn
Definition: iotexpresslink3.h:154
uint8_t iotexpresslink3_get_event_pin(iotexpresslink3_t *ctx)
IoT ExpressLink 3 get event pin function.
IoT ExpressLink 3 Click configuration object.
Definition: iotexpresslink3.h:170
uart_stop_bits_t stop_bit
Definition: iotexpresslink3.h:186
@ IOTEXPRESSLINK3_ERROR_CMD
Definition: iotexpresslink3.h:199
@ IOTEXPRESSLINK3_ERROR_UNKNOWN
Definition: iotexpresslink3.h:200
uart_t uart
Definition: iotexpresslink3.h:157
uart_parity_t parity_bit
Definition: iotexpresslink3.h:185
digital_in_t wake
Definition: iotexpresslink3.h:153
pin_name_t rx_pin
Definition: iotexpresslink3.h:172
void iotexpresslink3_cfg_setup(iotexpresslink3_cfg_t *cfg)
IoT ExpressLink 3 configuration object setup function.
#define IOTEXPRESSLINK3_TX_DRV_BUFFER_SIZE
IoT ExpressLink 3 driver buffer size.
Definition: iotexpresslink3.h:112
@ IOTEXPRESSLINK3_OK
Definition: iotexpresslink3.h:196
pin_name_t tx_pin
Definition: iotexpresslink3.h:173
void iotexpresslink3_enable_device(iotexpresslink3_t *ctx)
IoT ExpressLink 3 enable device function.
void iotexpresslink3_send_cmd(iotexpresslink3_t *ctx, uint8_t *cmd)
IoT ExpressLink 3 send cmd function.
pin_name_t event
Definition: iotexpresslink3.h:177
pin_name_t rst
Definition: iotexpresslink3.h:176
@ IOTEXPRESSLINK3_ERROR
Definition: iotexpresslink3.h:197
uart_data_bits_t data_bit
Definition: iotexpresslink3.h:184
digital_out_t rst
Definition: iotexpresslink3.h:149
err_t iotexpresslink3_init(iotexpresslink3_t *ctx, iotexpresslink3_cfg_t *cfg)
IoT ExpressLink 3 initialization function.
IoT ExpressLink 3 Click context object.
Definition: iotexpresslink3.h:147
uint8_t iotexpresslink3_get_rsn_pin(iotexpresslink3_t *ctx)
IoT ExpressLink 3 get rsn pin function.
uint32_t baud_rate
Definition: iotexpresslink3.h:182
pin_name_t rsn
Definition: iotexpresslink3.h:179
pin_name_t wake
Definition: iotexpresslink3.h:178
void iotexpresslink3_reset_device(iotexpresslink3_t *ctx)
IoT ExpressLink 3 reset device function.
err_t iotexpresslink3_generic_write(iotexpresslink3_t *ctx, uint8_t *data_in, uint16_t len)
IoT ExpressLink 3 data writing function.