README.md

SpireMS

介绍

Spire消息系统，一个类似ROS的轻量化消息发布、订阅软件包，支持图像、雷达等传感器话题。

安装教程

Python安装

1. 安装（命令行执行）

pip install spirems

2. 引入（Python代码）

from spirems import Subscriber, Publisher, def_msg

C++安装（Ubuntu系统）

1. 依赖项安装，如果已经安装cmake、opencv则可以忽略以下2行

sudo apt update
sudo apt -y install cmake libopencv-dev

2. 源码安装

git clone https://gitee.com/jario-jin/spirems.git
cd spirems/spirems_cpp
mkdir build && cd build
cmake ..
sudo make install

3. 在自己项目的CMakeLists.txt中引入SpireMS

find_package(SpireMS REQUIRED)
include_directories(${SpireMS_INCLUDE_DIRS})
target_link_libraries(YourAppName ${SpireMS_LIBS})

使用说明

Python使用说明

1. 启动Core服务

smscore

2. 发布话题

from spirems import Publisher, def_msg
import time
pub = Publisher('/topic/hello', 'std_msgs::String')
msg = def_msg('std_msgs::String')
while True:
    msg['data'] = 'hello world!'
    pub.publish(msg)
    time.sleep(1)

3. 订阅话题

from spirems import Subscriber

def callback_f(msg):
    print(msg['data'])

sub = Subscriber('/topic/hello', 'std_msgs::String', callback_f)

C++使用说明

1. 启动Core服务（命令行方式，也可以用Python中的启动方式，启动一次即可）

smscore

2. 发布话题

#include <sms_core.h>

int main(int argc, char *argv[])
{
    sms::Publisher pub("/topic/hello", "std_msgs::String");
    nlohmann::json msg = sms::def_msg("std_msgs::String");
    
    while (true)
    {
        msg["data"] = "hello world!";
        pub.publish(msg);
        sleep(1);
    }
}

3. 订阅话题

#include <sms_core.h>

void callback(nlohmann::json msg)
{
    std::cout << msg["data"] << std::endl;
}

int main(int argc, char *argv[])
{
    sms::Subscriber sub("/topic/hello", "std_msgs::String", callback);
    sub.join();
    return 0;
}

命令行控制

1. 显示所有话题

sms list

2. 打印话题

sms echo /topic/hello

3. 打印话题频率

sms hz /topic/hello

4. 打印参数服务器所有参数

smsparam list

5. 在线更新参数

smsparam set param_key param_value

6. 导出所有参数

smsparam export output.json

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request