TwiceAsNice  2019-02-18
Namespaces | Enumerations | Variables
CommandIDs.h File Reference

This file includes the command IDs of MPIA in-house electronic that are supported by all MPIA electronic devices. More...

This graph shows which files directly or indirectly include this file:

Namespaces

 Basda
 These are contants that are used by the services internally.
 
 Basda::MessageMode
 MPIA electronic response code.
 
 Basda::Error
 
 Basda::Cmd
 
 Basda::ValueSwitch
 Basic value parameter.
 
 Basda::ValueSerialRate
 This are the parameter definitions of the command MPIA_SET_SERIEL_RATE.
 
 Basda::ValueCanRate
 This are the parameter definitions of the command MPIA_SET_CAN_RATE.
 
 Basda::SelectMessageMode
 This are the parameter definitions of the command MPIA_SET_MESSAGE_FLAG.
 

Enumerations

enum  Basda::MessageMode::Constant {
  Basda::MessageMode::COMMAND_OK_MSG = 1, Basda::MessageMode::DATA_MSG = 2, Basda::MessageMode::EVENT_MSG = 3, Basda::MessageMode::INFO_MSG = 4,
  Basda::MessageMode::COMMAND_OK_MSG = 1, Basda::MessageMode::DATA_MSG = 2, Basda::MessageMode::EVENT_MSG = 3, Basda::MessageMode::INFO_MSG = 4
}
 
enum  Basda::ValueSwitch::Constant { Basda::ValueSwitch::MPIA_VALUE_DISABLE = 0, Basda::ValueSwitch::MPIA_VALUE_ENABLE = 1, Basda::ValueSwitch::MPIA_VALUE_DISABLE = 0, Basda::ValueSwitch::MPIA_VALUE_ENABLE = 1 }
 
enum  Basda::ValueSerialRate::Constant {
  Basda::ValueSerialRate::MPIA_VALUE_SERIAL_RATE_9600 = 0, Basda::ValueSerialRate::MPIA_VALUE_SERIAL_RATE_19200 = 1, Basda::ValueSerialRate::MPIA_VALUE_SERIAL_RATE_38400 = 2, Basda::ValueSerialRate::MPIA_VALUE_SERIAL_RATE_57600 = 3,
  Basda::ValueSerialRate::MPIA_VALUE_SERIAL_RATE_115200 = 4, Basda::ValueSerialRate::MPIA_VALUE_SERIAL_RATE_9600 = 0, Basda::ValueSerialRate::MPIA_VALUE_SERIAL_RATE_19200 = 1, Basda::ValueSerialRate::MPIA_VALUE_SERIAL_RATE_38400 = 2,
  Basda::ValueSerialRate::MPIA_VALUE_SERIAL_RATE_57600 = 3, Basda::ValueSerialRate::MPIA_VALUE_SERIAL_RATE_115200 = 4
}
 
enum  Basda::ValueCanRate::Constant {
  Basda::ValueCanRate::MPIA_VALUE_CAN_RATE_125K = 0, Basda::ValueCanRate::MPIA_VALUE_CAN_RATE_250K = 1, Basda::ValueCanRate::MPIA_VALUE_CAN_RATE_500K = 2, Basda::ValueCanRate::MPIA_VALUE_CAN_RATE_800K = 3,
  Basda::ValueCanRate::MPIA_VALUE_CAN_RATE_1000K = 4, Basda::ValueCanRate::MPIA_VALUE_CAN_RATE_125K = 0, Basda::ValueCanRate::MPIA_VALUE_CAN_RATE_250K = 1, Basda::ValueCanRate::MPIA_VALUE_CAN_RATE_500K = 2,
  Basda::ValueCanRate::MPIA_VALUE_CAN_RATE_800K = 3, Basda::ValueCanRate::MPIA_VALUE_CAN_RATE_1000K = 4
}
 
