@mxtommy/kip 1.3.0 → 2.0.1

package/src/app/signalk-full.service.ts

@@ -1,99 +0,0 @@
-import { Injectable } from '@angular/core';
-
-import { SignalKService } from './signalk.service';
-
-@Injectable()
-export class SignalKFullService {
-
-  constructor(private SignalKService: SignalKService,) { }
-
-
-  processFullUpdate(data) {
-
-    //set self urn
-    this.SignalKService.setSelf(data.self)
-
-    // set Sources
-    //this.SignalKService.setDataFull(data);
-
-    // so we will walk the array recusively
-    this.findKeys(data);
-  }
-
-  findKeys(data, currentPath: string[] = []) {
-    let path = currentPath.join('.');
-
-    if (data === null) { //notifications don't have timestamp... hmmm TODO get notif into tree...
-      return;
-    }
-    if (path == 'sources') { return; } // ignore the sources tree
-    
-    if ( (typeof(data) == 'string') || (typeof(data) == 'number') || (typeof(data) == 'boolean')) {  // is it a simple value?
-      let timestamp = Date.now();
-      let source = 'noSource'
-      this.SignalKService.updatePathData(path, source, timestamp, data);
-      this.SignalKService.setDefaultSource(path, source);
-      return;
-    }     
-    else if ('timestamp' in data) { // is it a timestamped value?
-
-      // try and get source
-      let source: string;
-      if (typeof(data['$source']) == 'string') {
-        source = data['$source'];
-      } else if (typeof(data['source']) == 'object') {
-        source = data['source']['label'];
-      } else {
-        source = 'noSource';
-      }
-      
-      let timestamp = Date.parse(data.timestamp);
-
-
-      // is it a normal value, or a compound value?
-      if ('value' in data) {
-        if (typeof(data['value']) == 'object' && (data['value'] !== null)) {
-          // compound
-          Object.keys(data['value']).forEach(key => {
-            let compoundPath = path+"."+key;
-            this.SignalKService.updatePathData(compoundPath, source, timestamp, data.value[key]);
-            this.SignalKService.setDefaultSource(compoundPath, source);       
-            // try and get metadata.
-            if (typeof(data['meta']) == 'object') {
-              //does meta have one with properties for each one?
-              if (typeof(data.meta['properties']) == 'object' && typeof(data.meta.properties[key]) == 'object') {
-                this.SignalKService.setMeta(compoundPath, data.meta.properties[key]);
-              } else {
-                this.SignalKService.setMeta(compoundPath, data['meta']);
-              }
-            }
-          });
-        } else {
-          //simple
-          this.SignalKService.updatePathData(path, source, timestamp, data.value);
-          this.SignalKService.setDefaultSource(path, source);
-          // try and get metadata.
-          if (typeof(data['meta']) == 'object') {
-            this.SignalKService.setMeta(path, data['meta']);
-          } 
-        }
-      }
-
-      return;
-    }
-    
-    // it's not a value, dig deaper
-    else {
-      // process children
-      let keys = Object.keys(data);
-      let len = keys.length;
-      for (let i = 0; i < len; i += 1) {
-        let newPath = currentPath.slice();
-        newPath.push(keys[i])
-        this.findKeys(data[keys[i]], newPath);
-      }
-    }
-  }
- 
-
-}

package/src/app/signalk-interfaces.ts

