@mxtommy/kip 1.3.0 → 2.0.0

package/src/app/notifications.service.ts

@@ -1,392 +0,0 @@
-/**
- * This class handles both App notifications Snackbar and SignalK Notifications
- */
-import { Injectable } from '@angular/core';
-import { Subject, BehaviorSubject, Observable, Subscription } from 'rxjs';
-import { ISignalKNotification } from "./signalk-interfaces";
-import { AppSettingsService, INotificationConfig } from "./app-settings.service";
-import { isNull } from 'util';
-
-import { Howl } from 'howler';
-
-const alarmTrack = {
-  1000 : 'notification', //filler
-  1001 : 'alert',
-  1002 : 'warn',
-  1003 : 'alarm',
-  1004 : 'emergency',
-};
-
-
-/**
- * Snack-bar notification message interface.
- */
-export interface AppNotification {
-  message: string;
-  duration: number;
-}
-
-/**
- * Kip Alarm object. Alarm index key is the path string. Alarm contains native SignalK Notification
- * values in and additional feature enhancing alarm properties.
- *
- * @path SignalK alarm path - Defines source of the alarm
- * @ack Optional Alarm acknowledgment property
- * @notification Native SignalK Notification message as Object ISignalKNotification
- */
-export interface Alarm {
-  path: string;
-  type: string;
-  isAck: boolean;
-  notification: ISignalKNotification;
-}
-
-/**
- * Alarm information, some stats used
- */
-export interface IAlarmInfo {
-  audioSev: number;
-  visualSev: number;
-  alarmCount: number;
-  unackCount: number;
-  isMuted: boolean;
-}
-
-@Injectable({
-  providedIn: 'root'
-})
-export class NotificationsService {
-  private notificationServiceSettings: Subscription;
-  private notificationConfig: INotificationConfig;
-
-  private alarms: { [path: string]: Alarm } = {}; // local array of Alarms with path as index key
-  private activeAlarmsSubject = new BehaviorSubject<any>({});
-  private alarmsInfo: BehaviorSubject<IAlarmInfo> = new BehaviorSubject<IAlarmInfo>({
-    audioSev: 0,
-    visualSev: 0,
-    alarmCount: 0,
-    unackCount: 0,
-    isMuted: false
-  });
-  public snackbarAppNotifications: Subject<AppNotification> = new Subject<AppNotification>(); // for snackbar message
-
-  // sounds properties
-  howlPlayer: Howl;
-  activeAlarmSoundtrack: number;
-  activeHowlId: number;
-  isHowlIdMuted: boolean = false;
-
-
-  constructor(
-    private appSettingsService: AppSettingsService,
-    ) {
-    // Observe Notification configuration
-    this.notificationServiceSettings = this.appSettingsService.getNotificationConfigService().subscribe(config => {
-      this.notificationConfig = config;
-      if (this.notificationConfig.disableNotifications) {
-        this.resetAlarms();
-      }
-      if (this.notificationConfig.sound.disableSound) {
-        this.playAlarm(1000); // will stop any playing track if any
-      } else {
-        this.checkAlarms(); //see if any we need to start playing again
-      }
-    });
-
-    // init alarm player
-    this.howlPlayer = this.getPlayer(1000);
-   }
-
-  /**
-   * Display Kip Snackbar notification.
-   *
-   * @param message Text to be displayed.
-   * @param duration Display duration in milliseconds before automatic dismissal.
-   * Duration value of 0 is indefinite or until use clicks Dismiss button. Defaults
-   *  to 10000 of no value is provided.
-   */
-  sendSnackbarNotification(message: string, duration: number = 10000) {
-    this.snackbarAppNotifications.next({ message: message, duration: duration});
-  }
-
-  public subscribeAlarms() {}
-  public unsubscribeAlarms() {}
-  public listAlarms() {}
-
-  /**
-   * Clears all Kip internal Notification Alarm system/array.
-   * Used when server connection is reset/changed or the notification disabled.
-   *
-   * @usageNotes Internal function - Do not use.
-   */
-  public resetAlarms() {
-    this.alarms = {};
-    this.activeAlarmsSubject.next(this.alarms);
-  }
-
-  /**
-   * Returns an Observable of type alarms containing alarms. Used
-   * by observers whom are interested in Alarms such as Widgets and Alarm menu.
-   */
-  public getAlarms(): Observable<any> {
-    return this.activeAlarmsSubject.asObservable();
-  }
-
-  /**
-   * Add new Alarm and send
-   * @param path SignalK path of the notification
-   * @param notification Raw content of the notification message from SignalK server as ISignalKNotification
-   */
-  public addAlarm(path: string, notification: ISignalKNotification) {
-
-    if (/^notifications.security./.test(path)) {
-      return; // as per sbender this part is not ready in the spec - Don't add to alarms
-    }
-
-    if (this.notificationConfig.disableNotifications) { return; }
-
-    if (path in this.alarms) {
-      this.alarms[path].notification = notification;
-    } else {
-      let newAlarm: Alarm = {
-        path: path,         // duplicate from Alarm Object key index for added scope from individual alarm context
-        type: "device",
-        isAck: false,
-        notification: notification,
-      };
-      this.alarms[path] = newAlarm;
-    }
-    this.checkAlarms();
-    this.activeAlarmsSubject.next(this.alarms);
-  }
-
-  /**
-   * Update Alarm notification data (data from SignalK) only. ie. alarm.notification
-   * @param path
-   * @param notification
-   */
-  public updateAlarm(path: string, notification: ISignalKNotification) {
-    this.alarms[path].notification = notification;
-    this.checkAlarms();
-    this.activeAlarmsSubject.next(this.alarms);
-  }
-
-  /**
-  * Deletes one alarm and notifies all observers
-  * @param path String path for the alarm to delete
-  * @return True If path exists, false if not found.
-  */
-  public deleteAlarm(path: string): boolean {
-    if (path in this.alarms) {
-      delete this.alarms[path];
-      this.checkAlarms();
-      this.activeAlarmsSubject.next(this.alarms);
-      return true;
-    }
-    return false;
-  }
-
-  /**
-   * Set Acknowledgement and send to other observers so they can react accordingly
-   * @param path alarm to acknowledge
-   * @param timeout if set will unacknowledge in this time
-   * @return true of alarms found, else false
-   */
-  public acknowledgeAlarm(path: string, timeout: number = 0): boolean {
-    if (path in this.alarms) {
-      this.alarms[path].isAck = true;
-      this.activeAlarmsSubject.next(this.alarms);      
-      if (timeout > 0) {
-        setTimeout(()=>{
-          console.log("unack: "+ path);
-          if (path in this.alarms) {
-            this.alarms[path].isAck = false;
-            this.activeAlarmsSubject.next(this.alarms);
-          }
-        }, timeout);
-      }
-      this.checkAlarms();
-      return true;
-    }
-    return false
-  }
-
-  /**
-   * Checks all alarms for worst state, and sets any visualSev/AudioSev
-   * @returns 
-   */
-  public checkAlarms() {
-    // find worse alarm state
-    let unAckAlarms = 0;
-    let audioSev = 0;
-    let visualSev = 0;
-    for (const [path, alarm] of Object.entries(this.alarms))
-    {
-      if (alarm.isAck) { continue; }
-      unAckAlarms++;
-      let aSev = 0;
-      let vSev = 0;
-
-      //seems ISignalKNotification can sometimes not have method set. (Problem from server?)
-      if (!('method' in alarm.notification)) {
-        continue; // if there's no method, don't alarm...
-      }
-
-      switch (alarm.notification['state']) {
-        //case 'nominal':       // not sure yet... spec not clear. Maybe only relevant for Zones
-        case 'normal':        // information only ie.: engine temperature normal. Not usually displayed
-          if (alarm.notification['method'].includes('sound') && !this.notificationConfig.sound.muteNormal) { aSev = 0; }
-          if (alarm.notification['method'].includes('visual')) { aSev = 0; }
-          break;
-
-        case 'alert':         // user informational event ie.: auto-pilot waypoint reached, Engine Started/stopped, ect.
-          if (alarm.notification['method'].includes('sound') && !this.notificationConfig.sound.muteAlert) { aSev = 1; }
-          if (alarm.notification['method'].includes('visual')) { vSev = 1; }
-          break;
-
-        case 'warn':          // user attention needed ie.: auto-pilot detected Wind Shift (go check if it's all fine), bilge pump activated (check if you have an issue).
-          if (alarm.notification['method'].includes('sound') && !this.notificationConfig.sound.muteWarning) { aSev = 2; }
-          if (alarm.notification['method'].includes('visual')) { vSev = 1; }
-          break;
-
-        case 'alarm':         // a problem that requires immediate user attention ie.: auto-pilot can't stay on course, engine temp above specs.
-          if (alarm.notification['method'].includes('sound') && !this.notificationConfig.sound.muteAlarm) { aSev = 3; }
-          if (alarm.notification['method'].includes('visual')) { vSev = 2; }
-          break;
-
-        case 'emergency':     // safety threatening event ie.: MOB, collision eminent (AIS related), ran aground (water depth lower than keel draft)
-          if (alarm.notification['method'].includes('sound') && !this.notificationConfig.sound.muteEmergency) { aSev = 4; }
-          if (alarm.notification['method'].includes('visual')) { vSev = 2; }
-          break;
-
-        default: // we don;t know this one. Tell the user.
-          aSev = 0;
-          vSev = 0;
-          this.sendSnackbarNotification("Unknown Notification State received from SignalK", 0);
-          console.log("Unknown Notification State received from SignalK\n" + JSON.stringify(alarm));
-      }
-      audioSev = Math.max(audioSev, aSev);
-      visualSev = Math.max(visualSev, vSev);
-    }
-    
-    if (!this.notificationConfig.sound.disableSound) {
-      this.playAlarm(1000 + audioSev);
-    }
-    this.alarmsInfo.next({
-      audioSev: audioSev,
-      visualSev: visualSev,
-      alarmCount: Object.keys(this.alarms).length,
-      unackCount: unAckAlarms,
-      isMuted: this.isHowlIdMuted
-    });
-  }
-
-  getAlarmInfoAsO() {
-    return this.alarmsInfo.asObservable();
-  }
-
-  /**
-   * Observable to receive Kip app Snackbar notification. Use in app.component ONLY.
-   *
-   * @usageNotes To send a Snackbar notification, use sendSnackbarNotification().
-   * Notifications are purely client side and have no relationship or
-   * interactions with the SignalK server.
-   */
-  public getSnackbarAppNotifications() {
-    return this.snackbarAppNotifications.asObservable();
-  }
-
-/**
- * Processes SignalK Delta metadata containing Notifications information and
- * routes to Kip Notification system as Alarms and Notifications.
- *
- * @param path path of message ie. the subject of the message
- * @param notificationValue Content of the message. Must conform to ISignalKNotification interface.
- * @usageNotes This function is internal and should not be used.
- */
-  public processNotificationDelta(path: string, notificationValue: ISignalKNotification) {
-    if (this.notificationConfig.disableNotifications) {
-      return;
-    }
-
-    if (isNull(notificationValue)) {
-      // Alarm removed/cleared on server.
-      if (this.deleteAlarm(path)) {};
-    } else {
-      if (path in this.alarms) {
-        //already know of this alarm. Just check if updated (no need to update doc/etc if no change)
-        if (    (this.alarms[path].notification['state'] != notificationValue['state'])
-              ||(this.alarms[path].notification['message'] != notificationValue['message'])
-              ||(JSON.stringify(this.alarms[path].notification['method']) != JSON.stringify(notificationValue['method'])) ) { // no easy way to compare arrays??? ok...
-          this.updateAlarm(path, notificationValue);
-        }
-      } else {
-        // New Alarm, send it
-        this.addAlarm(path, notificationValue);
-      }
-    }
-  }
-
-  /**
-   * Load player with a specific track in loop mode.
-   * @param track track ID to play. See const for definition
-   */
-   getPlayer(track: number): Howl {
-    this.activeAlarmSoundtrack = track;
-    let player = new Howl({
-        src: ['assets/' + alarmTrack[track] + '.mp3'],
-        autoUnlock: true,
-        autoSuspend: false,
-        autoplay: false,
-        preload: true,
-        loop: true,
-        onend: function() {
-          // console.log('Finished!');
-        },
-        onloaderror: function() {
-          console.log("player onload error");
-        },
-        onplayerror: function() {
-          console.log("player locked");
-          this.howlPlayer.once('unlock', function() {
-            this.howlPlayer.play();
-          });
-        }
-      });
-    return player;
-  }
-
-    /**
-   * mute Howl Player active track ei.: howlId. Note Howl howlId is not the
-   * same as Player Soundtrack TrackId which represents the selected sound file.
-   * @param state sound muted boolean state
-   */
-    mutePlayer(state) {
-      this.howlPlayer.mute(state, this.activeHowlId);
-      this.isHowlIdMuted = state;
-      this.checkAlarms(); //make sure to push updated info tro alarm menu
-    }
-
-   /**
-   * play audio notification sound
-   * @param trackId track to play
-   */
-   playAlarm(trackId: number) {
-    console.log(this.notificationConfig);
-    if (this.activeAlarmSoundtrack == trackId) {   // same track, do nothing
-      return;
-    }
-    if (trackId == 1000) {   // Stop track
-      if (this.howlPlayer) {
-        this.howlPlayer.stop();
-      }
-      this.activeAlarmSoundtrack = 1000;
-      return;
-    }
-    this.howlPlayer.stop();
-    this.howlPlayer = this.getPlayer(trackId);
-    this.activeHowlId = this.howlPlayer.play();
-  }
-
-
-}

