update readme.md + isZero() (#11)

- update readme.md
- add **isZero()**
- minor edits

Author: RobTillaart

Angle.cpp

@@ -1,7 +1,7 @@
 //
 //    FILE: Angle.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.0
+// VERSION: 0.2.1
 // PURPOSE: library for Angle math for Arduino
 //     URL: https://github.com/RobTillaart/Angle
 //          http://forum.arduino.cc/index.php?topic=339402
@@ -134,6 +134,12 @@ Angle::Angle(const char * str)
 }
 
 
+//
+bool Angle::isZero()
+{
+  return (_degrees == 0 && _minutes == 0 && _seconds == 0 && _tenths == 0);
+}
+
 //  PRINTING
 size_t Angle::printTo(Print& p, AngleFormatMode mode) const
 {

Angle.h

@@ -2,7 +2,7 @@
 //
 //    FILE: Angle.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.0
+// VERSION: 0.2.1
 // PURPOSE: angle library for Arduino
 //     URL: https://github.com/RobTillaart/Angle
 //          http://forum.arduino.cc/index.php?topic=339402
@@ -15,7 +15,7 @@
 #include "Printable.h"
 
 
-#define ANGLE_LIB_VERSION               (F("0.2.0"))
+#define ANGLE_LIB_VERSION               (F("0.2.1"))
 
 
 class Angle;
@@ -43,11 +43,12 @@ class Angle: public Printable
     Angle(double alpha);
     Angle(const char * str);
 
-    int sign()        { return _negative ? -1 : 1; };
-    int degree()      { return _degrees; };
-    int minute()      { return _minutes; };
-    int second()      { return _seconds; };
-    int tenthousand() { return _tenths; };
+    bool isZero();
+    int  sign()        { return _negative ? -1 : 1; };
+    int  degree()      { return _degrees; };
+    int  minute()      { return _minutes; };
+    int  second()      { return _seconds; };
+    int  tenthousand() { return _tenths; };
 
     size_t printTo(Print& p) const { return printTo( p, T ); }
     size_t printTo(Print& p, AngleFormatMode mode) const;
@@ -56,7 +57,8 @@ class Angle: public Printable
 
     double toDouble();
     double toRadians() { return toDouble() * (PI / 180.0); };
-    void fromRadians(double radians) { *this = radians * (180.0 / PI); };
+    void   fromRadians(double radians) { *this = radians * (180.0 / PI); };
+
 
     //  EQUALITIES
     bool operator == (const Angle& a) { return compare(*this, a) == 0; };
@@ -66,6 +68,7 @@ class Angle: public Printable
     bool operator >  (const Angle& a) { return compare(*this, a) >  0; };
     bool operator >= (const Angle& a) { return compare(*this, a) >= 0; };
 
+
     //  NEGATE
     Angle operator - ();
 

CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.2.1] - 2025-08-16
+- update readme.md
+- add **isZero()**
+- minor edits
+
 ## [0.2.0] - 2024-04-06
 - update GitHub actions
 - give internal variables descriptive names

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2015-2024 Rob Tillaart
+Copyright (c) 2015-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

README.md

@@ -31,7 +31,15 @@ The library implements the Printable interface, allowing one to call
 Degree sign ° = ALT-0176 (Windows)
 
 
-#### Related
+### Note
+
+The library has not been tested extensively and it could still contain bugs. 
+Especially the constructor does not check input so use it carefully.
+
+As always feedback is welcome
+
+
+### Related
 
 - https://github.com/RobTillaart/AngleConvertor
 - https://github.com/RobTillaart/AverageAngle