@@ -1,129 +0,0 @@
-import { ZoneState } from './app-settings.service';
-
-
-// Metadata, Notification and Stream Subscription type restrictions.
-const states = ["nominal", "normal", "alert", "warn", "alarm", "emergency"] as ["nominal", "normal", "alert", "warn", "alarm", "emergency"];
-type State = typeof states[number];
-
-const types = ["linear", "logarithmic", "squareroot", "power"] as ["linear", "logarithmic", "squareroot", "power"];
-type Type = typeof types[number];
-
-const methods = ["visual", "sound"] as ["visual", "sound"];
-type Method = typeof methods[number];
-
-const formats = ["delta", "full"] as ["delta", "full"];
-export type Format = typeof formats[number];
-
-const policies = ["instant", "ideal", "fixed"] as ["instant", "ideal", "fixed"];
-export type Policy = typeof policies[number];
-
-/**
- * Not used
- */
-export interface IUpdateMessage {
-  source: {
-    label: string;
-    type: string;
-    pgn?: string;
-    src?: string;
-    talker?: string;
-  };
-  timestamp: string;
-  values: {
-    path: string;
-    value: any;
-  }[]
-}
-
-/**
- * SignalK Delta low level raw message interface.
- */
-export interface IDeltaMessage {
-  updates?: IUpdateMessage[];
-  requestId?: string;
-  state?: string;
-  statusCode?: number;
-  context: string;
-  self?: string;
-  version?: string;
-  message?: string;
-  accessRequest?: {
-    permission?: string;
-    token?: string
-  }
-}
-
-/**
- * Kip SignalK path Objects interface. This object is used to contain all server received data
- */
-export interface IPathObject {
-  path: string;
-  defaultSource: string; // default source
-  sources: {
-    [sourceName: string]: { // per source data
-      timestamp: number;
-      value: any;
-    }
-  }
-  meta?: ISignalKMetadata;
-  type: string;
-  state: ZoneState;
-}
-
-/**
- * SignalK Metadata Object interface. Follow URL for full SignalK specification
- * and description of fields:
- * @url https://signalk.org/specification/1.4.0/doc/data_model_metadata.html
- */
-export interface ISignalKMetadata {
-  // normal state value
-  description: string;  //SK base required value
-  units: string;         //SK base required value
-  displayName?: string;
-  longName?: string;
-  shortName?: string;
-  state?: State;
-  timeout?: number;
-  method?: Method[];
-  displayScale?: {      //This object provides information regarding the recommended type and extent of the scale used for displaying values.
-    lower?: number;
-    upper?: number;
-    type?: Type;
-  }
-  // elevated state value
-  alertMethod?: Method[];
-  warnMethod?: Method[];
-  alarmMethod?: Method[];
-  emergencyMethod?: Method[];
-  zones?: {             //This provides a series of hints to the consumer which can be used to properly set a range on a display gauge and also color sectors of a gauge to indicate normal or dangerous operating conditions.
-    state: string;
-    lower?: number;
-    upper?: number;
-    message?: string;
-  }[]
-}
-
-/**
- * Interface for Metadata by Paths
- */
-export interface IPathAndMetaObjects {
-  path: string;
-  meta?: ISignalKMetadata;
-}
-
-/**
- * SignalK Notification Object interface. Follow URL for full SignalK specification
- * and description of fields:
- * @url https://signalk.org/specification/1.4.0/doc/notifications.html
- */
-export interface ISignalKNotification {
-  method: Method[],
-  state: State,
-  message: string
-  timestamp: string,
-}
-
-export interface IPathInfo {
-  path: string;
-
-}

package/src/app/signalk-requests.service.spec.ts

@@ -1,12 +0,0 @@
-import { TestBed } from '@angular/core/testing';
-
-import { SignalkRequestsService } from './signalk-requests.service';
-
-describe('SignalkRequestsService', () => {
-  beforeEach(() => TestBed.configureTestingModule({}));
-
-  it('should be created', () => {
-    const service: SignalkRequestsService = TestBed.get(SignalkRequestsService);
-    expect(service).toBeTruthy();
-  });
-});

package/src/app/signalk-requests.service.ts

