summaryrefslogtreecommitdiff
path: root/bin/is_nighttime
blob: 16a620a25a20fa3fb3b9eaeef3650fe932504dd4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
#!/usr/bin/env perl

use strict;
use warnings;
use 5.010;

use Astro::Sunrise;
use DateTime;
use DateTime::Duration;
use Getopt::Std;

our $VERSION = '0.0';

sub show_usage {
	my ($exit_status) = @_;

	say
"Usage: $0 [-d <offset>] [-t <twilight altitude>] [-ov] <latitude> <longitude>";
	exit( $exit_status // 0 );
}

sub get_rise_and_set {
	my ( $ts, $lon, $lat, $alt ) = @_;

	my ( $rise_str, $set_str )
	  = sunrise( $ts->year, $ts->month, $ts->day, $lon, $lat,
		$ts->offset / 3600,
		0, $alt );

	my ( $rise_h, $rise_m ) = ( $rise_str =~ m{(..):(..)} );
	my ( $set_h,  $set_m )  = ( $set_str =~ m{(..):(..)} );

	my $rise = $ts->clone->set(
		hour   => $rise_h,
		minute => $rise_m,
		second => 0,
	);

	my $set = $ts->clone->set(
		hour   => $set_h,
		minute => $set_m,
		second => 0,
	);

	return ( $rise, $set );
}

my %opts;
getopts( 'd:hot:v', \%opts );

if ( $opts{h} ) {
	show_usage(0);
}

if ( @ARGV != 2 ) {
	show_usage(1);
}

my ( $latitude, $longitude ) = @ARGV;

if ( $opts{d} and not $opts{d} =~ m{ ^ -? [[:digit:]]+ $}x ) {
	say STDERR "Error: Offset (-d ...) must be a number\n";
	show_usage(1);
}

my $now = DateTime->now( time_zone => 'local' );
my $delta = DateTime::Duration->new( minutes => $opts{d} || 0 );
my $altitude = $opts{t} // Astro::Sunrise::DEFAULT;

my ( $sunrise, $sunset )
  = get_rise_and_set( $now, $longitude, $latitude, $altitude );

$sunrise->add_duration($delta);
$sunset->subtract_duration($delta);

if ( $opts{v} ) {
	say 'rise at ' . $sunrise->strftime('%H:%M');
	say 'now is ' . $now->strftime('%H:%M');
	say 'set at ' . $sunset->strftime('%H:%M');
}

if ( $opts{o} ) {
	say( ( $now < $sunrise or $now > $sunset ) ? '1' : '0' );
	exit 0;
}

if ( $now < $sunrise or $now > $sunset ) {
	exit 0;
}
exit 1;

__END__

=head1 NAME

is_nighttime - Check whether it is day or night

=head1 SYNOPSIS

B<is_nighttime> [B<-d> I<offset>] [B<-t> I<twilight altitude>] [B<-ov>]
I<latitude> I<longitude>

=head1 VERSION

version 0.00

=head1 DESCRIPTION

B<is_nighttime> determines whether it is day or night at a given position.  It
supports various nighttime definitions based on the altitude of the sun with
respect to the horizon. B<is_nighttime> is mostly a CLI frontend to
L<Astro::Sunrise>.

For instance, C<< is_nighttime -v 51.21653 6.78342 >> checks whether it is
civil nightttime in DE<uuml>sseldorf, Germany, and also prints sunrise,
current, and sunset time in HH:MM format on stdout.

=head1 OPTIONS

=over

=item B<-d> I<offset>

Report sunrise I<offset> minutes later and sunset I<offset> minutes earlier,
thus causing the reported night to be B<2*>I<offset> minutes longer.

=item B<-o>

Print day/night status on stdout instead of signaling it via the exit code.
C<0> means day, C<1> is night.

=item B<-t> I<twilight altitude>

Change definition of nighttime: It is night iff the center of the sun's disk
is at least I<twilight altitude> degrees below a mathematical horizon.
Defaults to B<-0.833> degrees. This is the point at wich the sun's upper limb
touches the horizon, accounting for atmospheric refraction.

The following values (taken from L<Astro::Sunrise>) may also be useful:

=over

=item B<0> degrees

Center of sun's disk touches a mathematical horizon.

=item B<-0.25> degrees

Sun's upper limb touches a mathematical horizon.

=item B<-0.583> degrees

Center of sun's disk touches the horizon, accounting for atmospheric refraction.

=item B<-0.833> degrees

Sun's upper limb touches the horizon, accounting for atmospheric refraction.
This is the default.

=item B<-6> degrees

Civil twilight (reading without artificial illumination is no longer possible).

=item B<-12> degrees

Nautical twilight (sea horizon is no longer visible).

=item B<-15> degrees

Amateur astronomical twilight (the sky is quite dark).

=item B<-18> degrees

Astronomical twilight (the sky is completely dark).

=back

Note that, depending on time of year and altitude, there are twilight
definitions for which no sunrise and sunset exist.  B<is_nighttime> behaviour
for these cases has not yet been defined.

=item B<-v>

Print sunrise, current, and sunset time in HH:MM format on stdout.

=back

=head1 EXIT STATUS

When B<-o> is used: 0 after normal operation, 1 if an error occured.

Otherwise: 0 if it is nighttime, 1 if it is daytime or an error occured.

=head1 CONFIGURATION

None.

=head1 DEPENDENCIES

=over

=item * Astro::Sunrise

=back

=head1 BUGS AND LIMITATIONS

Sunset after midnight is not handled properly.

=head1 AUTHOR

Copyright (C) 2018 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>

=head1 LICENSE

  This program is licensed under the same terms as Perl itself.