Cleanup répertoire

This commit is contained in:
2023-01-06 12:47:02 -05:00
parent f1da647f35
commit 9024b8283c
113 changed files with 0 additions and 0 deletions
@@ -0,0 +1,761 @@
#include "02_GetSetParameter.h"
GetSetParameter::GetSetParameter()
{
ShowConfigurationHelp(); // Shows information about this sample
ShowCurrentConfiguration(); // Shows the current parameters configuration
TPCANStatus stsResult;
// Initialization of the selected channel
if (IsFD)
stsResult = CAN_InitializeFD(PcanHandle, BitrateFD);
else
stsResult = CAN_Initialize(PcanHandle, Bitrate);
if (stsResult != PCAN_ERROR_OK)
{
std::cout << "Can not initialize. Please check the defines in the code.\n";
ShowStatus(stsResult);
std::cout << "\n";
std::cout << "Closing...\n";
system("PAUSE");
return;
}
std::cout << "Successfully initialized.\n";
std::cout << "Get/set parameter\n";
system("PAUSE");
std::cout << "\n";
RunSelectedCommands();
std::cout << "\n";
std::cout << "Closing...\n";
system("PAUSE");
}
GetSetParameter::~GetSetParameter()
{
CAN_Uninitialize(PCAN_NONEBUS);
}
void GetSetParameter::RunSelectedCommands()
{
// Fill commands here
std::cout << "Fill \"RunSelectedCommands\"-function with parameter functions from \"Parameter commands\"-Region in the code.\n";
}
void GetSetParameter::GetPCAN_DEVICE_ID()
{
UINT32 iDeviceID;
TPCANStatus stsResult = CAN_GetValue(PcanHandle, PCAN_DEVICE_ID, &iDeviceID, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Get PCAN_DEVICE_ID: " << iDeviceID << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::SetPCAN_DEVICE_ID(UINT32 iDeviceID)
{
TPCANStatus stsResult = CAN_SetValue(PcanHandle, PCAN_DEVICE_ID, &iDeviceID, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Set PCAN_DEVICE_ID: " << iDeviceID << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::GetPCAN_ATTACHED_CHANNELS()
{
UINT32 iChannelsCount;
TPCANStatus stsResult = CAN_GetValue(PCAN_NONEBUS, PCAN_ATTACHED_CHANNELS_COUNT, &iChannelsCount, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
TPCANChannelInformation* ciChannelInformation = new TPCANChannelInformation[iChannelsCount];
stsResult = CAN_GetValue(PCAN_NONEBUS, PCAN_ATTACHED_CHANNELS, ciChannelInformation, iChannelsCount * sizeof(TPCANChannelInformation));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Get PCAN_ATTACHED_CHANNELS:\n";
for (int i = 0; i < (int)iChannelsCount; i++)
{
std::cout << "---------------------------\n";
char buffer[MAX_PATH];
GetTPCANHandleName(ciChannelInformation[i].channel_handle, buffer);
if (IsFD)
std::cout << "channel_handle: " << buffer << "BUS" << (ciChannelInformation[i].channel_handle & 0xFF) << "\n";
else
std::cout << "channel_handle: " << buffer << "BUS" << (ciChannelInformation[i].channel_handle & 0xF) << "\n";
std::cout << "device_type: " << ConvertDeviceTypeToString(ciChannelInformation[i].device_type) << "\n";
std::cout << "controller_number: " << (int)ciChannelInformation[i].controller_number << "\n";
std::cout << "device_features: " << ConvertToChannelFeatures(ciChannelInformation[i].device_features) << "\n";
std::cout << "device_name: " << ciChannelInformation[i].device_name << "\n";
std::cout << "device_id: " << ciChannelInformation[i].device_id << "\n";
std::cout << "channel_condition: " << ConvertToChannelCondition(ciChannelInformation[i].channel_condition) << "\n";
}
std::cout << "\n";
}
delete [] ciChannelInformation;
}
if (stsResult != PCAN_ERROR_OK)
ShowStatus(stsResult);
}
void GetSetParameter::GetPCAN_CHANNEL_CONDITION()
{
UINT32 iChannelCondition;
TPCANStatus stsResult = CAN_GetValue(PcanHandle, PCAN_CHANNEL_CONDITION, &iChannelCondition, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Get PCAN_CHANNEL_CONDITION: " << ConvertToChannelCondition(iChannelCondition) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::GetPCAN_CHANNEL_IDENTIFYING()
{
UINT32 iChannelIdentifying;
TPCANStatus stsResult = CAN_GetValue(PcanHandle, PCAN_CHANNEL_IDENTIFYING, &iChannelIdentifying, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Get PCAN_CHANNEL_IDENTIFYING: " << ConvertToParameterOnOff(iChannelIdentifying) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::SetPCAN_CHANNEL_IDENTIFYING(bool value)
{
UINT32 ciChannelIdentifying;
if (value)
ciChannelIdentifying = PCAN_PARAMETER_ON;
else
ciChannelIdentifying = PCAN_PARAMETER_OFF;
TPCANStatus stsResult = CAN_SetValue(PcanHandle, PCAN_CHANNEL_IDENTIFYING, &ciChannelIdentifying, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Set PCAN_CHANNEL_IDENTIFYING: " << ConvertToParameterOnOff(ciChannelIdentifying) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::GetPCAN_CHANNEL_FEATURES()
{
UINT32 iChannelFeatures;
TPCANStatus stsResult = CAN_GetValue(PcanHandle, PCAN_CHANNEL_FEATURES, &iChannelFeatures, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Get PCAN_CHANNEL_FEATURES: " << ConvertToChannelFeatures(iChannelFeatures) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::GetPCAN_BITRATE_ADAPTING()
{
UINT32 iBitrateAdapting;
TPCANStatus stsResult = CAN_GetValue(PcanHandle, PCAN_BITRATE_ADAPTING, &iBitrateAdapting, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Get PCAN_BITRATE_ADAPTING: " << ConvertToParameterOnOff(iBitrateAdapting) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::SetPCAN_BITRATE_ADAPTING(bool value)
{
UINT32 iBitrateAdapting;
// Note: SetPCAN_BITRATE_ADAPTING requires an uninitialized channel,
//
CAN_Uninitialize(PCAN_NONEBUS);
if (value)
iBitrateAdapting = PCAN_PARAMETER_ON;
else
iBitrateAdapting = PCAN_PARAMETER_OFF;
TPCANStatus stsResult = CAN_SetValue(PcanHandle, PCAN_BITRATE_ADAPTING, &iBitrateAdapting, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Set PCAN_BITRATE_ADAPTING: " << ConvertToParameterOnOff(iBitrateAdapting) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
// Channel will be connected again
if (IsFD)
stsResult = CAN_InitializeFD(PcanHandle, BitrateFD);
else
stsResult = CAN_Initialize(PcanHandle, Bitrate);
if (stsResult != PCAN_ERROR_OK)
{
std::cout << "Error while re-initializing the channel.\n";
ShowStatus(stsResult);
}
}
void GetSetParameter::GetPCAN_ALLOW_STATUS_FRAMES()
{
UINT32 iAllowStatusFrames;
TPCANStatus stsResult = CAN_GetValue(PcanHandle, PCAN_ALLOW_STATUS_FRAMES, &iAllowStatusFrames, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Get PCAN_ALLOW_STATUS_FRAMES: " << ConvertToParameterOnOff(iAllowStatusFrames) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::SetPCAN_ALLOW_STATUS_FRAMES(bool value)
{
UINT32 iAllowStatusFrames;
if (value)
iAllowStatusFrames = PCAN_PARAMETER_ON;
else
iAllowStatusFrames = PCAN_PARAMETER_OFF;
TPCANStatus stsResult = CAN_SetValue(PcanHandle, PCAN_ALLOW_STATUS_FRAMES, &iAllowStatusFrames, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Set PCAN_ALLOW_STATUS_FRAMES: " << ConvertToParameterOnOff(iAllowStatusFrames) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::GetPCAN_ALLOW_RTR_FRAMES()
{
UINT32 iAllowRTRFrames;
TPCANStatus stsResult = CAN_GetValue(PcanHandle, PCAN_ALLOW_RTR_FRAMES, &iAllowRTRFrames, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Get PCAN_ALLOW_RTR_FRAMES: " << ConvertToParameterOnOff(iAllowRTRFrames) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::SetPCAN_ALLOW_RTR_FRAMES(bool value)
{
UINT32 iAllowRTRFrames;
if (value)
iAllowRTRFrames = PCAN_PARAMETER_ON;
else
iAllowRTRFrames = PCAN_PARAMETER_OFF;
TPCANStatus stsResult = CAN_SetValue(PcanHandle, PCAN_ALLOW_RTR_FRAMES, &iAllowRTRFrames, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Set PCAN_ALLOW_RTR_FRAMES: " << ConvertToParameterOnOff(iAllowRTRFrames) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::GetPCAN_ALLOW_ERROR_FRAMES()
{
UINT32 iAllowErrorFrames;
TPCANStatus stsResult = CAN_GetValue(PcanHandle, PCAN_ALLOW_ERROR_FRAMES, &iAllowErrorFrames, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Get PCAN_ALLOW_ERROR_FRAMES: " << ConvertToParameterOnOff(iAllowErrorFrames) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::SetPCAN_ALLOW_ERROR_FRAMES(bool value)
{
UINT32 iAllowErrorFrames;
if (value)
iAllowErrorFrames = PCAN_PARAMETER_ON;
else
iAllowErrorFrames = PCAN_PARAMETER_OFF;
TPCANStatus stsResult = CAN_SetValue(PcanHandle, PCAN_ALLOW_ERROR_FRAMES, &iAllowErrorFrames, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Set PCAN_ALLOW_ERROR_FRAMES: " << ConvertToParameterOnOff(iAllowErrorFrames) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::GetPCAN_ALLOW_ECHO_FRAMES()
{
UINT32 iAllowEchoFrames;
TPCANStatus stsResult = CAN_GetValue(PcanHandle, PCAN_ALLOW_ECHO_FRAMES, &iAllowEchoFrames, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Get PCAN_ALLOW_ECHO_FRAMES: " << ConvertToParameterOnOff(iAllowEchoFrames) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::SetPCAN_ALLOW_ECHO_FRAMES(bool value)
{
UINT32 iAllowEchoFrames;
if (value)
iAllowEchoFrames = PCAN_PARAMETER_ON;
else
iAllowEchoFrames = PCAN_PARAMETER_OFF;
TPCANStatus stsResult = CAN_SetValue(PcanHandle, PCAN_ALLOW_ECHO_FRAMES, &iAllowEchoFrames, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Set PCAN_ALLOW_ECHO_FRAMES: " << ConvertToParameterOnOff(iAllowEchoFrames) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::GetPCAN_ACCEPTANCE_FILTER_11BIT()
{
UINT64 iAcceptanceFilter11Bit;
TPCANStatus stsResult = CAN_GetValue(PcanHandle, PCAN_ACCEPTANCE_FILTER_11BIT, &iAcceptanceFilter11Bit, sizeof(UINT64));
if (stsResult == PCAN_ERROR_OK)
{
char result[MAX_PATH];
std::cout << "-----------------------------------------------------------------------------------------\n";
sprintf_s(result, sizeof(result), "%I64X", iAcceptanceFilter11Bit);
std::cout << "Get PCAN_ACCEPTANCE_FILTER_11BIT: " << std::setfill('0') << std::setw(16) << std::hex << result << "h\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::SetPCAN_ACCEPTANCE_FILTER_11BIT(UINT64 iacceptancefilter11bit)
{
TPCANStatus stsResult = CAN_SetValue(PcanHandle, PCAN_ACCEPTANCE_FILTER_11BIT, &iacceptancefilter11bit, sizeof(UINT64));
if (stsResult == PCAN_ERROR_OK)
{
char result[MAX_PATH];
std::cout << "-----------------------------------------------------------------------------------------\n";
sprintf_s(result, sizeof(result), "%I64X", iacceptancefilter11bit);
std::cout << "Set PCAN_ACCEPTANCE_FILTER_11BIT: " << std::setfill('0') << std::setw(16) << std::hex << result << "h\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::GetPCAN_ACCEPTANCE_FILTER_29BIT()
{
UINT64 iAcceptanceFilter29Bit;
TPCANStatus stsResult = CAN_GetValue(PcanHandle, PCAN_ACCEPTANCE_FILTER_29BIT, &iAcceptanceFilter29Bit, sizeof(UINT64));
if (stsResult == PCAN_ERROR_OK)
{
char result[MAX_PATH];
std::cout << "-----------------------------------------------------------------------------------------\n";
sprintf_s(result, sizeof(result), "%I64X", iAcceptanceFilter29Bit);
std::cout << "Get PCAN_ACCEPTANCE_FILTER_29BIT: " << std::setfill('0') << std::setw(16) << std::hex << result << "h\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::SetPCAN_ACCEPTANCE_FILTER_29BIT(UINT64 iacceptancefilter29bit)
{
TPCANStatus stsResult = CAN_SetValue(PcanHandle, PCAN_ACCEPTANCE_FILTER_29BIT, &iacceptancefilter29bit, sizeof(UINT64));
if (stsResult == PCAN_ERROR_OK)
{
char result[MAX_PATH];
std::cout << "-----------------------------------------------------------------------------------------\n";
sprintf_s(result, sizeof(result), "%I64X", iacceptancefilter29bit);
std::cout << "Set PCAN_ACCEPTANCE_FILTER_29BIT: " << std::setfill('0') << std::setw(16) << std::hex << result << "h\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::GetPCAN_MESSAGE_FILTER()
{
UINT32 iMessageFilter;
TPCANStatus stsResult = CAN_GetValue(PcanHandle, PCAN_MESSAGE_FILTER, &iMessageFilter, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Get PCAN_MESSAGE_FILTER: " << ConvertToFilterOpenCloseCustom(iMessageFilter) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::SetPCAN_MESSAGE_FILTER(UINT32 imessagefilter)
{
TPCANStatus stsResult = CAN_SetValue(PcanHandle, PCAN_MESSAGE_FILTER, &imessagefilter, sizeof(UINT32));
if (stsResult == PCAN_ERROR_OK)
{
std::cout << "-----------------------------------------------------------------------------------------\n";
std::cout << "Set PCAN_MESSAGE_FILTER: " << ConvertToFilterOpenCloseCustom(imessagefilter) << "\n";
std::cout << "\n";
}
else
ShowStatus(stsResult);
}
void GetSetParameter::ShowConfigurationHelp()
{
std::cout << "=========================================================================================\n";
std::cout << "| PCAN-Basic GetSetParameter Example |\n";
std::cout << "=========================================================================================\n";
std::cout << "Following parameters are to be adjusted before launching, according to the hardware used |\n";
std::cout << " |\n";
std::cout << "* PcanHandle: Numeric value that represents the handle of the PCAN-Basic channel to use. |\n";
std::cout << " See 'PCAN-Handle Definitions' within the documentation |\n";
std::cout << "* IsFD: Boolean value that indicates the communication mode, CAN (false) or CAN-FD (true)|\n";
std::cout << "* Bitrate: Numeric value that represents the BTR0/BR1 bitrate value to be used for CAN |\n";
std::cout << " communication |\n";
std::cout << "* BitrateFD: String value that represents the nominal/data bitrate value to be used for |\n";
std::cout << " CAN-FD communication |\n";
std::cout << "=========================================================================================\n";
std::cout << "\n";
}
void GetSetParameter::ShowCurrentConfiguration()
{
std::cout << "Parameter values used\n";
std::cout << "----------------------\n";
char buffer[MAX_PATH];
FormatChannelName(PcanHandle, buffer, IsFD);
std::cout << "* PCANHandle: " << buffer << "\n";
if (IsFD)
std::cout << "* IsFD: True\n";
else
std::cout << "* IsFD: False\n";
ConvertBitrateToString(Bitrate, buffer);
std::cout << "* Bitrate: " << buffer << "\n";
std::cout << "* BitrateFD: " << BitrateFD << "\n";
std::cout << "\n";
}
void GetSetParameter::ShowStatus(TPCANStatus status)
{
std::cout << "=========================================================================================\n";
char buffer[MAX_PATH];
GetFormattedError(status, buffer);
std::cout << buffer << "\n";
std::cout << "=========================================================================================\n";
}
void GetSetParameter::FormatChannelName(TPCANHandle handle, LPSTR buffer, bool isFD)
{
TPCANDevice devDevice;
BYTE byChannel;
// Gets the owner device and channel for a PCAN-Basic handle
if (handle < 0x100)
{
devDevice = (TPCANDevice)(handle >> 4);
byChannel = (BYTE)(handle & 0xF);
}
else
{
devDevice = (TPCANDevice)(handle >> 8);
byChannel = (BYTE)(handle & 0xFF);
}
// Constructs the PCAN-Basic Channel name and return it
char handleBuffer[MAX_PATH];
GetTPCANHandleName(handle, handleBuffer);
if (isFD)
sprintf_s(buffer, MAX_PATH, "%s:FD %d (%Xh)", handleBuffer, byChannel, handle);
else
sprintf_s(buffer, MAX_PATH, "%s %d (%Xh)", handleBuffer, byChannel, handle);
}
void GetSetParameter::GetTPCANHandleName(TPCANHandle handle, LPSTR buffer)
{
strcpy_s(buffer, MAX_PATH, "PCAN_NONE");
switch (handle)
{
case PCAN_PCIBUS1:
case PCAN_PCIBUS2:
case PCAN_PCIBUS3:
case PCAN_PCIBUS4:
case PCAN_PCIBUS5:
case PCAN_PCIBUS6:
case PCAN_PCIBUS7:
case PCAN_PCIBUS8:
case PCAN_PCIBUS9:
case PCAN_PCIBUS10:
case PCAN_PCIBUS11:
case PCAN_PCIBUS12:
case PCAN_PCIBUS13:
case PCAN_PCIBUS14:
case PCAN_PCIBUS15:
case PCAN_PCIBUS16:
strcpy_s(buffer, MAX_PATH, "PCAN_PCI");
break;
case PCAN_USBBUS1:
case PCAN_USBBUS2:
case PCAN_USBBUS3:
case PCAN_USBBUS4:
case PCAN_USBBUS5:
case PCAN_USBBUS6:
case PCAN_USBBUS7:
case PCAN_USBBUS8:
case PCAN_USBBUS9:
case PCAN_USBBUS10:
case PCAN_USBBUS11:
case PCAN_USBBUS12:
case PCAN_USBBUS13:
case PCAN_USBBUS14:
case PCAN_USBBUS15:
case PCAN_USBBUS16:
strcpy_s(buffer, MAX_PATH, "PCAN_USB");
break;
case PCAN_LANBUS1:
case PCAN_LANBUS2:
case PCAN_LANBUS3:
case PCAN_LANBUS4:
case PCAN_LANBUS5:
case PCAN_LANBUS6:
case PCAN_LANBUS7:
case PCAN_LANBUS8:
case PCAN_LANBUS9:
case PCAN_LANBUS10:
case PCAN_LANBUS11:
case PCAN_LANBUS12:
case PCAN_LANBUS13:
case PCAN_LANBUS14:
case PCAN_LANBUS15:
case PCAN_LANBUS16:
strcpy_s(buffer, MAX_PATH, "PCAN_LAN");
break;
default:
strcpy_s(buffer, MAX_PATH, "UNKNOWN");
break;
}
}
void GetSetParameter::GetFormattedError(TPCANStatus error, LPSTR buffer)
{
// Gets the text using the GetErrorText API function. If the function success, the translated error is returned.
// If it fails, a text describing the current error is returned.
if (CAN_GetErrorText(error, 0x09, buffer) != PCAN_ERROR_OK)
sprintf_s(buffer, MAX_PATH, "An error occurred. Error-code's text (%Xh) couldn't be retrieved", error);
}
void GetSetParameter::ConvertBitrateToString(TPCANBaudrate bitrate, LPSTR buffer)
{
switch (bitrate)
{
case PCAN_BAUD_1M:
strcpy_s(buffer, MAX_PATH, "1 MBit/sec");
break;
case PCAN_BAUD_800K:
strcpy_s(buffer, MAX_PATH, "800 kBit/sec");
break;
case PCAN_BAUD_500K:
strcpy_s(buffer, MAX_PATH, "500 kBit/sec");
break;
case PCAN_BAUD_250K:
strcpy_s(buffer, MAX_PATH, "250 kBit/sec");
break;
case PCAN_BAUD_125K:
strcpy_s(buffer, MAX_PATH, "125 kBit/sec");
break;
case PCAN_BAUD_100K:
strcpy_s(buffer, MAX_PATH, "100 kBit/sec");
break;
case PCAN_BAUD_95K:
strcpy_s(buffer, MAX_PATH, "95,238 kBit/sec");
break;
case PCAN_BAUD_83K:
strcpy_s(buffer, MAX_PATH, "83,333 kBit/sec");
break;
case PCAN_BAUD_50K:
strcpy_s(buffer, MAX_PATH, "50 kBit/sec");
break;
case PCAN_BAUD_47K:
strcpy_s(buffer, MAX_PATH, "47,619 kBit/sec");
break;
case PCAN_BAUD_33K:
strcpy_s(buffer, MAX_PATH, "33,333 kBit/sec");
break;
case PCAN_BAUD_20K:
strcpy_s(buffer, MAX_PATH, "20 kBit/sec");
break;
case PCAN_BAUD_10K:
strcpy_s(buffer, MAX_PATH, "10 kBit/sec");
break;
case PCAN_BAUD_5K:
strcpy_s(buffer, MAX_PATH, "5 kBit/sec");
break;
default:
strcpy_s(buffer, MAX_PATH, "Unknown Bitrate");
break;
}
}
std::string GetSetParameter::ConvertDeviceTypeToString(BYTE devicetype)
{
switch (devicetype)
{
case 0:
return "PCAN_NONE";
case 1:
return "PCAN_PEAKCAN";
case 2:
return "PCAN_ISA";
case 3:
return "PCAN_DNG";
case 4:
return "PCAN_PCI";
case 5:
return "PCAN_USB";
case 6:
return "PCAN_PCC";
case 7:
return "PCAN_VIRTUAL";
case 8:
return "PCAN_LAN";
default:
return "";
}
}
std::string GetSetParameter::ConvertToParameterOnOff(UINT32 value)
{
switch (value)
{
case PCAN_PARAMETER_OFF:
return "PCAN_PARAMETER_OFF";
case PCAN_PARAMETER_ON:
return "PCAN_PARAMETER_ON";
default:
return "Status unknown: " + std::to_string(value);
}
}
std::string GetSetParameter::ConvertToChannelFeatures(UINT32 value)
{
std::string sFeatures = "";
if ((value & FEATURE_FD_CAPABLE) == FEATURE_FD_CAPABLE)
sFeatures += "FEATURE_FD_CAPABLE";
if ((value & FEATURE_DELAY_CAPABLE) == FEATURE_DELAY_CAPABLE)
if (sFeatures != "")
sFeatures += ", FEATURE_DELAY_CAPABLE";
else
sFeatures += "FEATURE_DELAY_CAPABLE";
if ((value & FEATURE_IO_CAPABLE) == FEATURE_IO_CAPABLE)
if (sFeatures != "")
sFeatures += ", FEATURE_IO_CAPABLE";
else
sFeatures += "FEATURE_IO_CAPABLE";
return sFeatures;
}
std::string GetSetParameter::ConvertToChannelCondition(UINT32 value)
{
switch (value)
{
case PCAN_CHANNEL_UNAVAILABLE:
return "PCAN_CHANNEL_UNAVAILABLE";
case PCAN_CHANNEL_AVAILABLE:
return "PCAN_CHANNEL_AVAILABLE";
case PCAN_CHANNEL_OCCUPIED:
return "PCAN_CHANNEL_OCCUPIED";
case PCAN_CHANNEL_PCANVIEW:
return "PCAN_CHANNEL_PCANVIEW";
default:
return "Status unknow: " + std::to_string(value);
}
}
std::string GetSetParameter::ConvertToFilterOpenCloseCustom(UINT32 value)
{
switch (value)
{
case PCAN_FILTER_CLOSE:
return "PCAN_FILTER_CLOSE";
case PCAN_FILTER_OPEN:
return "PCAN_FILTER_OPEN";
case PCAN_FILTER_CUSTOM:
return "PCAN_FILTER_CUSTOM";
default:
return "Status unknown: " + std::to_string(value);
}
}
@@ -0,0 +1,245 @@
#include "stdafx.h"
#include "PCANBasic.h"
class GetSetParameter
{
private:
/// <summary>
/// Sets the PCANHandle (Hardware Channel)
/// </summary>
const TPCANHandle PcanHandle = PCAN_USBBUS1;
/// <summary>
/// Sets the desired connection mode (CAN = false / CAN-FD = true)
/// </summary>
const bool IsFD = false;
/// <summary>
/// Sets the bitrate for normal CAN devices
/// </summary>
const TPCANBaudrate Bitrate = PCAN_BAUD_500K;
/// <summary>
/// Sets the bitrate for CAN FD devices.
/// Example - Bitrate Nom: 1Mbit/s Data: 2Mbit/s:
/// "f_clock_mhz=20, nom_brp=5, nom_tseg1=2, nom_tseg2=1, nom_sjw=1, data_brp=2, data_tseg1=3, data_tseg2=1, data_sjw=1"
/// </summary>
const TPCANBitrateFD BitrateFD = const_cast<LPSTR>("f_clock_mhz=20, nom_brp=5, nom_tseg1=2, nom_tseg2=1, nom_sjw=1, data_brp=2, data_tseg1=3, data_tseg2=1, data_sjw=1");
public:
// GetSetParameter constructor
//
GetSetParameter();
// GetSetParameter destructor
//
~GetSetParameter();
private:
/// <summary>
/// Runs all commands for get or set parameters
/// </summary>
void RunSelectedCommands();
/// <summary>
/// Shows device identifier parameter
/// </summary>
void GetPCAN_DEVICE_ID();
/// <summary>
/// Sets device identifier parameter
/// </summary>
/// <param name="iDeviceID"></param>
void SetPCAN_DEVICE_ID(UINT32 iDeviceID);
/// <summary>
/// Shows all information about attached channels
/// </summary>
void GetPCAN_ATTACHED_CHANNELS();
/// <summary>
/// Shows the status of selected PCAN-Channel
/// </summary>
void GetPCAN_CHANNEL_CONDITION();
/// <summary>
/// Shows the status from the status LED of the USB devices
/// </summary>
void GetPCAN_CHANNEL_IDENTIFYING();
/// <summary>
/// De/Activates the status LED of the USB devices
/// </summary>
/// <param name="value">True to turn on; False to turn off</param>
void SetPCAN_CHANNEL_IDENTIFYING(bool value);
/// <summary>
/// Shows information about features
/// </summary>
void GetPCAN_CHANNEL_FEATURES();
/// <summary>
/// Shows the status from Bitrate-Adapting mode
/// </summary>
void GetPCAN_BITRATE_ADAPTING();
/// <summary>
/// De/Activates the Bitrate-Adapting mode
/// </summary>
/// <param name="value">True to turn on; False to turn off</param>
void SetPCAN_BITRATE_ADAPTING(bool value);
/// <summary>
/// Shows the status from the reception of status frames
/// </summary>
void GetPCAN_ALLOW_STATUS_FRAMES();
/// <summary>
/// De/Activates the reception of status frames
/// </summary>
/// <param name="value">True to turn on; False to turn off</param>
void SetPCAN_ALLOW_STATUS_FRAMES(bool value);
/// <summary>
/// Shows the status from the reception of RTR frames
/// </summary>
void GetPCAN_ALLOW_RTR_FRAMES();
/// <summary>
/// De/Activates the reception of RTR frames
/// </summary>
/// <param name="value">True to turn on; False to turn off</param>
void SetPCAN_ALLOW_RTR_FRAMES(bool value);
/// <summary>
/// Shows the status from the reception of CAN error frames
/// </summary>
void GetPCAN_ALLOW_ERROR_FRAMES();
/// <summary>
/// De/Activates the reception of CAN error frames
/// </summary>
/// <param name="value">True to turn on; False to turn off</param>
void SetPCAN_ALLOW_ERROR_FRAMES(bool value);
/// <summary>
/// Shows the status from the reception of Echo frames
/// </summary>
void GetPCAN_ALLOW_ECHO_FRAMES();
/// <summary>
/// De/Activates the reception of Echo frames
/// </summary>
/// <param name="value">True to turn on; False to turn off</param>
void SetPCAN_ALLOW_ECHO_FRAMES(bool value);
/// <summary>
/// Shows the reception filter with a specific 11-bit acceptance code and mask
/// </summary>
void GetPCAN_ACCEPTANCE_FILTER_11BIT();
/// <summary>
/// Sets the reception filter with a specific 11-bit acceptance code and mask
/// </summary>
/// <param name="iacceptancefilter11bit">Acceptance code and mask</param>
void SetPCAN_ACCEPTANCE_FILTER_11BIT(UINT64 iacceptancefilter11bit);
/// <summary>
/// Shows the reception filter with a specific 29-bit acceptance code and mask
/// </summary>
void GetPCAN_ACCEPTANCE_FILTER_29BIT();
/// <summary>
/// Sets the reception filter with a specific 29-bit acceptance code and mask
/// </summary>
/// <param name="iacceptancefilter29bit">Acceptance code and mask</param>
void SetPCAN_ACCEPTANCE_FILTER_29BIT(UINT64 iacceptancefilter29bit);
/// <summary>
/// Shows the status of the reception filter
/// </summary>
void GetPCAN_MESSAGE_FILTER();
/// <summary>
/// De/Activates the reception filter
/// </summary>
/// <param name="imessagefilter">Configure reception filter</param>
void SetPCAN_MESSAGE_FILTER(UINT32 imessagefilter);
/// <summary>
/// Shows/prints the configurable parameters for this sample and information about them
/// </summary>
void ShowConfigurationHelp();
/// <summary>
/// Shows/prints the configured paramters
/// </summary>
void ShowCurrentConfiguration();
/// <summary>
/// Shows formatted status
/// </summary>
/// <param name="status">Will be formatted</param>
void ShowStatus(TPCANStatus status);
/// <summary>
/// Gets the formatted text for a PCAN-Basic channel handle
/// </summary>
/// <param name="handle">PCAN-Basic Handle to format</param>
/// <parma name="buffer">A string buffer for the channel name</param>
/// <param name="isFD">If the channel is FD capable</param>
void FormatChannelName(TPCANHandle handle, LPSTR buffer, bool isFD);
/// <summary>
/// Gets name of a TPCANHandle
/// </summary>
/// <param name="handle">TPCANHandle to get name</param>
/// <param name="buffer">A string buffer for the name of the TPCANHandle (size MAX_PATH)</param>
void GetTPCANHandleName(TPCANHandle handle, LPSTR buffer);
/// <summary>
/// Help Function used to get an error as text
/// </summary>
/// <param name="error">Error code to be translated</param>
/// <param name="buffer">A string buffer for the translated error (size MAX_PATH)</param>
void GetFormattedError(TPCANStatus error, LPSTR buffer);
/// <summary>
/// Convert bitrate c_short value to readable string
/// </summary>
/// <param name="bitrate">Bitrate to be converted</param>
/// <param name="buffer">A string buffer for the converted bitrate (size MAX_PATH)</param>
void ConvertBitrateToString(TPCANBaudrate bitrate, LPSTR buffer);
/// <summary>
/// Convert BYTE value to readable string value
/// </summary>
/// <param name="devicetype"></param>
/// <returns></returns>
std::string ConvertDeviceTypeToString(BYTE devicetype);
/// <summary>
/// Convert uint value to readable string value
/// </summary>
/// <param name="value"></param>
/// <returns></returns>
std::string ConvertToParameterOnOff(UINT32 value);
/// <summary>
/// Convert uint value to readable string value
/// </summary>
/// <param name="value"></param>
/// <returns></returns>
std::string ConvertToChannelFeatures(UINT32 value);
/// <summary>
/// Convert uint value to readable string value
/// </summary>
/// <param name="value"></param>
/// <returns></returns>
std::string ConvertToChannelCondition(UINT32 value);
/// <summary>
/// Convert uint value to readable string value
/// </summary>
/// <param name="value"></param>
/// <returns></returns>
std::string ConvertToFilterOpenCloseCustom(UINT32 value);
};
@@ -0,0 +1,31 @@
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 16
VisualStudioVersion = 16.0.31205.134
MinimumVisualStudioVersion = 10.0.40219.1
Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "GetSetParameter", "02_GetSetParameter.vcxproj", "{4333360A-2706-409C-8FE5-018B189219F6}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|x64 = Debug|x64
Debug|x86 = Debug|x86
Release|x64 = Release|x64
Release|x86 = Release|x86
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{4333360A-2706-409C-8FE5-018B189219F6}.Debug|x64.ActiveCfg = Debug|x64
{4333360A-2706-409C-8FE5-018B189219F6}.Debug|x64.Build.0 = Debug|x64
{4333360A-2706-409C-8FE5-018B189219F6}.Debug|x86.ActiveCfg = Debug|Win32
{4333360A-2706-409C-8FE5-018B189219F6}.Debug|x86.Build.0 = Debug|Win32
{4333360A-2706-409C-8FE5-018B189219F6}.Release|x64.ActiveCfg = Release|x64
{4333360A-2706-409C-8FE5-018B189219F6}.Release|x64.Build.0 = Release|x64
{4333360A-2706-409C-8FE5-018B189219F6}.Release|x86.ActiveCfg = Release|Win32
{4333360A-2706-409C-8FE5-018B189219F6}.Release|x86.Build.0 = Release|Win32
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {DF41B51B-1929-46AD-9287-082CFBC458CE}
EndGlobalSection
EndGlobal
@@ -0,0 +1,159 @@
<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<ItemGroup Label="ProjectConfigurations">
<ProjectConfiguration Include="Debug|Win32">
<Configuration>Debug</Configuration>
<Platform>Win32</Platform>
</ProjectConfiguration>
<ProjectConfiguration Include="Release|Win32">
<Configuration>Release</Configuration>
<Platform>Win32</Platform>
</ProjectConfiguration>
<ProjectConfiguration Include="Debug|x64">
<Configuration>Debug</Configuration>
<Platform>x64</Platform>
</ProjectConfiguration>
<ProjectConfiguration Include="Release|x64">
<Configuration>Release</Configuration>
<Platform>x64</Platform>
</ProjectConfiguration>
</ItemGroup>
<PropertyGroup Label="Globals">
<VCProjectVersion>16.0</VCProjectVersion>
<Keyword>Win32Proj</Keyword>
<ProjectGuid>{4333360a-2706-409c-8fe5-018b189219f6}</ProjectGuid>
<RootNamespace>GetSetParameter</RootNamespace>
<WindowsTargetPlatformVersion>10.0</WindowsTargetPlatformVersion>
</PropertyGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
<ConfigurationType>Application</ConfigurationType>
<UseDebugLibraries>true</UseDebugLibraries>
<PlatformToolset>v142</PlatformToolset>
<CharacterSet>Unicode</CharacterSet>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
<ConfigurationType>Application</ConfigurationType>
<UseDebugLibraries>false</UseDebugLibraries>
<PlatformToolset>v142</PlatformToolset>
<WholeProgramOptimization>true</WholeProgramOptimization>
<CharacterSet>Unicode</CharacterSet>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
<ConfigurationType>Application</ConfigurationType>
<UseDebugLibraries>true</UseDebugLibraries>
<PlatformToolset>v142</PlatformToolset>
<CharacterSet>Unicode</CharacterSet>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
<ConfigurationType>Application</ConfigurationType>
<UseDebugLibraries>false</UseDebugLibraries>
<PlatformToolset>v142</PlatformToolset>
<WholeProgramOptimization>true</WholeProgramOptimization>
<CharacterSet>Unicode</CharacterSet>
</PropertyGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
<ImportGroup Label="ExtensionSettings">
</ImportGroup>
<ImportGroup Label="Shared">
</ImportGroup>
<ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
</ImportGroup>
<ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
</ImportGroup>
<ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
</ImportGroup>
<ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
</ImportGroup>
<PropertyGroup Label="UserMacros" />
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
<LinkIncremental>true</LinkIncremental>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
<LinkIncremental>false</LinkIncremental>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
<LinkIncremental>true</LinkIncremental>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
<LinkIncremental>false</LinkIncremental>
</PropertyGroup>
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
<ClCompile>
<WarningLevel>Level3</WarningLevel>
<SDLCheck>true</SDLCheck>
<PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
</ClCompile>
<Link>
<SubSystem>Console</SubSystem>
<GenerateDebugInformation>true</GenerateDebugInformation>
</Link>
</ItemDefinitionGroup>
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
<ClCompile>
<WarningLevel>Level3</WarningLevel>
<FunctionLevelLinking>true</FunctionLevelLinking>
<IntrinsicFunctions>true</IntrinsicFunctions>
<SDLCheck>true</SDLCheck>
<PreprocessorDefinitions>WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
</ClCompile>
<Link>
<SubSystem>Console</SubSystem>
<EnableCOMDATFolding>true</EnableCOMDATFolding>
<OptimizeReferences>true</OptimizeReferences>
<GenerateDebugInformation>true</GenerateDebugInformation>
</Link>
</ItemDefinitionGroup>
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
<ClCompile>
<WarningLevel>Level3</WarningLevel>
<SDLCheck>true</SDLCheck>
<PreprocessorDefinitions>_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
</ClCompile>
<Link>
<SubSystem>Console</SubSystem>
<GenerateDebugInformation>true</GenerateDebugInformation>
</Link>
</ItemDefinitionGroup>
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
<ClCompile>
<WarningLevel>Level3</WarningLevel>
<FunctionLevelLinking>true</FunctionLevelLinking>
<IntrinsicFunctions>true</IntrinsicFunctions>
<SDLCheck>true</SDLCheck>
<PreprocessorDefinitions>NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
</ClCompile>
<Link>
<SubSystem>Console</SubSystem>
<EnableCOMDATFolding>true</EnableCOMDATFolding>
<OptimizeReferences>true</OptimizeReferences>
<GenerateDebugInformation>true</GenerateDebugInformation>
</Link>
</ItemDefinitionGroup>
<ItemGroup>
<ClCompile Include="02_GetSetParameter.cpp" />
<ClCompile Include="RunExample.cpp" />
<ClCompile Include="stdafx.cpp" />
</ItemGroup>
<ItemGroup>
<ClInclude Include="02_GetSetParameter.h" />
<ClInclude Include="PCANBasic.h" />
<ClInclude Include="stdafx.h" />
<ClInclude Include="targetver.h" />
</ItemGroup>
<ItemGroup>
<Library Include="lib\x64\PCANBasic.lib" />
<Library Include="lib\x86\PCANBasic.lib" />
</ItemGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<ImportGroup Label="ExtensionTargets">
</ImportGroup>
</Project>
@@ -0,0 +1,46 @@
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<ItemGroup>
<Filter Include="Resource Files">
<UniqueIdentifier>{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}</UniqueIdentifier>
<Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions>
</Filter>
<Filter Include="Header Files">
<UniqueIdentifier>{93995380-89BD-4b04-88EB-625FBE52EBFB}</UniqueIdentifier>
<Extensions>h;hh;hpp;hxx;h++;hm;inl;inc;ipp;xsd</Extensions>
</Filter>
<Filter Include="Source Files">
<UniqueIdentifier>{4FC737F1-C7A5-4376-A066-2A32D752A2FF}</UniqueIdentifier>
<Extensions>cpp;c;cc;cxx;c++;cppm;ixx;def;odl;idl;hpj;bat;asm;asmx</Extensions>
</Filter>
</ItemGroup>
<ItemGroup>
<ClCompile Include="02_GetSetParameter.cpp">
<Filter>Source Files</Filter>
</ClCompile>
<ClCompile Include="stdafx.cpp">
<Filter>Source Files</Filter>
</ClCompile>
<ClCompile Include="RunExample.cpp">
<Filter>Source Files</Filter>
</ClCompile>
</ItemGroup>
<ItemGroup>
<ClInclude Include="PCANBasic.h">
<Filter>Header Files</Filter>
</ClInclude>
<ClInclude Include="stdafx.h">
<Filter>Header Files</Filter>
</ClInclude>
<ClInclude Include="targetver.h">
<Filter>Header Files</Filter>
</ClInclude>
<ClInclude Include="02_GetSetParameter.h">
<Filter>Header Files</Filter>
</ClInclude>
</ItemGroup>
<ItemGroup>
<Library Include="lib\x64\PCANBasic.lib" />
<Library Include="lib\x86\PCANBasic.lib" />
</ItemGroup>
</Project>
@@ -0,0 +1,585 @@
// PCANBasic.h
//
// ~~~~~~~~~~~~
//
// PCAN-Basic API
//
// ~~~~~~~~~~~~
//
// ------------------------------------------------------------------
// Author : Keneth Wagner
// Last change: 2022-07-06
//
// Language: ANSI-C
// ------------------------------------------------------------------
//
// Copyright (C) 1999-2022 PEAK-System Technik GmbH, Darmstadt
// more Info at http://www.peak-system.com
//
#ifndef __PCANBASICH__
#define __PCANBASICH__
////////////////////////////////////////////////////////////
// Value definitions
////////////////////////////////////////////////////////////
// Currently defined and supported PCAN channels
//
#define PCAN_NONEBUS 0x00U // Undefined/default value for a PCAN bus
#define PCAN_ISABUS1 0x21U // PCAN-ISA interface, channel 1
#define PCAN_ISABUS2 0x22U // PCAN-ISA interface, channel 2
#define PCAN_ISABUS3 0x23U // PCAN-ISA interface, channel 3
#define PCAN_ISABUS4 0x24U // PCAN-ISA interface, channel 4
#define PCAN_ISABUS5 0x25U // PCAN-ISA interface, channel 5
#define PCAN_ISABUS6 0x26U // PCAN-ISA interface, channel 6
#define PCAN_ISABUS7 0x27U // PCAN-ISA interface, channel 7
#define PCAN_ISABUS8 0x28U // PCAN-ISA interface, channel 8
#define PCAN_DNGBUS1 0x31U // PCAN-Dongle/LPT interface, channel 1
#define PCAN_PCIBUS1 0x41U // PCAN-PCI interface, channel 1
#define PCAN_PCIBUS2 0x42U // PCAN-PCI interface, channel 2
#define PCAN_PCIBUS3 0x43U // PCAN-PCI interface, channel 3
#define PCAN_PCIBUS4 0x44U // PCAN-PCI interface, channel 4
#define PCAN_PCIBUS5 0x45U // PCAN-PCI interface, channel 5
#define PCAN_PCIBUS6 0x46U // PCAN-PCI interface, channel 6
#define PCAN_PCIBUS7 0x47U // PCAN-PCI interface, channel 7
#define PCAN_PCIBUS8 0x48U // PCAN-PCI interface, channel 8
#define PCAN_PCIBUS9 0x409U // PCAN-PCI interface, channel 9
#define PCAN_PCIBUS10 0x40AU // PCAN-PCI interface, channel 10
#define PCAN_PCIBUS11 0x40BU // PCAN-PCI interface, channel 11
#define PCAN_PCIBUS12 0x40CU // PCAN-PCI interface, channel 12
#define PCAN_PCIBUS13 0x40DU // PCAN-PCI interface, channel 13
#define PCAN_PCIBUS14 0x40EU // PCAN-PCI interface, channel 14
#define PCAN_PCIBUS15 0x40FU // PCAN-PCI interface, channel 15
#define PCAN_PCIBUS16 0x410U // PCAN-PCI interface, channel 16
#define PCAN_USBBUS1 0x51U // PCAN-USB interface, channel 1
#define PCAN_USBBUS2 0x52U // PCAN-USB interface, channel 2
#define PCAN_USBBUS3 0x53U // PCAN-USB interface, channel 3
#define PCAN_USBBUS4 0x54U // PCAN-USB interface, channel 4
#define PCAN_USBBUS5 0x55U // PCAN-USB interface, channel 5
#define PCAN_USBBUS6 0x56U // PCAN-USB interface, channel 6
#define PCAN_USBBUS7 0x57U // PCAN-USB interface, channel 7
#define PCAN_USBBUS8 0x58U // PCAN-USB interface, channel 8
#define PCAN_USBBUS9 0x509U // PCAN-USB interface, channel 9
#define PCAN_USBBUS10 0x50AU // PCAN-USB interface, channel 10
#define PCAN_USBBUS11 0x50BU // PCAN-USB interface, channel 11
#define PCAN_USBBUS12 0x50CU // PCAN-USB interface, channel 12
#define PCAN_USBBUS13 0x50DU // PCAN-USB interface, channel 13
#define PCAN_USBBUS14 0x50EU // PCAN-USB interface, channel 14
#define PCAN_USBBUS15 0x50FU // PCAN-USB interface, channel 15
#define PCAN_USBBUS16 0x510U // PCAN-USB interface, channel 16
#define PCAN_PCCBUS1 0x61U // PCAN-PC Card interface, channel 1
#define PCAN_PCCBUS2 0x62U // PCAN-PC Card interface, channel 2
#define PCAN_LANBUS1 0x801U // PCAN-LAN interface, channel 1
#define PCAN_LANBUS2 0x802U // PCAN-LAN interface, channel 2
#define PCAN_LANBUS3 0x803U // PCAN-LAN interface, channel 3
#define PCAN_LANBUS4 0x804U // PCAN-LAN interface, channel 4
#define PCAN_LANBUS5 0x805U // PCAN-LAN interface, channel 5
#define PCAN_LANBUS6 0x806U // PCAN-LAN interface, channel 6
#define PCAN_LANBUS7 0x807U // PCAN-LAN interface, channel 7
#define PCAN_LANBUS8 0x808U // PCAN-LAN interface, channel 8
#define PCAN_LANBUS9 0x809U // PCAN-LAN interface, channel 9
#define PCAN_LANBUS10 0x80AU // PCAN-LAN interface, channel 10
#define PCAN_LANBUS11 0x80BU // PCAN-LAN interface, channel 11
#define PCAN_LANBUS12 0x80CU // PCAN-LAN interface, channel 12
#define PCAN_LANBUS13 0x80DU // PCAN-LAN interface, channel 13
#define PCAN_LANBUS14 0x80EU // PCAN-LAN interface, channel 14
#define PCAN_LANBUS15 0x80FU // PCAN-LAN interface, channel 15
#define PCAN_LANBUS16 0x810U // PCAN-LAN interface, channel 16
// Represent the PCAN error and status codes
//
#define PCAN_ERROR_OK 0x00000U // No error
#define PCAN_ERROR_XMTFULL 0x00001U // Transmit buffer in CAN controller is full
#define PCAN_ERROR_OVERRUN 0x00002U // CAN controller was read too late
#define PCAN_ERROR_BUSLIGHT 0x00004U // Bus error: an error counter reached the 'light' limit
#define PCAN_ERROR_BUSHEAVY 0x00008U // Bus error: an error counter reached the 'heavy' limit
#define PCAN_ERROR_BUSWARNING PCAN_ERROR_BUSHEAVY // Bus error: an error counter reached the 'warning' limit
#define PCAN_ERROR_BUSPASSIVE 0x40000U // Bus error: the CAN controller is error passive
#define PCAN_ERROR_BUSOFF 0x00010U // Bus error: the CAN controller is in bus-off state
#define PCAN_ERROR_ANYBUSERR (PCAN_ERROR_BUSWARNING | PCAN_ERROR_BUSLIGHT | PCAN_ERROR_BUSHEAVY | PCAN_ERROR_BUSOFF | PCAN_ERROR_BUSPASSIVE) // Mask for all bus errors
#define PCAN_ERROR_QRCVEMPTY 0x00020U // Receive queue is empty
#define PCAN_ERROR_QOVERRUN 0x00040U // Receive queue was read too late
#define PCAN_ERROR_QXMTFULL 0x00080U // Transmit queue is full
#define PCAN_ERROR_REGTEST 0x00100U // Test of the CAN controller hardware registers failed (no hardware found)
#define PCAN_ERROR_NODRIVER 0x00200U // Driver not loaded
#define PCAN_ERROR_HWINUSE 0x00400U // Hardware already in use by a Net
#define PCAN_ERROR_NETINUSE 0x00800U // A Client is already connected to the Net
#define PCAN_ERROR_ILLHW 0x01400U // Hardware handle is invalid
#define PCAN_ERROR_ILLNET 0x01800U // Net handle is invalid
#define PCAN_ERROR_ILLCLIENT 0x01C00U // Client handle is invalid
#define PCAN_ERROR_ILLHANDLE (PCAN_ERROR_ILLHW | PCAN_ERROR_ILLNET | PCAN_ERROR_ILLCLIENT) // Mask for all handle errors
#define PCAN_ERROR_RESOURCE 0x02000U // Resource (FIFO, Client, timeout) cannot be created
#define PCAN_ERROR_ILLPARAMTYPE 0x04000U // Invalid parameter
#define PCAN_ERROR_ILLPARAMVAL 0x08000U // Invalid parameter value
#define PCAN_ERROR_UNKNOWN 0x10000U // Unknown error
#define PCAN_ERROR_ILLDATA 0x20000U // Invalid data, function, or action
#define PCAN_ERROR_ILLMODE 0x80000U // Driver object state is wrong for the attempted operation
#define PCAN_ERROR_CAUTION 0x2000000U // An operation was successfully carried out, however, irregularities were registered
#define PCAN_ERROR_INITIALIZE 0x4000000U // Channel is not initialized [Value was changed from 0x40000 to 0x4000000]
#define PCAN_ERROR_ILLOPERATION 0x8000000U // Invalid operation [Value was changed from 0x80000 to 0x8000000]
// PCAN devices
//
#define PCAN_NONE 0x00U // Undefined, unknown or not selected PCAN device value
#define PCAN_PEAKCAN 0x01U // PCAN Non-PnP devices. NOT USED WITHIN PCAN-Basic API
#define PCAN_ISA 0x02U // PCAN-ISA, PCAN-PC/104, and PCAN-PC/104-Plus
#define PCAN_DNG 0x03U // PCAN-Dongle
#define PCAN_PCI 0x04U // PCAN-PCI, PCAN-cPCI, PCAN-miniPCI, and PCAN-PCI Express
#define PCAN_USB 0x05U // PCAN-USB and PCAN-USB Pro
#define PCAN_PCC 0x06U // PCAN-PC Card
#define PCAN_VIRTUAL 0x07U // PCAN Virtual hardware. NOT USED WITHIN PCAN-Basic API
#define PCAN_LAN 0x08U // PCAN Gateway devices
// PCAN parameters
//
#define PCAN_DEVICE_ID 0x01U // Device identifier parameter
#define PCAN_5VOLTS_POWER 0x02U // 5-Volt power parameter
#define PCAN_RECEIVE_EVENT 0x03U // PCAN receive event handler parameter
#define PCAN_MESSAGE_FILTER 0x04U // PCAN message filter parameter
#define PCAN_API_VERSION 0x05U // PCAN-Basic API version parameter
#define PCAN_CHANNEL_VERSION 0x06U // PCAN device channel version parameter
#define PCAN_BUSOFF_AUTORESET 0x07U // PCAN Reset-On-Busoff parameter
#define PCAN_LISTEN_ONLY 0x08U // PCAN Listen-Only parameter
#define PCAN_LOG_LOCATION 0x09U // Directory path for log files
#define PCAN_LOG_STATUS 0x0AU // Debug-Log activation status
#define PCAN_LOG_CONFIGURE 0x0BU // Configuration of the debugged information (LOG_FUNCTION_***)
#define PCAN_LOG_TEXT 0x0CU // Custom insertion of text into the log file
#define PCAN_CHANNEL_CONDITION 0x0DU // Availability status of a PCAN-Channel
#define PCAN_HARDWARE_NAME 0x0EU // PCAN hardware name parameter
#define PCAN_RECEIVE_STATUS 0x0FU // Message reception status of a PCAN-Channel
#define PCAN_CONTROLLER_NUMBER 0x10U // CAN-Controller number of a PCAN-Channel
#define PCAN_TRACE_LOCATION 0x11U // Directory path for PCAN trace files
#define PCAN_TRACE_STATUS 0x12U // CAN tracing activation status
#define PCAN_TRACE_SIZE 0x13U // Configuration of the maximum file size of a CAN trace
#define PCAN_TRACE_CONFIGURE 0x14U // Configuration of the trace file storing mode (TRACE_FILE_***)
#define PCAN_CHANNEL_IDENTIFYING 0x15U // Physical identification of a USB based PCAN-Channel by blinking its associated LED
#define PCAN_CHANNEL_FEATURES 0x16U // Capabilities of a PCAN device (FEATURE_***)
#define PCAN_BITRATE_ADAPTING 0x17U // Using of an existing bit rate (PCAN-View connected to a channel)
#define PCAN_BITRATE_INFO 0x18U // Configured bit rate as Btr0Btr1 value
#define PCAN_BITRATE_INFO_FD 0x19U // Configured bit rate as TPCANBitrateFD string
#define PCAN_BUSSPEED_NOMINAL 0x1AU // Configured nominal CAN Bus speed as Bits per seconds
#define PCAN_BUSSPEED_DATA 0x1BU // Configured CAN data speed as Bits per seconds
#define PCAN_IP_ADDRESS 0x1CU // Remote address of a LAN channel as string in IPv4 format
#define PCAN_LAN_SERVICE_STATUS 0x1DU // Status of the Virtual PCAN-Gateway Service
#define PCAN_ALLOW_STATUS_FRAMES 0x1EU // Status messages reception status within a PCAN-Channel
#define PCAN_ALLOW_RTR_FRAMES 0x1FU // RTR messages reception status within a PCAN-Channel
#define PCAN_ALLOW_ERROR_FRAMES 0x20U // Error messages reception status within a PCAN-Channel
#define PCAN_INTERFRAME_DELAY 0x21U // Delay, in microseconds, between sending frames
#define PCAN_ACCEPTANCE_FILTER_11BIT 0x22U // Filter over code and mask patterns for 11-Bit messages
#define PCAN_ACCEPTANCE_FILTER_29BIT 0x23U // Filter over code and mask patterns for 29-Bit messages
#define PCAN_IO_DIGITAL_CONFIGURATION 0x24U // Output mode of 32 digital I/O pin of a PCAN-USB Chip. 1: Output-Active 0 : Output Inactive
#define PCAN_IO_DIGITAL_VALUE 0x25U // Value assigned to a 32 digital I/O pins of a PCAN-USB Chip
#define PCAN_IO_DIGITAL_SET 0x26U // Value assigned to a 32 digital I/O pins of a PCAN-USB Chip - Multiple digital I/O pins to 1 = High
#define PCAN_IO_DIGITAL_CLEAR 0x27U // Clear multiple digital I/O pins to 0
#define PCAN_IO_ANALOG_VALUE 0x28U // Get value of a single analog input pin
#define PCAN_FIRMWARE_VERSION 0x29U // Get the version of the firmware used by the device associated with a PCAN-Channel
#define PCAN_ATTACHED_CHANNELS_COUNT 0x2AU // Get the amount of PCAN channels attached to a system
#define PCAN_ATTACHED_CHANNELS 0x2BU // Get information about PCAN channels attached to a system
#define PCAN_ALLOW_ECHO_FRAMES 0x2CU // Echo messages reception status within a PCAN-Channel
#define PCAN_DEVICE_PART_NUMBER 0x2DU // Get the part number associated to a device
// DEPRECATED parameters
//
#define PCAN_DEVICE_NUMBER PCAN_DEVICE_ID // Deprecated parameter. Use PCAN_DEVICE_ID instead
// PCAN parameter values
//
#define PCAN_PARAMETER_OFF 0x00U // The PCAN parameter is not set (inactive)
#define PCAN_PARAMETER_ON 0x01U // The PCAN parameter is set (active)
#define PCAN_FILTER_CLOSE 0x00U // The PCAN filter is closed. No messages will be received
#define PCAN_FILTER_OPEN 0x01U // The PCAN filter is fully opened. All messages will be received
#define PCAN_FILTER_CUSTOM 0x02U // The PCAN filter is custom configured. Only registered messages will be received
#define PCAN_CHANNEL_UNAVAILABLE 0x00U // The PCAN-Channel handle is illegal, or its associated hardware is not available
#define PCAN_CHANNEL_AVAILABLE 0x01U // The PCAN-Channel handle is available to be connected (PnP Hardware: it means furthermore that the hardware is plugged-in)
#define PCAN_CHANNEL_OCCUPIED 0x02U // The PCAN-Channel handle is valid, and is already being used
#define PCAN_CHANNEL_PCANVIEW (PCAN_CHANNEL_AVAILABLE | PCAN_CHANNEL_OCCUPIED) // The PCAN-Channel handle is already being used by a PCAN-View application, but is available to connect
#define LOG_FUNCTION_DEFAULT 0x00U // Logs system exceptions / errors
#define LOG_FUNCTION_ENTRY 0x01U // Logs the entries to the PCAN-Basic API functions
#define LOG_FUNCTION_PARAMETERS 0x02U // Logs the parameters passed to the PCAN-Basic API functions
#define LOG_FUNCTION_LEAVE 0x04U // Logs the exits from the PCAN-Basic API functions
#define LOG_FUNCTION_WRITE 0x08U // Logs the CAN messages passed to the CAN_Write function
#define LOG_FUNCTION_READ 0x10U // Logs the CAN messages received within the CAN_Read function
#define LOG_FUNCTION_ALL 0xFFFFU // Logs all possible information within the PCAN-Basic API functions
#define TRACE_FILE_SINGLE 0x00U // A single file is written until it size reaches PAN_TRACE_SIZE
#define TRACE_FILE_SEGMENTED 0x01U // Traced data is distributed in several files with size PAN_TRACE_SIZE
#define TRACE_FILE_DATE 0x02U // Includes the date into the name of the trace file
#define TRACE_FILE_TIME 0x04U // Includes the start time into the name of the trace file
#define TRACE_FILE_OVERWRITE 0x80U // Causes the overwriting of available traces (same name)
#define FEATURE_FD_CAPABLE 0x01U // Device supports flexible data-rate (CAN-FD)
#define FEATURE_DELAY_CAPABLE 0x02U // Device supports a delay between sending frames (FPGA based USB devices)
#define FEATURE_IO_CAPABLE 0x04U // Device supports I/O functionality for electronic circuits (USB-Chip devices)
#define SERVICE_STATUS_STOPPED 0x01U // The service is not running
#define SERVICE_STATUS_RUNNING 0x04U // The service is running
// Other constants
//
#define MAX_LENGTH_HARDWARE_NAME 33 // Maximum length of the name of a device: 32 characters + terminator
#define MAX_LENGTH_VERSION_STRING 256 // Maximum length of a version string: 255 characters + terminator
// PCAN message types
//
#define PCAN_MESSAGE_STANDARD 0x00U // The PCAN message is a CAN Standard Frame (11-bit identifier)
#define PCAN_MESSAGE_RTR 0x01U // The PCAN message is a CAN Remote-Transfer-Request Frame
#define PCAN_MESSAGE_EXTENDED 0x02U // The PCAN message is a CAN Extended Frame (29-bit identifier)
#define PCAN_MESSAGE_FD 0x04U // The PCAN message represents a FD frame in terms of CiA Specs
#define PCAN_MESSAGE_BRS 0x08U // The PCAN message represents a FD bit rate switch (CAN data at a higher bit rate)
#define PCAN_MESSAGE_ESI 0x10U // The PCAN message represents a FD error state indicator(CAN FD transmitter was error active)
#define PCAN_MESSAGE_ECHO 0x20U // The PCAN message represents an echo CAN Frame
#define PCAN_MESSAGE_ERRFRAME 0x40U // The PCAN message represents an error frame
#define PCAN_MESSAGE_STATUS 0x80U // The PCAN message represents a PCAN status message
// LookUp Parameters
//
#define LOOKUP_DEVICE_TYPE __T("devicetype") // Lookup channel by Device type (see PCAN devices e.g. PCAN_USB)
#define LOOKUP_DEVICE_ID __T("deviceid") // Lookup channel by device id
#define LOOKUP_CONTROLLER_NUMBER __T("controllernumber") // Lookup channel by CAN controller 0-based index
#define LOOKUP_IP_ADDRESS __T("ipaddress") // Lookup channel by IP address (LAN channels only)
// Frame Type / Initialization Mode
//
#define PCAN_MODE_STANDARD PCAN_MESSAGE_STANDARD
#define PCAN_MODE_EXTENDED PCAN_MESSAGE_EXTENDED
// Baud rate codes = BTR0/BTR1 register values for the CAN controller.
// You can define your own Baud rate with the BTROBTR1 register.
// Take a look at www.peak-system.com for our free software "BAUDTOOL"
// to calculate the BTROBTR1 register for every bit rate and sample point.
//
#define PCAN_BAUD_1M 0x0014U // 1 MBit/s
#define PCAN_BAUD_800K 0x0016U // 800 kBit/s
#define PCAN_BAUD_500K 0x001CU // 500 kBit/s
#define PCAN_BAUD_250K 0x011CU // 250 kBit/s
#define PCAN_BAUD_125K 0x031CU // 125 kBit/s
#define PCAN_BAUD_100K 0x432FU // 100 kBit/s
#define PCAN_BAUD_95K 0xC34EU // 95,238 kBit/s
#define PCAN_BAUD_83K 0x852BU // 83,333 kBit/s
#define PCAN_BAUD_50K 0x472FU // 50 kBit/s
#define PCAN_BAUD_47K 0x1414U // 47,619 kBit/s
#define PCAN_BAUD_33K 0x8B2FU // 33,333 kBit/s
#define PCAN_BAUD_20K 0x532FU // 20 kBit/s
#define PCAN_BAUD_10K 0x672FU // 10 kBit/s
#define PCAN_BAUD_5K 0x7F7FU // 5 kBit/s
// Represents the configuration for a CAN bit rate
// Note:
// * Each parameter and its value must be separated with a '='.
// * Each pair of parameter/value must be separated using ','.
//
// Example:
// f_clock=80000000,nom_brp=10,nom_tseg1=5,nom_tseg2=2,nom_sjw=1,data_brp=4,data_tseg1=7,data_tseg2=2,data_sjw=1
//
#define PCAN_BR_CLOCK __T("f_clock")
#define PCAN_BR_CLOCK_MHZ __T("f_clock_mhz")
#define PCAN_BR_NOM_BRP __T("nom_brp")
#define PCAN_BR_NOM_TSEG1 __T("nom_tseg1")
#define PCAN_BR_NOM_TSEG2 __T("nom_tseg2")
#define PCAN_BR_NOM_SJW __T("nom_sjw")
#define PCAN_BR_NOM_SAMPLE __T("nom_sam")
#define PCAN_BR_DATA_BRP __T("data_brp")
#define PCAN_BR_DATA_TSEG1 __T("data_tseg1")
#define PCAN_BR_DATA_TSEG2 __T("data_tseg2")
#define PCAN_BR_DATA_SJW __T("data_sjw")
#define PCAN_BR_DATA_SAMPLE __T("data_ssp_offset")
// Type of PCAN (Non-PnP) hardware
//
#define PCAN_TYPE_ISA 0x01U // PCAN-ISA 82C200
#define PCAN_TYPE_ISA_SJA 0x09U // PCAN-ISA SJA1000
#define PCAN_TYPE_ISA_PHYTEC 0x04U // PHYTEC ISA
#define PCAN_TYPE_DNG 0x02U // PCAN-Dongle 82C200
#define PCAN_TYPE_DNG_EPP 0x03U // PCAN-Dongle EPP 82C200
#define PCAN_TYPE_DNG_SJA 0x05U // PCAN-Dongle SJA1000
#define PCAN_TYPE_DNG_SJA_EPP 0x06U // PCAN-Dongle EPP SJA1000
////////////////////////////////////////////////////////////
// Type definitions
////////////////////////////////////////////////////////////
#define TPCANHandle WORD // Represents a PCAN hardware channel handle
#define TPCANStatus DWORD // Represents a PCAN status/error code
#define TPCANParameter BYTE // Represents a PCAN parameter to be read or set
#define TPCANDevice BYTE // Represents a PCAN device
#define TPCANMessageType BYTE // Represents the type of a PCAN message
#define TPCANType BYTE // Represents the type of PCAN hardware to be initialized
#define TPCANMode BYTE // Represents a PCAN filter mode
#define TPCANBaudrate WORD // Represents a PCAN Baud rate register value
#define TPCANBitrateFD LPSTR // Represents a PCAN-FD bit rate string
#define TPCANTimestampFD UINT64 // Represents a timestamp of a received PCAN FD message
////////////////////////////////////////////////////////////
// Structure definitions
////////////////////////////////////////////////////////////
// Represents a PCAN message
//
typedef struct tagTPCANMsg
{
DWORD ID; // 11/29-bit message identifier
TPCANMessageType MSGTYPE; // Type of the message
BYTE LEN; // Data Length Code of the message (0..8)
BYTE DATA[8]; // Data of the message (DATA[0]..DATA[7])
} TPCANMsg;
// Represents a timestamp of a received PCAN message
// Total Microseconds = micros + 1000 * millis + 0x100000000 * 1000 * millis_overflow
//
typedef struct tagTPCANTimestamp
{
DWORD millis; // Base-value: milliseconds: 0.. 2^32-1
WORD millis_overflow; // Roll-arounds of millis
WORD micros; // Microseconds: 0..999
} TPCANTimestamp;
// Represents a PCAN message from a FD capable hardware
//
typedef struct tagTPCANMsgFD
{
DWORD ID; // 11/29-bit message identifier
TPCANMessageType MSGTYPE; // Type of the message
BYTE DLC; // Data Length Code of the message (0..15)
BYTE DATA[64]; // Data of the message (DATA[0]..DATA[63])
} TPCANMsgFD;
// Describes an available PCAN channel
//
typedef struct tagTPCANChannelInformation
{
TPCANHandle channel_handle; // PCAN channel handle
TPCANDevice device_type; // Kind of PCAN device
BYTE controller_number; // CAN-Controller number
DWORD device_features; // Device capabilities flag (see FEATURE_*)
char device_name[MAX_LENGTH_HARDWARE_NAME]; // Device name
DWORD device_id; // Device number
DWORD channel_condition; // Availability status of a PCAN-Channel
}TPCANChannelInformation;
#ifdef __cplusplus
extern "C" {
#define _DEF_ARG =0
#else
#define _DEF_ARG
#endif
////////////////////////////////////////////////////////////
// PCAN-Basic API function declarations
////////////////////////////////////////////////////////////
/// <summary>
/// Initializes a PCAN Channel
/// </summary>
/// <param name="Channel">"The handle of a PCAN Channel"</param>
/// <param name="Btr0Btr1">"The speed for the communication (BTR0BTR1 code)"</param>
/// <param name="HwType">"Non-PnP: The type of hardware and operation mode"</param>
/// <param name="IOPort">"Non-PnP: The I/O address for the parallel port"</param>
/// <param name="Interrupt">"Non-PnP: Interrupt number of the parallel port"</param>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_Initialize(
TPCANHandle Channel,
TPCANBaudrate Btr0Btr1,
TPCANType HwType _DEF_ARG,
DWORD IOPort _DEF_ARG,
WORD Interrupt _DEF_ARG);
/// <summary>
/// Initializes a FD capable PCAN Channel
/// </summary>
/// <param name="Channel">"The handle of a FD capable PCAN Channel"</param>
/// <param name="BitrateFD">"The speed for the communication (FD bit rate string)"</param>
/// <remarks>See PCAN_BR_* values
/// * Parameter and values must be separated by '='
/// * Couples of Parameter/value must be separated by ','
/// * Following Parameter must be filled out: f_clock, data_brp, data_sjw, data_tseg1, data_tseg2,
/// nom_brp, nom_sjw, nom_tseg1, nom_tseg2.
/// * Following Parameters are optional (not used yet): data_ssp_offset, nom_sam
///</remarks>
/// <example>f_clock=80000000,nom_brp=10,nom_tseg1=5,nom_tseg2=2,nom_sjw=1,data_brp=4,data_tseg1=7,data_tseg2=2,data_sjw=1</example>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_InitializeFD(
TPCANHandle Channel,
TPCANBitrateFD BitrateFD);
/// <summary>
/// Uninitializes one or all PCAN Channels initialized by CAN_Initialize
/// </summary>
/// <remarks>Giving the TPCANHandle value "PCAN_NONEBUS",
/// uninitialize all initialized channels</remarks>
/// <param name="Channel">"The handle of a PCAN Channel"</param>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_Uninitialize(
TPCANHandle Channel);
/// <summary>
/// Resets the receive and transmit queues of the PCAN Channel
/// </summary>
/// <remarks>
/// A reset of the CAN controller is not performed.
/// </remarks>
/// <param name="Channel">"The handle of a PCAN Channel"</param>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_Reset(
TPCANHandle Channel);
/// <summary>
/// Gets the current status of a PCAN Channel
/// </summary>
/// <param name="Channel">"The handle of a PCAN Channel"</param>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_GetStatus(
TPCANHandle Channel);
/// <summary>
/// Reads a CAN message from the receive queue of a PCAN Channel
/// </summary>
/// <param name="Channel">"The handle of a PCAN Channel"</param>
/// <param name="MessageBuffer">"A TPCANMsg structure buffer to store the CAN message"</param>
/// <param name="TimestampBuffer">"A TPCANTimestamp structure buffer to get
/// the reception time of the message. If this value is not desired, this parameter
/// should be passed as NULL"</param>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_Read(
TPCANHandle Channel,
TPCANMsg* MessageBuffer,
TPCANTimestamp* TimestampBuffer);
/// <summary>
/// Reads a CAN message from the receive queue of a FD capable PCAN Channel
/// </summary>
/// <param name="Channel">"The handle of a FD capable PCAN Channel"</param>
/// <param name="MessageBuffer">"A TPCANMsgFD structure buffer to store the CAN message"</param>
/// <param name="TimestampBuffer">"A TPCANTimestampFD buffer to get
/// the reception time of the message. If this value is not desired, this parameter
/// should be passed as NULL"</param>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_ReadFD(
TPCANHandle Channel,
TPCANMsgFD* MessageBuffer,
TPCANTimestampFD *TimestampBuffer);
/// <summary>
/// Transmits a CAN message
/// </summary>
/// <param name="Channel">"The handle of a PCAN Channel"</param>
/// <param name="MessageBuffer">"A TPCANMsg buffer with the message to be sent"</param>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_Write(
TPCANHandle Channel,
TPCANMsg* MessageBuffer);
/// <summary>
/// Transmits a CAN message over a FD capable PCAN Channel
/// </summary>
/// <param name="Channel">"The handle of a FD capable PCAN Channel"</param>
/// <param name="MessageBuffer">"A TPCANMsgFD buffer with the message to be sent"</param>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_WriteFD(
TPCANHandle Channel,
TPCANMsgFD* MessageBuffer);
/// <summary>
/// Configures the reception filter.
/// </summary>
/// <remarks>The message filter will be expanded with every call to
/// this function. If it is desired to reset the filter, please use
/// the CAN_SetValue function</remarks>
/// <param name="Channel">"The handle of a PCAN Channel"</param>
/// <param name="FromID">"The lowest CAN ID to be received"</param>
/// <param name="ToID">"The highest CAN ID to be received"</param>
/// <param name="Mode">"Message type, Standard (11-bit identifier) or
/// Extended (29-bit identifier)"</param>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_FilterMessages(
TPCANHandle Channel,
DWORD FromID,
DWORD ToID,
TPCANMode Mode);
/// <summary>
/// Retrieves a PCAN Channel value
/// </summary>
/// <remarks>Parameters can be present or not according with the kind
/// of Hardware (PCAN Channel) being used. If a parameter is not available,
/// a PCAN_ERROR_ILLPARAMTYPE error will be returned</remarks>
/// <param name="Channel">"The handle of a PCAN Channel"</param>
/// <param name="Parameter">"The TPCANParameter parameter to get"</param>
/// <param name="Buffer">"Buffer for the parameter value"</param>
/// <param name="BufferLength">"Size in bytes of the buffer"</param>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_GetValue(
TPCANHandle Channel,
TPCANParameter Parameter,
void* Buffer,
DWORD BufferLength);
/// <summary>
/// Configures or sets a PCAN Channel value
/// </summary>
/// <remarks>Parameters can be present or not according with the kind
/// of Hardware (PCAN Channel) being used. If a parameter is not available,
/// a PCAN_ERROR_ILLPARAMTYPE error will be returned</remarks>
/// <param name="Channel">"The handle of a PCAN Channel"</param>
/// <param name="Parameter">"The TPCANParameter parameter to set"</param>
/// <param name="Buffer">"Buffer with the value to be set"</param>
/// <param name="BufferLength">"Size in bytes of the buffer"</param>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_SetValue(
TPCANHandle Channel,
TPCANParameter Parameter,
void* Buffer,
DWORD BufferLength);
/// <summary>
/// Returns a descriptive text of a given TPCANStatus error
/// code, in any desired language
/// </summary>
/// <remarks>The current languages available for translation are:
/// Neutral (0x00), German (0x07), English (0x09), Spanish (0x0A),
/// Italian (0x10) and French (0x0C)</remarks>
/// <param name="Error">"A TPCANStatus error code"</param>
/// <param name="Language">"Indicates a 'Primary language ID'"</param>
/// <param name="Buffer">"Buffer for a null terminated char array"</param>
/// <returns>"A TPCANStatus error code"</returns>
TPCANStatus __stdcall CAN_GetErrorText(
TPCANStatus Error,
WORD Language,
LPSTR Buffer);
/// <summary>
/// Finds a PCAN-Basic channel that matches with the given parameters
/// </summary>
/// <param name="Parameters">A comma separated string contained pairs of
/// parameter-name/value to be matched within a PCAN-Basic channel</param>
/// <param name="FoundChannel">Buffer for returning the PCAN-Basic channel,
/// when found</param>
/// <returns>A TPCANStatus error code</returns>
TPCANStatus __stdcall CAN_LookUpChannel(
LPSTR Parameters,
TPCANHandle* FoundChannel);
#ifdef __cplusplus
}
#endif
#endif
@@ -0,0 +1,6 @@
#include "02_GetSetParameter.h"
int main()
{
GetSetParameter start;
}
@@ -0,0 +1,7 @@
// stdafx.cpp : source file that includes just the standard includes
// PCANBasicExample.pch will be the pre-compiled header
// stdafx.obj will contain the pre-compiled type information
#include "stdafx.h"
@@ -0,0 +1,12 @@
// stdafx.h : include file for standard system include files,
// or project specific include files that are used frequently,
// but are changed infrequently
#pragma once
#include <iostream>
#include <atlstr.h>
#include <conio.h>
#include <iomanip>
#include <Windows.h>
#include <string>
#include "targetver.h"
@@ -0,0 +1,25 @@
#pragma once
// The following macros define the minimum required platform. The minimum required platform
// is the earliest version of Windows, Internet Explorer etc. that has the necessary features to run
// your application. The macros work by enabling all features available on platform versions up to and
// including the version specified.
// Modify the following defines if you have to target a platform prior to the ones specified below.
// Refer to MSDN for the latest info on corresponding values for different platforms.
#ifndef WINVER // Specifies that the minimum required platform is Windows Vista.
#define WINVER 0x0600 // Change this to the appropriate value to target other versions of Windows.
#endif
#ifndef _WIN32_WINNT // Specifies that the minimum required platform is Windows Vista.
#define _WIN32_WINNT 0x0600 // Change this to the appropriate value to target other versions of Windows.
#endif
#ifndef _WIN32_WINDOWS // Specifies that the minimum required platform is Windows 98.
#define _WIN32_WINDOWS 0x0410 // Change this to the appropriate value to target Windows Me or later.
#endif
#ifndef _WIN32_IE // Specifies that the minimum required platform is Internet Explorer 7.0.
#define _WIN32_IE 0x0700 // Change this to the appropriate value to target other versions of IE.
#endif