Changed function names.

Updated 'keywords.txt'.
Updated 'libary.properties'.
Added 'esp32-sntp' example.

Author: CelliesProjects

examples/esp32-sntp/esp32-sntp.ino

@@ -0,0 +1,42 @@
+#include<WiFi.h>
+#include <moonPhase.h>
+
+const char * wifissid = "networkname";
+const char * wifipsk = "password";
+
+moonPhase moonPhase; // include a MoonPhase instance
+
+void setup() {
+  // put your setup code here, to run once:
+  Serial.begin(115200);
+  Serial.print( "Connecting to " );
+  Serial.println( wifissid );
+  WiFi.begin( wifissid, wifipsk );
+  while ( !WiFi.isConnected() )
+    delay(100);
+
+  Serial.println( " Connected. Getting time..." );
+
+  configTzTime( "CET-1CEST-2,M3.5.0/02:00:00,M10.5.0/03:00:00", "0.pool.ntp.org" ); //Amsterdam, Netherlands
+
+  struct tm timeinfo = {0};
+
+  while ( !getLocalTime( &timeinfo, 0 ) )
+    vTaskDelay( 10 / portTICK_PERIOD_MS );
+}
+
+void loop() {
+  struct tm timeinfo = {0};
+  getLocalTime( &timeinfo );
+  Serial.print( asctime( &timeinfo ) );
+
+  moonData_t moon; // variable to receive the data
+  moon = moonPhase.getPhase();
+
+  Serial.print( "Moon phase angle: " );
+  Serial.print( moon.angle );                       // angle is a integer between 0-360
+  Serial.print( " degrees. Moon surface lit: " );
+  Serial.printf( "%f%%\n", moon.percentLit * 100 ); // percentLit is a real between 0-1
+  Serial.println();
+  delay(1000);
+}

keywords.txt

@@ -11,7 +11,7 @@ moonData_t	KEYWORD1
 #######################################
 # Methods and Functions (KEYWORD2)
 #######################################
-getInfo	KEYWORD2
+getPhase	KEYWORD2
 angle	KEYWORD2
 percentLit	KEYWORD2
 

library.properties

@@ -1,10 +1,10 @@
 name=MoonPhase
-version=0.0.1
+version=0.99.0
 author=Cellie
 maintainer=Cellie
 sentence=Calculate the lunar phase at a certain time.
-paragraph=
+paragraph=Arduino library to calculate the moon phase and visible surface at a given time.
 category=Other
-url=https://github.com/CelliesProjects/MoonPhase
+url=https://github.com/CelliesProjects/moonPhase
 architectures=*
 includes=MoonPhase.h

moonPhase.cpp

@@ -7,11 +7,11 @@ inline T map(T2 val, T2 in_min, T2 in_max, T out_min, T out_max) {
 		return (val - in_min) * (out_max - out_min) / (in_max - in_min) + out_min;
 }
 
-inline double moonPhase::fhour( const struct tm &timeinfo ) {
+inline double moonPhase::_fhour( const struct tm &timeinfo ) {
   return timeinfo.tm_hour + map( ( timeinfo.tm_min * 60 ) + timeinfo.tm_sec, 0, 3600, 0.0, 1.0 );
 }
 
-moonData_t moonPhase::_getInfo( const int32_t &year, const int32_t &month, const int32_t &day, const double &hour )
+moonData_t moonPhase::_getPhase( const int32_t &year, const int32_t &month, const int32_t &day, const double &hour )
 {
 /*
   Calculates the phase of the moon at the given epoch.
@@ -28,17 +28,17 @@ moonData_t moonPhase::_getInfo( const int32_t &year, const int32_t &month, const
   return returnValue;
 }
 
-moonData_t moonPhase::getInfo( const time_t t ) {
+moonData_t moonPhase::getPhase( const time_t t ) {
   struct tm timeinfo;
   gmtime_r( &t, &timeinfo );
-  double hour = fhour( timeinfo );
-  return _getInfo( 1900 + timeinfo.tm_year, 1 + timeinfo.tm_mon, timeinfo.tm_mday, hour );
+  double hour = _fhour( timeinfo );
+  return _getPhase( 1900 + timeinfo.tm_year, 1 + timeinfo.tm_mon, timeinfo.tm_mday, hour );
 }
 
-moonData_t moonPhase::getInfo() {
+moonData_t moonPhase::getPhase() {
     time_t now;
     time( &now );
-    return getInfo( now );
+    return getPhase( now );
 }
 
 double moonPhase::_Julian( int32_t year, int32_t month, const double &day )

moonPhase.h

@@ -20,14 +20,13 @@ struct moonData_t
 class moonPhase
 {
 public:
-  moonData_t getInfo();
-  moonData_t getInfo( const time_t t );
+  moonData_t getPhase();
+  moonData_t getPhase( const time_t t );
 private:
-  moonData_t _getInfo( const int32_t &year, const int32_t &month, const int32_t &day, const double &hour );
-  double fhour( const struct tm &timeinfo );
-  double _Julian( int32_t year, int32_t month, const double &day );
-  double _sun_position( const double &j );
-  double _moon_position( const double &j, const double &ls );
-
+  moonData_t _getPhase( const int32_t &year, const int32_t &month, const int32_t &day, const double &hour );
+  double     _fhour( const struct tm &timeinfo );
+  double     _Julian( int32_t year, int32_t month, const double &day );
+  double     _sun_position( const double &j );
+  double     _moon_position( const double &j, const double &ls );
 };
 #endif