forked from briis/hass-weatherflow2mqtt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
helpers.py
455 lines (377 loc) · 15.1 KB
/
helpers.py
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
"""Several Helper Functions."""
import datetime
import time
import json
import math
from typing import OrderedDict
import logging
import yaml
from cmath import rect, phase
from math import gamma, radians, degrees
from sqlite import SQLFunctions
from const import (
DEVICE_STATUS,
EXTERNAL_DIRECTORY,
SUPPORTED_LANGUAGES,
UNITS_IMPERIAL,
)
_LOGGER = logging.getLogger(__name__)
class ConversionFunctions:
"""Class to help with converting from different units."""
def __init__(self, unit_system, translations):
self._unit_system = unit_system
self._translations = translations
async def temperature(self, value) -> float:
"""Convert Temperature Value."""
if value is not None:
if self._unit_system == UNITS_IMPERIAL:
return round((value * 9 / 5) + 32, 1)
return round(value, 1)
_LOGGER.error("FUNC: temperature ERROR: Temperature value was reported as NoneType. Check the sensor")
async def pressure(self, value) -> float:
"""Convert Pressure Value."""
if value is not None:
if self._unit_system == UNITS_IMPERIAL:
return round(value * 0.02953, 3)
return round(value, 2)
_LOGGER.error("FUNC: pressure ERROR: Pressure value was reported as NoneType. Check the sensor")
async def speed(self, value, kmh=False) -> float:
"""Convert Wind Speed."""
if value is not None:
if self._unit_system == UNITS_IMPERIAL:
return round(value * 2.2369362920544, 2)
if kmh:
return round((value * 18 / 5), 1)
return round(value, 1)
_LOGGER.error("FUNC: speed ERROR: Wind value was reported as NoneType. Check the sensor")
async def distance(self, value) -> float:
"""Convert distance."""
if value is not None:
if self._unit_system == UNITS_IMPERIAL:
return round(value / 1.609344, 2)
return value
_LOGGER.error("FUNC: distance ERROR: Lightning Distance value was reported as NoneType. Check the sensor")
async def rain(self, value) -> float:
"""Convert rain."""
if value is not None:
if self._unit_system == UNITS_IMPERIAL:
return round(value * 0.0393700787, 2)
return round(value, 2)
_LOGGER.error("FUNC: rain ERROR: Rain value was reported as NoneType. Check the sensor")
async def rain_type(self, value) -> str:
"""Convert rain type."""
type_array = ["none", "rain", "hail", "heavy-rain"]
try:
precip_type = type_array[int(value)]
return self._translations["precip_type"][precip_type]
except IndexError as e:
_LOGGER.debug("VALUE is: %s", value)
return f"Unknown - {value}"
async def direction(self, value) -> str:
"""Returns a directional Wind Direction string."""
if value is None:
return "N"
direction_array = [
"N",
"NNE",
"NE",
"ENE",
"E",
"ESE",
"SE",
"SSE",
"S",
"SSW",
"SW",
"WSW",
"W",
"WNW",
"NW",
"NNW",
"N",
]
direction_str = direction_array[int((value + 11.25) / 22.5)]
return self._translations["wind_dir"][direction_str]
async def air_density(self, temperature, station_pressure):
"""Returns the Air Density."""
if temperature is not None and station_pressure is not None:
kelvin = temperature + 273.15
pressure = station_pressure
r_specific = 287.058
decimals = 2
air_dens = (pressure * 100) / (r_specific * kelvin)
if self._unit_system == UNITS_IMPERIAL:
air_dens = air_dens * 0.06243
decimals = 4
return round(air_dens, decimals)
_LOGGER.error("FUNC: air_density ERROR: Temperature or Pressure value was reported as NoneType. Check the sensor")
async def sea_level_pressure(self, station_press, elevation):
"""Returns Sea Level pressure.
Converted from a JS formula made by Gary W Funk
"""
if station_press is not None:
elev = float(elevation)
press = float(station_press)
# Constants
gravity = 9.80665
gas_constant = 287.05
atm_rate = 0.0065
std_pressure = 1013.25
std_temp = 288.15
# Sub Calculation
l = gravity / (gas_constant * atm_rate)
c = gas_constant * atm_rate / gravity
u = math.pow(1 + math.pow(std_pressure / press, c) * (atm_rate * elev / std_temp), l)
sea_pressure = (press * u)
return await self.pressure(sea_pressure)
_LOGGER.error("FUNC: sea_level_pressure ERROR: Temperature or Pressure value was reported as NoneType. Check the sensor")
async def dewpoint(self, temperature, humidity):
"""Returns Dewpoint."""
if temperature is not None and humidity is not None:
dewpoint_c = round(
243.04
* (
math.log(humidity / 100)
+ ((17.625 * temperature) / (243.04 + temperature))
)
/ (
17.625
- math.log(humidity / 100)
- ((17.625 * temperature) / (243.04 + temperature))
),
1,
)
return await self.temperature(dewpoint_c)
_LOGGER.error("FUNC: dewpoint ERROR: Temperature and/or Humidity value was reported as NoneType. Check the sensor")
async def rain_rate(self, value):
"""Returns rain rate per hour."""
if not value:
return 0
return await self.rain(value * 60)
async def feels_like(self, temperature, humidity, windspeed):
"""Calculates the feel like temperature."""
if temperature is None or humidity is None or windspeed is None:
return 0
e_value = (
humidity * 0.06105 * math.exp((17.27 * temperature) / (237.7 + temperature))
)
feelslike_c = temperature + 0.348 * e_value - 0.7 * windspeed - 4.25
return await self.temperature(feelslike_c)
async def average_bearing(self, bearing_arr) -> int:
"""Returns the average Wind Bearing from an array of bearings."""
mean_angle = degrees(phase(sum(rect(1, radians(d)) for d in bearing_arr)/len(bearing_arr)))
return int(abs(mean_angle))
async def visibility(self, elevation):
"""Returns the visibility."""
if self._unit_system == UNITS_IMPERIAL:
return round(1.22459 * math.sqrt(elevation * 3.2808), 1)
return round(3.56972 * math.sqrt(elevation), 1)
async def wetbulb(self, temp, humidity, pressure):
"""Returns the Wel Bulb Temperature.
Converted from a JS formula made by Gary W Funk
Input:
Temperature in Celcius
Humdity in Percent
Station Pressure in MB
"""
t = float(temp)
rh = float(humidity)
p = float(pressure)
# Variables
edifference = 1
twguess = 0
previoussign = 1
incr = 10
es = 6.112 * math.exp(17.67 * t / (t + 243.5))
e2 = es * (rh / 100)
while (abs(edifference) > 0.005):
ewguess = 6.112 * math.exp((17.67 * twguess) / (twguess + 243.5))
eguess = ewguess - p * (t - twguess) * 0.00066 * (1 + (0.00115 * twguess))
edifference = e2 - eguess
if edifference == 0:
break
if edifference < 0:
cursign = -1
if (cursign != previoussign):
previoussign = cursign
incr = incr / 10
else:
incr = incr
else:
cursign = 1
if (cursign != previoussign):
previoussign = cursign
incr = incr / 10
else:
incr = incr
twguess = twguess + incr * previoussign
return await self.temperature(twguess)
async def delta_t(self, temp, humidity, pressure):
"""Returns Delta T temperature."""
wb = await self.wetbulb(temp, humidity, pressure)
deltat = temp - wb
return await self.temperature(deltat)
async def beaufort(self, wind_speed):
"""Returns the Beaufort Scale value based on Wind Speed."""
if wind_speed is None:
return 0, self._translations["beaufort"][str(0)]
if wind_speed > 32.7:
bft_value = 12
elif wind_speed >= 28.5:
bft_value = 11
elif wind_speed >= 24.5:
bft_value = 10
elif wind_speed >= 20.8:
bft_value = 9
elif wind_speed >= 17.2:
bft_value = 8
elif wind_speed >= 13.9:
bft_value = 7
elif wind_speed >= 10.8:
bft_value = 6
elif wind_speed >= 8.0:
bft_value = 5
elif wind_speed >= 5.5:
bft_value = 4
elif wind_speed >= 3.4:
bft_value = 3
elif wind_speed >= 1.6:
bft_value = 2
elif wind_speed >= 0.3:
bft_value = 1
else:
bft_value = 0
bft_text = self._translations["beaufort"][str(bft_value)]
return bft_value, bft_text
async def dewpoint_level(self, dewpoint_c):
"""Returns a text based comfort level, based on dewpoint F value."""
if dewpoint_c is None:
return "no-data"
if self._unit_system == UNITS_IMPERIAL:
dewpoint = dewpoint_c
else:
dewpoint = (dewpoint_c * 9 / 5) + 32
if dewpoint >= 80:
return self._translations["dewpoint"]["severely-high"]
if dewpoint >= 75:
return self._translations["dewpoint"]["miserable"]
if dewpoint >= 70:
return self._translations["dewpoint"]["oppressive"]
if dewpoint >= 65:
return self._translations["dewpoint"]["uncomfortable"]
if dewpoint >= 60:
return self._translations["dewpoint"]["ok-for-most"]
if dewpoint >= 55:
return self._translations["dewpoint"]["comfortable"]
if dewpoint >= 50:
return self._translations["dewpoint"]["very-comfortable"]
if dewpoint >= 30:
return self._translations["dewpoint"]["somewhat-dry"]
if dewpoint >= 0.5:
return self._translations["dewpoint"]["dry"]
if dewpoint >= 0:
return self._translations["dewpoint"]["very-dry"]
return self._translations["dewpoint"]["undefined"]
async def temperature_level(self, temperature_c):
"""Returns a text based comfort level, based on Air Temperature value."""
if temperature_c is None:
return "no-data"
temperature = (temperature_c * 9 / 5) + 32
if temperature >= 104:
return self._translations["temperature"]["inferno"]
if temperature >= 95:
return self._translations["temperature"]["very-hot"]
if temperature >= 86:
return self._translations["temperature"]["hot"]
if temperature >= 77:
return self._translations["temperature"]["warm"]
if temperature >= 68:
return self._translations["temperature"]["nice"]
if temperature >= 59:
return self._translations["temperature"]["cool"]
if temperature >= 41:
return self._translations["temperature"]["chilly"]
if temperature >= 32:
return self._translations["temperature"]["cold"]
if temperature >= 20:
return self._translations["temperature"]["freezing"]
if temperature <= 20:
return self._translations["temperature"]["fridged"]
return self._translations["temperature"]["undefined"]
async def uv_level(self, uvi):
"""Returns a text based UV Description."""
if uvi is None:
return "no-data"
if uvi >= 10.5:
return self._translations["uv"]["extreme"]
if uvi >= 7.5:
return self._translations["uv"]["very-high"]
if uvi >= 5.5:
return self._translations["uv"]["high"]
if uvi >= 2.5:
return self._translations["uv"]["moderate"]
if uvi > 0:
return self._translations["uv"]["low"]
return self._translations["uv"]["none"]
async def humanize_time(self, value):
"""Humanize Time in Seconds."""
if value is None:
return "None"
return str(datetime.timedelta(seconds=value))
async def device_status(self, value):
"""Return device status as string."""
if value is None:
return
binvalue = str(bin(value))
binarr = binvalue[2:]
return_value = []
for x in range(len(binarr)):
if binarr[x:x+1] == "1":
return_value.append(DEVICE_STATUS[len(binarr)-x])
return return_value
class DataStorage:
"""Handles reading and writing of the external storage file."""
logging.basicConfig(level=logging.DEBUG)
async def read_config(self):
"""Reads the config file, to look for sensors."""
try:
filepath = f"{EXTERNAL_DIRECTORY}/config.yaml"
with open(filepath, "r") as file:
data = yaml.load(file, Loader=yaml.FullLoader)
sensors = data.get("sensors")
return sensors
except FileNotFoundError as e:
return None
except Exception as e:
_LOGGER.debug("Could not read config.yaml file. Error message: %s", e)
return None
async def getLanguageFile(self, language: str):
"""Return the language file json array."""
try:
if language not in SUPPORTED_LANGUAGES:
filename = "translations/en.json"
else:
filename = f"translations/{language.lower()}.json"
with open(filename, "r") as json_file:
return json.load(json_file)
except FileNotFoundError as e:
_LOGGER.debug("Could not read language file. Error message: %s", e)
return None
except Exception as e:
_LOGGER.debug("Could not read language file. Error message: %s", e)
return None
def getVersion(self):
"""Returns the version number stored in the VERSION file."""
try:
filepath = "/VERSION"
with open(filepath, "r") as file:
lines = file.readlines()
for line in lines:
if line != "\n":
return line.replace("\n", "")
except FileNotFoundError as e:
_LOGGER.error("Could not find VERSION File.")
return None
except Exception as e:
_LOGGER.debug("Could not read program version file. Error message: %s", e)
return None