blink_tm 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 290de1234088715cb8d957462afdd3a8f54c1c876f2b49ae35de7546cb352da8
-  data.tar.gz: e4a103649d1c326c86eb74931ca4a4796e150c186e9f6ef05926410d33ab31b2
+  metadata.gz: 0b0b02fc01c3e3de3cfd449cfb597d1668ace99bc1cbfff09d3851dd1697d6b8
+  data.tar.gz: eb28af7d601f618b53fd65fd288963cfa84018437532a8cf8aeb651e1871efe6
 SHA512:
-  metadata.gz: 7641d9d08838db8707dd75a327a417090ef0c0ecdddf0f458f34c5caeffb1406dde99272db73ad30d5e3ef288b348534b5834e09365ead845b4db34efa598c5d
-  data.tar.gz: 119773e1b395a46910267f6bee5f6c284a7bb3208953c40649c1d3981f31f6508f39b202d983a658ffedb7988b3dc4082be86c162df01b0063a0bf373352d4c9
+  metadata.gz: 64e11a3838a4c77219d888587407bf2b63e5210fec99e257519375b582e1b113e859d5785a20dff056a5a8757ab35dfbc483a5ee3063de56982f462e38f8d3cc
+  data.tar.gz: 63ffe2ecb618d3ed602ee46e19005103fba2bb9b6873a882d1820e39402f9136358914e4047d21fd8bf67f7e50d3a348922dd0809e60cdac52a35cb3e7fd16c6

data/exe/blink-tm

@@ -7,6 +7,19 @@ if ARGV.any?(/^\-(\-version|v)$/)
 	exit
 end
 
+coords = ARGV.select { |x| x[/^\-(\-coords|c)=.+$/] }.last
+daylight_checker_options = { latitude: nil, longitude: nil }
+
+if coords && !coords.empty?
+	lat_long = coords.split('=').last
+	lat, long = lat_long.split(',')
+
+	abort('Please specify latitude and longitude splitted by a comma (,). For example -22.88,88.33') if !lat || !long
+
+	daylight_checker_options[:latitude] = lat
+	daylight_checker_options[:longitude] = long
+end
+
 written_pid = false
 
 BlinkTM::log "BlinkTM Version #{BlinkTM::VERSION}"
@@ -47,11 +60,11 @@ end
 retry_count = 0
 
 # Find Device running Blink Taskmanager
-dev = BlinkTM::find_device!
 file = nil
 
 begin
-	BlinkTM.start(dev) { |x| file = x }
+	dev = BlinkTM::find_device!
+	BlinkTM.start(dev, daylight_checker_options) { |x| file = x }
 rescue BlinkTM::SyncError
 	sleep 1
 	retry
@@ -62,9 +75,7 @@ rescue Errno::ENOENT, Errno::EIO, BlinkTM::NoDeviceError
 	retry
 rescue Interrupt, SystemExit, SignalException
 	file &.close
-	File.delete(BlinkTM::LOCKFILE)
 rescue Exception
-
 	mesg = <<~EOF
 		:: Time: #{Time.now.strftime("%A %d %B %Y, %H:%M:%S:%5N %p")}:
 		#{$!.full_message}

data/lib/blink_tm/blink_tm.rb

@@ -74,11 +74,15 @@ module BlinkTM
 		"%06.2f".%(n).split('.').join
 	end
 
-	def start(device)
+	def start(device, daylight_checker_options)
 		return false unless device
 
+		latitude, longitude = daylight_checker_options[:latitude]&.to_f, daylight_checker_options[:longitude]&.to_f
+		log 'success', "Set latitude to #{latitude}, longitude to #{longitude}" if !latitude.nil? && !longitude.nil?
+
 		cpu_u = mem_u = swap_u = iostat = net_u = net_d = 0
 		io_r = io_w = 0
+		built_in_led_state = 0
 
 		Thread.new {
 			while true
@@ -107,6 +111,7 @@ module BlinkTM
 		}
 
 		prev_crc32 = ''
+		prev_time = { min: -1, hour: -1 }
 		raise NoDeviceError unless device
 
 		in_sync = false
@@ -157,6 +162,22 @@ module BlinkTM
 			_swap_u = swapstat[:used].to_i.*(1024).*(100).fdiv(swapstat[:total].to_i * 1024)
 			swap_u = _swap_u.nan? ? 255 : _swap_u.round
 
