c5gnbiot 2.0.0.0
c5gnbiot.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 C5GNBIOT_H
36#define C5GNBIOT_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_uart.h"
41
42
43// -------------------------------------------------------------- PUBLIC MACROS
53#define C5GNBIOT_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56 cfg.on = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
65#define C5GNBIOT_MODULE_POWER_ON 1
66#define C5GNBIOT_MODULE_POWER_OFF 0
73#define C5GNBIOT_CMD_AT "AT"
74#define C5GNBIOT_CMD_ATI "ATI"
75#define C5GNBIOT_CMD_CGMR "AT+CGMR"
76
77#define C5GNBIOT_CMD_CFUN "AT+CFUN"
78#define C5GNBIOT_CMD_CREG "AT+CREG"
79#define C5GNBIOT_CMD_CEREG "AT+CEREG"
80#define C5GNBIOT_CMD_CGDCONT "AT+CGDCONT"
81#define C5GNBIOT_CMD_CIMI "AT+CIMI"
82#define C5GNBIOT_CMD_CGATT "AT+CGATT"
83#define C5GNBIOT_CMD_CESQ "AT+CESQ"
84#define C5GNBIOT_CMD_COPS "AT+COPS"
85#define C5GNBIOT_CMD_CMGS "AT+CMGS"
92#define DRV_RX_BUFFER_SIZE 300
93#define DRV_TX_BUFFER_SIZE 300 // End group macro
97// --------------------------------------------------------------- PUBLIC TYPES
105typedef struct
106{
107 // Output pins
108
109 digital_out_t on;
110 digital_out_t rts;
111
112 // Input pins
113
114 digital_in_t cts;
115
116 // Modules
117
118 uart_t uart;
119
120 char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
121 char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
122
123} c5gnbiot_t;
124
128typedef struct
129{
130 // Communication gpio pins
131
132 pin_name_t rx_pin;
133 pin_name_t tx_pin;
134
135 // Additional gpio pins
136
137 pin_name_t on;
138 pin_name_t cts;
139 pin_name_t rts;
140
141 // static variable
142
143 uint32_t baud_rate; // Clock speed.
145 uart_data_bits_t data_bit; // Data bits.
146 uart_parity_t parity_bit; // Parity bit.
147 uart_stop_bits_t stop_bit; // Stop bits.
148
150
155typedef enum
156{
158 C5GNBIOT_ERROR = -1
159
161 // End types group
163// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
164
170#ifdef __cplusplus
171extern "C"{
172#endif
173
184
200
214err_t c5gnbiot_generic_write ( c5gnbiot_t *ctx, char *data_buf, uint16_t len );
215
229err_t c5gnbiot_generic_read ( c5gnbiot_t *ctx, char *data_buf, uint16_t max_len );
230
239
248void c5gnbiot_set_on ( c5gnbiot_t *ctx, uint8_t state );
249
258void c5gnbiot_set_rts ( c5gnbiot_t *ctx, uint8_t state );
259
269
279void c5gnbiot_send_cmd ( c5gnbiot_t *ctx, char *cmd );
280
291void c5gnbiot_send_cmd_with_parameter ( c5gnbiot_t *ctx, char *at_cmd_buf, char *param_buf );
292
302void c5gnbiot_send_cmd_check ( c5gnbiot_t *ctx, char *at_cmd_buf );
303
313void c5gnbiot_send_cmd_parameter_check ( c5gnbiot_t *ctx, char *at_cmd_buf );
314
324void c5gnbiot_set_sim_apn ( c5gnbiot_t *ctx, char *sim_apn );
325
339err_t c5gnbiot_send_text_message ( c5gnbiot_t *ctx, char *service_center_number,
340 char *phone_number, char *sms_text );
341
342#ifdef __cplusplus
343}
344#endif
345#endif // _C5GNBIOT_H_
346 // End public_function group
349
350// ------------------------------------------------------------------------- END
#define DRV_RX_BUFFER_SIZE
Definition: c5gnbiot.h:92
#define DRV_TX_BUFFER_SIZE
Definition: c5gnbiot.h:93
void c5gnbiot_send_cmd_with_parameter(c5gnbiot_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
err_t c5gnbiot_send_text_message(c5gnbiot_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
5G NB IoT send SMS in PDU mode.
err_t c5gnbiot_init(c5gnbiot_t *ctx, c5gnbiot_cfg_t *cfg)
5G NB IoT initialization function.
uint8_t c5gnbiot_get_cts(c5gnbiot_t *ctx)
CTS Pin Get function.
void c5gnbiot_send_cmd_parameter_check(c5gnbiot_t *ctx, char *at_cmd_buf)
Check the command parameters.
void c5gnbiot_power_on(c5gnbiot_t *ctx)
5G NB IoT module power on.
void c5gnbiot_send_cmd(c5gnbiot_t *ctx, char *cmd)
Send command function.
void c5gnbiot_cfg_setup(c5gnbiot_cfg_t *cfg)
5G NB IoT configuration object setup function.
void c5gnbiot_set_rts(c5gnbiot_t *ctx, uint8_t state)
Sets state of the RTS pin.
void c5gnbiot_set_on(c5gnbiot_t *ctx, uint8_t state)
Sets state of the ON pin.
void c5gnbiot_send_cmd_check(c5gnbiot_t *ctx, char *at_cmd_buf)
Check the sent command.
err_t c5gnbiot_generic_write(c5gnbiot_t *ctx, char *data_buf, uint16_t len)
5G NB IoT data writing function.
err_t c5gnbiot_generic_read(c5gnbiot_t *ctx, char *data_buf, uint16_t max_len)
5G NB IoT data reading function.
void c5gnbiot_set_sim_apn(c5gnbiot_t *ctx, char *sim_apn)
Set sim card APN.
c5gnbiot_return_value_t
5G NB IoT Click return value data.
Definition: c5gnbiot.h:156
@ C5GNBIOT_OK
Definition: c5gnbiot.h:157
@ C5GNBIOT_ERROR
Definition: c5gnbiot.h:158
Click configuration structure definition.
Definition: c5gnbiot.h:129
pin_name_t rts
Definition: c5gnbiot.h:139
uint32_t baud_rate
Definition: c5gnbiot.h:143
pin_name_t cts
Definition: c5gnbiot.h:138
bool uart_blocking
Definition: c5gnbiot.h:144
uart_data_bits_t data_bit
Definition: c5gnbiot.h:145
pin_name_t on
Definition: c5gnbiot.h:137
pin_name_t tx_pin
Definition: c5gnbiot.h:133
pin_name_t rx_pin
Definition: c5gnbiot.h:132
uart_stop_bits_t stop_bit
Definition: c5gnbiot.h:147
uart_parity_t parity_bit
Definition: c5gnbiot.h:146
Click ctx object definition.
Definition: c5gnbiot.h:106
digital_out_t on
Definition: c5gnbiot.h:109
digital_out_t rts
Definition: c5gnbiot.h:110
uart_t uart
Definition: c5gnbiot.h:118
digital_in_t cts
Definition: c5gnbiot.h:114