enum  Basda::SelectMessageMode::Constant { Basda::SelectMessageMode::MPIA_SELECT_NOT_EXIST = 0, Basda::SelectMessageMode::MPIA_SELECT_NOT_EXIST = 0 }
 

Variables

const int Basda::MOCON = 0x001
 Motor controller type ID. More...
 
const int Basda::UNIMOD = 0x011
 UNIMOD type ID. More...
 
const int Basda::ROCON = 0x021
 ROCON type ID. More...
 
const int Basda::MCCLBLEV = 0x031
 MCCLBLEV type ID. More...
 
const int Basda::COCON = 0x041
 CoCon type ID. More...
 
const int Basda::CARD_TYPE_MASK = 0x3F0
 Mask to get the card type. More...
 
const int Basda::Error::ERR_MSG_CARD_NR = -1
 Error number. More...
 
const int Basda::Error::ERR_MSG_COMMAND = -2
 Error number. More...
 
const int Basda::Error::ERR_MSG_MODULE_NR = -3
 Error number. More...
 
const int Basda::Error::ERR_MSG_PARAMETER = -4
 Error number. More...
 
const int Basda::Error::ERR_MSG_DOUBLE_ID = -5
 Error number. More...
 
const int Basda::Error::ERR_MSG_CMD_B_OVERRUN = -6
 Error number. More...
 
const int Basda::Error::ERR_MSG_CAN_B_OVERRUN = -7
 Error number. More...
 
const int Basda::Error::ERR_MSG_SER_B_OVERRUN = -8
 Error number. More...
 
const int Basda::Error::ERR_MSG_RAM_FULL = -9
 Error number. More...
 
const int Basda::Error::ERR_MSG_FUNCTION_ERR = -10
 Error number. More...
 
const int Basda::Error::ERR_MSG_ETH_B_OVERRUN = -12
 Error number. More...
 
const int Basda::Error::ERR_MSG_MAX_NR_CLIENTS = -13
 Error number. More...
 
const int Basda::Error::ERR_MSG_TEL_PASSWORD = -14
 Error number. More...
 
const int Basda::Error::ERR_MSG_LOGIN_NEEDED = -15
 Error number. More...
 
const int Basda::Error::ERR_MSG_USER_DISABLE = -16
 Error number. More...
 
const int Basda::Error::ERR_MSG_PORT_IN_USE = -17
 Error number. More...
 
const int Basda::Error::ERR_MSG_MODULE_IN_USE = -18
 Error number. More...
 
const int Basda::Error::ERR_MSG_NO_MODULE_RES = -19
 Error number. More...
 
const int Basda::Error::ERR_MSG_HUGEDATA_IN_USE = -20
 Error number. More...
 
const int Basda::Error::ERR_MSG_HD_NOT_SUPPORT = -21
 Error number. More...
 
const int Basda::Error::ERR_MSG_FRAG_SIZE_SMALL = -22
 Error number. More...
 
const int Basda::Error::ERR_MSG_FATAL_ERROR = -30
 Error number. More...
 
const int Basda::Cmd::MPIA_VERSION = 1
 Basic command. More...
 
const int Basda::Cmd::MPIA_HELLO_WORLD = 6
 Basic command. More...
 
const int Basda::Cmd::MPIA_GET_REGISTRATION = 7
 Basic command. More...
 
const int Basda::Cmd::MPIA_SW_RESET = 8
 Basic command. More...
 
const int Basda::Cmd::MPIA_GET_ERROR_CODE = 9
 Basic command. More...
 
const int Basda::Cmd::MPIA_RST_ERROR = 10
 Basic command. More...
 
const int Basda::Cmd::MPIA_XON_XOFF = 11
 Basic command. More...
 
const int Basda::Cmd::MPIA_GET_XON_XOFF = 12
 Basic command. More...
 
const int Basda::Cmd::MPIA_SET_SERIEL_RATE = 13
 Basic command. More...
 
