Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sbender9 committed Feb 1, 2020
1 parent ce215b0 commit 8b465dd
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# signalk-autopilot

[![Greenkeeper badge](https://badges.greenkeeper.io/sbender9/signalk-autopilot.svg)](https://greenkeeper.io/)

<p align="center"><img src="./small-rayremote.png"></p>

`signalk-autopilot` is composed of 2 modules:
Expand All @@ -14,6 +12,8 @@ This current only supports Raymarine NMEA 2000 Autopilots, but I'll be adding su

All messages to plugin are done using PUT requests. These can be done via HTTP or over WebSockets.

Detailed info on [PUT](https://signalk.org/specification/1.3.0/doc/put.html) and [Request/Response](https://signalk.org/specification/1.3.0/doc/request_response.html)

Http:

```
Expand All @@ -28,7 +28,7 @@ Delta:
```
{
"context": "vessels.self",
"correlationId": "184743-434373-348483",
"requestId": "184743-434373-348483",
"put": {
"path": "steering.autopilot.target.headingMagnetic",
"value": 1.52
Expand Down Expand Up @@ -67,10 +67,9 @@ PUT http://localhost:3000/signalk/v1/api/vessels/self/steering/autopilot/actions
}
```

## Take a tack to port or starboard
## Tack to port or starboard

The `value` is `port` or `starboard`.
This command must be send only when your pilot is in `auto` or `wind` mode.

```
PUT http://localhost:3000/signalk/v1/api/vessels/self/steering/autopilot/actions/tack
Expand Down

0 comments on commit 8b465dd

Please sign in to comment.