Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 1.67 KB

README.md

File metadata and controls

65 lines (38 loc) · 1.67 KB

Sailsd

Build status: BuildStatus

Sailsd - designed to be run with boatd.

Installing

Make sure libsailing is installed by cloning this repository with

$ git clone --recursive https://github.com/sails-simulator/sailsd.git

Install dependencies (jansson for JSON parsing), then run make.

Alternatively, install Nix and run

$ nix-env -i sailsd

Protocol

Sailsd uses a simple protocol consisting of JSON blobs sent over TCP.

Example valid messages to send to sailsd:

{"request": ["version"]}

{"request": ["latitude"]}

{"request": ["latitude", "longitude"]}

{"set": {"rudder": 0}}

{"set": {"rudder": 0, "sail": 10}}

{"set": {"latitude": 0, "longitude": 0}}

{"set": {"running": false}}

Code styling

Sailsd uses astyle to automate style conformity. Run:

$ astyle --style=google --indent-switches sailsd.c

Licence

Copyright © 2014-2016 Louis Taylor

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.