const int Basda::Cmd::MPIA_GET_SERIEL_RATE = 14
 Basic command. More...
 
const int Basda::Cmd::MPIA_SET_CAN_RATE = 15
 Basic command. More...
 
const int Basda::Cmd::MPIA_GET_CAN_RATE = 16
 Basic command. More...
 
const int Basda::Cmd::MPIA_SET_EVENT_FLAG = 17
 Basic command. More...
 
const int Basda::Cmd::MPIA_GET_EVENT_FLAG = 18
 Basic command. More...
 
const int Basda::Cmd::MPIA_SET_INFO_FLAG = 19
 Basic command. More...
 
const int Basda::Cmd::MPIA_GET_INFO_FLAG = 20
 Basic command. More...
 
const int Basda::Cmd::MPIA_TELNET_LOGIN = 21
 Basic command. More...
 
const int Basda::Cmd::MPIA_TELNET_PWD = 22
 Basic command. More...
 
const int Basda::Cmd::MPIA_RESERVE_MOD = 23
 Basic command. More...
 
const int Basda::Cmd::MPIA_FREE_MOD = 24
 Basic command. More...
 
const int Basda::Cmd::MPIA_PLOT_RES_MOD = 25
 Basic command. More...
 
const int Basda::Cmd::MPIA_HUGE_DATA_RES = 26
 Basic command. More...
 
const int Basda::Cmd::MPIA_HUGE_DATA_FREE = 27
 Basic command. More...
 
const int Basda::Cmd::MPIA_EXIT_TELNET = 29
 Basic command. More...
 
const int Basda::Cmd::MPIA_SET_IP_ADDRESS = 30
 Basic command. More...
 
const int Basda::Cmd::MPIA_GET_IP_ADDRESS = 31
 Basic command. More...
 
const int Basda::Cmd::MPIA_SET_GATE_ADDRESS = 32
 Basic command. More...
 
const int Basda::Cmd::MPIA_GET_GATE_ADDRESS = 33
 Basic command. More...
 
const int Basda::Cmd::MPIA_SET_MASK_ADDRESS = 34
 Basic command. More...
 
const int Basda::Cmd::MPIA_GET_MASK_ADDRESS = 35
 Basic command. More...
 
const int Basda::Cmd::MPIA_SET_LINK_TIMEOUT = 36
 Basic command. More...
 
const int Basda::Cmd::MPIA_GET_LINK_TIMEOUT = 37
 Basic command. More...
 

Detailed Description

This file includes the command IDs of MPIA in-house electronic that are supported by all MPIA electronic devices.

The MPIA electronic provides a serial communication via the serial interface (RS232) and via the Ethernet. The communication protocol is according to ASCII. The commands consist of a sequence of numbers. The command syntax is as followed:

< cardNo > < commandID > < moduleNo > [ < select > ] [ < values > ]

where < cardNo > and < moduleNo > are the IDs of the card and the module. Usually the card ID is 1, but the MPIA electronic support also to cascade several cards. The communication to these serials connected cards is done over the first card, which will be the master cards. All other cards are numbered consecutively. The master card addresses the incoming command to the corresponding card based on the <cardNo>.The module number specify which module should be used on the card. Depending on the MPIA electronic card one or more modules are driven by the card. To address a command to the card itself, the module number has to be zero (0).

The < commandID > is the command number. This file defines for each MPIA core command an alias name. (Core commands are commands that are supported by all MPIA electronic devices. The specific card and module commands needs to be defined in the CommandIDs.h file of the specific implementation of the card and module.)

Some commands provide a < select > options to specify which option is defined via the < values >. The < values > can be on or more parameter separated by a space.

Note
This file is not the same file like MPIA_Interface.h from Lars Mohr.
The command numbers are defined by Lars Mohr, the select, value, type and mode numbers are defined by Frank Kittmann.
Author
Frank Kittmann
Version
08.04.21
Date
2008.04.21