package/src/app/object-keys.pipe.spec.ts

@@ -1,8 +0,0 @@
-import { ObjectKeysPipe } from './object-keys.pipe';
-
-describe('ObjectKeysPipe', () => {
-  it('create an instance', () => {
-    const pipe = new ObjectKeysPipe();
-    expect(pipe).toBeTruthy();
-  });
-});

package/src/app/object-keys.pipe.ts

@@ -1,13 +0,0 @@
-import { Pipe, PipeTransform } from '@angular/core';
-
-@Pipe({
-  name: 'objectKeys'
-})
-export class ObjectKeysPipe implements PipeTransform {
-
-  transform(value: any, args?: any): any {
-    return Object.keys(value)//.map(key => value[key]);
-  }
-
-
-}

package/src/app/reset-config/reset-config.component.html

@@ -1,3 +0,0 @@
-<p>
-  reset-config works!
-</p>

package/src/app/reset-config/reset-config.component.spec.ts

@@ -1,25 +0,0 @@
-import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
-
-import { ResetConfigComponent } from './reset-config.component';
-
-describe('ResetConfigComponent', () => {
-  let component: ResetConfigComponent;
-  let fixture: ComponentFixture<ResetConfigComponent>;
-
-  beforeEach(waitForAsync(() => {
-    TestBed.configureTestingModule({
-      declarations: [ ResetConfigComponent ]
-    })
-    .compileComponents();
-  }));
-
-  beforeEach(() => {
-    fixture = TestBed.createComponent(ResetConfigComponent);
-    component = fixture.componentInstance;
-    fixture.detectChanges();
-  });
-
-  it('should be created', () => {
-    expect(component).toBeTruthy();
-  });
-});

