This file contains API for IoT ExpressLink 3 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Data Structures
struct	iotexpresslink3_t
	IoT ExpressLink 3 Click context object. More...

struct	iotexpresslink3_cfg_t
	IoT ExpressLink 3 Click configuration object. More...

Macros
#define	IOTEXPRESSLINK3_CMD_AT "AT"
	IoT ExpressLink 3 AT commands list.

#define	IOTEXPRESSLINK3_CMD_CONNECT "AT+CONNECT"

#define	IOTEXPRESSLINK3_CMD_CONNECT_CHECK "AT+CONNECT?"

#define	IOTEXPRESSLINK3_CMD_DISCONNECT "AT+DISCONNECT"

#define	IOTEXPRESSLINK3_CMD_SLEEP "AT+SLEEP"

#define	IOTEXPRESSLINK3_CMD_CONFMODE "AT+CONFMODE"

#define	IOTEXPRESSLINK3_CMD_RESET "AT+RESET"

#define	IOTEXPRESSLINK3_CMD_FACTORY_RESET "AT+FACTORY_RESET"

#define	IOTEXPRESSLINK3_CMD_SEND "AT+SEND"

#define	IOTEXPRESSLINK3_CMD_GET "AT+GET"

#define	IOTEXPRESSLINK3_CMD_SUBSCRIBE "AT+SUBSCRIBE"

#define	IOTEXPRESSLINK3_CMD_UNSUBSCRIBE "AT+UNSUBSCRIBE"

#define	IOTEXPRESSLINK3_CMD_CONF "AT+CONF"

#define	IOTEXPRESSLINK3_CMD_CONF_CHECK "AT+CONF?"

#define	IOTEXPRESSLINK3_CMD_EVENT "AT+EVENT?"

#define	IOTEXPRESSLINK3_CMD_TIME "AT+TIME?"

#define	IOTEXPRESSLINK3_CMD_WHERE "AT+WHERE?"

#define	IOTEXPRESSLINK3_CMD_SEPARATOR " "

#define	IOTEXPRESSLINK3_CMD_SIGN_EQUAL "="

#define	IOTEXPRESSLINK3_CONF_KEY_ABOUT "About"
	IoT ExpressLink 3 config key parameters list.

#define	IOTEXPRESSLINK3_CONF_KEY_VERSION "Version"

#define	IOTEXPRESSLINK3_CONF_KEY_TECH_SPEC "TechSpec"

#define	IOTEXPRESSLINK3_CONF_KEY_THING_NAME "ThingName"

#define	IOTEXPRESSLINK3_CONF_KEY_CERTIFICATE "Certificate"

#define	IOTEXPRESSLINK3_CONF_KEY_CUSTOM_NAME "CustomName"

#define	IOTEXPRESSLINK3_CONF_KEY_ENDPOINT "Endpoint"

#define	IOTEXPRESSLINK3_CONF_KEY_ROOT_CA "RootCA"

#define	IOTEXPRESSLINK3_CONF_KEY_DEFENDER "Defender"

#define	IOTEXPRESSLINK3_CONF_KEY_HOTA_CERTIFICATE "HOTAcertificate"

#define	IOTEXPRESSLINK3_CONF_KEY_OTA_CERTIFICATE "OTAcertificate"

#define	IOTEXPRESSLINK3_CONF_KEY_SSID "SSID"

#define	IOTEXPRESSLINK3_CONF_KEY_PASSPHRASE "Passphrase"

#define	IOTEXPRESSLINK3_CONF_KEY_APN "APN"

#define	IOTEXPRESSLINK3_CONF_KEY_QOS "QOS"

#define	IOTEXPRESSLINK3_CONF_KEY_TOPIC "Topic"

#define	IOTEXPRESSLINK3_RSP_OK "OK"
	IoT ExpressLink 3 device response for AT commands.

#define	IOTEXPRESSLINK3_RSP_ERR "ERR"

#define	IOTEXPRESSLINK3_TX_DRV_BUFFER_SIZE 300
	IoT ExpressLink 3 driver buffer size.

#define	IOTEXPRESSLINK3_RX_DRV_BUFFER_SIZE 1000

#define	IOTEXPRESSLINK3_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	iotexpresslink3_return_value_t { IOTEXPRESSLINK3_OK = 0 , IOTEXPRESSLINK3_ERROR = -1 , IOTEXPRESSLINK3_ERROR_TIMEOUT = -2 , IOTEXPRESSLINK3_ERROR_CMD = -3 , IOTEXPRESSLINK3_ERROR_UNKNOWN = -4 }
	IoT ExpressLink 3 Click return value data. More...

Functions
void	iotexpresslink3_cfg_setup (iotexpresslink3_cfg_t *cfg)
	IoT ExpressLink 3 configuration object setup function.

err_t	iotexpresslink3_init (iotexpresslink3_t ctx, iotexpresslink3_cfg_t cfg)
	IoT ExpressLink 3 initialization function.

err_t	iotexpresslink3_generic_write (iotexpresslink3_t ctx, uint8_t data_in, uint16_t len)
	IoT ExpressLink 3 data writing function.

err_t	iotexpresslink3_generic_read (iotexpresslink3_t ctx, uint8_t data_out, uint16_t len)
	IoT ExpressLink 3 data reading function.

void	iotexpresslink3_send_cmd (iotexpresslink3_t ctx, uint8_t cmd)
	IoT ExpressLink 3 send cmd function.

void	iotexpresslink3_enable_device (iotexpresslink3_t *ctx)
	IoT ExpressLink 3 enable device function.

void	iotexpresslink3_disable_device (iotexpresslink3_t *ctx)
	IoT ExpressLink 3 disable device function.

void	iotexpresslink3_reset_device (iotexpresslink3_t *ctx)
	IoT ExpressLink 3 reset device function.

uint8_t	iotexpresslink3_get_rsn_pin (iotexpresslink3_t *ctx)
	IoT ExpressLink 3 get rsn pin function.

uint8_t	iotexpresslink3_get_event_pin (iotexpresslink3_t *ctx)
	IoT ExpressLink 3 get event pin function.

uint8_t	iotexpresslink3_get_wake_pin (iotexpresslink3_t *ctx)
	IoT ExpressLink 3 get wake pin function.

Detailed Description

This file contains API for IoT ExpressLink 3 Click Driver.

Enumeration Type Documentation

◆ iotexpresslink3_return_value_t

enum iotexpresslink3_return_value_t

IoT ExpressLink 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
IOTEXPRESSLINK3_OK
IOTEXPRESSLINK3_ERROR
IOTEXPRESSLINK3_ERROR_TIMEOUT
IOTEXPRESSLINK3_ERROR_CMD
IOTEXPRESSLINK3_ERROR_UNKNOWN

Data Structures

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ iotexpresslink3_return_value_t