Go to the documentation of this file.
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
52 #define SPIRIT_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.cmd = MIKROBUS( mikrobus, MIKROBUS_CS ); \
57 cfg.shd = MIKROBUS( mikrobus, MIKROBUS_PWM )
64 #define SPIRIT_RETVAL uint8_t
66 #define SPIRIT_OK 0x00
67 #define SPIRIT_INIT_ERROR 0xFF
74 #define SPIRIT_MODULE_POWER_ON 1
75 #define SPIRIT_MODULE_POWER_OFF 0
82 #define DRV_RX_BUFFER_SIZE 500
83 #define DRV_TX_BUFFER_SIZE 200
90 #define SPIRIT_OPERATING_MODE 0x01
91 #define SPIRIT_COMMAND_MODE 0x00
93 #define SPIRIT_MODULE_WAKE_UP 0x01
94 #define SPIRIT_MODULE_SHUTDOWN 0x00
101 #define SPIRIT_CMD_ENTER_COMMAND_MODE "+++"
102 #define SPIRIT_CMD_ENTER_OPERATING_MODE "ATO"
103 #define SPIRIT_CMD_READ_MODULE_VERSION "AT/V"
104 #define SPIRIT_CMD_READ_ALL_CONFIG_REG "AT/S"
105 #define SPIRIT_CMD_STORE_CURRENT_CONFIG "AT/C"
106 #define SPIRIT_CMD_RESET_CONFIG "ATR"
107 #define SPIRIT_CMD_RESET_MODULE "ATZ"
114 #define SPIRIT_CMD_READ_INFO_PER "ATI0"
115 #define SPIRIT_CMD_READ_INFO_PSSI "ATI1"
116 #define SPIRIT_CMD_READ_INFO_LQI "ATI2"
117 #define SPIRIT_CMD_READ_INFO_PQI "ATI3"
118 #define SPIRIT_CMD_READ_INFO_SQI "ATI4"
119 #define SPIRIT_CMD_READ_INFO_PACKET_COUNT "ATI5"
120 #define SPIRIT_CMD_READ_INFO_PACKETS_LOST "ATI6"
127 #define SPIRIT_CMD_CFG_BAUD_RATE "ATS00"
128 #define SPIRIT_CMD_CFG_FREQUENCY "ATS01"
129 #define SPIRIT_CMD_CFG_DATA_RATE "ATS02"
130 #define SPIRIT_CMD_CFG_MODULATION "ATS03"
131 #define SPIRIT_CMD_CFG_OUTPUT_POWER "ATS04"
132 #define SPIRIT_CMD_CFG_FREQ_DEVIATION "ATS05"
133 #define SPIRIT_CMD_CFG_RX_FILTER "ATS06"
134 #define SPIRIT_CMD_CFG_CS_MODE "ATS07"
135 #define SPIRIT_CMD_CFG_RSSI_THRESHOLD "ATS08"
136 #define SPIRIT_CMD_CFG_PREAMBLE_LEN "ATS09"
137 #define SPIRIT_CMD_CFG_SYNC_LENGTH "ATS10"
138 #define SPIRIT_CMD_CFG_SYNC_VALUE "ATS11"
139 #define SPIRIT_CMD_CFG_CRC_MODE "ATS12"
140 #define SPIRIT_CMD_CFG_WHITENING "ATS13"
141 #define SPIRIT_CMD_CFG_FEC "ATS14"
142 #define SPIRIT_CMD_CFG_SOURCE_ADDR "ATS15"
143 #define SPIRIT_CMD_CFG_DESTINATION_ADDR "ATS16"
144 #define SPIRIT_CMD_CFG_MULTICAST_ADDR "ATS17"
145 #define SPIRIT_CMD_CFG_BROADCAST_ADDR "ATS18"
146 #define SPIRIT_CMD_CFG_FILTER_CRC "ATS19"
147 #define SPIRIT_CMD_CFG_FILTER_SOURCE "ATS20"
148 #define SPIRIT_CMD_CFG_FILTER_DESTINATION "ATS21"
149 #define SPIRIT_CMD_CFG_FILTER_MULTICAST "ATS22"
150 #define SPIRIT_CMD_CFG_FILTER_BROADCAST "ATS23"
151 #define SPIRIT_CMD_CFG_TXRX_LED "ATS24"
152 #define SPIRIT_CMD_CFG_ESCAPE_SEQ "ATS26"
153 #define SPIRIT_CMD_CFG_SOURCE_FILT_MASK "ATS27"
154 #define SPIRIT_CMD_CFG_PAYLOAD_SIZE "ATS28"
161 #define SPIRIT_PCFG_ENABLE "1"
162 #define SPIRIT_PCFG_DISABLE "0"
169 #define SPIRIT_PCFG_BAUD_RATE_9600 "9600"
170 #define SPIRIT_PCFG_BAUD_RATE_19200 "19200"
171 #define SPIRIT_PCFG_BAUD_RATE_38400 "38400"
172 #define SPIRIT_PCFG_BAUD_RATE_56000 "56000"
173 #define SPIRIT_PCFG_BAUD_RATE_57600 "57600"
174 #define SPIRIT_PCFG_BAUD_RATE_115200 "115200"
175 #define SPIRIT_PCFG_BAUD_RATE_128000 "128000"
176 #define SPIRIT_PCFG_BAUD_RATE_256000 "256000"
183 #define SPIRIT_PCFG_CSMODE_STATIC_SENSING "0"
184 #define SPIRIT_PCFG_CSMODE_DYNAMIC_SENSING_6dB "1"
185 #define SPIRIT_PCFG_CSMODE_DYNAMIC_SENSING_12dB "2"
186 #define SPIRIT_PCFG_CSMODE_DYNAMIC_SENSING_18dB "3"
193 #define SPIRIT_PCFG_CRCMODE_POLY_0x07 "1"
194 #define SPIRIT_PCFG_CRCMODE_POLY_0x8005 "2"
195 #define SPIRIT_PCFG_CRCMODE_POLY_0x1021 "3"
196 #define SPIRIT_PCFG_CRCMODE_POLY_0x864CFB "4"
203 #define SPIRIT_PCFG_TXRXLED_DISABLED "0"
204 #define SPIRIT_PCFG_TXRXLED_OPEN_DRAIN "1"
205 #define SPIRIT_PCFG_TXRXLED_PUSH_PULL "2"
212 #define SPIRIT_PCFG_MODULATION_2_FSK "0"
213 #define SPIRIT_PCFG_MODULATION_GFSK05 "1"
214 #define SPIRIT_PCFG_MODULATION_GFSK1 "2"
215 #define SPIRIT_PCFG_MODULATION_GMSK "3"
216 #define SPIRIT_PCFG_MODULATION_OOK "4"
217 #define SPIRIT_PCFG_MODULATION_ASK "5"
224 #define SPIRIT_CMD_SET_RF_TEST_MODE_DISABLE "AT/T0"
225 #define SPIRIT_CMD_SET_RF_TEST_MODE_PN9 "AT/T1"
226 #define SPIRIT_CMD_SET_RF_TEST_MODE_CW "AT/T2"
Click ctx object definition.
Definition: spirit.h:238
void spirit_set_mode(spirit_t *ctx, uint8_t mode)
Set mode function.
#define DRV_RX_BUFFER_SIZE
Definition: spirit.h:82
pin_name_t cmd
Definition: spirit.h:268
void spirit_send_cmd_check(spirit_t *ctx, char *at_cmd_buf)
Check the sent command.
digital_out_t shd
Definition: spirit.h:244
pin_name_t tx_pin
Definition: spirit.h:263
pin_name_t shd
Definition: spirit.h:269
uart_data_bits_t data_bit
Definition: spirit.h:275
int32_t spirit_generic_read(spirit_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
uint32_t baud_rate
Definition: spirit.h:273
void spirit_power_module(spirit_t *ctx, uint8_t power_state)
Power module function.
SPIRIT_RETVAL spirit_init(spirit_t *ctx, spirit_cfg_t *cfg)
Initialization function.
char spirit_actuator_str_t
Error type.
Definition: spirit.h:285
uart_stop_bits_t stop_bit
Definition: spirit.h:277
#define SPIRIT_RETVAL
Definition: spirit.h:64
pin_name_t rx_pin
Definition: spirit.h:262
void spirit_reset(spirit_t *ctx)
Software reset function.
digital_out_t rst
Definition: spirit.h:242
bool uart_blocking
Definition: spirit.h:274
uart_parity_t parity_bit
Definition: spirit.h:276
digital_out_t cmd
Definition: spirit.h:243
void spirit_cfg_setup(spirit_cfg_t *cfg)
Config Object Initialization function.
uint8_t spirit_error_t
Definition: spirit.h:288
void spirit_generic_write(spirit_t *ctx, char *data_buf, uint16_t len)
Generic write function.
pin_name_t rst
Definition: spirit.h:267
Click configuration structure definition.
Definition: spirit.h:258
void spirit_send_cmd_parameter_check(spirit_t *ctx, char *at_cmd_buf)
Check the command parameters.
void spirit_send_cmd_with_parameter(spirit_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
uart_t uart
Definition: spirit.h:248
void spirit_send_cmd(spirit_t *ctx, char *cmd)
Send command function.