Browse Source

Add link to PixelHub protocol in README. Also, *sped -> spec in the last commit.

master
Starbeamrainbowlabs 4 years ago
parent
commit
e142105b6f
1 changed files with 1 additions and 9 deletions
  1. +1
    -9
      README.md

+ 1
- 9
README.md View File

@ -3,15 +3,7 @@
A combination of a C# server and an arduino program that allows the control of a Hull Pixelbot.
## PixelHub Cilent protocol
The PixelHub client protocol is a (mostly) text-based protocol that the server uses to give the robot instructions. One instruction or message is passed per line (and line endings are '\n'). The message flow works something like this:
(todo: diagram here :D)
1. The server sends a command ot the robot
2. The robot sends back to say whether it will/can execute the command
3. The robot executes the command
4. The robot messages back to say it's finished executing a given command.
The PixelHub client protocol is a (mostly) binary-based protocol that the server uses to talk to the PixelBot and give it instructions. It is documented in the [PixelHub Protocol](PixelHub Protocol.md) file.
## Split-brain robots