C++ and MATLAB Simulink tips for HWIL simulation software engineers
Wednesday, December 15, 2021
Getting file/folder list in Windows and Linux
Wednesday, December 1, 2021
Vectors for Software Engineers
Vectors are common in simulations but software engineers can forget the basics of vector operations. Here is a quick refresher:
In equation (1), we have a velocity vector of point m with respect to point c, expressed as a sum of two vectors.In equation (2), we have the same equation but in scalar form. The "(n)" represents the reference frame in which the components of the vectors are expressed. In order to perform addition, all vector components must be expressed in the same reference frame.
If you want more detail, check out my advanced dynamics lecture notes (PDF).
Tuesday, November 30, 2021
Generate C/C++ Code From Matlab Function
Use MATLAB Coder to generate C/C++ code from an m file (must be a function). At the end of the process, click on "View Report" and on the Report Viewer window, click on Package Code to package all the dependencies (e.g. tmwtypes.h) into a single zip file.
Friday, November 26, 2021
Check if the MATLAB instance you created has exited
When you run MATLAB from a Windows bat file and want to know if it has finished its job and exited (without considering other already open MATLAB instance), you can use the following:
start matlab.exe -nosplash -nodesktop -noFigureWindows
set pid=not found
for /f "tokens=2" %%a in ('tasklist^|find /i "matlab") do (set pid=%%a)
echo matlab pid = %pid%
:waitForMatlabToExit
timeout /t /5 /nobreak
tasklist /fi "pid eq %pid%" | find ":">nul
if errorlevel 1 goto waitForMatlabToExit
echo Matlab exited
exit /b
Thursday, November 25, 2021
Windows batch file: goto vs call
In a Windows batch file, goto label2 command goes to the label2 and continues from the end of label2. call :label2 goes to label2 and after seeing a exit /b (or end of script, eof), returns back right after the call command. In other words, call behaves like a function call in Java, C++ etc. but you have to use exit /b instead of return.
Calling a Matlab function from Windows command line (cmd)
Calling a Matlab function from a Windows cmd batch file is easy if the function has no string arguments. However if the function takes a string argument, you have to use two single quotes around the argument. Example:
start matlab -nosplash -nodesktop -noFigureWindows -r eval("'myFunction(''fileName.txt'')'")
Thursday, November 11, 2021
Bundling JavaScript dependencies into a single JS file
To bundle/embed/include all JS dependencies into a single JS file, you can use webpack.
Module Bundlers Explained... Webpack, Rollup, Parcel, and Snowpack
Wednesday, November 10, 2021
Remote connection and file transfer
The easiest way to connect from Windows to a remote Linux computer is to fire up cmd.exe and type ssh user@ip where user is the Linux user name and ip is the IP address of the Linux computer.
For file transfer, you can use sftp user@ip or scp fileName user@remoteIP/remoteFileName.
ssh, sftp and scp come with Windows 10, you don't have to install anything. Just make sure that SSH is enabled on Linux.
Tuesday, November 9, 2021
Simple way/pattern to separate GUI from model
Prepare your model as a separate executable that reads input from file and writes output to a file. Then you can code your GUI in whatever language you like (e.g. Excel macros) that takes input from user, writes them to file, runs the model executable and reads outputs from file when executable finishes.
This completely decouples GUI from implementation. Compared to a DLL, it has a simpler interface, it will not crash your JVM if there is an error in model, and let's you run models in parallel much easier and also facilitates easy batch run of model executable via scripts.Wednesday, November 3, 2021
Debugging Effort
The hardest part of debugging is finding the root cause of the problem, therefore it is wise to optimize code for debugging, see clean code:
Tuesday, November 2, 2021
memcpy() vs memmove()
When you need to implement removal of an element from an arraylist, don't use memcpy, use memmove. Your program might run fine on Windows but cause trouble in Linux, whose root cause would be hard to find.
memcpy() vs memmove(): in case of memcpy(), there is no extra buffer taken for source memory. The copying is done directly on the memory so that when there is memory overlap, we get unexpected results.
Monday, November 1, 2021
Simulink versions
Matlab release - Simulink version (helpful when you know the Simulink version and wonder which Matlab release it corresponds to):
Wednesday, September 29, 2021
Safety-Critical System Development
Monday, September 27, 2021
Binary string permutations
Previously, I had solved printing all permutations of a string. As part of a programming contest, I solved binary string permutations using C++. What is interesting in this solution is that is uses a simple for loop and obtains each binary permutation by converting a decimal number to a binary number:
Sunday, September 12, 2021
Hiding internal details of a C++ library
When you need to provide your simulation as an external library (dll, lib) to someone, you should simplify the API as much as possible so that you are able to provide the minimal amount of header files, without exposing details the user doesn't care about. You can achieve this by hiding all the internal dependencies in the implementation (cpp) file. If the user has to be able to create multiple (concurrent) simulations, you can use a static map to hold each simulation object. Here is an example (C++11):
Wednesday, July 14, 2021
C++: Using 1 byte enum
By default, enum size in C++ is usually 4 bytes, both in Windows and Linux. If you need to use 1 byte enum, you have to declare it as follows:
enum e : unsigned char { a, b };
This requires at least C++ 11. printf("size = %ld\n", sizeof(e)) will output 1.
If you are using gcc (e.g. Eclipse), you can also use the compiler flag -fshort-enum (Eclipse properties - C/C++ Build - Settings - Tool Settings - GCC C++ Compiler - Miscellaneous) to convert all enums in code to 1 byte, but you won't have that option in Visual Studio. So it is better to use the unsigned char option.
Friday, July 9, 2021
Use memset only with zero
Consider the following C++ definitions:
typedef struct {
int i;
double d[3];
} A_STRUCT
A_STRUCT s;
When I use memset(&s, 0, sizeof(s)), i and d values are set to zero as expected. When I use memset(&s, -1, sizeof(s)), I would expect all values to be -1 but on inspection you will see that they have strange values, in my case i was -1 but d values were -nan. When I use memset(&s, 1, sizeof(s)), I get 16843009 for i and 7.74...e-304 for d values.
Reason: The memset() function writes bytes, not words. So writing 1 to sizeof(int)*100 bytes writes 00000001 to every set of 8-bits.Thus, each integer in binary looks like the following:
0000 0001 0000 0001 0000 0001 0000 0001 (1 int = 4 bytes)
which in decimal is, exactly, 16843009..
memset doesn't only work with 0. It also works with all numbers with identically repeating byte pattern. Like for example ~0.
Tuesday, January 12, 2021
#define considered harmful
In C++, #define has global scope. If you have a #define FAIL (-1) in a header file that you include, you cannot declare a variable named FAIL anywhere else, not even inside a namespace. If you do, you will get the cryptic error message "expected an identifier":
So, don't use define for named constants in C++, use const int etc. If you are using C instead of C++, read this.