@@ -1,180 +0,0 @@
-import { Injectable } from '@angular/core';
-import { Subscription ,  Observable ,  Subject } from 'rxjs';
-
-import { AppSettingsService } from './app-settings.service';
-import { SignalKConnectionService } from './signalk-connection.service';
-import { IDeltaMessage } from './signalk-interfaces';
-import { SignalKDeltaService } from './signalk-delta.service';
-import { NotificationsService } from './notifications.service';
-
-const deltaStatusCodes = {
-  200: "The request was successfully.",
-  202: "The request is awaiting authorization.",
-  400: "Bad Client request format.",
-  401: "The request has not been applied because it lacks valid authentication credentials.",
-  403: "You must be authenticated to send command. Request a Client Authorization Token from Kip configuration. The request must be approved by a SignalK admin in Security > Access Requests.",
-  405: "The server does not support the request.",
-  500: "The request failed.",
-  502: "Something went wrong carrying out the request on the server side.",
-  504: "Timeout on the server side trying to carry out the request."
-}
-export interface skRequest {
-  requestId: string;
-  state: string;
-  statusCode: number;
-  statusCodeDescription?: string;
-  widgetUUID?: string;
-  message?: string;
-}
-
-@Injectable({
-  providedIn: 'root'
-})
-export class SignalkRequestsService {
-
-  private requestStatus = new Subject<skRequest>(); // public Observable passing message post processing
-  private requests: skRequest[] = []; // Private array of all requests.
-
-  constructor(
-    private SignalKConnectionService: SignalKConnectionService,
-    private SignalKDeltaService: SignalKDeltaService,
-    private AppSettingsService: AppSettingsService,
-    private NotificationsService: NotificationsService,
-    ) {
-      let requestsSub: Subscription; // used to get all the requests from signalk-delta while avoiding circular dependencies in services...
-
-      requestsSub = this.SignalKDeltaService.subscribeRequest().subscribe(
-        requestMessage => { this.updateRequest(requestMessage); }
-      );
-
-      let endPointStatus: Subscription; // Monitor if Endpoints are reset and clean up
-      endPointStatus = this.SignalKConnectionService.getSignalKConnectionsStatus().subscribe(
-        signalKConnections => {
-          if (!signalKConnections.rest.status) {
-            this.requests = []; // flush array to clean values that will become stale post error or server reconnect
-          }
-        }
-      );
-    }
-
-  /**
-   * Submit a SignalK server Read/Write authorization request - only required if you need to
-   * submit data to SignalK.
-   *
-   * Once approved, an authorization Token will be sent and automatically saved in the Kip
-   * Config. The authorization is a manual process done on the
-   * server.
-   */
-  public requestAuth() {
-    let requestId = this.newUuid();
-    let accessRequest = {
-      requestId: requestId,
-      accessRequest: {
-        clientId: this.AppSettingsService.getKipUUID(),
-        description: "Kip web app",
-        permissions: "admin"
-      }
-    }
-
-    this.SignalKConnectionService.publishDelta(JSON.stringify(accessRequest));
-    let request = {
-      requestId: requestId,
-      state: null,
-      statusCode: null
-    }
-    this.requests.push(request);
-  }
-
-  /**
-     * Sends request to SignalK server and returns requestId.
-     * @param path SignalK full path. Automatically removes "self" if included in path.
-     * @param value Value to be sent.
-     * @param widgetUUID Optional - Subscriber's Widget UUID to be included as part of
-     * the subscribeRequest Subject response. Enables Widget specific filtering.
-     * @return requestId Identifier for this specific request. Enables Request specific filtering.
-     */
-  public putRequest(path: string, value: any, widgetUUID: string): string {
-    let requestId = this.newUuid();
-    let noSelfPath = path.replace(/^(self\.)/,""); //no self in path...
-    let selfContext: string = "vessels.self";    // hard coded context. Could be dynamic at some point
-    let message = {
-      "context": selfContext,
-      "requestId": requestId,
-      "put": {
-        "path": noSelfPath,
-        "value": value
-      }
-    }
-    this.SignalKConnectionService.publishDelta(JSON.stringify(message)); //send request
-
-    let request: skRequest = {
-      requestId: requestId,
-      state: null,
-      statusCode: null,
-      widgetUUID: widgetUUID,
-    };
-
-    this.requests.push(request); // save to private array pending response with widgetUUID so we can filter response from subscriber
-    return requestId; // return the ID to the Subscriber, if tracking of individual request is required
-  }
-
-  /**
-   * Handles request updates, issue display and logging.
-   *
-   * @param delta SignalK Delta message
-   */
-  private updateRequest(delta: IDeltaMessage) {
-    let index = this.requests.findIndex(r => r.requestId == delta.requestId);
-    if (index > -1) {  // exists in local array
-      this.requests[index].state = delta.state;
-      this.requests[index].statusCode = delta.statusCode;
-      this.requests[index].message = delta.message;
-
-      const currentStatusCode = deltaStatusCodes[delta.statusCode];
-
-      if ((typeof currentStatusCode != 'undefined') && (this.requests[index].statusCode == 200 || this.requests[index].statusCode == 202)) {
-        this.requests[index].statusCodeDescription = currentStatusCode;
-
-        if (this.requests[index].statusCode == 202) {
-          this.NotificationsService.sendSnackbarNotification(this.requests[index].statusCodeDescription);
-          return;
-        }
-        if ((delta.accessRequest !== undefined) && (delta.accessRequest.token !== undefined)) {
-          this.AppSettingsService.setSignalKToken({token: delta.accessRequest.token, new: true});
-          this.NotificationsService.sendSnackbarNotification(delta.accessRequest.permission + ": Read/Write Token request response received from server.");
-          console.log(delta.accessRequest.permission + ": New R/W token response received");
-        }
-      } else {
-        this.NotificationsService.sendSnackbarNotification("Request Error received: " + this.requests[index].statusCode + " - " + deltaStatusCodes[this.requests[index].statusCode] + " - " + this.requests[index].message);
-        console.log("Request Error received: " + this.requests[index].statusCode + " - " + deltaStatusCodes[this.requests[index].statusCode] + " - " + this.requests[index].message);
-      }
-      try {
-        this.requestStatus.next(this.requests[index]);    // Broadcast results
-        this.requests.splice(index, 1);                 // result dispatched, cleanup array
-      } catch (err) {
-        this.requestStatus.error(err);
-        console.log(err);
-        this.requests = []; // flush array to clean values that will become stale post error
-      }
-    } else {
-      this.NotificationsService.sendSnackbarNotification("Received unknown Request delta:\n" + JSON.stringify(delta));
-      console.log("Received unknown Request delta:\n" + JSON.stringify(delta))
-    }
-  }
-
-  /**
-   * Subscribe to SignalK request response. This allows you to inspect server response information such as State, Status Codes and such for further processing logic. Subscription object should be used for the Return :)
-   *
-   * @return Observable if type skRequest.
-   */
-  public subscribeRequest(): Observable<skRequest> {
-    return this.requestStatus.asObservable();
-  }
-
-  private newUuid() {
-    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
-        var r = Math.random()*16|0, v = c == 'x' ? r : (r&0x3|0x8);
-        return v.toString(16);
-    });
-  }
-}

package/src/app/signalk.service.spec.ts

@@ -1,15 +0,0 @@
-import { TestBed, inject } from '@angular/core/testing';
-
-import { SignalkService } from './signalk.service';
-
-describe('SignalkService', () => {
-  beforeEach(() => {
-    TestBed.configureTestingModule({
-      providers: [SignalkService]
-    });
-  });
-
-  it('should be created', inject([SignalkService], (service: SignalkService) => {
-    expect(service).toBeTruthy();
-  }));
-});