@mxtommy/kip - npm Package Compare versions

Comparing version 2.9.10-beta.1 to 2.10.0-beta.1

CHANGELOG.md

@@ -0,1 +1,16 @@
+# V 2.9.3
+## Improvements
+* Reintroduced High Contrast mode in Settings > General options panel
+* Correct misspellings for units description by @mshulman
+* Tutorial and Help improvements by @mshulman
+* README.md file refresh to reflect latest KIP capabilities
+* README.md file updates improving How To Contribute instructions by @mshulman
+## Fixes
+* Radial Gauge tick value label displayed incorrectly with fractional numbers
+* Radial Gauge automatic range scaling feature creating value indicator position discrepancies
+* Radial and Linear Gauges zone indicators not converted to gauge units settings
+* Steel Style Radial Gauge not displaying zones
+## New Contributors
+* @mshulman made their first contribution
+# V 2.9.2 - retracted due to build issues. Republished as 2.9.3
 # V 2.9.1
@@ -2,0 +17,0 @@ ## Improvements

package.json

 {
   "name": "@mxtommy/kip",
-  "version": "2.9.10-beta.1",
+  "version": "2.10.0-beta.1",
   "description": "An advanced and versatile marine instrumentation package to display Signal K data.",
@@ -48,16 +48,18 @@ "license": "MIT",
   "devDependencies": {
-    "@angular-devkit/build-angular": "^17.2.0",
-    "@angular/animations": "17.2.1",
-    "@angular/cdk": "^17.2.0",
-    "@angular/cli": "^17.2.0",
-    "@angular/common": "17.2.1",
-    "@angular/compiler": "17.2.1",
-    "@angular/compiler-cli": "17.2.1",
-    "@angular/core": "17.2.1",
-    "@angular/forms": "17.2.1",
-    "@angular/language-service": "17.2.1",
-    "@angular/material": "^17.2.0",
-    "@angular/platform-browser": "17.2.1",
-    "@angular/platform-browser-dynamic": "17.2.1",
-    "@angular/router": "17.2.1",
+    "@angular-devkit/build-angular": "^17.3.4",
+    "@angular/animations": "17.3.4",
+    "@angular/cdk": "^17.3.4",
+    "@angular/cli": "^17.3.4",
+    "@angular/common": "17.3.4",
+    "@angular/compiler": "17.3.4",
+    "@angular/compiler-cli": "17.3.4",
+    "@angular/core": "17.3.4",
+    "@angular/forms": "17.3.4",
+    "@angular/language-service": "17.3.4",
+    "@angular/material": "^17.3.4",
+    "@angular/platform-browser": "17.3.4",
+    "@angular/platform-browser-dynamic": "17.3.4",
+    "@angular/router": "17.3.4",
+    "@biacsics/ng-canvas-gauges": "^6.0.14",
+    "@robloche/chartjs-plugin-streaming": "^3.1.0",
     "@types/canvas-gauges": "^2.1.2",
@@ -70,10 +72,8 @@ "@types/hammerjs": "^2.0.45",
     "@types/lodash-es": "^4.17.9",
-    "@types/node": "^20.8.6",
+    "@types/node": "^18.19.30",
     "angular-resize-event": "git+https://[e-mail]/dereekb/angular-resize-event#00ef5139ccd6a02f0afd7639ae1bd365ac8b13f9",
     "angular-split": "^17.2.0",
-    "canvas-gauges": "^2.1.7",
     "chart.js": "^4.4.2",
     "chartjs-adapter-date-fns": "^3.0.0",
     "chartjs-plugin-annotation": "^3.0.1",
-    "@robloche/chartjs-plugin-streaming": "^3.1.0",
     "codelyzer": "^6.0.0",
@@ -104,5 +104,5 @@ "compare-versions": "^5.0.1",
     "tslint": "^6.1.3",
-    "typescript": "^5.3.3",
+    "typescript": "^5.4.5",
     "zone.js": "~0.14.4"
   }
 }

public/3rdpartylicenses.txt

@@ -69,2 +69,27 @@ @angular/animations
 
+@biacsics/ng-canvas-gauges
+MIT
+MIT License
+
+Copyright (c) 2017 Vlad Martynenko <[e-mail]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
 @kurkle/color
@@ -71,0 +96,0 @@ MIT

README.md

@@ -5,2 +5,4 @@ # About KIP
 
+![KIP](./images/kip-1024.png)
+
 # Design Goal
@@ -24,4 +26,4 @@
 ### Touch Devices
-- Swipe left and right to cycle trough your Widget layouts.
-- Double tap to toggle night mode.
+- Swipe left and right to cycle trough your Page layouts.
+- Double tap to toggle Night / Day modes.
 
@@ -31,2 +33,4 @@ ### KIP Mobile App
 
+![KIP PWA mode](./images/kipPhone.png)
+
 To install KIP as an App, first load KIP in the browser. Then follow the steps below:
@@ -46,13 +50,4 @@
 
-## Multiple User Profiles
-  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.
-
 ## User Experience
 
-### Night Mode
-  Keep your night vision with a simple double tap. The below image looks very dark, but at night...it's perfect!
-
-  ![Night mode](./images/KipNightMode-1024x488.png)
-
-## Page Layouts and Configuration
 ### Flexible and Easy
@@ -62,3 +57,3 @@ Meant to build purposeful screen(s) with however many widgets you want, where you want them.
   Quickly split pages into multiple areas, resize and align 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.
-  ![Layouts Configuration Image](./images/KipWidgetConfig-layout-1024x488.png)
+  ![Layouts Configuration Image](./images/KipWidgetConfig-layout-1024.png)
   
@@ -72,23 +67,26 @@ Easy basic widget configuration.
   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.
