Firmware SDK
twr_wssfm10r1at.h
1 #ifndef _TWR_WSSFM10R1AT_H
2 #define _TWR_WSSFM10R1AT_H
3 
4 #include <twr_scheduler.h>
5 #include <twr_gpio.h>
6 #include <twr_uart.h>
7 
11 
13 
14 #define TWR_WSSFM10R1AT_TX_FIFO_BUFFER_SIZE 64
15 #define TWR_WSSFM10R1AT_RX_FIFO_BUFFER_SIZE 64
16 
18 
20 
21 typedef enum
22 {
25 
28 
31 
34 
37 
40 
42 
44 
46 
48 
49 typedef enum
50 {
51  TWR_WSSFM10R1AT_STATE_READY = 0,
52  TWR_WSSFM10R1AT_STATE_ERROR = 1,
53  TWR_WSSFM10R1AT_STATE_INITIALIZE = 2,
54  TWR_WSSFM10R1AT_STATE_INITIALIZE_RESET_L = 3,
55  TWR_WSSFM10R1AT_STATE_INITIALIZE_RESET_H = 4,
56  TWR_WSSFM10R1AT_STATE_INITIALIZE_AT_COMMAND = 5,
57  TWR_WSSFM10R1AT_STATE_INITIALIZE_AT_RESPONSE = 6,
58  TWR_WSSFM10R1AT_STATE_SET_POWER_COMMAND = 7,
59  TWR_WSSFM10R1AT_STATE_SET_POWER_RESPONSE = 8,
60  TWR_WSSFM10R1AT_STATE_SEND_RF_FRAME_COMMAND = 9,
61  TWR_WSSFM10R1AT_STATE_SEND_RF_FRAME_RESPONSE = 10,
62  TWR_WSSFM10R1AT_STATE_READ_DEVICE_ID_COMMAND = 11,
63  TWR_WSSFM10R1AT_STATE_READ_DEVICE_ID_RESPONSE = 12,
64  TWR_WSSFM10R1AT_STATE_READ_DEVICE_PAC_COMMAND = 13,
65  TWR_WSSFM10R1AT_STATE_READ_DEVICE_PAC_RESPONSE = 14,
66  TWR_WSSFM10R1AT_STATE_CONTINUOUS_WAVE_COMMAND = 15,
67  TWR_WSSFM10R1AT_STATE_CONTINUOUS_WAVE_RESPONSE = 16,
68  TWR_WSSFM10R1AT_STATE_CONTINUOUS_WAVE = 17,
69  TWR_WSSFM10R1AT_STATE_DEEP_SLEEP_COMMAND = 18,
70  TWR_WSSFM10R1AT_STATE_DEEP_SLEEP_RESPONSE = 19,
71  TWR_WSSFM10R1AT_STATE_DEEP_SLEEP = 20
72 
73 } twr_wssfm10r1at_state_t;
74 
75 struct twr_wssfm10r1at_t
76 {
77  twr_scheduler_task_id_t _task_id;
78  twr_gpio_channel_t _reset_signal;
79  twr_uart_channel_t _uart_channel;
80  twr_wssfm10r1at_state_t _state;
81  twr_wssfm10r1at_state_t _state_after_sleep;
82  bool _deep_sleep;
83  twr_fifo_t _tx_fifo;
84  twr_fifo_t _rx_fifo;
85  uint8_t _tx_fifo_buffer[TWR_WSSFM10R1AT_TX_FIFO_BUFFER_SIZE];
86  uint8_t _rx_fifo_buffer[TWR_WSSFM10R1AT_RX_FIFO_BUFFER_SIZE];
87  void (*_event_handler)(twr_wssfm10r1at_t *, twr_wssfm10r1at_event_t, void *);
88  void *_event_param;
89  char _command[TWR_WSSFM10R1AT_TX_FIFO_BUFFER_SIZE];
90  char _response[TWR_WSSFM10R1AT_RX_FIFO_BUFFER_SIZE];
91  uint8_t _message_buffer[12];
92  size_t _message_length;
93 };
94 
96 
101 
102 void twr_wssfm10r1at_init(twr_wssfm10r1at_t *self, twr_gpio_channel_t reset_signal, twr_uart_channel_t uart_channel);
103 
108 
109 void twr_wssfm10r1at_set_event_handler(twr_wssfm10r1at_t *self, void (*event_handler)(twr_wssfm10r1at_t *, twr_wssfm10r1at_event_t, void *), void *event_param);
110 
115 
117 
124 
125 bool twr_wssfm10r1at_send_rf_frame(twr_wssfm10r1at_t *self, const void *buffer, size_t length);
126 
131 
133 
140 
141 bool twr_wssfm10r1at_get_device_id(twr_wssfm10r1at_t *self, char *buffer, size_t buffer_size);
142 
147 
149 
156 
157 bool twr_wssfm10r1at_get_device_pac(twr_wssfm10r1at_t *self, char *buffer, size_t buffer_size);
158 
163 
165 
167 
168 #endif // _TWR_WSSFM10R1AT_H
twr_wssfm10r1at_event_t
twr_wssfm10r1at_event_t
Callback events.
Definition: twr_wssfm10r1at.h:21
TWR_WSSFM10R1AT_EVENT_READ_DEVICE_ID
@ TWR_WSSFM10R1AT_EVENT_READ_DEVICE_ID
Device ID has been read event.
Definition: twr_wssfm10r1at.h:36
TWR_WSSFM10R1AT_EVENT_SEND_RF_FRAME_DONE
@ TWR_WSSFM10R1AT_EVENT_SEND_RF_FRAME_DONE
RF frame transmission finished event.
Definition: twr_wssfm10r1at.h:33
TWR_WSSFM10R1AT_EVENT_READ_DEVICE_PAC
@ TWR_WSSFM10R1AT_EVENT_READ_DEVICE_PAC
Device PAC has been read event.
Definition: twr_wssfm10r1at.h:39
twr_wssfm10r1at_send_rf_frame
bool twr_wssfm10r1at_send_rf_frame(twr_wssfm10r1at_t *self, const void *buffer, size_t length)
Send RF frame command.
Definition: twr_wssfm10r1at.c:64
TWR_WSSFM10R1AT_EVENT_READY
@ TWR_WSSFM10R1AT_EVENT_READY
Ready event.
Definition: twr_wssfm10r1at.h:24
twr_wssfm10r1at_read_device_pac
bool twr_wssfm10r1at_read_device_pac(twr_wssfm10r1at_t *self)
Read device PAC command.
Definition: twr_wssfm10r1at.c:116
TWR_WSSFM10R1AT_EVENT_ERROR
@ TWR_WSSFM10R1AT_EVENT_ERROR
Error event.
Definition: twr_wssfm10r1at.h:27
twr_wssfm10r1at_get_device_id
bool twr_wssfm10r1at_get_device_id(twr_wssfm10r1at_t *self, char *buffer, size_t buffer_size)
Get device ID (can be called only in TWR_WSSFM10R1AT_EVENT_READ_DEVICE_ID event)
Definition: twr_wssfm10r1at.c:92
twr_scheduler_task_id_t
size_t twr_scheduler_task_id_t
Task ID assigned by scheduler.
Definition: twr_scheduler.h:22
twr_wssfm10r1at_init
void twr_wssfm10r1at_init(twr_wssfm10r1at_t *self, twr_gpio_channel_t reset_signal, twr_uart_channel_t uart_channel)
Initialize WSSFM10R1AT.
Definition: twr_wssfm10r1at.c:20
twr_wssfm10r1at_get_device_pac
bool twr_wssfm10r1at_get_device_pac(twr_wssfm10r1at_t *self, char *buffer, size_t buffer_size)
Get device PAC (can be called only in TWR_WSSFM10R1AT_EVENT_READ_DEVICE_PAC event)
Definition: twr_wssfm10r1at.c:128
twr_wssfm10r1at_continuous_wave
bool twr_wssfm10r1at_continuous_wave(twr_wssfm10r1at_t *self)
Generate continuous wave command.
Definition: twr_wssfm10r1at.c:152
twr_wssfm10r1at_read_device_id
bool twr_wssfm10r1at_read_device_id(twr_wssfm10r1at_t *self)
Read device ID command.
Definition: twr_wssfm10r1at.c:80
twr_wssfm10r1at_t
struct twr_wssfm10r1at_t twr_wssfm10r1at_t
WSSFM10R1AT instance.
Definition: twr_wssfm10r1at.h:45
twr_fifo_t
Structure of FIFO instance.
Definition: twr_fifo.h:12
twr_wssfm10r1at_is_ready
bool twr_wssfm10r1at_is_ready(twr_wssfm10r1at_t *self)
Check if modem is ready for commands.
Definition: twr_wssfm10r1at.c:49
twr_gpio_channel_t
twr_gpio_channel_t
GPIO channels.
Definition: twr_gpio.h:12
TWR_WSSFM10R1AT_EVENT_SEND_RF_FRAME_START
@ TWR_WSSFM10R1AT_EVENT_SEND_RF_FRAME_START
RF frame transmission started event.
Definition: twr_wssfm10r1at.h:30
twr_wssfm10r1at_set_event_handler
void twr_wssfm10r1at_set_event_handler(twr_wssfm10r1at_t *self, void(*event_handler)(twr_wssfm10r1at_t *, twr_wssfm10r1at_event_t, void *), void *event_param)
Set callback function.
Definition: twr_wssfm10r1at.c:43
twr_uart_channel_t
twr_uart_channel_t
UART channels.
Definition: twr_uart.h:13