如何让C#.NET与Arduino项目共用同一份结构体定义文件？

针对C# .NET与Arduino项目共用通信协议定义文件的问题，以下是几种实用方案：

方案一：条件编译+共享文件重命名引用 #

核心思路是用一份包含条件编译指令的共享文件，通过链接引用的方式让两个项目分别识别为对应语言的代码文件。

步骤： #

1. 创建共享协议文件
   新建文件CommonComms.common，用条件编译区分C#和C++语法：

   // 条件编译分支：C++/Arduino
   #if defined(__cplusplus)
   #pragma once
   
   struct __attribute__((packed)) VelocityChange
   {
       const static char ID = 'V';
       float LeftVelocity;
       float RightVelocity;
   };
   
   // 条件编译分支：C#
   #elif defined(__CS__)
   using System;
   using System.Runtime.InteropServices;
   
   namespace Inq.Utils
   {
       [StructLayout(LayoutKind.Sequential, Pack = 1)]
       public struct VelocityChange
       {
           const char ID = 'V';
           float LeftVelocity;
           float RightVelocity;
       };
   }
   #endif
   

   注：添加__attribute__((packed))和StructLayout是为了强制结构体内存对齐一致，避免TCP通信时数据解析错误。

2. C#项目配置

   • 右键项目 → 添加 → 现有项，选中CommonComms.common，点击添加按钮旁的下拉箭头选择添加为链接
   • 选中添加的链接文件，在属性面板中将文件名改为CommonComms.cs，生成操作设为编译
   • 右键项目 → 属性 → 生成，在「条件编译符号」中添加__CS__

3. Arduino项目配置

   • 将CommonComms.common复制到Arduino项目文件夹，重命名为CommonComms.h
   • 在Arduino代码中直接#include "CommonComms.h"即可，Arduino的GCC编译器会自动触发__cplusplus分支

方案二：代码生成工具（适合复杂协议） #

维护一份纯文本格式的协议定义（如JSON/YAML），用脚本自动生成C#和Arduino对应的代码文件，彻底避免手动同步的麻烦。

步骤： #

1. 编写协议定义文件
   新建protocol_def.json，结构化描述所有通信消息：

   {
     "messages": [
       {
         "name": "VelocityChange",
         "id": "'V'",
         "fields": [
           {"type": "float", "name": "LeftVelocity"},
           {"type": "float", "name": "RightVelocity"}
         ]
       }
     ]
   }
   

2. 编写代码生成脚本
   用Python/Shell等写一个简单脚本，读取JSON内容后分别生成C#的.cs和Arduino的.h文件。示例Python片段：

   import json
   
   with open('protocol_def.json', 'r') as f:
       proto = json.load(f)
   
   # 生成C#代码
   cs_content = "using System;\nusing System.Runtime.InteropServices;\n\nnamespace Inq.Utils\n{\n"
   for msg in proto['messages']:
       cs_content += f"    [StructLayout(LayoutKind.Sequential, Pack = 1)]\n"
       cs_content += f"    public struct {msg['name']}\n    {{\n"
       cs_content += f"        const char ID = {msg['id']};\n"
       for field in msg['fields']:
           cs_content += f"        {field['type']} {field['name']};\n"
       cs_content += "    };\n"
   cs_content += "}"
   with open('CommonComms.cs', 'w') as f:
       f.write(cs_content)
   
   # 生成Arduino/C++代码
   cpp_content = "#pragma once\n\n"
   for msg in proto['messages']:
       cpp_content += f"struct __attribute__((packed)) {msg['name']}\n{{\n"
       cpp_content += f"    const static char ID = {msg['id']};\n"
       for field in msg['fields']:
           cpp_content += f"    {field['type']} {field['name']};\n"
       cpp_content += "};\n\n"
   with open('CommonComms.h', 'w') as f:
       f.write(cpp_content)
   

3. 使用流程
   每次新增/修改协议时，只需要编辑protocol_def.json，然后运行脚本即可自动生成两边的代码文件，直接编译使用。

方案三：编译后自动同步（简单场景） #

如果协议变动不频繁，可在C#项目中设置编译后事件，自动将共享文件复制到Arduino项目目录并修改扩展名：

1. 右键C#项目 → 属性 → 生成事件 → 后期生成事件命令行，添加命令：

   copy "$(ProjectDir)CommonComms.common" "$(ArduinoProjectPath)CommonComms.h" /Y
   

2. 替换$(ArduinoProjectPath)为你的Arduino项目实际路径，编译C#项目时会自动同步文件到Arduino端。

内容的提问来源于stack exchange，提问作者Inq