stspin233  2.0.0.0
stspin233.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 STSPIN233_H
36 #define STSPIN233_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 DRV_RX_BUFFER_SIZE 500
54 
61 #define STSPIN233_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
63  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
64  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
65  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
66 
72 #define STSPIN233_RETVAL uint8_t
73 
74 #define STSPIN233_OK 0x00
75 #define STSPIN233_INIT_ERROR 0xFF
76 
82 #define STSPIN233_CMD_START_MOTOR "STARTM"
83 #define STSPIN233_CMD_STOP_MOTOR "STOPMT"
84 #define STSPIN233_CMD_DIR_MOTOR "DIRECT"
85 #define STSPIN233_CMD_SET_SPEED "SETSPD"
86 #define STSPIN233_CMD_GET_SPEED "GETSPD"
87 #define STSPIN233_CMD_STATUS "STATUS"
88 #define STSPIN233_CMD_HELP "HELP"
89 #define STSPIN233_CMD_SET_PWM "INIREF"
90 #define STSPIN233_CMD_COM_DELAY "COMDEL"
91 #define STSPIN233_CMD_MOTOR_POLE "POLESP"
92 #define STSPIN233_CMD_KP_PRM "KP-PRM"
93 #define STSPIN233_CMD_KI_PRM "KI-PRM"
94 
100 #define STSPIN233_CW_DIR "1"
101 #define STSPIN233_CCW_DIR "0"
102 
108 #define STSPIN233_START_PWM_DUTY_10p "409"
109 #define STSPIN233_START_PWM_DUTY_20p "819"
110 #define STSPIN233_START_PWM_DUTY_DEF "819"
111 #define STSPIN233_START_PWM_DUTY_30p "1229"
112 #define STSPIN233_START_PWM_DUTY_40p "1638"
113 #define STSPIN233_START_PWM_DUTY_50p "2048"
114 #define STSPIN233_START_PWM_DUTY_60p "2458"
115 #define STSPIN233_START_PWM_DUTY_70p "2867"
116 #define STSPIN233_START_PWM_DUTY_80p "3277"
117 #define STSPIN233_START_PWM_DUTY_90p "3687"
118 #define STSPIN233_START_PWM_DUTY_100p "4095"
119 
125 #define STSPIN233_COMM_DELAY_7ms "7"
126 #define STSPIN233_COMM_DELAY_DEF "7"
127 
133 #define STSPIN233_M_POLE_2 "2"
134 #define STSPIN233_M_POLE_3 "3"
135 #define STSPIN233_M_POLE_4 "4"
136 #define STSPIN233_M_POLE_5 "5"
137 #define STSPIN233_M_POLE_6 "6"
138 #define STSPIN233_M_POLE_DEF "6"
139 #define STSPIN233_M_POLE_7 "7"
140 #define STSPIN233_M_POLE_8 "8"
141 
147 #define STSPIN233_KP_PRM_DEF "500"
148 #define STSPIN233_KI_PRM_DEF "250"
149 
155 #define STSPIN233_SPEED_1000RPM "1000"
156 #define STSPIN233_SPEED_DEF "1000"
157 #define STSPIN233_SPEED_900RPM "900"
158 #define STSPIN233_SPEED_1100RPM "1100"
159 #define STSPIN233_SPEED_1200RPM "1200"
160 #define STSPIN233_SPEED_1300RPM "1300"
161 #define STSPIN233_SPEED_1400RPM "1400"
162 #define STSPIN233_SPEED_1500RPM "1500"
163 #define STSPIN233_SPEED_1600RPM "1600"
164 #define STSPIN233_SPEED_1700RPM "1700"
165 #define STSPIN233_SPEED_1800RPM "1800"
166 #define STSPIN233_SPEED_1900RPM "1900"
167 #define STSPIN233_SPEED_2000RPM "2000"
168 #define STSPIN233_SPEED_2100RPM "2100"
169  // End group macro
172 // --------------------------------------------------------------- PUBLIC TYPES
181 typedef struct
182 {
183  // Output pins
184 
185  digital_out_t rst;
186 
187  // Input pins
188 
189  digital_in_t int_pin;
190 
191  // Modules
192 
193  uart_t uart;
194 
195  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
196  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
197 
198 } stspin233_t;
199 
203 typedef struct
204 {
205  // Communication gpio pins
206 
207  pin_name_t rx_pin;
208  pin_name_t tx_pin;
209 
210  // Additional gpio pins
211 
212  pin_name_t rst;
213  pin_name_t int_pin;
214 
215  // static variable
216 
217  uint32_t baud_rate; // Clock speed.
219  uart_data_bits_t data_bit; // Data bits.
220  uart_parity_t parity_bit; // Parity bit.
221  uart_stop_bits_t stop_bit; // Stop bits.
222 
224  // End types group
226 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
227 
233 #ifdef __cplusplus
234 extern "C"{
235 #endif
236 
246 
255 
264 
271 void stspin233_generic_write ( stspin233_t *ctx, char *data_buf, uint16_t len );
272 
280 int32_t stspin233_generic_read ( stspin233_t *ctx, char *data_buf, uint16_t max_len );
281 
288 
301 void stspin233_send_single_cmd ( stspin233_t *ctx, uint8_t *tx_buf );
302 
317 void stspin233_send_double_cmd ( stspin233_t *ctx, uint8_t *cmd_buf, uint8_t *arg_buf );
318 
325 void stspin233_set_reset_state ( stspin233_t *ctx, uint8_t state );
326 
335 
336 #ifdef __cplusplus
337 }
338 #endif
339 #endif // _STSPIN233_H_
340  // End public_function group
343 
344 // ------------------------------------------------------------------------- END
stspin233_generic_write
void stspin233_generic_write(stspin233_t *ctx, char *data_buf, uint16_t len)
Generic write function.
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: stspin233.h:53
stspin233_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: stspin233.h:219
stspin233_generic_read
int32_t stspin233_generic_read(stspin233_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
stspin233_t::uart
uart_t uart
Definition: stspin233.h:193
STSPIN233_RETVAL
#define STSPIN233_RETVAL
Definition: stspin233.h:72
stspin233_cfg_t::rst
pin_name_t rst
Definition: stspin233.h:212
stspin233_t
Click ctx object definition.
Definition: stspin233.h:182
stspin233_get_int_state
uint8_t stspin233_get_int_state(stspin233_t *ctx)
Get INT pin state.
stspin233_cfg_setup
void stspin233_cfg_setup(stspin233_cfg_t *cfg)
Config Object Initialization function.
stspin233_cfg_t::uart_blocking
bool uart_blocking
Definition: stspin233.h:218
stspin233_cfg_t::int_pin
pin_name_t int_pin
Definition: stspin233.h:213
stspin233_cfg_t::tx_pin
pin_name_t tx_pin
Definition: stspin233.h:208
stspin233_init
STSPIN233_RETVAL stspin233_init(stspin233_t *ctx, stspin233_cfg_t *cfg)
Initialization function.
stspin233_wakeup
void stspin233_wakeup(stspin233_t *ctx)
Module wake-up (procedure)
stspin233_cfg_t::baud_rate
uint32_t baud_rate
Definition: stspin233.h:217
stspin233_send_double_cmd
void stspin233_send_double_cmd(stspin233_t *ctx, uint8_t *cmd_buf, uint8_t *arg_buf)
Send double command.
stspin233_default_cfg
void stspin233_default_cfg(stspin233_t *ctx)
Click Default Configuration function.
stspin233_t::int_pin
digital_in_t int_pin
Definition: stspin233.h:189
stspin233_cfg_t
Click configuration structure definition.
Definition: stspin233.h:204
stspin233_t::rst
digital_out_t rst
Definition: stspin233.h:185
stspin233_cfg_t::rx_pin
pin_name_t rx_pin
Definition: stspin233.h:207
stspin233_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: stspin233.h:221
stspin233_send_single_cmd
void stspin233_send_single_cmd(stspin233_t *ctx, uint8_t *tx_buf)
Send single command.
stspin233_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: stspin233.h:220
stspin233_set_reset_state
void stspin233_set_reset_state(stspin233_t *ctx, uint8_t state)
Set RST pin state.