package/src/app/reset-config/reset-config.component.ts

@@ -1,31 +0,0 @@
-import { Component, OnInit } from '@angular/core';
-import { ActivatedRoute } from '@angular/router';
-
-
-import { AppSettingsService } from '../app-settings.service';
-
-
-
-@Component({
-  selector: 'app-reset-config',
-  templateUrl: './reset-config.component.html',
-  styleUrls: ['./reset-config.component.css']
-})
-export class ResetConfigComponent implements OnInit {
-
-  constructor(
-    private AppSettingsService: AppSettingsService,
-    private route: ActivatedRoute) { }
-
-    
-  ngOnInit() {
-    this.route.url.subscribe(url => {
-      if (url[0].path == 'demo') {
-        this.AppSettingsService.loadDemoConfig();
-      } else {
-        this.AppSettingsService.resetSettings();
-      }
-    });
-  }
-
-}

package/src/app/root-display/root-display.component.html

@@ -1,4 +0,0 @@
-<layout-split
-    [unlockStatus]=unlockStatus
-    [splitUUID]=currentRootUUID
-    ></layout-split>

package/src/app/root-display/root-display.component.spec.ts

@@ -1,25 +0,0 @@
-import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
-
-import { RootDisplayComponent } from './root-display.component';
-
-describe('RootDisplayComponent', () => {
-  let component: RootDisplayComponent;
-  let fixture: ComponentFixture<RootDisplayComponent>;
-
-  beforeEach(waitForAsync(() => {
-    TestBed.configureTestingModule({
-      declarations: [ RootDisplayComponent ]
-    })
-    .compileComponents();
-  }));
-
-  beforeEach(() => {
-    fixture = TestBed.createComponent(RootDisplayComponent);
-    component = fixture.componentInstance;
-    fixture.detectChanges();
-  });
-
-  it('should be created', () => {
-    expect(component).toBeTruthy();
-  });
-});

