Skip to content

kyma-as/api-dashboard

Repository files navigation

SensorShip a Kyma Dashboard Application

A cross platform desktop application for data for vessels in shipping. Used to demonstrate ways a customer may use the sensor data that the Kyma API provides. The application is built using JavaScript with Electron and the Vue framework.

Installation

Requires Yarn

Project setup

yarn install

Compiles and hot-reloads for development

yarn run electron:serve

Compiles and minifies for production

yarn run electron:build

Lints and fixes files

yarn run lint

Customize configuration

See Configuration Reference.

Application Overview

Application Login

Takes an email and a password and converts it into a 64bit api key and authenticates with the Kyma server

Screenshot 2019-07-03 at 13 22 01

Main Vessels Dashboard

Showing graphs over a specified timeframe

Screenshot 2019-07-03 at 13 33 42

Single Vessel Data View

A line-graph showing the speed of a ship over a month

Screenshot 2019-07-03 at 13 25 24

Graph selection with dropdown button

Screenshot 2019-07-03 at 13 34 23

Fuel Report View

Fuel report showing the specific engines' fuel usage over a year displayed monthly

Screenshot 2019-07-03 at 13 18 22

CSV File Printout View

Printing CSV files with the selected variables and granularity over the specified timeframe

Screenshot 2019-07-03 at 13 23 27

API Bulletpoints

Vessels

Lists all vessels and their basic information: /vessels

  • id of vessel
  • name of vessel
  • logData min/max date
  • trendData min/Max date
  • lastExportDate

Log Variables

Finds log variables active on a vessel: /logvariables/find?vesselId={vesselId}

  • id of variable
  • name of variable
  • min/max limit
  • display precision
  • units

Log Data

Finds log data for the specific variable:/logdata/find?logVariableId={logVariableId}&granularity={granularity}&fromDate={fromDate}&toDate={toDate}

  • Granularity: Frequency of data points(Raw, Minute, QuarterHour, Hour, Day)
  • fromDate/toDate: yyyy-mm-dd

About

A demo dashboard application for Kyma Online API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published