xbee3.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 XBEE3_H
#define XBEE3_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 XBEE3_ENTER_CMD_MODE                "+++"
#define XBEE3_EXIT_CMD_MODE                 "CN"
#define XBEE3_FACTORY_RESET                 "RE"
#define XBEE3_SET_NODE_IDENTIFIER           "NI"
#define XBEE3_GET_SERIAL_NUMBER             "SH,SL"
#define XBEE3_SET_DEST_ADDR_HIGH            "DH"
#define XBEE3_SET_DEST_ADDR_LOW             "DL"
#define XBEE3_APPLY_CHANGES                 "AC"
#define XBEE3_API_MODE                      "AP"
#define XBEE3_SAVE_CHANGES                  "WR"
#define XBEE3_CMD_AT                        "AT"
#define XBEE3_DELIMITER                     ","
#define XBEE3_CARRIAGE_RETURN               "\r"
 
#define XBEE3_MODE_TRANSPARENT              0
#define XBEE3_MODE_API_WITHOUT_ESC          1
#define XBEE3_MODE_API_WITH_ESC             2
 
#define XBEE3_BROADCAST_DEST_ADDRESS_HIGH   "00000000"
#define XBEE3_BROADCAST_DEST_ADDRESS_LOW    "0000FFFF"
 
#define XBEE3_RSP_OK                        "OK"
#define XBEE3_RSP_ERROR                     "ERROR"
 
#define DRV_BUFFER_SIZE                     200
 
 // xbee3_cmd
 
#define XBEE3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.att_dtr = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // xbee3_map
 // xbee3
 
typedef struct
{
    // Output pins
    digital_out_t rts;              
    digital_out_t rst;              
    digital_out_t cs;               
    // Input pins
    digital_in_t cts;               
    digital_in_t att_dtr;           
    // Modules
    uart_t uart;                    
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];     
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];     
} xbee3_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;              
    pin_name_t tx_pin;              
    // Additional gpio pins
    pin_name_t rts;                 
    pin_name_t rst;                 
    pin_name_t cs;                  
    pin_name_t cts;                 
    pin_name_t att_dtr;             
    // 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;             
} xbee3_cfg_t;
 
typedef enum
{
    XBEE3_OK = 0,
    XBEE3_ERROR = -1
 
} xbee3_return_value_t;
 
void xbee3_cfg_setup ( xbee3_cfg_t *cfg );
 
err_t xbee3_init ( xbee3_t *ctx, xbee3_cfg_t *cfg );
 
err_t xbee3_generic_write ( xbee3_t *ctx, char *data_in, uint16_t len );
 
err_t xbee3_generic_read ( xbee3_t *ctx, char *data_out, uint16_t len );
 
void xbee3_set_rts_pin ( xbee3_t *ctx, uint8_t state );
 
void xbee3_set_rst_pin ( xbee3_t *ctx, uint8_t state );
 
void xbee3_set_cs_pin ( xbee3_t *ctx, uint8_t state );
 
uint8_t xbee3_get_cts_pin ( xbee3_t *ctx );
 
uint8_t xbee3_get_att_dtr_pin ( xbee3_t *ctx );
 
err_t xbee3_write_command ( xbee3_t *ctx, char *data_buf );
 
void xbee3_hw_reset ( xbee3_t *ctx );
 
err_t xbee3_enter_command_mode ( xbee3_t *ctx );
 
err_t xbee3_exit_command_mode ( xbee3_t *ctx );
 
err_t xbee3_factory_reset ( xbee3_t *ctx );
 
err_t xbee3_get_serial_number ( xbee3_t *ctx );
 
err_t xbee3_set_device_name ( xbee3_t *ctx, char *dev_name );
 
err_t xbee3_set_destination_address ( xbee3_t *ctx, char *dest_addr_high, char *dest_addr_low );
 
err_t xbee3_set_api_mode ( xbee3_t *ctx, uint8_t api_mode );
 
err_t xbee3_apply_changes ( xbee3_t *ctx );
 
err_t xbee3_save_changes ( xbee3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // XBEE3_H
 
 // xbee3
 
// ------------------------------------------------------------------------ END