Skip to content

Commit 8721e18

Browse files
author
josh
committed
Added more information to the readme
1 parent 12d1951 commit 8721e18

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

readme.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,35 @@
1+
# ROS Serial Arduino library
2+
3+
## Purpose
4+
5+
Installing ROS Serial library into and Arduino IDE can be an involved task. See instructions http://wiki.ros.org/rosserial. If you don't already have ROS installed on your workstation it's difficult to build due to the Catkin workspace requirement. This repo packages the library for the Arduino IDE and PlatformIO in an expected format.
6+
7+
## ROS Serial Description
8+
9+
rosserial is a protocol for wrapping standard ROS serialized messages and multiplexing multiple topics and services over a character device such as a serial port or network socket.
10+
111
Use an Arduino as a ROS publisher/subscriber
212

313
Works with http://wiki.ros.org/rosserial, requires a rosserial node to connect
414

5-
This fork exists for the purpose of implementing MKR1000 support.
15+
## Updating
16+
17+
There is a script to pull in the current changes from https://github.com/ros-drivers/rosserial. It creates a Docker container with ROS and Catkin setup. It then downloads the current version of ROS Serial from Github and builds the libraries. Finally it overwrites the current src files with the new build. Currently there is no automatic testing. So it must be manually tested (to involved to discuss here).
18+
19+
```
20+
./update.sh
21+
```
22+
23+
## Reporting issues
24+
25+
If this repo is out of date feel free to report an issue. However pull requests should be directed to https://github.com/ros-drivers/rosserial. Any changes to this repo would be overwritten by incoming changes from upstream.
26+
27+
## License
28+
29+
Apache 2.0
30+
31+
## Author Information
32+
33+
Joshua Frank [@frankjoshua77](https://www.twitter.com/@frankjoshua77)
34+
<br>
35+
[http://roboticsascode.com](http://roboticsascode.com)

0 commit comments

Comments
 (0)