@mxtommy/kip 1.2.3 → 1.3.0

package/.angulardoc.json

@@ -1,4 +1,4 @@
-{
-  "repoId": "609324d9-e673-438b-bc4d-3b73014f8dbd",
-  "lastSync": 0
+{
+  "repoId": "609324d9-e673-438b-bc4d-3b73014f8dbd",
+  "lastSync": 0
 }

package/CHANGELOG.md

@@ -1,135 +1,145 @@
-# V 1.2.3
-* Fix bug in ng-Gauges initialization
-* Don't error out on missing notification method
-* Add some more help videos
-
-# V1.2.2
-* Option to make historical graphs vertical, thanks ahm4711!
-
-# V1.2.1
-* Fix bad base href in V1.2.0
-
-# V1.2.0
-## Features
-* Zones!!!
-  * Set zones in Settings, give range and state for that range.
-  * Warnings and alarms generated when in range.
-  * Radial / Linear Gauges show zones. Sets colors on gauge and red value on warn/alarm.
-  * Numeric widget alarming on Zones. Red text on warning, flashing red background on alarm.
-* New Data Browser feature!
-* Start of a Help section (still needs some more content, feel free to suggest ideas!)
-* Enable/Disable different notification sounds in settings (normal/warning/alarm/etc)
-* Added choice between numeric and cardinal ticks on compass (0,90,180,270 vs N,E,S,W)
-* Allow paths that do not exist in path input.
-* Added percent unit
-* Optimize font size calculations by up to 50x on numeric widget
-* Added a new color option on linear gauges (No Progress). Makes it just the needle, usefull for example rudder position
-
-## Bugfix/Other
-* Refactor alarms/notification service.
-* Fix blank config version
-* Update Dependencies to latest (Angular 11)
-* Fix full tree API parsing (might not work with very old server versions though...) (commit 30220f0)
-* Fix various small typos / small bugs
-* Position updates are in deg, but KIP expects rad. Convert deg to rad on incoming position data.
-* Fix metadata parsing
-
-# V1.1.2
-* Don't save unlock status in config (not needed)
-* Add hPA/mbar units
-* Fix unit selection on historical widgets
-
-# V1.1.1
-* Fix base Href
-
-# V1.1.0
-* A lot of code cleanup!
-* UI refresh/cleanup
-* Updated dependencies to latest Angular/etc
-* Path selection dropdown in Widget settings modal replaced with auto-complete. Also has path description if available
-* Config has UUID to that instance (for identifying to server)
-* Settings page has updates per second graph
-* Start of support for metadata in widgets
-* additional notifications settings
-* fix Wind gauge wind sectors theming
-* Widget select modal refactor into groups
-
-### V1.0.3
-* updated navbar styling
-* Theme work/cleanup
-* Work on ng gauges
- 
-### V1.0.2
-* Tooltip for long messages, and hide badge when 0 unacked alarms 
-
-### V1.0.1
-* Respect methods for alarms! 
-
-# V1.0.0
-* add ngcanvasgauges and new modern theme (thanks godind!)
-* new Theme change event allowing widgets to subscribe to theme changes (thanks godind!)
-* Historical Graph color change on theme update
-* Update WidgetString to use canvas like numeric widget for dynamic font size
-* Latitude/Longitude Unit format
-* Load / Save config from server!
-* Notifications service for application status (snackbar)
-* Deleting the last widget in a page deletes the page!
-* Signalk Notifications in menubar!
-
-### V0.1.12
-* iFrame to embed something in kip
-* Unit defaults!
-
-### V0.1.11
-* Performance fixes for large numeric widgets
-* Bugfixes
-
-### V0.1.10
-* Numeric Min/Max
-
-
-### V0.1.9
-* Updated NPM dependencies
-* Show connection lost overlay on closed websocket connection
-* Only resize Steelseries Gauges max 1 a second (helps in resizing)
-* Add Frequency Units
-* Put Support! On/Off and Momentary support on boolean state
-* Request R/W token from SignalK Server
-
-### V0.1.8
-* Fix bug related to source parsing in deltas
-
-### V0.1.7
-Note, Any configs stored in browser will be lost as config format has changed.
-* Performance gain in Numeric widget in large fonts
-* Sailgauge updates (laylines, windsectors, general refactor)
-* Simplified source selection in the code
-* Removed Derived Data
-* Added Percentage unit, and stopped showing "no unit" on numeric
-* Updated Angular from v4 to v5 and also all dependencies to latest version
-* Complete re-write of widget settings modal for future ease of coding
-* Complete re-write of unit conversion service. Now if metadata specifies unit, it only offers you compatible units
-* Gauge Background and frame color options!
-* new Signal K Theme
-
-### V0.1.6
-* Hash based routing
-* Start of Boolean state widget
-* default to /signalk in url
-
-### V0.1.5
-* fix select dialogs (missing mat-form-field)
-
-### V0.1.4
-* Fix typo in settings page
-
-### V0.1.1
-* Tutorial Widget
-* fix new page bug (had to reload to access it)
-
-### V0.1
-* Derived Data - true wind and dow
-* Sailgauge (True wind)
-* Demo default config
-* Load/Save Config
-* Get a few themes going, theme wind gauge
+# V 1.3.0
+* Platform update to Node 14, Angular and Angular Material 12
+* Upgrade to Awesomefont6 with new icon style classes update
+* Retired old node-sass in favor of new Sass module
+* Dependecies updated to latest
+* App manifest added, thanks VibroAxe
+* Added new ng server dev configuration with map files enabling debugger breakpoints. Use: ng server --configuration=dev to enable VS Code debugger map file and inline break points.
+* Fixed issue: Latest Master doesn't build #111 - NG-Canvas-Gauge package dependecy
+* Fix Kip N2K Autopilot gauge buttons layout and modes feature. AP Gauge should work with Raymarine Seatalk, N2K APs and SmartPilots connected to Seatalk-STNG-Converter device. Latest n2k-signalk (2.5.2+) and signalk-autopitot (v1.2.5+) plugin are required.
+
+# V 1.2.3
+* Fix bug in ng-Gauges initialization
+* Don't error out on missing notification method
+* Add some more help videos
+
+# V1.2.2
+* Option to make historical graphs vertical, thanks ahm4711!
+
+# V1.2.1
+* Fix bad base href in V1.2.0
+
+# V1.2.0
+## Features
+* Zones!!!
+  * Set zones in Settings, give range and state for that range.
+  * Warnings and alarms generated when in range.
+  * Radial / Linear Gauges show zones. Sets colors on gauge and red value on warn/alarm.
+  * Numeric widget alarming on Zones. Red text on warning, flashing red background on alarm.
+* New Data Browser feature!
+* Start of a Help section (still needs some more content, feel free to suggest ideas!)
+* Enable/Disable different notification sounds in settings (normal/warning/alarm/etc)
+* Added choice between numeric and cardinal ticks on compass (0,90,180,270 vs N,E,S,W)
+* Allow paths that do not exist in path input.
+* Added percent unit
+* Optimize font size calculations by up to 50x on numeric widget
+* Added a new color option on linear gauges (No Progress). Makes it just the needle, usefull for example rudder position
+
+## Bugfix/Other
+* Refactor alarms/notification service.
+* Fix blank config version
+* Update Dependencies to latest (Angular 11)
+* Fix full tree API parsing (might not work with very old server versions though...) (commit 30220f0)
+* Fix various small typos / small bugs
+* Position updates are in deg, but KIP expects rad. Convert deg to rad on incoming position data.
+* Fix metadata parsing
+
+# V1.1.2
+* Don't save unlock status in config (not needed)
+* Add hPA/mbar units
+* Fix unit selection on historical widgets
+
+# V1.1.1
+* Fix base Href
+
+# V1.1.0
+* A lot of code cleanup!
+* UI refresh/cleanup
+* Updated dependencies to latest Angular/etc
+* Path selection dropdown in Widget settings modal replaced with auto-complete. Also has path description if available
+* Config has UUID to that instance (for identifying to server)
+* Settings page has updates per second graph
+* Start of support for metadata in widgets
+* additional notifications settings
+* fix Wind gauge wind sectors theming
+* Widget select modal refactor into groups
+
+### V1.0.3
+* updated navbar styling
+* Theme work/cleanup
+* Work on ng gauges
+ 
+### V1.0.2
+* Tooltip for long messages, and hide badge when 0 unacked alarms 
+
+### V1.0.1
+* Respect methods for alarms! 
+
+# V1.0.0
+* add ngcanvasgauges and new modern theme (thanks godind!)
+* new Theme change event allowing widgets to subscribe to theme changes (thanks godind!)
+* Historical Graph color change on theme update
+* Update WidgetString to use canvas like numeric widget for dynamic font size
+* Latitude/Longitude Unit format
+* Load / Save config from server!
+* Notifications service for application status (snackbar)
+* Deleting the last widget in a page deletes the page!
+* Signalk Notifications in menubar!
+
+### V0.1.12
+* iFrame to embed something in kip
+* Unit defaults!
+
+### V0.1.11
+* Performance fixes for large numeric widgets
+* Bugfixes
+
+### V0.1.10
+* Numeric Min/Max
+
+
+### V0.1.9
+* Updated NPM dependencies
+* Show connection lost overlay on closed websocket connection
+* Only resize Steelseries Gauges max 1 a second (helps in resizing)
+* Add Frequency Units
+* Put Support! On/Off and Momentary support on boolean state
+* Request R/W token from SignalK Server
+
+### V0.1.8
+* Fix bug related to source parsing in deltas
+
+### V0.1.7
+Note, Any configs stored in browser will be lost as config format has changed.
+* Performance gain in Numeric widget in large fonts
+* Sailgauge updates (laylines, windsectors, general refactor)
+* Simplified source selection in the code
+* Removed Derived Data
+* Added Percentage unit, and stopped showing "no unit" on numeric
+* Updated Angular from v4 to v5 and also all dependencies to latest version
+* Complete re-write of widget settings modal for future ease of coding
+* Complete re-write of unit conversion service. Now if metadata specifies unit, it only offers you compatible units
+* Gauge Background and frame color options!
+* new Signal K Theme
+
+### V0.1.6
+* Hash based routing
+* Start of Boolean state widget
+* default to /signalk in url
+
+### V0.1.5
+* fix select dialogs (missing mat-form-field)
+
+### V0.1.4
+* Fix typo in settings page
+
+### V0.1.1
+* Tutorial Widget
+* fix new page bug (had to reload to access it)
+
+### V0.1
+* Derived Data - true wind and dow
+* Sailgauge (True wind)
+* Demo default config
+* Load/Save Config
+* Get a few themes going, theme wind gauge

package/CONTRIBUTORS.md

@@ -1,16 +1,16 @@
-KIP contributors (sorted alphabetically)
-============================================
-
-* **[ahm4711](https://github.com/ahm4711)**
-  * Vertical historical graphs
-
-* **[David Godin](https://github.com/godind)**
-
-  * Integration of Canvas-Gauges
-  * A lot of UI polishing and code cleanup
-  * Additional Customization of gauges
-  * Metadata/Zones work
-
-* **[Thomas St-Pierre](https://github.com/mxtommy)**
-
-  * Original Author and maintainer
+KIP contributors (sorted alphabetically)
+============================================
+
+* **[ahm4711](https://github.com/ahm4711)**
+  * Vertical historical graphs
+
+* **[David Godin](https://github.com/godind)**
+
+  * Integration of Canvas-Gauges
+  * A lot of UI polishing and code cleanup
+  * Additional Customization of gauges
+  * Metadata/Zones work
+
+* **[Thomas St-Pierre](https://github.com/mxtommy)**
+
+  * Original Author and maintainer

package/README.md

@@ -1,102 +1,102 @@
-# Kip 
-
-This is a marine instrumentation package to display signalK data. Display can be split up in any arrangement to show any kind data available on the server.
-
-# Design Goal
-
-The idea is to replicate the functionality of your average MFD such as the B&G Triton, Raymarine i70, or Garmin GMI20.
-- Display should be fullscreen and not require any scrolling
-- Anything displayed should be as big as possible in the given space
-- Touchscreen user experience should be excellent
-- Layout and configuration should be both easy to operate and flexible
-- Compatibility with Chromium browser and other device form factor important (**HELP WANTED)  
-
-# Features
-## User Experience
-### Built-in Theme Sample
-  Request a theme and send us inspirational/reference material (web sites, picture, etc.). If we fall in love, we will do it. Even better, branch and contribute. We will assist and guide!
-
-  Modern Dark Theme
-  ![Modern Dark Theme](./KipSample-1-1024x488.png)
-  
-  SignalK Inspired Theme
-  ![SignalK Inspired Theme](./KipSample-2-1024x488.png)
-  
-  Light Blue Theme
-  ![Light Blue Theme](./KipSample-3-1024x488.png)
-
-### Accessible Night Mode
-  Keep your night vision with a quick Night Mode access button, regardless of the selected theme. The below image looks very dark, but at night...it's perfect!
-
-  ![Light Blue Theme](./KipNightMode-1024x488.png)
-
-
-## Gauge Layout and Configuration
-### Flexible and Easy
-  Built purposeful screen(s) with however many gauges you want, where you want them. 
-
-  Split or delete gauge zones, resize and position, then simply add the gauge of your choosing. Add as many pages as you whish to keep screens purposeful.
-  ![Layouts Configuration Image](./KipWidgetConfig-layout-1024x488.png)
-  
-  Easy basic gauge config.
-  ![Gauges Configuration Image](./KipConfig-display-1024x488.png) 
-  
-  See what SignalK has to offer that you can leverage in a gauge. Select it and tweak the display options for your purpose.
-  ![Paths Configuration Image](./KipWidgetConfig-paths-1024x488.png)
-  
-  Many units are supported. Choose your prefered App defaults, than tweak it gauge by gauge as necessary. Kip will convert the displayed units for you.
-  ![Units Configuration Image](./KipConfig-Units-1024x488.png) 
-
-### Reusable Gauge Library
-  Get the latest version of Kip to see what's new!
-
-  Sample gauge types
-  ![Sample Gauges Image](./KipGaugeSample-1-1024x545.png)
-  
-  Electrical and Tank monitoring sample 
-  ![Electrical Concept Image](./KipMonitor-1024x488.png)
-
-# Developing
-
-Kip is built on Angular using various open-source assets. All free!
-
-**Tools**
-
-Linux, Macs, Pi or Windows dev platform supported
-1. Install the latest Node version
-2. Download you favorite coding IDE (we use the free Visual Code)
-3. Create your own GitHub Kip fork and configure your IDE source control to point to this Fork (With Visual Code, GitHub support is built-in)
-
-**Setup**
-1. Create a GitHub Branch of your own Kip Fork
-2. Checkout this new Branch to get the source code locally.
-3. In a command shell (or in the Visual Code Terminal window), go to the root of you local project folder.
-4. Install project dependencies using NPM package and dependency manager: run `npm install`. NPM will read local Kip project dependencies (see Steps 2), download and install everything automatically for you.
-5. Build the app locally using Angular-CLI: from that same project root folder, run `ng build`. CLI tool will read local Kip project configuration (see Tools - steps 4) and build everything.
-
-**Work**
-1. Fire up your local dev instance with CLI using `ng serve`.
-2. Point your favorite browser to `http://localhost:4200/` and voila!
-
-*As you work on source code and save files, the app will automatically reload in the browser with your latest changes.*
-
-**Publish**
-1. From your Fork's working Branch, make a GitHub pull request to have your code reviewed, merged and part of the next release. 
-
-Or
-
-2. Build your own version:
-  1. Use the `-prod` flag for a production build.
-  2. To generate a npm package, run `npm run-script build-npm`.
-  3. Warning: Git Bash seems to mess up Base Href, fix it in public/index.html if needed
-  4. Deploy and have fun! 
-
-**Collaborate**
-Join us on Slack -> SignalK-dev / Apps_and_client channel. We will hook up and assist as best we can.
-
-# Feature Ideas
- * More Customization options for Historical Charts
- * Attitude Indicator
- * Sailing Polars with ChartJS Radar type chart?
- * More Customization options for radial/linear Gauges
- * Pre-created widgets for commonly used displays
+# Kip 
+
+This is a marine instrumentation package to display signalK data. Display can be split up in any arrangement to show any kind data available on the server.
+
+# Design Goal
+
+The idea is to replicate the functionality of your average MFD such as the B&G Triton, Raymarine i70, or Garmin GMI20.
+- Display should be fullscreen and not require any scrolling
+- Anything displayed should be as big as possible in the given space
+- Touchscreen user experience should be excellent
+- Layout and configuration should be both easy to operate and flexible
+- Compatibility with Chromium browser and other device form factor important (**HELP WANTED)  
+
+# Features
+## User Experience
+### Built-in Theme Sample
+  Request a theme and send us inspirational/reference material (web sites, picture, etc.). If we fall in love, we will do it. Even better, branch and contribute. We will assist and guide!
+
+  Modern Dark Theme
+  ![Modern Dark Theme](./KipSample-1-1024x488.png)
+  
+  SignalK Inspired Theme
+  ![SignalK Inspired Theme](./KipSample-2-1024x488.png)
+  
+  Light Blue Theme
+  ![Light Blue Theme](./KipSample-3-1024x488.png)
+
+### Accessible Night Mode
+  Keep your night vision with a quick Night Mode access button, regardless of the selected theme. The below image looks very dark, but at night...it's perfect!
+
+  ![Light Blue Theme](./KipNightMode-1024x488.png)
+
+
+## Gauge Layout and Configuration
+### Flexible and Easy
+  Built purposeful screen(s) with however many gauges you want, where you want them. 
+
+  Split or delete gauge zones, resize and position, then simply add the gauge of your choosing. Add as many pages as you whish to keep screens purposeful.
+  ![Layouts Configuration Image](./KipWidgetConfig-layout-1024x488.png)
+  
+  Easy basic gauge config.
+  ![Gauges Configuration Image](./KipConfig-display-1024x488.png) 
+  
+  See what SignalK has to offer that you can leverage in a gauge. Select it and tweak the display options for your purpose.
+  ![Paths Configuration Image](./KipWidgetConfig-paths-1024x488.png)
+  
+  Many units are supported. Choose your prefered App defaults, than tweak it gauge by gauge as necessary. Kip will convert the displayed units for you.
+  ![Units Configuration Image](./KipConfig-Units-1024x488.png) 
+
+### Reusable Gauge Library
+  Get the latest version of Kip to see what's new!
+
+  Sample gauge types
+  ![Sample Gauges Image](./KipGaugeSample-1-1024x545.png)
+  
+  Electrical and Tank monitoring sample 
+  ![Electrical Concept Image](./KipMonitor-1024x488.png)
+
+# Developing
+
+Kip is built on Angular using various open-source assets. All free!
+
+**Tools**
+
+Linux, Macs, Pi or Windows dev platform supported
+1. Install the latest Node version
+2. Download you favorite coding IDE (we use the free Visual Code)
+3. Create your own GitHub Kip fork and configure your IDE source control to point to this Fork (With Visual Code, GitHub support is built-in)
+
+**Setup**
+1. Create a GitHub Branch of your own Kip Fork
+2. Checkout this new Branch to get the source code locally.
+3. In a command shell (or in the Visual Code Terminal window), go to the root of you local project folder.
+4. Install project dependencies using NPM package and dependency manager: run `npm install`. NPM will read local Kip project dependencies (see Steps 2), download and install everything automatically for you.
+5. Build the app locally using Angular-CLI: from that same project root folder, run `ng build`. CLI tool will read local Kip project configuration (see Tools - steps 4) and build everything.
+
+**Work**
+1. Fire up your local dev instance with CLI using `ng serve --configuration=dev`.
+2. Point your favorite browser to `http://localhost:4200/` and voila!
+
+*As you work on source code and save files, the app will automatically reload in the browser with your latest changes.*
+
+**Publish**
+1. From your Fork's working Branch, make a GitHub pull request to have your code reviewed, merged and part of the next release. 
+
+Or
+
+2. Build your own version:
+  1. Use the `-prod` flag for a production build.
+  2. To generate a npm package, run `npm run-script build-npm`.
+  3. Warning: Git Bash seems to mess up Base Href, fix it in public/index.html if needed
+  4. Deploy and have fun! 
+
+**Collaborate**
+Join us on Slack -> SignalK-dev / Apps_and_client channel. We will hook up and assist as best we can.
+
+# Feature Ideas
+ * More Customization options for Historical Charts
+ * Attitude Indicator
+ * Sailing Polars with ChartJS Radar type chart?
+ * More Customization options for radial/linear Gauges
+ * Pre-created widgets for commonly used displays