An open API service indexing awesome lists of open source software.

https://github.com/nohal/signalkcat

A simple tool to test SignalK websocket servers.
https://github.com/nohal/signalkcat

Last synced: 3 months ago
JSON representation

A simple tool to test SignalK websocket servers.

Awesome Lists containing this project

README

        

# SignalKCat

Tool to dump data served by a SignalK websocket server.

[![Build Status](https://travis-ci.org/nohal/signalkcat.svg?branch=master)](https://travis-ci.org/nohal/signalkcat)
[![Coverity Scan](https://img.shields.io/coverity/scan/8281.svg)](https://scan.coverity.com/projects/nohal-signalkcat)

## Usage:
```
signalkcat [--port=

] [--ssl] [-k] [-v ] [-d ] [-l]
```

### Minimal usage example:
```
signalkdump localhost
```

### TLS support:
```
signalkdump localhost --ssl
```

To get additional diagnosting information, invoke with a high value for the ```-d``` parameter, like 1023.

## Building

### Linux
You must have libwebsockets installed, on Debian based distributions, use ```sudo apt-get install libwebsockets```.

The build was tested with libwebsockets version 1.6 and 1.7, version 1.2.2 (as in Jessie and all but recent Ubuntus) is known not to work at this moment. You may try the packages from https://launchpad.net/~acooks/+archive/ubuntu/libwebsockets6/+packages

Build signalkcat executable by invoking ```make```

If you want to install the tool, invoke ```sudo make install```

Building a statically linked binary: ```make static```

### Mac OS X
You must have libwebsockets installed, the easiest is to get it from Homebrew using ```brew install libwebsockets```

Build signalkcat executable by invoking ```make```

If you want to install the tool, invoke ```make install```

### MS Windows
TBD

## TODO
* Switch to cmake