+			time_minute = Time.now.min
+			time_hour = Time.now.hour
+
+			if (time_minute != prev_time[:min] || time_hour != prev_time[:hour]) && !latitude.nil? && !longitude.nil?
+				dark_outside = DaylightChecker.new(
+					latitude,
+					longitude,
+					Time.now
+				).is_it_dark?
+
+				built_in_led_state = dark_outside ? 1 : 0
+
+				prev_time[:min] = time_minute
+				prev_time[:hour] = time_hour
+			end
+
 			# Output has to be exactly this long. If not, blink-taskmanager shows invalid result.
 			# No string is split inside blink-task manager, it just depends on the string length.
 			#
@@ -171,7 +192,7 @@ module BlinkTM
 
 			str = "!##{"%03d" % cpu_u}#{"%03d" % mem_u}#{"%03d" % swap_u}"\
 			"#{convert_bytes(net_u)}#{convert_bytes(net_d)}"\
-			"#{convert_bytes(io_r)}#{convert_bytes(io_w)}1~"
+			"#{convert_bytes(io_r)}#{convert_bytes(io_w)}#{built_in_led_state}1~"
 
 			# Rescuing from suspend
 			file.syswrite(str)

data/lib/blink_tm/daylight_checker.rb

@@ -0,0 +1,104 @@
+require 'date'
+
+class DaylightChecker
+	attr_reader :latitude, :longitude, :time, :date, :offset_in_hours
+	# Each day earth moves across sun about 360 / 365.24 = 0.9856
+	EARTH_ORBITAL_DEGREE_PER_DAY = 0.9856
+
+	# Is a constant that adjusts the mean anomaly based on the time of year.
+	# It's derived from a more complex formula involving the Earth's orbital eccentricity
+	# and the position of perihelion (the point in Earth's orbit that's closest to the Sun).
+	MEAN_ANOMALY_ADJUSTMENT = 3.289
+
+	AXIAL_TILT = 0.39782
+	TIME_CORRECTION_FACTOR = 0.06571
+	DEGREES_TO_RADIANS = Math::PI / 180
+	RADIANS_TO_DEGREES = 180 / Math::PI
+
+	# Math.cos(23.44 (angle in degrees) * (Math::PI / 180))
+	COSINE_OBLIQUITY_ECLIPTIC = 0.91747
+
+	def initialize(latitude, longitude, time)
+		@latitude = latitude
+		@longitude = longitude
+		@time = time
+		@date = time.to_date
+		@offset_in_hours = time.utc_offset / 3600.0
+	end
+
+	def is_it_dark?
+		sunrise_time, sunset_time = sun_times(date, latitude, longitude, offset_in_hours)
+		current_time = time.utc.hour + offset_in_hours
+
+		current_time < sunrise_time or current_time > sunset_time
+	end
+
+	private
+
+	def sun_times(date, latitude, longitude, offset_in_hours)
+		# Calculation of the sun rise/set is based on the papers:
+		#    http://williams.best.vwh.net/sunrise_sunset_algorithm.htm
+		#    http://aa.quae.nl/en/reken/zonpositie.html
+
+		# Convert the longitude to hour value and calculate an approximate time
+		lng_hour = longitude / 15.0
+
+		t_rise = date.yday + ((6 - lng_hour) / 24)
+		t_set = date.yday + ((18 - lng_hour) / 24)
+
+		# Calculate the Sun's mean anomaly
+		m_rise = (EARTH_ORBITAL_DEGREE_PER_DAY * t_rise) - MEAN_ANOMALY_ADJUSTMENT
+		m_set = (EARTH_ORBITAL_DEGREE_PER_DAY * t_set) - MEAN_ANOMALY_ADJUSTMENT
+
+		# Calculate the Sun's true longitude, and adjust angle to be between 0 and 360
+		l_rise = (m_rise + (1.916 * Math.sin(m_rise * DEGREES_TO_RADIANS)) + (0.020 * Math.sin(2 * m_rise * DEGREES_TO_RADIANS)) + 282.634) % 360
+		l_set = (m_set + (1.916 * Math.sin(m_set * DEGREES_TO_RADIANS)) + (0.020 * Math.sin(2 * m_set * DEGREES_TO_RADIANS)) + 282.634) % 360
+
+		# Calculate the Sun's right ascension, and adjust angle to be between 0 and 360
+		ra_rise = RADIANS_TO_DEGREES * Math.atan(COSINE_OBLIQUITY_ECLIPTIC * Math.tan(l_rise * DEGREES_TO_RADIANS))
+		ra_rise = (ra_rise + 360) % 360
+		ra_set = RADIANS_TO_DEGREES * Math.atan(COSINE_OBLIQUITY_ECLIPTIC * Math.tan(l_set * DEGREES_TO_RADIANS))
+		ra_set = (ra_set + 360) % 360
+
+		# Right ascension value needs to be in the same quadrant as L
+		l_quadrant_rise  = (l_rise / 90).floor * 90
+		ra_quadrant_rise = (ra_rise / 90).floor * 90
+		ra_rise = ra_rise + (l_quadrant_rise - ra_quadrant_rise)
+
+		l_quadrant_set  = (l_set / 90).floor * 90
+		ra_quadrant_set = (ra_set / 90).floor * 90
+		ra_set = ra_set + (l_quadrant_set - ra_quadrant_set)
+
+		# Right ascension value needs to be converted into hours
+		ra_rise = ra_rise / 15
+		ra_set = ra_set / 15
+
+		# Calculate the Sun's declination
+		sin_dec_rise = AXIAL_TILT * Math.sin(l_rise * DEGREES_TO_RADIANS)
+		cos_dec_rise = Math.cos(Math.asin(sin_dec_rise))
+
+		sin_dec_set = AXIAL_TILT * Math.sin(l_set * DEGREES_TO_RADIANS)
+		cos_dec_set = Math.cos(Math.asin(sin_dec_set))
+
+		# Calculate the Sun's local hour angle
+		cos_h_rise = (Math.sin(-0.83 * DEGREES_TO_RADIANS) - (sin_dec_rise * Math.sin(latitude * DEGREES_TO_RADIANS))) / (cos_dec_rise * Math.cos(latitude * DEGREES_TO_RADIANS))
+		h_rise = (360 - RADIANS_TO_DEGREES * Math.acos(cos_h_rise)) / 15
+
+		cos_h_set = (Math.sin(-0.83 * DEGREES_TO_RADIANS) - (sin_dec_set * Math.sin(latitude * DEGREES_TO_RADIANS))) / (cos_dec_set * Math.cos(latitude * DEGREES_TO_RADIANS))
+		h_set = RADIANS_TO_DEGREES * Math.acos(cos_h_set) / 15
+
+		# Calculate local mean time of rising/setting
+		t_rise = h_rise + ra_rise - (TIME_CORRECTION_FACTOR * t_rise) - 6.622
+		t_set = h_set + ra_set - (TIME_CORRECTION_FACTOR * t_set) - 6.622
+
+		# Adjust back to UTC, and keep the value between 0 and 24
+		ut_rise = (t_rise - lng_hour) % 24
+		ut_set = (t_set - lng_hour) % 24
+
+		# Convert UT value to local time zone of latitude/longitude
+		local_t_rise = (ut_rise + offset_in_hours) % 24
+		local_t_set = (ut_set + offset_in_hours) % 24
+
+		return local_t_rise, local_t_set
+	end
+end

data/lib/blink_tm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlinkTM
-	VERSION = "2.1.0"
+	VERSION = "2.2.0"
 end

data/lib/blink_tm.rb

@@ -49,5 +49,6 @@ end
 
 require 'blink_tm/version'
 require 'fcntl'
+require 'blink_tm/daylight_checker'
 require 'blink_tm/blink_tm'
 require 'blink_tm/crc32'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blink_tm
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Sourav Goswami
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2023-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: linux_stat
@@ -41,6 +41,7 @@ files:
 - ext/crc32/extconf.rb
 - lib/blink_tm.rb
 - lib/blink_tm/blink_tm.rb
+- lib/blink_tm/daylight_checker.rb
 - lib/blink_tm/version.rb
 homepage: https://github.com/souravgoswami/blink-tm
 licenses:
@@ -61,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
+rubygems_version: 3.3.25
 signing_key:
 specification_version: 4
 summary: A controller for Arduino OLED System Monitor, Blink Task Manager