awsiot.h File Reference

This file contains API for AWS IoT Click Driver. More...

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

Go to the source code of this file.

Data Structures
struct	awsiot_t
	AWS IoT Click context object. More...
struct	awsiot_cfg_t
	AWS IoT Click configuration object. More...

Macros
#define	AWSIOT_CMD_AT   "AT"
	AWS IoT AT commands list.
#define	AWSIOT_CMD_CONNECT   "AT+CONNECT"
#define	AWSIOT_CMD_CONNECT_CHECK   "AT+CONNECT?"
#define	AWSIOT_CMD_DISCONNECT   "AT+DISCONNECT"
#define	AWSIOT_CMD_SLEEP   "AT+SLEEP"
#define	AWSIOT_CMD_CONFMODE   "AT+CONFMODE"
#define	AWSIOT_CMD_RESET   "AT+RESET"
#define	AWSIOT_CMD_FACTORY_RESET   "AT+FACTORY_RESET"
#define	AWSIOT_CMD_SEND   "AT+SEND"
#define	AWSIOT_CMD_GET   "AT+GET"
#define	AWSIOT_CMD_SUBSCRIBE   "AT+SUBSCRIBE"
#define	AWSIOT_CMD_UNSUBSCRIBE   "AT+UNSUBSCRIBE"
#define	AWSIOT_CMD_CONF   "AT+CONF"
#define	AWSIOT_CMD_CONF_CHECK   "AT+CONF?"
#define	AWSIOT_CMD_EVENT   "AT+EVENT?"
#define	AWSIOT_CMD_TIME   "AT+TIME"
#define	AWSIOT_CMD_WHERE   "AT+WHERE"
#define	AWSIOT_CMD_SEPARATOR   " "
#define	AWSIOT_CMD_SIGN_EQUAL   "="
#define	AWSIOT_CONF_KEY_ABOUT   "About"
	AWS IoT config key parameters list.
#define	AWSIOT_CONF_KEY_VERSION   "Version"
#define	AWSIOT_CONF_KEY_TECH_SPEC   "TechSpec"
#define	AWSIOT_CONF_KEY_THING_NAME   "ThingName"
#define	AWSIOT_CONF_KEY_CERTIFICATE   "Certificate"
#define	AWSIOT_CONF_KEY_CUSTOM_NAME   "CustomName"
#define	AWSIOT_CONF_KEY_ENDPOINT   "Endpoint"
#define	AWSIOT_CONF_KEY_ROOT_CA   "RootCA"
#define	AWSIOT_CONF_KEY_DEFENDER   "Defender"
#define	AWSIOT_CONF_KEY_HOTA_CERTIFICATE   "HOTAcertificate"
#define	AWSIOT_CONF_KEY_OTA_CERTIFICATE   "OTAcertificate"
#define	AWSIOT_CONF_KEY_SSID   "SSID"
#define	AWSIOT_CONF_KEY_PASSPHRASE   "Passphrase"
#define	AWSIOT_CONF_KEY_APN   "APN"
#define	AWSIOT_CONF_KEY_QOS   "QOS"
#define	AWSIOT_CONF_KEY_TOPIC   "Topic"
#define	AWSIOT_RSP_OK   "OK"
	AWS IoT device response for AT commands.
#define	AWSIOT_RSP_ERR   "ERR"
#define	AWSIOT_TX_DRV_BUFFER_SIZE   300
	AWS IoT driver buffer size.
#define	AWSIOT_RX_DRV_BUFFER_SIZE   1000
#define	AWSIOT_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	awsiot_return_value_t {   AWSIOT_OK = 0 , AWSIOT_ERROR = -1 , AWSIOT_ERROR_TIMEOUT = -2 , AWSIOT_ERROR_CMD = -3 ,   AWSIOT_ERROR_UNKNOWN = -4 }
	AWS IoT Click return value data. More...

Functions
void	awsiot_cfg_setup (awsiot_cfg_t *cfg)
	AWS IoT configuration object setup function.
err_t	awsiot_init (awsiot_t *ctx, awsiot_cfg_t *cfg)
	AWS IoT initialization function.
err_t	awsiot_generic_write (awsiot_t *ctx, uint8_t *data_in, uint16_t len)
	AWS IoT data writing function.
err_t	awsiot_generic_read (awsiot_t *ctx, uint8_t *data_out, uint16_t len)
	AWS IoT data reading function.
void	awsiot_send_cmd (awsiot_t *ctx, uint8_t *cmd)
	AWS IoT send cmd function.
void	awsiot_enable_device (awsiot_t *ctx)
	AWS IoT enable device function.
void	awsiot_disable_device (awsiot_t *ctx)
	AWS IoT disable device function.
void	awsiot_reset_device (awsiot_t *ctx)
	AWS IoT reset device function.
void	awsiot_set_boot_pin (awsiot_t *ctx, uint8_t state)
	AWS IoT set boot pin function.
uint8_t	awsiot_get_event_pin (awsiot_t *ctx)
	AWS IoT get event pin function.
uint8_t	awsiot_get_wake_pin (awsiot_t *ctx)
	AWS IoT get wake pin function.

Detailed Description

This file contains API for AWS IoT Click Driver.

Enumeration Type Documentation

awsiot_return_value_t

enum awsiot_return_value_t

AWS IoT Click return value data.

Predefined enum values for driver return values.

Enumerator
AWSIOT_OK
AWSIOT_ERROR
AWSIOT_ERROR_TIMEOUT
AWSIOT_ERROR_CMD
AWSIOT_ERROR_UNKNOWN