Go to the source code of this file.
Defines | |
| #define | MP_BUFF_SIZE 1024 |
Functions | |
| void | rq_com_do_zero_force_flag (void) |
| Set the "zero sensor" flag to 1. When the next stream message will be decoded, the effort values will be stored as offsets a substracted from the next values. | |
| float | rq_com_get_received_data (UINT_8 i) |
| Return an effort component. | |
| void | rq_com_get_str_firmware_version (INT_8 *firmware_version) |
| Retrieves the sensor firmware version. | |
| void | rq_com_get_str_production_year (INT_8 *production_year) |
| Retrieves the sensor firmware version. | |
| void | rq_com_get_str_serial_number (INT_8 *serial_number) |
| Retrieves the sensor serial number. | |
| bool | rq_com_get_stream_detected (void) |
| retrieves the sensor firmware version | |
| bool | rq_com_get_valid_stream (void) |
| returns if the stream message is valid | |
| bool | rq_com_got_new_message (void) |
| Returns true if a new valid stream message has been decoded and is available. | |
| void | rq_com_listen_stream (void) |
| Listens and decode a valid stream input. | |
| INT_8 | rq_com_start_stream (void) |
| Starts the sensor streaming mode. | |
| INT_8 | rq_sensor_com (void) |
| Discovers and initialize the communication with the sensor. | |
| void | rq_sensor_com_read_info_high_lvl (void) |
| Reads and stores high level information from the sensor. These include the firmware version, the serial number and the production year. | |
| void | stop_connection (void) |
| close the serial port. | |
Define Documentation
| #define MP_BUFF_SIZE 1024 |
Definition at line 50 of file rq_sensor_com.h.
Function Documentation
| void rq_com_do_zero_force_flag | ( | void | ) |
Set the "zero sensor" flag to 1. When the next stream message will be decoded, the effort values will be stored as offsets a substracted from the next values.
Definition at line 1139 of file rq_sensor_com.cpp.
| float rq_com_get_received_data | ( | UINT_8 | i | ) |
Return an effort component.
- Parameters:
-
i Index of the component. 0 to 2 for Fx, Fy and Fz. 3 to 5 for Mx, My and Mz.
Definition at line 1110 of file rq_sensor_com.cpp.
| void rq_com_get_str_firmware_version | ( | INT_8 * | firmware_version | ) |
Retrieves the sensor firmware version.
- Parameters:
-
firmware_version Address of the return buffer
Definition at line 1074 of file rq_sensor_com.cpp.
| void rq_com_get_str_production_year | ( | INT_8 * | production_year | ) |
Retrieves the sensor firmware version.
- Parameters:
-
production_year Address of the return buffer
Definition at line 1083 of file rq_sensor_com.cpp.
| void rq_com_get_str_serial_number | ( | INT_8 * | serial_number | ) |
Retrieves the sensor serial number.
- Parameters:
-
serial_number address of the return buffer
Definition at line 1065 of file rq_sensor_com.cpp.
| bool rq_com_get_stream_detected | ( | void | ) |
retrieves the sensor firmware version
- Parameters:
-
production_year Address of the return buffer
Definition at line 1092 of file rq_sensor_com.cpp.
| bool rq_com_get_valid_stream | ( | void | ) |
returns if the stream message is valid
Definition at line 1100 of file rq_sensor_com.cpp.
| bool rq_com_got_new_message | ( | void | ) |
Returns true if a new valid stream message has been decoded and is available.
When this function is called, the variable that indicates if a new message is available is set to false even if the message hasn't beed read.
Definition at line 1127 of file rq_sensor_com.cpp.
| void rq_com_listen_stream | ( | void | ) |
Listens and decode a valid stream input.
Definition at line 319 of file rq_sensor_com.cpp.
| INT_8 rq_com_start_stream | ( | void | ) |
Starts the sensor streaming mode.
- Returns:
- 0 if the stream started, -1 otherwise
Definition at line 501 of file rq_sensor_com.cpp.
| void rq_sensor_com | ( | void | ) |
Discovers and initialize the communication with the sensor.
The functions loops through all the serial com ports and polls them to discover the sensor
Definition at line 141 of file rq_sensor_com.cpp.
| void rq_sensor_com_read_info_high_lvl | ( | void | ) |
Reads and stores high level information from the sensor. These include the firmware version, the serial number and the production year.
Definition at line 630 of file rq_sensor_com.cpp.
| void stop_connection | ( | void | ) |
close the serial port.
- Warning:
- Only valid under Windows.
Definition at line 1148 of file rq_sensor_com.cpp.