calypso  2.1.0.0
Data Structures | Macros | Enumerations | Functions
calypso.h File Reference

This file contains API for Calypso Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  calypso_t
 Calypso Click context object. More...
 
struct  calypso_cfg_t
 Calypso Click configuration object. More...
 

Macros

#define CALYPSO_CMD_AT   "AT"
 Calypso control commands. More...
 
#define CALYPSO_CMD_AT_START   "AT+start"
 
#define CALYPSO_CMD_AT_TEST   "AT+test"
 
#define CALYPSO_CMD_AT_REBOOT   "AT+reboot"
 
#define CALYPSO_CMD_AT_GET   "AT+get"
 
#define CALYPSO_CMD_AT_SET   "AT+set"
 
#define CALYPSO_CMD_AT_WLAN_SET_MODE   "AT+wlanSetMode"
 
#define CALYPSO_CMD_AT_WLAN_SCAN   "AT+wlanScan"
 
#define CALYPSO_CMD_AT_WLAN_CONNECT   "AT+wlanConnect"
 
#define CALYPSO_CMD_AT_WLAN_DISCONNECT   "AT+wlanDisconnect"
 
#define CALYPSO_CMD_AT_WLAN_PROFILE_ADD   "AT+wlanProfileAdd"
 
#define CALYPSO_CMD_AT_WLAN_PROFILE_GET   "AT+wlanProfileGet"
 
#define CALYPSO_CMD_AT_WLAN_PROFILE_DEL   "AT+wlanProfileDel"
 
#define CALYPSO_CMD_AT_WLAN_SET   "AT+wlanSet"
 
#define CALYPSO_CMD_AT_WLAN_GET   "AT+wlanGet"
 
#define CALYPSO_CMD_AT_WLAN_POLICY_SET   "AT+wlanPolicySet"
 
#define CALYPSO_CMD_AT_WLAN_POLICY_GET   "AT+wlanPolicyGet"
 
#define CALYPSO_CMD_AT_NET_CFG_SET   "AT+netCfgSet"
 
#define CALYPSO_CMD_AT_NET_CFG_GET   "AT+netCfgGet"
 
#define CALYPSO_CMD_AT_SOCKET   "AT+socket"
 
#define CALYPSO_CMD_AT_CLOSE   "AT+close"
 
#define CALYPSO_CMD_AT_BIND   "AT+bind"
 
#define CALYPSO_CMD_AT_LISTEN   "AT+listen"
 
#define CALYPSO_CMD_AT_CONNECT   "AT+connect"
 
#define CALYPSO_CMD_AT_ACCEPT   "AT+accept"
 
#define CALYPSO_CMD_AT_SELECT   "AT+select"
 
#define CALYPSO_CMD_AT_SET_SOCK_OPT   "AT+setSockOpt"
 
#define CALYPSO_CMD_AT_GET_SOCK_OPT   "AT+getSockOpt"
 
#define CALYPSO_CMD_AT_RECV   "AT+recv"
 
#define CALYPSO_CMD_AT_RECV_FROM   "AT+recvFrom"
 
#define CALYPSO_CMD_AT_SEND   "AT+send"
 
#define CALYPSO_CMD_AT_SEND_TO   "AT+sendTo"
 
#define CALYPSO_CMD_AT_GPIO_GET   "AT+gpioGet"
 
#define CALYPSO_CMD_AT_GPIO_SET   "AT+gpioSet"
 
#define CALYPSO_RSP_OK   "OK"
 Calypso response codes. More...
 
#define CALYPSO_RSP_ERROR   "ERROR"
 
#define CALYPSO_RSP_READY   "+eventstartup"
 
#define CALYPSO_RSP_CONNECTED   "+eventwlan:connect"
 
#define CALYPSO_APP_MODE_AT_COMMAND   0x00
 Calypso APP mode settings. More...
 
#define CALYPSO_APP_MODE_OTA   0x01
 
#define CALYPSO_APP_MODE_PROVISIONIG   0x02
 
#define CALYPSO_APP_MODE_TRANSPARENT   0x03
 
#define CALYPSO_REG_INPUT_PORT   0x00
 Calypso Port expander register address settings. More...
 
