From 3879c77c57c2248c92ec0313a0e9d3cc413c0bd3 Mon Sep 17 00:00:00 2001 From: Alex van de Sandt Date: Sat, 30 Mar 2019 09:45:28 -0400 Subject: [PATCH] Update README for server --- candid_server/README | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/candid_server/README b/candid_server/README index 0780447..2f0cb78 100644 --- a/candid_server/README +++ b/candid_server/README @@ -1,6 +1,6 @@ # CANdid Server -A server that reads frames from a Controller Area Network (CAN) bus and relays them to connected clients over a TCP connection. +A server that faciliates connections between remote TCP clients and a local CAN bus. Clients are sent frames read off the bus, and may send frames back to the server that are then written to the bus. Repository: https://gitlab.com/avandesa/candid-rs @@ -25,6 +25,8 @@ To run the server on a `vcan0` interface and `localhost`: # ip link set up vcan0 $ candid_server 127.0.0.1:6556 vcan0 ``` +Use [candid_client](https://crates.io/crates/candid_client) to connect to the server. There are examples [in the repository](https://gitlab.com/avandesa/candid-rs) for both sending and receiving frames. + ## Built With * [SocketCAN](https://www.kernel.org/doc/html/v4.16/networking/can.html) - The underlying kernel module. -- 2.51.2