thingstream  2.0.0.0
thingstream.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 THINGSTREAM_H
36 #define THINGSTREAM_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_uart.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define THINGSTREAM_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
64  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
65  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
66 
72 #define THINGSTREAM_OK 0
73 #define THINGSTREAM_ERROR -1
74 
80 #define THINGSTREAM_DRV_RX_BUFFER_SIZE 600
81 #define THINGSTREAM_DRV_TX_BUFFER_SIZE 100
82 
88 #define THINGSTREAM_NEMA_CGNSINF 1
89 #define THINGSTREAM_NEMA_GPGLL 3
90 #define THINGSTREAM_NEMA_CGNSINF_NUM_ELEMENT 20
91 #define THINGSTREAM_NEMA_GPGLL_NUM_ELEMENT 5
92 
98 #define THINGSTREAM_GPGGA_TIME 1
99 #define THINGSTREAM_GPGGA_LATITUDE 2
100 #define THINGSTREAM_GPGGA_LATITUDE_SIDE 3
101 #define THINGSTREAM_GPGGA_LONGITUDE 4
102 #define THINGSTREAM_GPGGA_LONGITUDE_SIDE 5
103 #define THINGSTREAM_GPGGA_QUALITY_INDICATOR 6
104 #define THINGSTREAM_GPGGA_NUMBER_OF_SATELLITES 7
105 #define THINGSTREAM_GPGGA_H_DILUTION_OF_POS 8
106 #define THINGSTREAM_GPGGA_ALTITUDE 9
107 #define THINGSTREAM_GPGGA_ALTITUDE_UNIT 10
108 #define THINGSTREAM_GPGGA_GEOIDAL_SEPARATION 11
109 #define THINGSTREAM_GPGGA_GEOIDAL_SEPARATION_UNIT 12
110 #define THINGSTREAM_GPGGA_TIME_SINCE_LAST_DGPS 13
111 #define THINGSTREAM_GPGGA_DGPS_REFERENCE_STATION_ID 14
112 
118 #define THINGSTREAM_GPGLL_LATITUDE 1
119 #define THINGSTREAM_GPGLL_LATITUDE_SIDE 2
120 #define THINGSTREAM_GPGLL_LONGITUDE 3
121 #define THINGSTREAM_GPGLL_LONGITUDE_SIDE 4
122 
128 #define THINGSTREAM_ERROR_COMMAND_OR_ELEMENT 0xFF
129 #define THINGSTREAM_ERROR_START_OR_END_COMMAND 0x8F
130 #define THINGSTREAM_ERROR_NEXT_ELEMENT 0x4F
131 #define THINGSTREAM_ERROR_CURRENT_ELEMENT 0x2F
132 #define THINGSTREAM_NO_ERROR 0x00
133 
139 #define THINGSTREAM_CGNSINF_RUN_STAT 1
140 #define THINGSTREAM_CGNSINF_FIX_STAT 2
141 #define THINGSTREAM_CGNSINF_DATE_TIME 3
142 #define THINGSTREAM_CGNSINF_LATITUDE 4
143 #define THINGSTREAM_CGNSINF_LONGITUDE 5
144 #define THINGSTREAM_CGNSINF_ALTITUDE 6
145 #define THINGSTREAM_CGNSINF_SPEED 7
146 #define THINGSTREAM_CGNSINF_COURSE 8
147 #define THINGSTREAM_CGNSINF_FIX_MODE 9
148 #define THINGSTREAM_CGNSINF_RESERVED1 10
149 #define THINGSTREAM_CGNSINF_HDOP 11
150 #define THINGSTREAM_CGNSINF_PDOP 12
151 #define THINGSTREAM_CGNSINF_VDOP 13
152 #define THINGSTREAM_CGNSINF_RESERVED2 14
153 #define THINGSTREAM_CGNSINF_SAT_VIEW 15
154 #define THINGSTREAM_CGNSINF_SAT_USED 16
155 #define THINGSTREAM_CGNSINF_GLONASS_VIEW 17
156 #define THINGSTREAM_CGNSINF_RESERVED3 18
157 #define THINGSTREAM_CGNSINF_C_N0 19
158 #define THINGSTREAM_CGNSINF_HPA 20
159 #define THINGSTREAM_CGNSINF_VPA 21
160  // End group macro
163 // --------------------------------------------------------------- PUBLIC TYPES
171 typedef struct
172 {
173  // Output pins
174  digital_out_t rst;
175 
176  // Modules
177  uart_t uart;
178 
179  char uart_rx_buffer[ THINGSTREAM_DRV_RX_BUFFER_SIZE ];
180  char uart_tx_buffer[ THINGSTREAM_DRV_TX_BUFFER_SIZE ];
181 
182 } thingstream_t;
183 
187 typedef struct
188 {
189  // Communication gpio pins
190  pin_name_t rx_pin;
191  pin_name_t tx_pin;
192 
193  // Additional gpio pins
194  pin_name_t rst;
195 
196  // static variable
197  uint32_t baud_rate; // Clock speed.
199  uart_data_bits_t data_bit; // Data bits.
200  uart_parity_t parity_bit; // Parity bit.
201  uart_stop_bits_t stop_bit; // Stop bits.
202 
204 
208 // Actuator switch type
210 
211 // Actuator counter type
213 
214 // Actuator string type
216 
217 // Parser error type
218 typedef uint8_t thingstream_error_t;
219  // End types group
221 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
222 
228 #ifdef __cplusplus
229 extern "C"{
230 #endif
231 
241 
250 
257 void thingstream_module_power ( thingstream_t *ctx, uint8_t power_state );
258 
265 void thingstream_reset_pin_state ( thingstream_t *ctx, uint8_t state );
266 
274 void thingstream_generic_write ( thingstream_t *ctx, char *data_buf, uint16_t len );
275 
285 int32_t thingstream_generic_read ( thingstream_t *ctx, char *data_buf, uint16_t max_len );
286 
293 void thingstream_send_command ( thingstream_t *ctx, char *command );
294 
305 thingstream_error_t thingstream_generic_parser ( char *rsp, uint8_t command,
306  uint8_t element, char *parser_buf );
307 
308 #ifdef __cplusplus
309 }
310 #endif
311 #endif // _THINGSTREAM_H_
312  // End public_function group
315 
316 // ------------------------------------------------------------------------- END
thingstream_send_command
void thingstream_send_command(thingstream_t *ctx, char *command)
Send command.
thingstream_cfg_t::baud_rate
uint32_t baud_rate
Definition: thingstream.h:197
thingstream_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: thingstream.h:201
thingstream_actuator_sw_t
uint8_t thingstream_actuator_sw_t
Error type.
Definition: thingstream.h:209
thingstream_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: thingstream.h:199
thingstream_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: thingstream.h:200
thingstream_cfg_setup
void thingstream_cfg_setup(thingstream_cfg_t *cfg)
Config Object Initialization function.
thingstream_cfg_t::rst
pin_name_t rst
Definition: thingstream.h:194
thingstream_init
err_t thingstream_init(thingstream_t *ctx, thingstream_cfg_t *cfg)
Initialization function.
thingstream_module_power
void thingstream_module_power(thingstream_t *ctx, uint8_t power_state)
Power module.
thingstream_generic_parser
thingstream_error_t thingstream_generic_parser(char *rsp, uint8_t command, uint8_t element, char *parser_buf)
Generic parser function.
THINGSTREAM_DRV_TX_BUFFER_SIZE
#define THINGSTREAM_DRV_TX_BUFFER_SIZE
Definition: thingstream.h:81
thingstream_error_t
uint8_t thingstream_error_t
Definition: thingstream.h:218
thingstream_cfg_t::tx_pin
pin_name_t tx_pin
Definition: thingstream.h:191
THINGSTREAM_DRV_RX_BUFFER_SIZE
#define THINGSTREAM_DRV_RX_BUFFER_SIZE
Definition: thingstream.h:80
thingstream_t::rst
digital_out_t rst
Definition: thingstream.h:174
thingstream_actuator_cnt_t
int16_t thingstream_actuator_cnt_t
Definition: thingstream.h:212
thingstream_cfg_t
Click configuration structure definition.
Definition: thingstream.h:188
thingstream_t
Click ctx object definition.
Definition: thingstream.h:172
thingstream_cfg_t::rx_pin
pin_name_t rx_pin
Definition: thingstream.h:190
thingstream_generic_read
int32_t thingstream_generic_read(thingstream_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
thingstream_actuator_str_t
char thingstream_actuator_str_t
Definition: thingstream.h:215
thingstream_generic_write
void thingstream_generic_write(thingstream_t *ctx, char *data_buf, uint16_t len)
Generic write function.
thingstream_reset_pin_state
void thingstream_reset_pin_state(thingstream_t *ctx, uint8_t state)
Set RST pin state.
thingstream_t::uart
uart_t uart
Definition: thingstream.h:177
thingstream_cfg_t::uart_blocking
bool uart_blocking
Definition: thingstream.h:198