package/src/app/root-display/root-display.component.ts

@@ -1,57 +0,0 @@
-import { Component, OnInit, OnDestroy } from '@angular/core';
-import { Subscription } from 'rxjs';
-import { ActivatedRoute } from '@angular/router';
-
-import { AppSettingsService } from '../app-settings.service';
-import { LayoutSplitsService } from '../layout-splits.service';
-
-
-@Component({
-  selector: 'app-root-display',
-  templateUrl: './root-display.component.html',
-  styleUrls: []
-})
-export class RootDisplayComponent implements OnInit, OnDestroy {
-
-  rootUUIDSub: Subscription;
-  currentRootUUID: string = null;
-  pageNumber: number;
-  pageNumberSub: Subscription;
-
-
-  unlockStatusSub: Subscription;
-  unlockStatus: boolean;
-
-  constructor(  private AppSettingsService: AppSettingsService,
-                private LayoutSplitsService: LayoutSplitsService,
-                private route: ActivatedRoute,
-                ) { }
-
-  ngOnInit() {
-
-    this.pageNumberSub = this.route.params.subscribe(params => {
-      this.pageNumber = +params['id'];
-      this.LayoutSplitsService.setActiveRootIndex(this.pageNumber);
-    })
-
-    // when root uuid changes, update page.
-    this.rootUUIDSub = this.LayoutSplitsService.getActiveRootSub().subscribe(
-      uuid => {
-        if (uuid === null) {return; }// no root UUID yet...
-          this.currentRootUUID = uuid;
-        }
-    );
-
-    // get Unlock Status
-    this.unlockStatusSub = this.AppSettingsService.getUnlockStatusAsO().subscribe(
-      unlockStatus => {
-        this.unlockStatus = unlockStatus;
-      }
-    );
-  }
-
-  ngOnDestroy() {
-    this.rootUUIDSub.unsubscribe();
-    this.unlockStatusSub.unsubscribe();
-  }
-}