-  ![Units Configuration Image](./images/KipConfig-Units-1024x488.png) 
+  ![Units Configuration Image](./images/KipConfig-Units-1024.png) 
 
-### Reusable Widget Library
+## Reusable Widget Library
   All KIP Widgets are visual presentation controls that are very versatile with multiple advanced configuration options available to suit your needs:
+  - Numeric display: Create gauges to display any numerical data sent by your system - SOG, Depth, Winds Speed, VMG, refrigerator temperature, weather data, etc.
   - Text display: Create gauges to display any textual data sent by your system - MPPT state, vessel details,Next Waypoint, Fusion radio song information, noon and sun phases, any system components configuration detail or statues available, etc.
-  - Numeric display: Create gauges to display any numerical data sent by your system - SOG, Depth, Winds Speed, VMG, refrigerator temperature, weather data, etc.
-  - Wind gauge: Your typical sailboat wind gauge
-  - Autopilot: Operate your autopilot from any device remotely 
+  - Date display: a timezone aware control with flexible presentation formatting support.
+  - Boolean Control Panel: A switch board to configure and operate remote devices - light switches, bilge pump, solenoid, any Signal K path that support boolean PUT operations.
+
   - Linear gauge: Visually display any numerical data on a vertically or horizontally scale - Tank and reservoir levels, battery remaining capacity, etc.
   - Linear electrical gauge: A visual display for electrical numerical data - chargers, MPPT, shunt, etc.
   - Radial gauge: Visually display any numerical data on a radial scale - heading, compass, Speed, etc.
-  - Radial and linear Steel gauge: Old school look & fell gauges
-  - Button and Switch control: Operate remote devices - light switches, bilge pump, solenoid, any Signal K path that support boolean PUT operations
-  - Date display: a timezone aware control with flexible presentation formatting support 
-  - Race Timer: Track regatta start sequence
-  - Historical datagram chart: Display numerical data over time on a chart
+  - Radial and linear Steel gauge: Old school look & fell gauges.
+
+  - Wind Steering Display: Your typical sailboat wind gauge.
+  - Freeboard-SK Chart Plotter: A high quality Signal K implementation of Freeboard.
+  - Autopilot Head: Operate your autopilot from any device remotely.
+  - Data Chart: Visualize data trends over time.
+  - Race Timer: Track regatta start sequence.
   - Embedded Webpage: A powerful way of integrating any web based content or application within with your KIP layout - Grafana dashboards, Node-RED dashboard, internet weather services, Youtube, Netflix, Twitter, Gmail, your own standalone webapp, you name it!
 
   Get the latest version of KIP to see what's new!
-
-  Widget Types Sample
+### Widget Samples
+  Various
   ![Sample Gauges Image](./images/KipGaugeSample1-1024x545.png)
@@ -99,6 +97,14 @@
 
-  Grafana Embedded Webpage sample 
+  Freeboard-SK Integration
+  ![Freeboard-SK Image](./images/KipFreeboard-SK-1024.png)
+
+  Grafana Integration 
   ![Embedded Webpage Concept Image](./images/KipGaugeSample3-1024x508.png)
 
-  ### Harness The Power Of Data State Notifications
+  ## Night Mode
+  Keep your night vision with a simple double tap. The below image looks very dark, but at night...it's perfect!
+
+  ![Night mode](./images/KipNightMode-1024.png)
+
+  ## Harness The Power Of Data State Notifications
   Stay informed with notifications about the state of the data you are interested in.
@@ -108,8 +114,17 @@ 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
 
+  ## Multiple User Profiles
+  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.
+
+# Connect & Share
+KIP has it's own Discord Signal K channel to get in touch. Join us at https://discord.gg/AMDYT2DQga
+
+# Feature, Ideas, Support
+See KIP's GitHub project for latest feature request.
+https://github.com/mxtommy/Kip/issues
+
+
 # How To Contribute
-
 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
@@ -120,2 +135,4 @@ 1. Install the latest Node version (v16+, v18 recommended)
 4. Configure your IDE's source control to point to your forked KIP instance (With Visual Code, GitHub support is built-in) and get the fork's Master branch locally.
+5. Install `npm` and `node`. On macOS, you can use `brew install node` if you have homebrew.
+6. Install the Angular CLI using `npm install -g @angular/cli`
 
@@ -131,3 +148,3 @@ **Coding**
 1. Fire up your local dev instance with `npm run dev`.
-2. Hit Run/Start Debugging in Visual Code or point your favorite browser to `http://localhost:4200/@mxtommy/kip`
+2. Hit Run/Start Debugging in Visual Code or point your favorite browser to `http://localhost:4200/@mxtommy/kip`. Alternatively to start the dev server and connect using remote devices use such as your phone: `ng serve --configuration=dev --serve-path=/@mxtommy/kip/ --host=<your computer's IP> --port=4200 --disable-host-check`
 3. Voila!
@@ -139,26 +156,6 @@
 **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%
+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.
-
-# Support
-KIP has it's own Discord Signal K channel to get in touch. Join us at https://discord.gg/AMDYT2DQga
-
-# Feature Ideas
- * AIS Widget - Help Wanted
- * Light indicator Widget for Boolean paths
- * Fuel Consumption Widget
- * GPS information Widget - Help Wanted
- * Improve Metadata/Zones support
- * Add a KIP Widget CLI Schematic to automate new Widget creation and facilitate app contributions
- * Improved error logging
- * Retire outdated SteelGauges
- * Upgrade notifications and navigation API to new Signal K Specifications
- * Attitude Indicator Widget - Help Wanted
- * Sailing Polars Widget - Help Wanted
- * More customization options for radial/linear Gauges
- * Pre-created Widgets for commonly used displays

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9048586

increased by7.33%

Worsened metrics

Number of lines in readme file

151

decreased by-1.95%

No dependency changes