24 releases (10 stable)
3.0.0 | Apr 10, 2020 |
---|---|
2.1.2 | Mar 10, 2020 |
2.1.1 | Feb 20, 2020 |
1.0.3 | Jun 25, 2019 |
0.3.1 | Sep 15, 2018 |
#108 in Robotics
54 downloads per month
53KB
1K
SLoC
nt-rs
nt-rs is an implementation of the NetworkTables revision 3 protocol in Rust using Tokio. Currently it is purely a client library. An API for creation of an NT server may come in the future.
Getting Started
This library can be found on https://crates.io and can be added to a project with nt = "0.1.0"
Sample usages can be found in the examples/
directory
What is NetworkTables?
NetworkTables, or NT, is a TCP based protocol for key-value data storage. It is most used within code for FIRST Robotics Competition robots, for sharing data across the robot's network.
Examples
Connecting to a server
let mut nt = NetworkTables::connect("10.TE.AM.2:1735", "nt-rs-client")?;
Creating a server
let mut nt = NetworkTables::bind("0.0.0.0:1735", "nt-rs-server");
Websockets
nt
1.0.0 adds support for clients and servers communicating over websockets. This is locked behind the websocket
feature.
Connecting to a websocket server
let mut nt = NetworkTables::connect_ws("ws://10.TE.AM.2:1735", "nt-ws-client")?;
Creating a websocket server
An existing NetworkTables server is capable of serving websockets if the program is compiled with the websocket feature. In cases where a websocket attempts to connect to a server that has not been configured for websocket clients, it will be sent an error message and the connection will be disconnected.
License
This project is licensed under the MIT license.
Acknowledgements
Thanks to Jess Creighton (https://github.com/jcreigh) for giving me the idea
Dependencies
~6.5MB
~106K SLoC