Skip to content

snikeguo/EmbedXrpc

Repository files navigation

EmbedXrpc 用户手册

QQ群134161401

这个东西类似于Google的GRPC,但是应用场景是单片机。RPC远程调用极大的方便了开发,使得不必关注于协议解析,数据的序列化和反序列化等繁琐的工作。可是目前还没有在单片机上实现好用的RPC框架,于是我就谋生了做这个RPC框架的想法,所用的技术是:C#做 IDL语言+csscript+自己实现序列化和反序列化+代码生成

应用场景:单片机近距离Client/Server交互场景(USB、串口、CAN(如J1939 、ISO15765协议等),)只要是流协议都支持

Sample1工程是例子!除了main.cpp的代码是手工写的之外,其他的代码都是工具生成的!这是个最简单的例子!

详情请看WIKI

WIKI教程已经写得很清楚,如果还是不懂,还可找我代写IDL文件,V信:snikeguo 适当收费。

一个简单的例子(教程请看WIKI)

1.编写idl文件:sample1.cs

using System;
using EmbedXrpcIdlParser;


[FileName("sample1.cs")]
[Role(RoleType.Client)]
delegate int Add(Int32 a, Int32 b);

[FileName("sample1.cs")]
public class OptionProcess : IOptionProcess
{
    public GenerationOption Process()
    {
        GenerationOption option = new GenerationOption();
        option.OutPutFileName = "Sample1";
        option.CSharpNameSpace = "Sample1";
        return option;
    }
}

2.执行命令,生成客户端(电脑端)的代码和服务端代码(这里假定执行命令中,-g参数你写的是all,而不是单独的client和server),接口所示:

EmbedXrpcIdlParser.exe -i sample1.cs -g all -l cpp-nano -o MyCodeFolder

生成的代码如下:

//----------客户端-----------
class Add_Requester
{
public:
    EmbedXrpcObject *RpcObject = nullptr;
    Add_Requester(EmbedXrpcObject *rpcobj) : RpcObject(rpcobj)
    {
    }
    uint16_t GetSid() { return Add_ServiceId; }
    Add_Parameter Add_SendData;
    Add_Return Add_reqresp;
    Add_Return &Add(UserDataOfTransportLayer_t *userDataOfTransportLayer,int a,int b);
    void Free_Add(Add_Return *response);
};


//----------服务端-----------
class Add_Service : public IService
{
public:
    uint16_t GetSid() { return Add_ServiceId; }
    Add_Return Response;
    virtual void Add(ServiceInvokeParameter *serviceInvokeParameter, Int32 a, Int32 b) {}
    Add_Parameter request;
    void Invoke(ServiceInvokeParameter *serviceInvokeParameter, SerializationManager *recManager, SerializationManager *sendManager);
};

3.服务端(单片机)这边,你需要编写代码:

EmbedXrpcObject ServerRpcObject;//参数我这里省略了

class Inter_AddServiceProvider :public Add_Service
{
public:
    void Add(ServiceInvokeParameter* serviceInvokeParameter,Int32 a, Int32 b)
	{
        Response.ReturnValue= a+b;
	}
};

4.客户端(电脑)这边,你需要编写代码:

EmbedXrpcObject ClientRpcObject;//参数我这里省略了
Add_Requester Client(&ClientRpcObject);//定义request对象
auto val=Client.Add(1,2);//这个函数将会把数据发送到服务器(比如单片机)上
if(val.State==ResponseState_Ok)
{
    UInt16 value=val.ReturnValue;//如果不出意外的话,value的值是3
    //你的代码
}
Client.Free_Add(&val);//最后用完val,记得调用接口对应的释放函数,形如: Free_你的接口()

至此一个完整的RPC调用就完成了 可以看下我自己项目上实现的

auto ThreadsInfo=Dev.Request.GetThreadsInfo();
CheckResponseState(ThreadsInfo);//我自己写的一个宏,就是判断State是否是OK,如果不是OK,就返回错误的,简单辅助宏罢了
printf("...");//打印参数

auto EraseResult=Dev.Request.FlashErase(addr,size);
CheckResponseState(EraseResult);
while(...)
{
  auto WriteResult=Dev.Request.FlashWrite(addr,size,bin);
  CheckResponseState(WriteResult);
}

是不是非常方便~~