Skip to content

Commit

Permalink
Update to 1.0.1.
Browse files Browse the repository at this point in the history
  • Loading branch information
CelliesProjects committed May 4, 2020
1 parent 8ff5c35 commit 73900c0
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8bc0dca32db84bb5a3b762be8d48d2b3)](https://www.codacy.com/manual/CelliesProjects/moonPhase?utm_source=github.com&utm_medium=referral&utm_content=CelliesProjects/moonPhase&utm_campaign=Badge_Grade)
### moonPhase

An ESP32 library to get the moon phase angle and percentage of the moon that is illuminated.
An esp32 library to get the moon phase angle and percentage of the moon that is illuminated.

#### Usage

1. Download the latest release and unpack in the esp32 `libraries` folder.
1. Download the latest release and unpack in the Arduino `libraries` folder.
2. Restart the Arduino IDE.

|function | result |
|:-----------------|:-------------------------------------|
| `getPhase()` | Get the current moon phase.<br>( First set freeRTOS system time ) |
| `getPhase( time_t t )` | Get the moon phase at time `t`. |
#### Functions:

- `moonPhase getPhase()` Get the current moon phase. (First set freeRTOS system time)

- `moonPhase getPhase( time_t t )` Get the moon phase at time `t`.

#### Example code

````c++
```c++
#include <moonPhase.h>

moonPhase moonPhase; // include a MoonPhase instance
moonPhase moonPhase; // include a MoonPhase instance

void setup() {
Serial.begin(115200);
Expand All @@ -40,4 +41,4 @@ void loop() {
// put your main code here, to run repeatedly:

}
````
```
12 changes: 6 additions & 6 deletions library.properties
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name=MoonPhase
version=1.0.0
author=Cellie
maintainer=Cellie
sentence=Get lunar phase information.
paragraph=ESP32 library to calculate the moon phase angle and luminated visible surface at a given time.
version=1.0.1
author=Cellie <[email protected]>
maintainer=Cellie <[email protected]>
sentence=Get lunar phase information on a esp32.
paragraph=Esp32 library to calculate the moon phase angle and luminated visible surface now or at a given time.
category=Other
url=https://github.com/CelliesProjects/moonPhase
url=https://github.com/CelliesProjects/moonPhase-esp32
architectures=esp32
includes=moonPhase.h

0 comments on commit 73900c0

Please sign in to comment.