spectral3  2.0.0.0
spectral3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef SPECTRAL3_H
36 #define SPECTRAL3_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define SPECTRAL3_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
54  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
55  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
56  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
57 
63 #define SPECTRAL3_RETVAL uint8_t
64 
65 #define SPECTRAL3_OK 0x00
66 #define SPECTRAL3_INIT_ERROR 0xFF
67 
73 #define DRV_RX_BUFFER_SIZE 500
74  // End group macro
77 // --------------------------------------------------------------- PUBLIC TYPES
85 typedef struct
86 {
87  // Output pins
88 
89  digital_out_t rst;
90 
91  // Input pins
92 
93  digital_in_t int_pin;
94 
95  // Modules
96 
97  uart_t uart;
98 
99  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
100  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
101 
102 } spectral3_t;
103 
107 typedef struct
108 {
109  // Communication gpio pins
110 
111  pin_name_t rx_pin;
112  pin_name_t tx_pin;
113 
114  // Additional gpio pins
115 
116  pin_name_t rst;
117  pin_name_t int_pin;
118 
119  // static variable
120 
121  uint32_t baud_rate; // Clock speed.
123  uart_data_bits_t data_bit; // Data bits.
124  uart_parity_t parity_bit; // Parity bit.
125  uart_stop_bits_t stop_bit; // Stop bits.
126 
128 
132 typedef uint8_t spectral3_error_t;
133  // End types group
135 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
136 
142 #ifdef __cplusplus
143 extern "C"{
144 #endif
145 
155 
165 
171 void spectral3_module_reset ( spectral3_t *ctx );
172 
179 void spectral3_set_rst_pin ( spectral3_t *ctx, uint8_t state );
180 
188 void spectral3_generic_write ( spectral3_t *ctx, char *data_buf, uint16_t len );
189 
199 uint16_t spectral3_generic_read ( spectral3_t *ctx, char *data_buf, uint16_t max_len );
200 
207 void spectral3_send_command ( spectral3_t *ctx, char *command );
208 
215 void spectral3_get_data ( char *rsp, uint16_t *c_data );
216 
217 #ifdef __cplusplus
218 }
219 #endif
220 #endif // _SPECTRAL3_H_
221  // End public_function group
224 
225 // ------------------------------------------------------------------------- END
pin_name_t int_pin
Definition: spectral3.h:117
SPECTRAL3_RETVAL spectral3_init(spectral3_t *ctx, spectral3_cfg_t *cfg)
Initialization function.
pin_name_t rst
Definition: spectral3.h:116
uart_parity_t parity_bit
Definition: spectral3.h:124
digital_in_t int_pin
Definition: spectral3.h:93
void spectral3_get_data(char *rsp, uint16_t *c_data)
Read raw X, Y, Z and NIR data as well as two special internal registers D, & C.
uart_stop_bits_t stop_bit
Definition: spectral3.h:125
Click ctx object definition.
Definition: spectral3.h:85
uart_t uart
Definition: spectral3.h:97
pin_name_t rx_pin
Definition: spectral3.h:111
uint16_t spectral3_generic_read(spectral3_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
uint32_t baud_rate
Definition: spectral3.h:121
#define DRV_RX_BUFFER_SIZE
Definition: spectral3.h:73
digital_out_t rst
Definition: spectral3.h:89
void spectral3_module_reset(spectral3_t *ctx)
Reset module.
#define SPECTRAL3_RETVAL
Definition: spectral3.h:63
void spectral3_generic_write(spectral3_t *ctx, char *data_buf, uint16_t len)
Generic write function.
uint8_t spectral3_error_t
Error type.
Definition: spectral3.h:132
void spectral3_send_command(spectral3_t *ctx, char *command)
Send command.
pin_name_t tx_pin
Definition: spectral3.h:112
void spectral3_set_rst_pin(spectral3_t *ctx, uint8_t state)
Set RST ( reset ) pin state.
Click configuration structure definition.
Definition: spectral3.h:107
bool uart_blocking
Definition: spectral3.h:122
void spectral3_cfg_setup(spectral3_cfg_t *cfg)
Config Object Initialization function.
uart_data_bits_t data_bit
Definition: spectral3.h:123