Mobile app using Ionic 2 and SteelSeries to promote the use of Signal K, a modern and open data format for marine use. Signal K Mobile runs on iOS and Android and is available on both app stores.
JavaScript TypeScript Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
hooks
resources
typings
www
.editorconfig
.gitignore
LICENSE
README.md
config.xml
gulpfile.js
ionic.config.json
package.json
tsconfig.json
tslint.json
typings.json

README.md

Signal K Mobile

Signal K Mobile is a reference mobile app implementation written in Ionic2 for Signal K, an open data format for marine use. Signal K is NMEA0183 and NMEA2000 compatible, friendly to WiFi, cellphones, tablets and the Internet.

Signal K Mobile requires a Signal K compatible server on the local network. Main features are:

  • Supports both iOS and Android. Can be ported to other platforms Ionic supports (possibly without Bonjour/mDNS support) fairly easily.
  • Available on Apple App Store and Google Play.
  • Detects Signal K server on the network using Bonjour/mDNS. If the server does not advertise itself, an address can be provided manually.
  • Displays AIS vessels on Google Maps (requires Internet connectivity for the base map).
  • Displays depth, speed, course, wind speed and direction (both apparent and true).
  • Displays temperature, humidity and pressure readings when they are available (Check this tutorial to make your own DIY sensors on a Raspberry Pi).
  • Re-connects automatically if the server connection goes down and visually indicates if the connection is up or down.
  • IMPORTANT NOTE: This is not a navigation app and should not be used for such purpose.

Installation

Signal K Mobile requires Ionic and Cordova, refer to Ionic instructions on setting it up. In very basic terms:

$ npm install -g ionic
$ npm install -g cordova

Building Signal K Mobile for iOS requires Xcode (therefore OS X). Building for Android requires the Android SDK. Make sure you follow the Ionic and Cordova installation instructions carefully and only proceed when it is complete.

When Ionic and Cordova are properly installed:

$ git clone https://github.com/itemir/signalk-mobile
$ cd signalk-mobile
$ npm install
$ ionic state restore

You can now launch it in development mode on your web browser (Bonjour/mDNS detection will not work in browser mode, you need to provide the server manually).

$ ionic serve

Assuming Cordova, XCode and/or Android SDK is properly installed, you can run the Signal K Mobile on an emulator or on your device:

$ ionic emulate ios
$ ionic emulate android
$ ionic run ios
$ ionic run android

When you build for iOS, if you receive the below error, open the project in XCode ("signalk-mobile/platforms/ios/Signal K.xcodeproj") and when prompted, click to convert to Switch 3 syntax.

“Use Legacy Swift Language Version” (SWIFT_VERSION) is required to be configured correctly for targets which use Swift. Use the [Edit > Convert > To Current Swift Syntax…] menu to choose a Swift version or use the Build Settings editor to configure the build setting directly.