PiFire/distance_hcsr04.py at main · tukutt/PiFire · GitHub

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
#!/usr/bin/env python3

# *****************************************
# PiFire hcsr04 Interface Library
# *****************************************
#
# Description: This library supports getting
# 	the hopper level from the distance sensor
#  NOTE: This library hasn't been tested with real
#  hardware yet and is provided for testing.
#
# Library dependency installation instructions:
#  sudo pip3 install hcsr04sensor
#
# *****************************************

# *****************************************
# Imported Libraries
# *****************************************

from hcsr04sensor import sensor
from common import write_log

class HopperLevel:

	def __init__(self, dev_pins, empty=22, full=4, debug=False):
		self.empty = empty # Empty is greater than distance measured for empty
		self.full = full # Full is less than or equal to the minimum full distance.
		if self.empty <= self.full:
			event = 'ERROR: Invalid Hopper Level Configuration Empty Level <= Full Level (forcing defaults)'
			write_log(event)
			# Set defaults that are valid
			self.empty = 22
			self.full = 4

		# (NOTE: This is a 5V device and must be connected to 5V VCC)
		self.trig_pin = dev_pins['distance']['trig']
		# (NOTE: This pin (echo_pin) must have a resistor divider to reduce the voltage to tolerable levels)
		# (Details: https://www.linuxnorth.org/hcsr04sensor/)
		self.echo_pin = dev_pins['distance']['echo']

		# Default values
		# unit = 'metric'
		# temperature = 20 (room temp in Celsius)

		#  Create a distance reading with the hcsr04 sensor module
		self.ultrasonic = sensor.Measurement(self.trig_pin, self.echo_pin)

	def set_level(self, level=100):
		# Do nothing
		return()

	def update_distances(self, empty=22, full=4):
		self.empty = empty
		self.full = full

	def get_distances(self):
		levels = {}
		levels['empty'] = self.empty
		levels['full'] = self.full
		return (levels)

	def get_level(self):
		avg_dist = self.ultrasonic.raw_distance()  # Average Distance in cm

		# If Average Distance is less than the full distance, we are at 100%
		if avg_dist <= self.full:
			level = 100
		# If Average Distance is less than the empty distance, calculate percentage
		elif avg_dist <= self.empty:
			capacity = self.empty - self.full
			adjusted_ratio = (self.empty / capacity) * 100
			level = adjusted_ratio * (1 - (avg_dist / self.empty))
		# If Average Distance is higher than empty distance, report 0 level
		else:
			level = 0

		return(int(level))