git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2021 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.astro.internal.handler;
  14
  15 import static org.openhab.binding.astro.internal.AstroBindingConstants.THING_TYPE_SUN;
  16
  17 import java.time.ZonedDateTime;
  18 import java.util.Arrays;
  19 import java.util.Calendar;
  20 import java.util.GregorianCalendar;
  21 import java.util.HashSet;
  22 import java.util.Set;
  23
  24 import org.eclipse.jdt.annotation.NonNullByDefault;
  25 import org.eclipse.jdt.annotation.Nullable;
  26 import org.openhab.binding.astro.internal.calc.SunCalc;
  27 import org.openhab.binding.astro.internal.job.DailyJobSun;
  28 import org.openhab.binding.astro.internal.job.Job;
  29 import org.openhab.binding.astro.internal.model.Planet;
  30 import org.openhab.binding.astro.internal.model.Position;
  31 import org.openhab.binding.astro.internal.model.Range;
  32 import org.openhab.binding.astro.internal.model.Sun;
  33 import org.openhab.binding.astro.internal.model.SunPhaseName;
  34 import org.openhab.core.i18n.TimeZoneProvider;
  35 import org.openhab.core.scheduler.CronScheduler;
  36 import org.openhab.core.thing.Thing;
  37 import org.openhab.core.thing.ThingTypeUID;
  38
  39 /**
  40  * The SunHandler is responsible for updating calculated sun data.
  41  *
  42  * @author Gerhard Riegler - Initial contribution
  43  * @author Amit Kumar Mondal - Implementation to be compliant with ESH Scheduler
  44  */
  45 @NonNullByDefault
  46 public class SunHandler extends AstroThingHandler {
  47
  48     public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES = new HashSet<>(Arrays.asList(THING_TYPE_SUN));
  49
  50     private final String[] positionalChannelIds = new String[] { "position#azimuth", "position#elevation",
  51             "radiation#direct", "radiation#diffuse", "radiation#total" };
  52     private final SunCalc sunCalc = new SunCalc();
  53     private @NonNullByDefault({}) Sun sun;
  54
  55     /**
  56      * Constructor
  57      */
  58     public SunHandler(Thing thing, final CronScheduler scheduler, final TimeZoneProvider timeZoneProvider) {
  59         super(thing, scheduler, timeZoneProvider);
  60     }
  61
  62     @Override
  63     public void publishPositionalInfo() {
  64         sun = getSunAt(ZonedDateTime.now());
  65         Double latitude = thingConfig.latitude;
  66         Double longitude = thingConfig.longitude;
  67         Double altitude = thingConfig.altitude;
  68         sunCalc.setPositionalInfo(Calendar.getInstance(), latitude != null ? latitude : 0,
  69                 longitude != null ? longitude : 0, altitude != null ? altitude : 0, sun);
  70
  71         sun.getEclipse().setElevations(this, timeZoneProvider);
  72
  73         publishPlanet();
  74     }
  75
  76     @Override
  77     public @Nullable Planet getPlanet() {
  78         return sun;
  79     }
  80
  81     @Override
  82     public void dispose() {
  83         super.dispose();
  84         sun = null;
  85     }
  86
  87     @Override
  88     protected String[] getPositionalChannelIds() {
  89         return positionalChannelIds;
  90     }
  91
  92     @Override
  93     protected Job getDailyJob() {
  94         return new DailyJobSun(thing.getUID().getAsString(), this);
  95     }
  96
  97     private Sun getSunAt(ZonedDateTime date) {
  98         Double latitude = thingConfig.latitude;
  99         Double longitude = thingConfig.longitude;
 100         Double altitude = thingConfig.altitude;
 101         return sunCalc.getSunInfo(GregorianCalendar.from(date), latitude != null ? latitude : 0,
 102                 longitude != null ? longitude : 0, altitude != null ? altitude : 0,
 103                 thingConfig.useMeteorologicalSeason);
 104     }
 105
 106     public @Nullable ZonedDateTime getEventTime(SunPhaseName sunPhase, ZonedDateTime date, boolean begin) {
 107         Range eventRange = getSunAt(date).getAllRanges().get(sunPhase);
 108         if (eventRange != null) {
 109             Calendar cal = begin ? eventRange.getStart() : eventRange.getEnd();
 110             return ZonedDateTime.ofInstant(cal.toInstant(), date.getZone());
 111         } else {
 112             return null;
 113         }
 114     }
 115
 116     @Override
 117     public @Nullable Position getPositionAt(ZonedDateTime date) {
 118         Sun localSun = getSunAt(date);
 119         Double latitude = thingConfig.latitude;
 120         Double longitude = thingConfig.longitude;
 121         Double altitude = thingConfig.altitude;
 122         sunCalc.setPositionalInfo(GregorianCalendar.from(date), latitude != null ? latitude : 0,
 123                 longitude != null ? longitude : 0, altitude != null ? altitude : 0, localSun);
 124         return localSun.getPosition();
 125     }
 126 }