Conversation
There was a problem hiding this comment.
You can create multi sub-README files in multi-languages, then link the different sub files in the main README file.
refer to https://blog.csdn.net/m0_57236802/article/details/132600529
README.md
Outdated
| @@ -1 +1,9 @@ | |||
| # flexiv_rdk_csharp No newline at end of file | |||
| # flexiv_rdk_csharp | |||
| ## Project Introduction | |||
There was a problem hiding this comment.
FlexivRdkCSharp
<Recommend adding the public license, you can pick a loose license like apache>
For C# developers to easily work with RDK, the APIs of RDK are wrapped in flexiv_rdk_csharp. It uses p/invoke to call most of the functions in the RDK C++ interface excluding the flexiv::rdk::Model and the flexiv::rdk::Scheduler.
References
Flexiv RDK main webpage contains important information like RDK user manual and network setup.
Compatibility
| Supported OS | Supported Visual Studio distribution |
|---|---|
| Windows10 | Visual Studio 2019 <Is the professional version required or personal version?> |
Getting Started
<Recommend listing the steps 1.2.3.... to guide the user to build the project from a newly booted windows system, which means that all the compiler and IDE were not installed, otherwise you will pay much effort to guide them ^_^ >
Example
<Recommend describing the provided examples, e.g. how to build and run >
ReleaseDll/FlexivRdkV151.dll
Outdated
There was a problem hiding this comment.
recommend renaming the file name with patten flexiv_rdk.OS platform-VS version.dll if this dll is only compatible with one OS and platform, e.g. flexiv_rdk.win64-vs2019.dll.
If it's compatible with multi-OS or plat form, then just name to FlexivRdk.
For compatibility with flexiv_rdk, you can describe the compatibility with rdk in your release note after you created a git tag.
There was a problem hiding this comment.
Ok. I will adjust the name of the dynamic library
There was a problem hiding this comment.
This file is really long, recommend moving the lines not used.
There was a problem hiding this comment.
This is automatically generated by the IDE and is relatively stable and reliable
| string robotSN = args[0]; | ||
| try | ||
| { | ||
| var robot = new Robot(robotSN); // Instantiate robot interface |
There was a problem hiding this comment.
recommend moving the comment line above the code
There was a problem hiding this comment.
Ok, I'll adjust the comment position
| string robotSN = args[0]; | ||
| try | ||
| { | ||
| var robot = new Robot(robotSN); // Instantiate robot interface |
There was a problem hiding this comment.
comment line position
There was a problem hiding this comment.
recommend naming the example files with the same style of flexiv_rdk/examples
There was a problem hiding this comment.
The capitalized file name is to comply with the norms recommended by the community, and when a new file is added, a namespace that conforms to the Pascal criterion will be automatically generated. For example, adding a new file under the "example" folder will generate the namespace FlexivRdkCSharp.Example. I will change the name of the sample program to the same as that in rdk c++
| {"lockExternalAxes", 0 } | ||
| }); | ||
| while (!(FlexivDataUtils.TryGet<int>(robot.GetPrimitiveStates(), | ||
| "reachedTarget", out var flag) && flag == 1)) // Wait for reached target |
There was a problem hiding this comment.
comment line position
FlexivRdkDll/FlexivRdkDll.vcxproj
Outdated
| <SDLCheck>true</SDLCheck> | ||
| <PreprocessorDefinitions>NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions> | ||
| <ConformanceMode>true</ConformanceMode> | ||
| <AdditionalIncludeDirectories>D:\flexiv_rdk\rdk_install_v1.5.1\include\eigen3;D:\flexiv_rdk\rdk_install_v1.5.1\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories> |
There was a problem hiding this comment.
Recommend removing the hardcoded include directory
D:\flexiv_rdk\rdk_install_v1.5.1\include\eigen3;D:\flexiv_rdk\rdk_install_v1.5.1\include;%(AdditionalIncludeDirectories
There was a problem hiding this comment.
If the user wants to compile the dynamic library by himself, this part of the configuration needs to be modified by himself. This is a fixed configuration in vs2019. The project already includes dynamic libraries that can be used directly, and users do not need to compile them by themselves. Unless I also add the static libraries compiled by RDK in the project and set the relative references.
FlexivRdkDll/FlexivRdkDll.vcxproj
Outdated
| <EnableCOMDATFolding>true</EnableCOMDATFolding> | ||
| <OptimizeReferences>true</OptimizeReferences> | ||
| <GenerateDebugInformation>true</GenerateDebugInformation> | ||
| <AdditionalLibraryDirectories>D:\flexiv_rdk\rdk_install_v1.5.1\lib;D:\flexiv_rdk\flexiv_rdk\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories> |
There was a problem hiding this comment.
Also here: <AdditionalLibraryDirectories>D:\flexiv_rdk\rdk_install_v1.5.1\lib;D:\flexiv_rdk\flexiv_rdk\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
Are there better ways to let user specify their env themselves?
There was a problem hiding this comment.
The project configuration file can be ignored
2 participants
This is a C# project that uses p/invoke to call the C++ Flexiv Rdk. It uses json to pass the FlexivDataTypes variable type, covering most of the functions in the C++ interface and excluding the Model class and the Scheduler class. Corresponding to Flexiv Rdk v1.5.1.