Freeman Oldman
The code from https://github.com/vpcola/Nucleo
cc3000_simple_link Class Reference
CC3000 Simple Link class which contains status of cc3000. More...
#include <cc3000.h>
Public Member Functions | |
| cc3000_simple_link () | |
| ctor - sets magic number in the buffers (overflow mark). | |
| ~cc3000_simple_link () | |
| dtor | |
| uint8_t | get_data_received_flag () |
| Returns data received flag. | |
| void | set_data_received_flag (uint8_t value) |
| Set data received flag. | |
| bool | get_tx_complete_signal () |
| Returns if tx was completed. | |
| void | set_tx_complete_signal (bool value) |
| Sets flag that tx was completed. | |
| uint8_t * | get_received_buffer () |
| Get receive buffer. | |
| uint8_t * | get_transmit_buffer () |
| Get transmit buffer. | |
| uint16_t | get_number_free_buffers () |
| Get number of free buffers. | |
| void | set_number_free_buffers (uint16_t value) |
| Set number of free buffers. | |
| uint16_t | get_buffer_length () |
| Retrieve buffer length. | |
| void | set_buffer_length (uint16_t value) |
| Set buffer length. | |
| uint16_t | get_pending_data () |
| Retrieve pending data flag. | |
| void | set_pending_data (uint16_t value) |
| Set pending data flag. | |
| uint16_t | get_op_code () |
| Retreive op code. | |
| void | set_op_code (uint16_t code) |
| Set op code. | |
| uint16_t | get_released_packets () |
| Get number of released packets. | |
| void | set_number_of_released_packets (uint16_t value) |
| Set number of released packets. | |
| uint16_t | get_sent_packets () |
| Get number of sent packats. | |
| void | set_sent_packets (uint16_t value) |
| Set number of sent packets. | |
| int32_t | get_transmit_error () |
| Retrieve transmit error. | |
| void | set_transmit_error (int32_t value) |
| Set transmit error. | |
| uint16_t | get_buffer_size () |
| Get buffer size. | |
| void | set_buffer_size (uint16_t value) |
| Set buffer size. | |
| void * | get_func_pointer (FunctionNumber function) |
| Not used currently. | |
| uint8_t * | get_received_data () |
| Retreive pointer to the received data. | |
| void | set_received_data (uint8_t *pointer) |
| Set received data pointer. | |
Detailed Description
CC3000 Simple Link class which contains status of cc3000.
Definition at line 141 of file cc3000.h.
Constructor & Destructor Documentation
ctor - sets magic number in the buffers (overflow mark).
- Parameters:
-
none
- Returns:
- none
Definition at line 46 of file cc3000_simplelink.cpp.
| ~cc3000_simple_link | ( | ) |
Member Function Documentation
| uint16_t get_buffer_length | ( | ) |
Retrieve buffer length.
- Parameters:
-
none
- Returns:
- Buffer length
Definition at line 122 of file cc3000_simplelink.cpp.
| uint16_t get_buffer_size | ( | void | ) |
Get buffer size.
- Parameters:
-
none
- Returns:
- Size of buffer.
Definition at line 158 of file cc3000_simplelink.cpp.
| uint8_t get_data_received_flag | ( | ) |
Returns data received flag.
- Returns:
- Data received flag.
Definition at line 54 of file cc3000_simplelink.cpp.
| void * get_func_pointer | ( | FunctionNumber | function ) |
Not used currently.
- Parameters:
-
function Number of desired function.
- Returns:
- void pointer to the function (need to recast).
Definition at line 58 of file cc3000_simplelink.cpp.
| uint16_t get_number_free_buffers | ( | ) |
Get number of free buffers.
- Parameters:
-
none
- Returns:
- Number of free buffers.
Definition at line 118 of file cc3000_simplelink.cpp.
| uint16_t get_op_code | ( | ) |
Retreive op code.
- Parameters:
-
none
- Returns:
- Op code
Definition at line 130 of file cc3000_simplelink.cpp.
| uint16_t get_pending_data | ( | ) |
Retrieve pending data flag.
- Parameters:
-
none
- Returns:
- Pending data flag
Definition at line 93 of file cc3000_simplelink.cpp.
| uint8_t * get_received_buffer | ( | ) |
Get receive buffer.
- Parameters:
-
none
- Returns:
- Pointer to the receive buffer.
Definition at line 81 of file cc3000_simplelink.cpp.
| uint8_t * get_received_data | ( | void | ) |
Retreive pointer to the received data.
- Parameters:
-
none
- Returns:
- Pointer to the received data buffer.
Definition at line 162 of file cc3000_simplelink.cpp.
| uint16_t get_released_packets | ( | ) |
Get number of released packets.
- Parameters:
-
none
- Returns:
- Number of released packets.
Definition at line 134 of file cc3000_simplelink.cpp.
| uint16_t get_sent_packets | ( | ) |
Get number of sent packats.
- Parameters:
-
none
- Returns:
- Number of sent packets.
Definition at line 138 of file cc3000_simplelink.cpp.
| uint8_t * get_transmit_buffer | ( | ) |
Get transmit buffer.
- Parameters:
-
none
- Returns:
- Pointer to the transmit buffer.
Definition at line 77 of file cc3000_simplelink.cpp.
| int32_t get_transmit_error | ( | ) |
Retrieve transmit error.
- Parameters:
-
none
- Returns:
- Transmit error
Definition at line 150 of file cc3000_simplelink.cpp.
| bool get_tx_complete_signal | ( | ) |
Returns if tx was completed.
- Returns:
- true if tx was completed, false otherwise.
Definition at line 110 of file cc3000_simplelink.cpp.
| void set_buffer_length | ( | uint16_t | value ) |
Set buffer length.
- Parameters:
-
value The length
- Returns:
- none
Definition at line 126 of file cc3000_simplelink.cpp.
| void set_buffer_size | ( | uint16_t | value ) |
Set buffer size.
- Parameters:
-
value Buffer size.
- Returns:
- none
Definition at line 154 of file cc3000_simplelink.cpp.
| void set_data_received_flag | ( | uint8_t | value ) |
Set data received flag.
- Parameters:
-
value The value to be set.
Definition at line 114 of file cc3000_simplelink.cpp.
| void set_number_free_buffers | ( | uint16_t | value ) |
Set number of free buffers.
- Parameters:
-
value Number of free buffers.
- Returns:
- none
Definition at line 97 of file cc3000_simplelink.cpp.
| void set_number_of_released_packets | ( | uint16_t | value ) |
Set number of released packets.
- Parameters:
-
value Number of released packets.
- Returns:
- none
Definition at line 101 of file cc3000_simplelink.cpp.
| void set_op_code | ( | uint16_t | code ) |
Set op code.
- Parameters:
-
code op code.
- Returns:
- none
Definition at line 85 of file cc3000_simplelink.cpp.
| void set_pending_data | ( | uint16_t | value ) |
Set pending data flag.
- Parameters:
-
value Pending data value.
- Returns:
- none
Definition at line 89 of file cc3000_simplelink.cpp.
| void set_received_data | ( | uint8_t * | pointer ) |
Set received data pointer.
- Parameters:
-
pointer Pointer to the buffer.
- Returns:
- none
Definition at line 166 of file cc3000_simplelink.cpp.
| void set_sent_packets | ( | uint16_t | value ) |
Set number of sent packets.
- Parameters:
-
value Number of sent packets.
- Returns:
- none
Definition at line 142 of file cc3000_simplelink.cpp.
| void set_transmit_error | ( | int32_t | value ) |
Set transmit error.
- Parameters:
-
value Error to be set.
- Returns:
- none
Definition at line 146 of file cc3000_simplelink.cpp.
| void set_tx_complete_signal | ( | bool | value ) |
Sets flag that tx was completed.
- Parameters:
-
value Value to be set
- Returns:
- none
Definition at line 106 of file cc3000_simplelink.cpp.
Generated on Tue Jul 12 2022 18:55:02 by
1.7.2