#define CALYPSO_REG_OUTPUT_PORT   0x01
 
#define CALYPSO_REG_POLARITY_INVERSION   0x02
 
#define CALYPSO_REG_CONFIGURATION   0x03
 
#define CALYPSO_TX_DRV_BUFFER_SIZE   256
 Calypso driver buffer size. More...
 
#define CALYPSO_RX_DRV_BUFFER_SIZE   256
 
#define CALYPSO_PIN_NONE_MASK   0x00
 Calypso driver buffer size. More...
 
#define CALYPSO_PIN_ALL_MASK   0x0F
 
#define CALYPSO_PIN_AP0_MASK   0x01
 
#define CALYPSO_PIN_AP1_MASK   0x02
 
#define CALYPSO_PIN_BOOT_MASK   0x04
 
#define CALYPSO_PIN_RM2_MASK   0x08
 
#define CALYPSO_PIN_STATE_HIGH   0x01
 Calypso pin states. More...
 
#define CALYPSO_PIN_STATE_LOW   0x00
 
#define CALYPSO_DEVICE_ADDRESS   0x41
 Calypso device address setting. More...
 
#define CALYPSO_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  calypso_return_value_t {
  CALYPSO_OK = 0, CALYPSO_ERROR = -1, CALYPSO_ERROR_TIMEOUT = -2, CALYPSO_ERROR_CMD = -3,
  CALYPSO_ERROR_UNKNOWN = -4
}
 Calypso Click return value data. More...
 

Functions

void calypso_cfg_setup (calypso_cfg_t *cfg)
 Calypso configuration object setup function. More...
 
err_t calypso_init (calypso_t *ctx, calypso_cfg_t *cfg)
 Calypso initialization function. More...
 
err_t calypso_default_cfg (calypso_t *ctx)
 Calypso default configuration function. More...
 
err_t calypso_generic_write (calypso_t *ctx, uint8_t *data_in, uint16_t len)
 Calypso data writing function. More...
 
err_t calypso_generic_read (calypso_t *ctx, uint8_t *data_out, uint16_t len)
 Calypso data reading function. More...
 
err_t calypso_port_expander_write (calypso_t *ctx, uint8_t reg, uint8_t data_in)
 Calypso port expander data writing function. More...
 
err_t calypso_port_expander_read (calypso_t *ctx, uint8_t reg, uint8_t *data_out)
 Calypso port expander data reading function. More...
 
err_t calypso_set_pins (calypso_t *ctx, uint8_t set_mask, uint8_t clr_mask)
 Calypso set port expander pin function. More...
 
err_t calypso_set_app_mode (calypso_t *ctx, uint8_t mode_sel)
 Calypso set app mode function. More...
 
void calypso_set_rst_pin (calypso_t *ctx, uint8_t pin_state)
 Calypso set RST pin function. More...
 
void calypso_set_cts_pin (calypso_t *ctx, uint8_t pin_state)
 Calypso set CTS pin function. More...
 
void calypso_set_wup_pin (calypso_t *ctx, uint8_t pin_state)
 Calypso set WUP pin function. More...
 
uint8_t calypso_get_rts_pin (calypso_t *ctx)
 Calypso get RTS pin state function. More...
 
uint8_t calypso_get_rm0_pin (calypso_t *ctx)
 Calypso get RM0 pin state function. More...
 
void calypso_hw_reset (calypso_t *ctx)
 Calypso HW reset function. More...
 
void calypso_send_cmd (calypso_t *ctx, uint8_t *at_cmd_buf)
 Calypso send command function. More...
 
void calypso_send_cmd_with_par (calypso_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
 Calypso send command with parameter function. More...
 
void calypso_send_cmd_check (calypso_t *ctx, uint8_t *at_cmd_buf)
 Calypso send command check function. More...
 

Detailed Description

This file contains API for Calypso Click Driver.

Enumeration Type Documentation

◆ calypso_return_value_t

Calypso Click return value data.

Predefined enum values for driver return values.

Enumerator
CALYPSO_OK 
CALYPSO_ERROR 
CALYPSO_ERROR_TIMEOUT 
CALYPSO_ERROR_CMD 
CALYPSO_ERROR_UNKNOWN