0.3.2 weight

Author: RobTillaart

libraries/weight/.github/workflows/arduino-lint.yml

@@ -6,8 +6,8 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v4
-      - uses: arduino/arduino-lint-action@v1
+      - uses: actions/checkout@v5
+      - uses: arduino/arduino-lint-action@v2
         with:
           library-manager: update
           compliance: strict

libraries/weight/.github/workflows/arduino_test_runner.yml

@@ -8,7 +8,7 @@ jobs:
     timeout-minutes: 20
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

libraries/weight/.github/workflows/jsoncheck.yml

@@ -5,13 +5,15 @@ on:
     paths:
       - '**.json'
   pull_request:
+    paths:
+      - '**.json'
 
 jobs:
   test:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: json-syntax-check
         uses: limitusus/json-syntax-check@v2
         with:

libraries/weight/CHANGELOG.md

@@ -6,9 +6,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
-## [0.3.1] - 2023-11-23
+## [0.3.2] - 2025-08-27
+- update github actions
 - update readme.md
+- minor edits
 
+## [0.3.1] - 2023-11-23
+- update readme.md
 
 ## [0.3.0] - 2023-08-29
 - rename class **weightConvertor** to **weightConverter**

libraries/weight/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2024 Rob Tillaart
+Copyright (c) 2020-2025 Rob Tillaart
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

libraries/weight/README.md

@@ -22,7 +22,7 @@ Open for additions, including obscure weight metrics or
 weight related math functions and constants.
 
 
-#### Overview of conversions:
+### Overview of conversions:
 
 ```
           stone - lbs - ounce
@@ -34,7 +34,7 @@ weight related math functions and constants.
 ```
 
 
-#### Related
+### Related
 
 - https://github.com/RobTillaart/AtomicWeight
 - https://github.com/RobTillaart/VolumeConverter
@@ -55,14 +55,14 @@ Functions are straightforward.
 - **float ounce2gram(float ounce)**
 - **float gram2ounce(float gram)**
 - **float gram2kilo(float gram)**
-- **float kilo2gram( float kilo)**
+- **float kilo2gram(float kilo)**
 - **float lbs2ounce(float lbs)**
 - **float ounce2lbs(float ounce)**
 - **float stone2lbs(float stone)**
 - **float lbs2stone(float lbs)**
 - **float stone2kilo(float stone)**
 - **float kilo2stone(float kilo)**
-- **float US2metric(float stone, float lbs, float ounce)**
+- **float US2metric(float stone, float lbs, float ounce)** returns kg.
 - **float metric2US(float kilo, float &stone, float &lbs, float &ounce)**
 
 
@@ -89,17 +89,58 @@ Internal representation is the gram as it the ISO standard.
 Since version 0.3.0 the converter can also add different units.
 
 
+### Example
+
+To convert from one less known format to another just takes two calls, example:
+
+```cpp
+  weightConverter wc;
+
+  wc.setStone(24.2);
+  float x = wc.getRobie();
+```
+
+If you need to convert a lot of data between two formats, it is also possible to 
+pre-calculate a factor so the conversion is faster.
+On an UNO R3 the gain goes up to 20%.
+
+
+```cpp
+  weightConverter wc;
+
+  wc.setGram(1);  //  any non zero value will work.
+  float factor = wc.getRobie() / wc.getStone();
+  sum = 0;
+  for (int i = 0; i < 1000; i++)
+  {
+    sum += i * factor;
+  }
+
+```
+
+or with the functions.
+
+```cpp
+  float grams2stoneFactor = lbs2stone(ounce2lbs(gram2ounce(1)));
+  sum = 0;
+  for (int i = 0; i < 1000; i++)
+  {
+    sum += i * factor;
+  }
+```
+
+
 ## Interface
 
 ```cpp
 #include "weight.h"
 ```
 
-#### Constructor
+### Constructor
 
 - **weightConverter()**
 
-#### Setters
+### Setters
 
 - **void setKilogram(float value = 0)** 
 - **void setGram(float value = 0)** 
@@ -120,7 +161,7 @@ Since version 0.3.0 the converter can also add different units.
 - **void setGrain(float value = 0)**
 - **void setCarat(float value = 0)**
 
-#### Adders
+### Adders
 
 - **void addKilogram(float value = 0)** 
 - **void addGram(float value = 0)** 
@@ -141,7 +182,7 @@ Since version 0.3.0 the converter can also add different units.
 - **void addGrain(float value = 0)**
 - **void addCarat(float value = 0)**
 
-#### Getters
+### Getters
 
 - **float getKilogram()**
 - **float getGram()**

libraries/weight/examples/weightConverter_test/weightConverter_test.ino

@@ -2,7 +2,7 @@
 //    FILE: weightConverter_test.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
-//    DATE: 2022-12-05
+//     URL: https://github.com/RobTillaart/weight
 
 
 #include "weight.h"
@@ -13,7 +13,10 @@ const float accuracy = 0.0001;
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
+  Serial.print("WEIGHT_LIB_VERSION: ");
+  Serial.println(WEIGHT_LIB_VERSION);
   Serial.println();
 
   weightConverter WC;

libraries/weight/examples/weightPerformance/weightPerformance.ino

@@ -2,7 +2,7 @@
 //    FILE: weightPerformance.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
-//    DATE: 2020-06-17
+//     URL: https://github.com/RobTillaart/weight
 
 
 #include "weight.h"
@@ -16,10 +16,14 @@ uint32_t start, stop;
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
+  Serial.print("WEIGHT_LIB_VERSION: ");
+  Serial.println(WEIGHT_LIB_VERSION);
+  Serial.println();
 
   Serial.println("\nFUNCTION:\tTIME (us)");
-  // measure_1();
+  //  measure_1();
   measure_2();
 }
 

libraries/weight/examples/weightTest/weightTest.ino

@@ -2,7 +2,7 @@
 //    FILE: weightTest.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
-//    DATE: 2020-06-17
+//     URL: https://github.com/RobTillaart/weight
 
 
 #include "weight.h"
@@ -13,7 +13,11 @@ const float accuracy = 0.0001;
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
+  Serial.print("WEIGHT_LIB_VERSION: ");
+  Serial.println(WEIGHT_LIB_VERSION);
+  Serial.println();
 }
 
 

libraries/weight/library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/weight.git"
   },
-  "version": "0.3.1",
+  "version": "0.3.2",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*",