nbiot  2.0.0.0
nbiot.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef NBIOT_H
36 #define NBIOT_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_uart.h"
55 
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define NBIOT_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
69  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
70  cfg.stat = MIKROBUS( mikrobus, MIKROBUS_AN ); \
71  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
72 
78 #define NBIOT_RETVAL uint8_t
79 
80 #define NBIOT_OK 0x00
81 #define NBIOT_INIT_ERROR 0xFF
82 
88 #define NBIOT_CMD_AT "AT"
89 #define NBIOT_CMD_ATI "ATI"
90 #define NBIOT_CMD_CGMR "AT+CGMR"
91 
92 #define NBIOT_CMD_CFUN "AT+CFUN"
93 #define NBIOT_CMD_CEREG "AT+CEREG"
94 #define NBIOT_CMD_CGDCONT "AT+CGDCONT"
95 #define NBIOT_CMD_CIMI "AT+CIMI"
96 #define NBIOT_CMD_CGATT "AT+CGATT"
97 #define NBIOT_CMD_CSQ "AT+CSQ"
98 #define NBIOT_CMD_CESQ "AT+CESQ"
99 #define NBIOT_CMD_COPS "AT+COPS"
100 
106 #define DRV_RX_BUFFER_SIZE 500
107 #define DRV_TX_BUFFER_SIZE 100
108  // End group macro
111 // --------------------------------------------------------------- PUBLIC TYPES
119 typedef struct
120 {
121  // Output pins
122 
123  digital_out_t rst;
124 
125  // Input pins
126 
127  digital_in_t stat;
128 
129  // Modules
130 
131  uart_t uart;
132 
133  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
134  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
135 
136 } nbiot_t;
137 
141 typedef struct
142 {
143  // Communication gpio pins
144 
145  pin_name_t rx_pin;
146  pin_name_t tx_pin;
147 
148  // Additional gpio pins
149 
150  pin_name_t stat;
151  pin_name_t rst;
152 
153  // static variable
154 
155  uint32_t baud_rate; // Clock speed.
157  uart_data_bits_t data_bit; // Data bits.
158  uart_parity_t parity_bit; // Parity bit.
159  uart_stop_bits_t stop_bit; // Stop bits.
160 
161 } nbiot_cfg_t;
162 
166 // Actuator switch type
167 typedef uint8_t nbiot_actuator_sw_t;
168 
169 // Actuator counter type
170 typedef int16_t nbiot_actuator_cnt_t;
171 
172 // Actuator string type
173 typedef char nbiot_actuator_str_t;
174 
175 // Parser error type
176 typedef uint8_t nbiot_error_t;
177  // End types group
179 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
180 
186 #ifdef __cplusplus
187 extern "C"{
188 #endif
189 
200 
215 err_t nbiot_init ( nbiot_t *ctx, nbiot_cfg_t *cfg );
216 
230 err_t nbiot_generic_write ( nbiot_t *ctx, char *data_buf, uint16_t len );
231 
245 err_t nbiot_generic_read ( nbiot_t *ctx, char *data_buf, uint16_t max_len );
246 
254 void nbiot_power_on ( nbiot_t *ctx );
255 
264 void nbiot_set_rst ( nbiot_t *ctx, uint8_t state );
265 
274 uint8_t nbiot_get_stat ( nbiot_t *ctx );
275 
285 void nbiot_send_cmd ( nbiot_t *ctx, char *cmd );
286 
297 void nbiot_send_cmd_with_parameter ( nbiot_t *ctx, char *at_cmd_buf, char *param_buf );
298 
308 void nbiot_send_cmd_check ( nbiot_t *ctx, char *at_cmd_buf );
309 
319 void nbiot_send_cmd_parameter_check ( nbiot_t *ctx, char *at_cmd_buf );
320 
330 void nbiot_set_sim_apn ( nbiot_t *ctx, char *sim_apn );
331 
332 #ifdef __cplusplus
333 }
334 #endif
335 #endif // _NBIOT_H_
336  // End public_function group
339 
340 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: nbiot.h:106
nbiot_get_stat
uint8_t nbiot_get_stat(nbiot_t *ctx)
STAT Pin Get function.
nbiot_t::uart
uart_t uart
Definition: nbiot.h:131
nbiot_actuator_sw_t
uint8_t nbiot_actuator_sw_t
Error type.
Definition: nbiot.h:167
nbiot_actuator_cnt_t
int16_t nbiot_actuator_cnt_t
Definition: nbiot.h:170
nbiot_cfg_t
Click configuration structure definition.
Definition: nbiot.h:142
nbiot_t
Click ctx object definition.
Definition: nbiot.h:120
nbiot_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: nbiot.h:159
nbiot_cfg_t::rst
pin_name_t rst
Definition: nbiot.h:151
nbiot_send_cmd_with_parameter
void nbiot_send_cmd_with_parameter(nbiot_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
nbiot_set_rst
void nbiot_set_rst(nbiot_t *ctx, uint8_t state)
Sets state of the RST pin.
nbiot_set_sim_apn
void nbiot_set_sim_apn(nbiot_t *ctx, char *sim_apn)
Set sim card APN.
nbiot_cfg_t::baud_rate
uint32_t baud_rate
Definition: nbiot.h:155
nbiot_init
err_t nbiot_init(nbiot_t *ctx, nbiot_cfg_t *cfg)
NB IoT initialization function.
nbiot_actuator_str_t
char nbiot_actuator_str_t
Definition: nbiot.h:173
nbiot_send_cmd
void nbiot_send_cmd(nbiot_t *ctx, char *cmd)
Send command function.
nbiot_cfg_t::uart_blocking
bool uart_blocking
Definition: nbiot.h:156
nbiot_cfg_t::rx_pin
pin_name_t rx_pin
Definition: nbiot.h:145
nbiot_send_cmd_check
void nbiot_send_cmd_check(nbiot_t *ctx, char *at_cmd_buf)
Check the sent command.
nbiot_t::stat
digital_in_t stat
Definition: nbiot.h:127
nbiot_error_t
uint8_t nbiot_error_t
Definition: nbiot.h:176
nbiot_t::rst
digital_out_t rst
Definition: nbiot.h:123
nbiot_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: nbiot.h:157
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: nbiot.h:107
nbiot_power_on
void nbiot_power_on(nbiot_t *ctx)
NB IoT module power on.
nbiot_cfg_t::tx_pin
pin_name_t tx_pin
Definition: nbiot.h:146
nbiot_send_cmd_parameter_check
void nbiot_send_cmd_parameter_check(nbiot_t *ctx, char *at_cmd_buf)
Check the command parameters.
nbiot_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: nbiot.h:158
nbiot_generic_write
err_t nbiot_generic_write(nbiot_t *ctx, char *data_buf, uint16_t len)
NB IoT data writing function.
nbiot_cfg_setup
void nbiot_cfg_setup(nbiot_cfg_t *cfg)
NB IoT configuration object setup function.
nbiot_cfg_t::stat
pin_name_t stat
Definition: nbiot.h:150
nbiot_generic_read
err_t nbiot_generic_read(nbiot_t *ctx, char *data_buf, uint16_t max_len)
NB IoT data reading function.