This file contains API for N-PLC Click Driver. More...

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

Data Structures
struct	nplc_t
	N-PLC Click context object. More...

struct	nplc_cfg_t
	N-PLC Click configuration object. More...

Macros
#define	NPLC_CMD_COMMAND_MODE "+++"
	N-PLC control commands.

#define	NPLC_CMD_DATA_MODE "ATO"

#define	NPLC_CMD_S100 "ATS100"

#define	NPLC_CMD_S110 "ATS110"

#define	NPLC_CMD_S111 "ATS111"

#define	NPLC_CMD_S112 "ATS112"

#define	NPLC_CMD_S113 "ATS113"

#define	NPLC_CMD_S114 "ATS114"

#define	NPLC_CMD_S300 "ATS300"

#define	NPLC_CMD_S301 "ATS301"

#define	NPLC_CMD_S302 "ATS302"

#define	NPLC_CMD_S305 "ATS305"

#define	NPLC_CMD_S306 "ATS306"

#define	NPLC_CMD_FWI "AT+FWI"

#define	NPLC_CMD_X "ATX"

#define	NPLC_CMD_Z "ATZ"

#define	NPLC_CMD_F "AT&F"

#define	NPLC_CMD_W "AT&W"

#define	NPLC_CMD_H "AT&H"

#define	NPLC_CMD_V "AT&V"

#define	NPLC_MODE_COMMAND 0
	N-PLC mode selection.

#define	NPLC_MODE_DATA 1

#define	NPLC_DRV_BUFFER_SIZE 200
	N-PLC driver buffer size.

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

Enumerations
enum	nplc_return_value_t { NPLC_OK = 0 , NPLC_ERROR = -1 }
	N-PLC Click return value data. More...

Functions
void	nplc_cfg_setup (nplc_cfg_t *cfg)
	N-PLC configuration object setup function.

err_t	nplc_init (nplc_t ctx, nplc_cfg_t cfg)
	N-PLC initialization function.

err_t	nplc_generic_write (nplc_t ctx, char data_in, uint16_t len)
	N-PLC data writing function.

err_t	nplc_generic_read (nplc_t ctx, char data_out, uint16_t len)
	N-PLC data reading function.

void	nplc_set_rst_pin (nplc_t *ctx, uint8_t state)
	N-PLC set rst pin function.

void	nplc_set_md1_pin (nplc_t *ctx, uint8_t state)
	N-PLC set md1 pin function.

void	nplc_set_cts_pin (nplc_t *ctx, uint8_t state)
	N-PLC set cts pin function.

uint8_t	nplc_get_rts_pin (nplc_t *ctx)
	N-PLC get rts pin function.

void	nplc_hw_reset (nplc_t *ctx)
	N-PLC hw reset function.

void	nplc_sw_reset (nplc_t *ctx)
	N-PLC sw reset function.

void	nplc_factory_reset (nplc_t *ctx)
	N-PLC factory reset function.

void	nplc_firmware_version (nplc_t *ctx)
	N-PLC firmware version function.

void	nplc_set_mode (nplc_t *ctx, uint8_t mode)
	N-PLC set mode function.

void	nplc_send_cmd (nplc_t ctx, char cmd)
	N-PLC send command function.

void	nplc_write_s_register (nplc_t ctx, char s_reg, char *param_buf)
	N-PLC write s register function.

void	nplc_read_s_register (nplc_t ctx, char s_reg)
	N-PLC read s register function.

Detailed Description

This file contains API for N-PLC Click Driver.

Enumeration Type Documentation

N-PLC Click return value data.

Predefined enum values for driver return values.

Enumerator
NPLC_OK
NPLC_ERROR