https://github.com/pascal-fb-martin/housealmanac
A test and fallback service to provide rough estimates of sunrise and sunset time
https://github.com/pascal-fb-martin/housealmanac
almanac service sunrise sunset web
Last synced: 2 months ago
JSON representation
A test and fallback service to provide rough estimates of sunrise and sunset time
- Host: GitHub
- URL: https://github.com/pascal-fb-martin/housealmanac
- Owner: pascal-fb-martin
- License: gpl-2.0
- Created: 2025-04-11T03:14:58.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-17T17:55:23.000Z (6 months ago)
- Last Synced: 2025-04-18T08:09:04.621Z (6 months ago)
- Topics: almanac, service, sunrise, sunset, web
- Language: C
- Homepage:
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HouseAlmanac
A fallback service providing rough estimates for almanac information
## Overview
This service provides very rough data about the current day:
- Sunrise time.
- Sunset time.
These values are estimated based on mid-month static data (from a configuration file). The estimation uses a linear regression method.
The purpose of this service is either as a test tools for applications that depend on an almanac service, or as a fallback when Internet connectivity is not available.
This service has no web UI.
## Installation
This service depends on the House series environment:
* Install git, icoutils, openssl (libssl-dev).
* Install [echttp](https://github.com/pascal-fb-martin/echttp)
* Install [houseportal](https://github.com/pascal-fb-martin/houseportal)
* Clone this repository.
* make rebuild
* sudo make install
## Configuration
The HouseAlmanac service loads its configuration from the almanac.json file, which syntax matches the example below:
```
{
"almanac": {
"sunrise": ["6:58","6:33","6:41","6:24","5:46","5:42","5:50","6:16","6:37","6:54","6:28","6:49"],
"sunset": ["17:33","17:59","19:19","19:49","20:14","20:31","20:40","19:57","19:15","19:33","17:04","17:08"],
"dst": ["03/09","11/02"]
}
}
```
All times are local time. the `dst` array represents the two DST changes dates, spring and fall.
An example of configuration for the Los Angeles area is provided.
## Web API
The HouseAlmanac service support the following web requests:
```
GET /almanac/tonight
```
Return JSON data that contains the following data for the upcoming or current
night:
- .host: name of the responding host.
- .timestamp: system time of the response, in seconds.
- .almanac.priority: a priority level that matches the data quality.
- .almanac.sunset: system time of tonight's sunset, in seconds (integer).
- .almanac.sunrise: system time of tonight's sunrise, in seconds (integer).
The sunset time can be in the past, typically at night time.
For this statically configured fallback service, the priority is always 1 (low).
```
GET /almanac/today
```
Return JSON data that contains the almanac data for this current day. The
format is the same as for the `/almanac/tonight` endpoint, except that both
the sunrise and sunset values are always for the current day.
```
GET /almanac/selftest
```
Return the complete sunset and sunrise information for the whole year. In this response both the sunset and sunrise fields are arrays of 365 entries, and each entry is a string in the format "MM/DD HH:MM". Leap years are not considered (this is just a test endpoint).
## Further References
More precise sunset and sunrise information can be obtained from [SunriseSunset](https://sunrise-sunset.org). See their [API](https://sunrise-sunset.org/api) for more information.
## Debian Packaging
The provided Makefile supports building private Debian packages. These are _not_ official packages:
- They do not follow all Debian policies.
- They are not built using Debian standard conventions and tools.
- The packaging is not separate from the upstream sources, and there is
no source package.
To build a Debian package, use the `debian-package` target:
```
make debian-package
```