@mxtommy/kip
Advanced tools
An advanced and versatile marine instrumentation package to display Signal K data.
KIP is powerful marine instrumentation package to display Signal K data. KIP, much like modern expensive MFDs, is very flexible and can be split up in any arrangements and display all kinds of data available to Signal K server.
The idea is to replicate the functionality of MFDs such as the B&G Triton, Raymarine i70, or Garmin GMI20.
Simply navigate to http://<Signal K Server URL>:<port>/@mxtommy/kip to load KIP and enjoy it's features remotely on any device.
KIP adjusts to the device type and form factor for the best possible user experience.
Run KIP in full screen, with no browser controls visible, just like regular mobile apps. This feature is supported on most mobile OS. Each browser has it's own way of handling PWA deployments.
To install KIP as an App, first load KIP in the browser. Then follow the steps below:
iOS
Android
If you have different roles on board; captain, skipper, tactician, navigator, engineers or simply different people with different needs, each can tailor as they wish. The use of profiles can also offer the ability to tie specific configuration arrangements to use case or device form factors.
Keep your night vision with a simple double tap. The below image looks very dark, but at night...it's perfect!
Apply your favorite style from the built-in themes gallery.
Modern Dark Theme
Signal K Inspired Theme
Light Blue Theme
NOTE: Request a new theme by sending us inspirational/reference material (web sites, picture, etc.). If we fall in love, we will do it. Even better, branch and contribute yourself. We will assist and guide!
Meant to build purposeful screen(s) with however many widgets you want, where you want them.
Quickly split pages into multiple areas, resize and aligne to your liking, add the widget of your choosing to each area. Need more? Add as many additional pages as you whish to keep your display purposeful. Simply swipe left and right or use the bottom page navigation button to quickly cycle from page to page.
Easy basic widget configuration.
See what Signal K has to offer that you can leverage with widgets. Select it and tweak the display options your your purpose.
Many units are supported. Choose your preferred App defaults, than tweak it widget-by-widget as necessary. KIP will automatically convert the units for you.
All KIP Widgets are visual presentation controls that are very versatile with multiple advanced configuration options available to suit your needs:
Get the latest version of KIP to see what's new!
Widget Types Sample
Electrical and Tank Monitoring Sample
Grafana Embedded Webpage sample
Stay informed with notifications about the state of the data you are interested in. As an example, KIP will notify you (inform, warn, alert) when a water depth or temperature sensors reaches certain levels. In addition to KIP's centralized basic visual and audio notification feature, each Widget offers a tailored visual representation appropriate to their design objectives providing an optimal user experience.
KIP is under MIT license and is built with Nodes and Angular using various open-source assets. All free!
Tools
Linux, Mac, Pi or Windows dev platform supported
Coding
npm install. NPM will read Kip project dependencies (see Steps 2), download and install everything automatically for you.ng build. CLI tool will build KIP.Setup
npm run dev.http://localhost:4200/@mxtommy/kipAs you work on source code and save files, the app will automatically reload in the browser with your latest changes. You also need a running Signal K server for KIP to connect to and receive data.
Apple PWA Icon Generation Use the following tool and command line: npx pwa-asset-generator ./src/svg-templates/KIP-icon.svg ./src/assets/ -i ./src/index.html -m ./src/manifest.json -b "linear-gradient(to bottom, rgba(255,255,255,0.15) 0%, rgba(0,0,0,0.15) 100%), radial-gradient(at top center, rgba(255,255,255,0.40) 0%, rgba(0,0,0,0.40) 120%) #989898" -p 5%
Share Once done with your work, from your fork's working branch, make a GitHub pull request to have your code reviewed, merged and part of the next release.
Communication and Collaboration Join us on Slack -> Signalk-dev / Kip channel. We will hook up and assist as best we can.
FAQs
An advanced and versatile marine instrumentation package to display Signal K data.
The npm package @mxtommy/kip receives a total of 298 weekly downloads. As such, @mxtommy/kip popularity was classified as not popular.
We found that @mxtommy/kip demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.