@@ -45,53 +53,42 @@ Degree sign ° = ALT-0176 (Windows)
 #include "Angle.h"
 ```
 
-#### Constructors
+### Constructors
 
 - **Angle(int dd = 0, int mm = 0, int ss = 0, int tt = 0)** create an Angle, default is zero.
 - **Angle(double alpha)** create an Angle from a double.
 - **Angle(char \* str)** create an Angle from a string e.g. "45.31234".
 
+### Base
 
-#### Base
-
-- **int sign()** returns -1 or 1.
+- **bool isZero()** returns true if angle is 0.
+- **int sign()** returns -1 or 1. Zero degrees will return 1.
 - **int degree()** returns # degrees.
 - **int minute()** returns # minutes.
 - **int second()** returns # seconds.
 - **int tenthousand()** returns # ten-thousands of a second.
 
-
-#### Conversions
+### Conversions
 
 - **double toDouble()** returns the angle as a double (0..360.0, float on UNO).
 - **double toRadians()** returns the angle in radians (0..TWO_PI).
 - **void fromRadian(double rad)** create an angle from radians.
 
-More conversions - https://github.com/RobTillaart/AngleConvertor
+For more conversions check - https://github.com/RobTillaart/AngleConvertor
 
 
-#### Equality operators
+### Equality operators
 
 The library supports equality operator "==", "!=", "<" "<=" ">" and ">=" .
 
 
-#### Math operators
+### Math operators
 
+The library supports:
 - **negate** returns -angle.
 - **addition** and **subtract** add angles to angles.
 - **multiplication** and **division** multiply an angle with a double.
-- **ratio**  ratio = Angle/Angle.
-
-
-## Operation
-
-See examples.
-
-
-## Note
-
-The library has not been tested extensively and it could still contain bugs. 
-Especially the constructor does not check input so use it carefully.
+- **ratio** ratio = Angle/Angle.
 
 
 ## Future

examples/Angle_performance/Angle_performance.ino

@@ -2,7 +2,7 @@
 //    FILE: Angle_performance.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo sketch to test angle class
-//     URL: https://github.com/RobTillaart/Angle.git
+//     URL: https://github.com/RobTillaart/Angle
 
 
 #include "Angle.h"
@@ -84,28 +84,28 @@ void testParts()
   stop = micros();
   Serial.println(stop - start);
   Serial.println(s, 7);
-  
+
   delay(100);
   start = micros();
   s = c.degree();
   stop = micros();
   Serial.println(stop - start);
   Serial.println(s, 7);
-  
+
   delay(100);
   start = micros();
   s = c.minute();
   stop = micros();
   Serial.println(stop - start);
   Serial.println(s, 7);
-  
+
   delay(100);
   start = micros();
   s = c.second();
   stop = micros();
   Serial.println(stop - start);
   Serial.println(s, 7);
-  
+
   delay(100);
   start = micros();
   s = c.tenthousand();
@@ -195,8 +195,6 @@ void testMultiply()
 }
 
 
-
-
 void testDivide()
 {
   Serial.println(__FUNCTION__);
@@ -241,9 +239,11 @@ void testRatio()
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ANGLE_LIB_VERSION: ");
   Serial.println(ANGLE_LIB_VERSION);
+  Serial.println();
 
   testConstructors();
   testToDouble();

examples/format_angle/format_angle.ino

@@ -1,16 +1,23 @@
 /*
  * Printing a formatted Angle example.
- * 
+ *
  * Written by: Christopher Andrews (https://github.com/Chris--A)
- * 
+ *
  * Licenced under MIT, free to use, blah blah...
+ *
+ * URL: https://github.com/RobTillaart/Angle
  */
 
 #include <Angle.h>
 
-void setup() {
+void setup()
+{
   Serial.begin(115200);
-  Serial.println("Start format_angle\n");
+  Serial.println();
+  Serial.println(__FILE__);
+  Serial.print("ANGLE_LIB_VERSION: ");
+  Serial.println(ANGLE_LIB_VERSION);
+  Serial.println();
 
   Angle angle( 23, 12, 10, 123 );
 
@@ -22,4 +29,4 @@ void setup() {
   Serial.println( angle.format(T) );        // Output includes minutes, seconds, tenthousands.
 }
 
-void loop() {}
+void loop() {}