package/src/app/safe.pipe.ts

@@ -1,16 +0,0 @@
-import { Pipe, PipeTransform } from '@angular/core';
-import { DomSanitizer } from '@angular/platform-browser';
-
-
-@Pipe({
-  name: 'safe'
-})
-
-export class SafePipe implements PipeTransform {
-
-  constructor(private sanitizer: DomSanitizer) { }
-  transform(url) {
-    return this.sanitizer.bypassSecurityTrustResourceUrl(url);
-  }
-
-}

package/src/app/settings/settings.component.css

@@ -1,9 +0,0 @@
-.settingsWindow {
-  padding-left: 0px;
-}
-
-.settingsPanels {
-  display: block;
-  padding: 3px;
-}
-

package/src/app/settings/settings.component.html

@@ -1,25 +0,0 @@
-<mat-tab-group class="settingsWindow">
-  <mat-tab label="SignalK">
-      <app-settings-signalk class="settingsPanels"></app-settings-signalk>
-  </mat-tab>
-  <mat-tab label="Historical Data">
-      <app-settings-datasets class="settingsPanels"></app-settings-datasets>
-  </mat-tab>
-  <!--<mat-tab class="settingsPanels" label="Derived Data">
-      <app-settings-derived></app-settings-derived>
-  </mat-tab> -->
-  <mat-tab label="Units">
-      <app-settings-units class="settingsPanels"></app-settings-units>
-  </mat-tab>
-  <mat-tab label="Zones">
-    <app-settings-zones class="settingsPanels"></app-settings-zones>
-  </mat-tab>
-  <mat-tab label="Notifications">
-      <settings-notifications class="settingsPanels"></settings-notifications>
-  </mat-tab>
-  <mat-tab label="Configuration">
-    <ng-template matTabContent>
-      <app-settings-config class="settingsPanels"></app-settings-config>
-    </ng-template>
-  </mat-tab>
-</mat-tab-group>

package/src/app/settings/settings.component.spec.ts

@@ -1,25 +0,0 @@
-import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
-
-import { SettingsComponent } from './settings.component';
-
-describe('SettingsComponent', () => {
-  let component: SettingsComponent;
-  let fixture: ComponentFixture<SettingsComponent>;
-
-  beforeEach(waitForAsync(() => {
-    TestBed.configureTestingModule({
-      declarations: [ SettingsComponent ]
-    })
-    .compileComponents();
-  }));
-
-  beforeEach(() => {
-    fixture = TestBed.createComponent(SettingsComponent);
-    component = fixture.componentInstance;
-    fixture.detectChanges();
-  });
-
-  it('should be created', () => {
-    expect(component).toBeTruthy();
-  });
-});

package/src/app/settings/settings.component.ts

@@ -1,22 +0,0 @@
-import { Component, OnInit } from '@angular/core';
-
-
-@Component({
-  selector: 'app-settings',
-  templateUrl: './settings.component.html',
-  styleUrls: ['./settings.component.css']
-})
-export class SettingsComponent implements OnInit {
-
-  constructor() { }
-
-
-  ngOnInit() {
-  }
-
- 
-
-
-
-
-}