nplc.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef NPLC_H
#define NPLC_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
 
#define NPLC_CMD_COMMAND_MODE   "+++"       
#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
#define NPLC_MODE_DATA          1
 
#define NPLC_DRV_BUFFER_SIZE    200
 
 // nplc_cmd
 
#define NPLC_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.md1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // nplc_map
 // nplc
 
typedef struct
{
    // Output pins
    digital_out_t cts;          
    digital_out_t rst;          
    digital_out_t md1;          
    // Input pins
    digital_in_t rts;           
    // Modules
    uart_t uart;                
    // Buffers
    char uart_rx_buffer[ NPLC_DRV_BUFFER_SIZE ];    
    char uart_tx_buffer[ NPLC_DRV_BUFFER_SIZE ];    
} nplc_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;          
    pin_name_t tx_pin;          
    // Additional gpio pins
    pin_name_t cts;             
    pin_name_t rst;             
    pin_name_t md1;             
    pin_name_t rts;             
    // Static variable
    uint32_t          baud_rate;        
    bool              uart_blocking;    
    uart_data_bits_t  data_bit;         
    uart_parity_t     parity_bit;       
    uart_stop_bits_t  stop_bit;         
} nplc_cfg_t;
 
typedef enum
{
    NPLC_OK = 0,
    NPLC_ERROR = -1
 
} nplc_return_value_t;
 
void nplc_cfg_setup ( nplc_cfg_t *cfg );
 
err_t nplc_init ( nplc_t *ctx, nplc_cfg_t *cfg );
 
err_t nplc_generic_write ( nplc_t *ctx, char *data_in, uint16_t len );
 
err_t nplc_generic_read ( nplc_t *ctx, char *data_out, uint16_t len );
 
void nplc_set_rst_pin ( nplc_t *ctx, uint8_t state );
 
void nplc_set_md1_pin ( nplc_t *ctx, uint8_t state );
 
void nplc_set_cts_pin ( nplc_t *ctx, uint8_t state );
 
uint8_t nplc_get_rts_pin ( nplc_t *ctx );
 
void nplc_hw_reset ( nplc_t *ctx );
 
void nplc_sw_reset ( nplc_t *ctx );
 
void nplc_factory_reset ( nplc_t *ctx );
 
void nplc_firmware_version ( nplc_t *ctx );
 
void nplc_set_mode ( nplc_t *ctx, uint8_t mode );
 
void nplc_send_cmd ( nplc_t *ctx, char *cmd );
 
void nplc_write_s_register ( nplc_t *ctx, char *s_reg, char *param_buf );
 
void nplc_read_s_register ( nplc_t *ctx, char *s_reg );
 
#ifdef __cplusplus
}
#endif
#endif // NPLC_H
 
 // nplc
 
// ------------------------------------------------------------------------ END