SerRelayBoard Class Reference
#include <SerRelayBoard.h>
List of all members.
Public Types |
| enum | RelBoardReturns {
NO_ERROR = 0,
NOT_INITIALIZED = 1,
GENERAL_SENDING_ERROR = 2,
TOO_LESS_BYTES_IN_QUEUE = 3,
NO_MESSAGES = 4,
CHECKSUM_ERROR = 5
} |
Public Member Functions |
| int | evalRxBuffer () |
| int | getAnalogIn (int *piAnalogIn) |
| int | getBatteryVoltage () |
| int | getChargeCurrent () |
| int | getDigIn () |
| bool | init () |
| bool | isEMStop () |
| bool | isScannerStop () |
| bool | reset () |
| int | sendRequest () |
| | SerRelayBoard (std::string ComPort, int ProtocolVersion=1) |
| int | setDigOut (int iChannel, bool bOn) |
| bool | shutdown () |
| | ~SerRelayBoard () |
Protected Types |
| enum | RelBoardCmd {
CMD_SET_CHARGE_RELAY = 1,
CMD_RESET_POS_CNT = 2,
CMD_QUICK_STOP = 4,
CMD_SET_RELAY1 = 8,
CMD_SET_RELAY2 = 16,
CMD_SET_RELAY3 = 32,
CMD_SET_RELAY4 = 64,
CMD_SET_RELAY5 = 128,
CMD_SET_RELAY6 = 256,
CMD_ZERO_GYRO = 512
} |
| enum | RelBoardConfig {
CONFIG_HAS_IOBOARD = 1,
CONFIG_HAS_USBOARD = 2,
CONFIG_HAS_GYROBOARD = 4,
CONFIG_HAS_RADARBOARD1 = 8,
CONFIG_HAS_RADARBOARD2 = 16,
CONFIG_HAS_DRIVES = 32
} |
Protected Member Functions |
| void | convDataToSendMsg (unsigned char cMsg[]) |
| bool | convRecMsgToData (unsigned char cMsg[]) |
| void | rxCharArray () |
| void | txCharArray () |
Protected Attributes |
| bool | m_bComInit |
| int | m_iChargeCurrent |
| int | m_iCmdRelayBoard |
| int | m_iConfigRelayBoard |
| int | m_iDigIn |
| int | m_iProtocolVersion |
| int | m_iRelBoardAnalogIn [4] |
| int | m_iRelBoardBattVoltage |
| int | m_iRelBoardKeyPad |
| int | m_iRelBoardStatus |
| int | m_iRelBoardTempSensor |
| Mutex | m_Mutex |
| int | m_NUM_BYTE_SEND |
| SerialIO | m_SerIO |
| std::string | m_sNumComPort |
Detailed Description
Driver class for communication with a Neobotix RelayBoard. Uses RS422 with 420 kBaud.
Definition at line 67 of file SerRelayBoard.h.
Member Enumeration Documentation
- Enumerator:
| CMD_SET_CHARGE_RELAY |
|
| CMD_RESET_POS_CNT |
|
| CMD_QUICK_STOP |
|
| CMD_SET_RELAY1 |
|
| CMD_SET_RELAY2 |
|
| CMD_SET_RELAY3 |
|
| CMD_SET_RELAY4 |
|
| CMD_SET_RELAY5 |
|
| CMD_SET_RELAY6 |
|
| CMD_ZERO_GYRO |
|
Definition at line 110 of file SerRelayBoard.h.
- Enumerator:
| CONFIG_HAS_IOBOARD |
|
| CONFIG_HAS_USBOARD |
|
| CONFIG_HAS_GYROBOARD |
|
| CONFIG_HAS_RADARBOARD1 |
|
| CONFIG_HAS_RADARBOARD2 |
|
| CONFIG_HAS_DRIVES |
|
Definition at line 124 of file SerRelayBoard.h.
- Enumerator:
| NO_ERROR |
|
| NOT_INITIALIZED |
|
| GENERAL_SENDING_ERROR |
|
| TOO_LESS_BYTES_IN_QUEUE |
|
| NO_MESSAGES |
|
| CHECKSUM_ERROR |
|
Definition at line 99 of file SerRelayBoard.h.
Constructor & Destructor Documentation
| SerRelayBoard::SerRelayBoard |
( |
std::string |
ComPort, |
|
|
int |
ProtocolVersion = 1 | |
|
) |
| | |
| SerRelayBoard::~SerRelayBoard |
( |
|
) |
|
Member Function Documentation
| void SerRelayBoard::convDataToSendMsg |
( |
unsigned char |
cMsg[] |
) |
[protected] |
| bool SerRelayBoard::convRecMsgToData |
( |
unsigned char |
cMsg[] |
) |
[protected] |
| int SerRelayBoard::evalRxBuffer |
( |
|
) |
|
| int SerRelayBoard::getAnalogIn |
( |
int * |
piAnalogIn |
) |
|
| int SerRelayBoard::getBatteryVoltage |
( |
|
) |
[inline] |
| int SerRelayBoard::getChargeCurrent |
( |
|
) |
[inline] |
| int SerRelayBoard::getDigIn |
( |
|
) |
|
| bool SerRelayBoard::init |
( |
|
) |
|
| bool SerRelayBoard::isEMStop |
( |
|
) |
|
| bool SerRelayBoard::isScannerStop |
( |
|
) |
|
| bool SerRelayBoard::reset |
( |
|
) |
|
| void SerRelayBoard::rxCharArray |
( |
|
) |
[protected] |
| int SerRelayBoard::sendRequest |
( |
|
) |
|
| int SerRelayBoard::setDigOut |
( |
int |
iChannel, |
|
|
bool |
bOn | |
|
) |
| | |
| bool SerRelayBoard::shutdown |
( |
|
) |
|
| void SerRelayBoard::txCharArray |
( |
|
) |
[protected] |
Member Data Documentation
The documentation for this class was generated from the following files:
