mirror of
https://github.com/PiBrewing/craftbeerpi4.git
synced 2024-09-20 06:17:29 +02:00
b3d87bc027
- Added path parameter in config.json for settings - If empty, 'upload' will be used per default as api path - If something is entered, a different api path will be used for the creation of recipes. -> this allows the standard usage of the recipe upload and selection via cbpi4, but adds the possibility that custom plugins can be written to create cbpi recipe flows from the uploaded files ********************* + some prep work to create the http endpoints
488 lines
21 KiB
Python
488 lines
21 KiB
Python
import asyncio
|
|
|
|
from cbpi.api import parameters, Property, action
|
|
from cbpi.api.step import StepResult, CBPiStep
|
|
from cbpi.api.timer import Timer
|
|
from datetime import datetime
|
|
import time
|
|
from voluptuous.schema_builder import message
|
|
from cbpi.api.dataclasses import NotificationAction, NotificationType
|
|
from cbpi.api.dataclasses import Kettle, Props
|
|
from cbpi.api import *
|
|
import logging
|
|
from socket import timeout
|
|
from typing import KeysView
|
|
from cbpi.api.config import ConfigType
|
|
from cbpi.api.base import CBPiBase
|
|
import numpy as np
|
|
#import scipy.optimize
|
|
import warnings
|
|
|
|
|
|
|
|
@parameters([Property.Text(label="Notification",configurable = True, description = "Text for notification"),
|
|
Property.Select(label="AutoNext",options=["Yes","No"], description="Automatically move to next step (Yes) or pause after Notification (No)")])
|
|
class NotificationStep(CBPiStep):
|
|
|
|
async def NextStep(self, **kwargs):
|
|
await self.next()
|
|
|
|
async def on_timer_done(self,timer):
|
|
self.summary = self.props.get("Notification","")
|
|
|
|
if self.AutoNext == True:
|
|
self.cbpi.notify(self.name, self.props.get("Notification",""), NotificationType.INFO)
|
|
await self.next()
|
|
else:
|
|
self.cbpi.notify(self.name, self.props.get("Notification",""), NotificationType.INFO, action=[NotificationAction("Next Step", self.NextStep)])
|
|
await self.push_update()
|
|
|
|
async def on_timer_update(self,timer, seconds):
|
|
await self.push_update()
|
|
|
|
async def on_start(self):
|
|
self.summary=""
|
|
self.AutoNext = False if self.props.get("AutoNext", "No") == "No" else True
|
|
if self.timer is None:
|
|
self.timer = Timer(1 ,on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
await self.push_update()
|
|
|
|
async def on_stop(self):
|
|
await self.timer.stop()
|
|
self.summary = ""
|
|
await self.push_update()
|
|
|
|
async def run(self):
|
|
while self.running == True:
|
|
await asyncio.sleep(1)
|
|
if self.timer.is_running is not True:
|
|
self.timer.start()
|
|
self.timer.is_running = True
|
|
|
|
return StepResult.DONE
|
|
|
|
@parameters([Property.Number(label="Temp", configurable=True),
|
|
Property.Sensor(label="Sensor"),
|
|
Property.Kettle(label="Kettle"),
|
|
Property.Text(label="Notification",configurable = True, description = "Text for notification hen Temp is reached"),
|
|
Property.Select(label="AutoMode",options=["Yes","No"], description="Switch Kettlelogic automatically on and off -> Yes")])
|
|
class MashInStep(CBPiStep):
|
|
|
|
async def NextStep(self, **kwargs):
|
|
await self.next()
|
|
|
|
async def on_timer_done(self,timer):
|
|
self.summary = "MashIn Temp reached. Please add Malt."
|
|
await self.push_update()
|
|
if self.AutoMode == True:
|
|
await self.setAutoMode(False)
|
|
self.cbpi.notify(self.name, self.props.get("Notification","Target Temp reached. Please klick next to move on."), action=[NotificationAction("Next Step", self.NextStep)])
|
|
|
|
async def on_timer_update(self,timer, seconds):
|
|
await self.push_update()
|
|
|
|
async def on_start(self):
|
|
self.AutoMode = True if self.props.get("AutoMode","No") == "Yes" else False
|
|
self.kettle=self.get_kettle(self.props.get("Kettle", None))
|
|
if self.kettle is not None:
|
|
self.kettle.target_temp = int(self.props.get("Temp", 0))
|
|
if self.AutoMode == True:
|
|
await self.setAutoMode(True)
|
|
self.summary = "Waiting for Target Temp"
|
|
if self.cbpi.kettle is not None and self.timer is None:
|
|
self.timer = Timer(1 ,on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
await self.push_update()
|
|
|
|
async def on_stop(self):
|
|
await self.timer.stop()
|
|
self.summary = ""
|
|
if self.AutoMode == True:
|
|
await self.setAutoMode(False)
|
|
await self.push_update()
|
|
|
|
async def run(self):
|
|
while self.running == True:
|
|
await asyncio.sleep(1)
|
|
sensor_value = self.get_sensor_value(self.props.get("Sensor", None)).get("value")
|
|
if sensor_value >= int(self.props.get("Temp",0)) and self.timer.is_running is not True:
|
|
self.timer.start()
|
|
self.timer.is_running = True
|
|
await self.push_update()
|
|
return StepResult.DONE
|
|
|
|
async def reset(self):
|
|
self.timer = Timer(1 ,on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
|
|
async def setAutoMode(self, auto_state):
|
|
try:
|
|
if (self.kettle.instance is None or self.kettle.instance.state == False) and (auto_state is True):
|
|
await self.cbpi.kettle.toggle(self.kettle.id)
|
|
elif (self.kettle.instance.state == True) and (auto_state is False):
|
|
await self.kettle.instance.stop()
|
|
await self.push_update()
|
|
|
|
except Exception as e:
|
|
logging.error("Failed to switch on KettleLogic {} {}".format(self.kettle.id, e))
|
|
|
|
|
|
@parameters([Property.Number(label="Timer", description="Time in Minutes", configurable=True),
|
|
Property.Number(label="Temp", configurable=True),
|
|
Property.Sensor(label="Sensor"),
|
|
Property.Kettle(label="Kettle"),
|
|
Property.Select(label="AutoMode",options=["Yes","No"], description="Switch Kettlelogic automatically on and off -> Yes")])
|
|
class MashStep(CBPiStep):
|
|
|
|
@action("Start Timer", [])
|
|
async def start_timer(self):
|
|
if self.timer.is_running is not True:
|
|
self.cbpi.notify(self.name, 'Timer started', NotificationType.INFO)
|
|
self.timer.start()
|
|
self.timer.is_running = True
|
|
else:
|
|
self.cbpi.notify(self.name, 'Timer is already running', NotificationType.WARNING)
|
|
|
|
@action("Add 5 Minutes to Timer", [])
|
|
async def add_timer(self):
|
|
if self.timer.is_running == True:
|
|
self.cbpi.notify(self.name, '5 Minutes added', NotificationType.INFO)
|
|
await self.timer.add(300)
|
|
else:
|
|
self.cbpi.notify(self.name, 'Timer must be running to add time', NotificationType.WARNING)
|
|
|
|
|
|
async def on_timer_done(self,timer):
|
|
self.summary = ""
|
|
if self.AutoMode == True:
|
|
await self.setAutoMode(False)
|
|
self.cbpi.notify(self.name, 'Step finished', NotificationType.SUCCESS)
|
|
|
|
await self.next()
|
|
|
|
async def on_timer_update(self,timer, seconds):
|
|
self.summary = Timer.format_time(seconds)
|
|
await self.push_update()
|
|
|
|
async def on_start(self):
|
|
self.AutoMode = True if self.props.get("AutoMode", "No") == "Yes" else False
|
|
self.kettle=self.get_kettle(self.props.Kettle)
|
|
if self.kettle is not None:
|
|
self.kettle.target_temp = int(self.props.get("Temp", 0))
|
|
if self.AutoMode == True:
|
|
await self.setAutoMode(True)
|
|
await self.push_update()
|
|
|
|
if self.cbpi.kettle is not None and self.timer is None:
|
|
self.timer = Timer(int(self.props.get("Timer",0)) *60 ,on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
self.summary = "Waiting for Target Temp"
|
|
await self.push_update()
|
|
|
|
async def on_stop(self):
|
|
await self.timer.stop()
|
|
self.summary = ""
|
|
if self.AutoMode == True:
|
|
await self.setAutoMode(False)
|
|
await self.push_update()
|
|
|
|
async def reset(self):
|
|
self.timer = Timer(int(self.props.get("Timer",0)) *60 ,on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
|
|
async def run(self):
|
|
while self.running == True:
|
|
await asyncio.sleep(1)
|
|
sensor_value = self.get_sensor_value(self.props.get("Sensor", None)).get("value")
|
|
if sensor_value >= int(self.props.get("Temp",0)) and self.timer.is_running is not True:
|
|
self.timer.start()
|
|
self.timer.is_running = True
|
|
estimated_completion_time = datetime.fromtimestamp(time.time()+ (int(self.props.get("Timer",0)))*60)
|
|
self.cbpi.notify(self.name, 'Timer started. Estimated completion: {}'.format(estimated_completion_time.strftime("%H:%M")), NotificationType.INFO)
|
|
return StepResult.DONE
|
|
|
|
async def setAutoMode(self, auto_state):
|
|
try:
|
|
if (self.kettle.instance is None or self.kettle.instance.state == False) and (auto_state is True):
|
|
await self.cbpi.kettle.toggle(self.kettle.id)
|
|
elif (self.kettle.instance.state == True) and (auto_state is False):
|
|
await self.kettle.instance.stop()
|
|
await self.push_update()
|
|
|
|
except Exception as e:
|
|
logging.error("Failed to switch on KettleLogic {} {}".format(self.kettle.id, e))
|
|
|
|
|
|
@parameters([Property.Number(label="Timer", description="Time in Minutes", configurable=True)])
|
|
class WaitStep(CBPiStep):
|
|
|
|
async def on_timer_done(self, timer):
|
|
self.summary = ""
|
|
await self.next()
|
|
|
|
async def on_timer_update(self, timer, seconds):
|
|
self.summary = Timer.format_time(seconds)
|
|
await self.push_update()
|
|
|
|
async def on_start(self):
|
|
if self.timer is None:
|
|
self.timer = Timer(int(self.props.Timer) * 60, on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
self.timer.start()
|
|
|
|
async def on_stop(self):
|
|
await self.timer.stop()
|
|
self.summary = ""
|
|
await self.push_update()
|
|
|
|
async def reset(self):
|
|
self.timer = Timer(int(self.props.Timer) * 60, on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
|
|
async def run(self):
|
|
while self.running == True:
|
|
await asyncio.sleep(1)
|
|
return StepResult.DONE
|
|
|
|
|
|
@parameters([Property.Number(label="Timer", description="Time in Minutes", configurable=True),
|
|
Property.Actor(label="Actor")])
|
|
class ActorStep(CBPiStep):
|
|
async def on_timer_done(self, timer):
|
|
self.summary = ""
|
|
await self.next()
|
|
|
|
async def on_timer_update(self, timer, seconds):
|
|
self.summary = Timer.format_time(seconds)
|
|
await self.push_update()
|
|
|
|
async def on_start(self):
|
|
if self.timer is None:
|
|
self.timer = Timer(int(self.props.Timer) * 60, on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
self.timer.start()
|
|
await self.actor_on(self.props.Actor)
|
|
|
|
async def on_stop(self):
|
|
await self.actor_off(self.props.Actor)
|
|
await self.timer.stop()
|
|
self.summary = ""
|
|
await self.push_update()
|
|
|
|
async def reset(self):
|
|
self.timer = Timer(int(self.props.Timer) * 60, on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
|
|
async def run(self):
|
|
while self.running == True:
|
|
await asyncio.sleep(1)
|
|
return StepResult.DONE
|
|
|
|
|
|
@parameters([Property.Number(label="Timer", description="Time in Minutes", configurable=True),
|
|
Property.Number(label="Temp", description="Boil temperature", configurable=True),
|
|
Property.Sensor(label="Sensor"),
|
|
Property.Kettle(label="Kettle"),
|
|
Property.Select(label="LidAlert",options=["Yes","No"], description="Trigger Alert to remove id if temp is close to boil"),
|
|
Property.Select(label="AutoMode",options=["Yes","No"], description="Switch Kettlelogic automatically on and off -> Yes"),
|
|
Property.Select("First_Wort", options=["Yes","No"], description="First Wort Hop alert if set to Yes"),
|
|
Property.Number("Hop_1", configurable = True, description="First Hop alert (minutes before finish)"),
|
|
Property.Number("Hop_2", configurable=True, description="Second Hop alert (minutes before finish)"),
|
|
Property.Number("Hop_3", configurable=True, description="Third Hop alert (minutes before finish)"),
|
|
Property.Number("Hop_4", configurable=True, description="Fourth Hop alert (minutes before finish)"),
|
|
Property.Number("Hop_5", configurable=True, description="Fifth Hop alert (minutes before finish)"),
|
|
Property.Number("Hop_6", configurable=True, description="Sixth Hop alert (minutes before finish)")])
|
|
class BoilStep(CBPiStep):
|
|
|
|
@action("Start Timer", [])
|
|
async def start_timer(self):
|
|
if self.timer.is_running is not True:
|
|
self.cbpi.notify(self.name, 'Timer started', NotificationType.INFO)
|
|
self.timer.start()
|
|
self.timer.is_running = True
|
|
else:
|
|
self.cbpi.notify(self.name, 'Timer is already running', NotificationType.WARNING)
|
|
|
|
@action("Add 5 Minutes to Timer", [])
|
|
async def add_timer(self):
|
|
if self.timer.is_running == True:
|
|
self.cbpi.notify(self.name, '5 Minutes added', NotificationType.INFO)
|
|
await self.timer.add(300)
|
|
else:
|
|
self.cbpi.notify(self.name, 'Timer must be running to add time', NotificationType.WARNING)
|
|
|
|
async def on_timer_done(self,timer):
|
|
self.summary = ""
|
|
self.kettle.target_temp = 0
|
|
if self.AutoMode == True:
|
|
await self.setAutoMode(False)
|
|
self.cbpi.notify(self.name, 'Boiling completed', NotificationType.SUCCESS)
|
|
await self.next()
|
|
|
|
async def on_timer_update(self,timer, seconds):
|
|
self.summary = Timer.format_time(seconds)
|
|
self.remaining_seconds = seconds
|
|
await self.push_update()
|
|
|
|
async def on_start(self):
|
|
|
|
self.lid_temp = 95 if self.get_config_value("TEMP_UNIT", "C") == "C" else 203
|
|
self.lid_flag = True if self.props.get("LidAlert", "No") == "Yes" else False
|
|
self.AutoMode = True if self.props.get("AutoMode", "No") == "Yes" else False
|
|
self.first_wort_hop_flag = False
|
|
self.first_wort_hop=self.props.get("First_Wort", "No")
|
|
self.hops_added=["","","","","",""]
|
|
self.remaining_seconds = None
|
|
|
|
self.kettle=self.get_kettle(self.props.get("Kettle", None))
|
|
if self.kettle is not None:
|
|
self.kettle.target_temp = int(self.props.get("Temp", 0))
|
|
|
|
if self.cbpi.kettle is not None and self.timer is None:
|
|
self.timer = Timer(int(self.props.get("Timer", 0)) *60 ,on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
|
|
self.summary = "Waiting for Target Temp"
|
|
if self.AutoMode == True:
|
|
await self.setAutoMode(True)
|
|
await self.push_update()
|
|
|
|
async def check_hop_timer(self, number, value):
|
|
if value is not None and self.hops_added[number-1] is not True:
|
|
if self.remaining_seconds != None and self.remaining_seconds <= (int(value) * 60 + 1):
|
|
self.hops_added[number-1]= True
|
|
self.cbpi.notify('Hop Alert', "Please add Hop %s" % number, NotificationType.INFO)
|
|
|
|
async def on_stop(self):
|
|
await self.timer.stop()
|
|
self.summary = ""
|
|
self.kettle.target_temp = 0
|
|
if self.AutoMode == True:
|
|
await self.setAutoMode(False)
|
|
await self.push_update()
|
|
|
|
async def reset(self):
|
|
self.timer = Timer(int(self.props.get("Timer", 0)) *60 ,on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
|
|
async def run(self):
|
|
if self.first_wort_hop_flag == False and self.first_wort_hop == "Yes":
|
|
self.first_wort_hop_flag = True
|
|
self.cbpi.notify('First Wort Hop Addition!', 'Please add hops for first wort', NotificationType.INFO)
|
|
|
|
while self.running == True:
|
|
await asyncio.sleep(1)
|
|
sensor_value = self.get_sensor_value(self.props.get("Sensor", None)).get("value")
|
|
|
|
if self.lid_flag == True and sensor_value >= self.lid_temp:
|
|
self.cbpi.notify("Please remove lid!", "Reached temp close to boiling", NotificationType.INFO)
|
|
self.lid_flag = False
|
|
|
|
if sensor_value >= int(self.props.get("Temp", 0)) and self.timer.is_running is not True:
|
|
self.timer.start()
|
|
self.timer.is_running = True
|
|
estimated_completion_time = datetime.fromtimestamp(time.time()+ (int(self.props.get("Timer", 0)))*60)
|
|
self.cbpi.notify(self.name, 'Timer started. Estimated completion: {}'.format(estimated_completion_time.strftime("%H:%M")), NotificationType.INFO)
|
|
else:
|
|
for x in range(1, 6):
|
|
await self.check_hop_timer(x, self.props.get("Hop_%s" % x, None))
|
|
|
|
return StepResult.DONE
|
|
|
|
async def setAutoMode(self, auto_state):
|
|
try:
|
|
if (self.kettle.instance is None or self.kettle.instance.state == False) and (auto_state is True):
|
|
await self.cbpi.kettle.toggle(self.kettle.id)
|
|
elif (self.kettle.instance.state == True) and (auto_state is False):
|
|
await self.kettle.instance.stop()
|
|
await self.push_update()
|
|
|
|
except Exception as e:
|
|
logging.error("Failed to switch on KettleLogic {} {}".format(self.kettle.id, e))
|
|
|
|
|
|
@parameters([Property.Number(label="Temp", configurable=True, description="Target temperature for cooldown. Notification will be send when temp is reached and Actor can be triggered"),
|
|
Property.Sensor(label="Sensor", description="Sensor that is used during cooldown"),
|
|
Property.Actor(label="Actor", description="Actor can trigger a valve for the cooldwon to target temperature"),
|
|
Property.Kettle(label="Kettle")])
|
|
class CooldownStep(CBPiStep):
|
|
|
|
async def on_timer_done(self,timer):
|
|
self.summary = ""
|
|
if self.actor is not None:
|
|
await self.actor_off(self.actor)
|
|
self.cbpi.notify('CoolDown', 'Wort cooled down. Please transfer to Fermenter.', NotificationType.INFO)
|
|
await self.next()
|
|
|
|
async def on_timer_update(self,timer, seconds):
|
|
await self.push_update()
|
|
|
|
async def on_start(self):
|
|
warnings.simplefilter('ignore', np.RankWarning)
|
|
self.temp_array = []
|
|
self.time_array = []
|
|
self.kettle = self.get_kettle(self.props.get("Kettle", None))
|
|
self.actor = self.props.get("Actor", None)
|
|
self.target_temp = int(self.props.get("Temp",0))
|
|
self.Interval = 15 # Interval in minutes on how often cooldwon end time is calculated
|
|
|
|
self.cbpi.notify(self.name, 'Cool down to {}°'.format(self.target_temp), NotificationType.INFO)
|
|
if self.timer is None:
|
|
self.timer = Timer(1,on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
self.start_time=time.time()
|
|
self.temp_array.append(self.get_sensor_value(self.props.get("Sensor", None)).get("value"))
|
|
self.time_array.append(time.time())
|
|
self.next_check = self.start_time + self.Interval * 60
|
|
self.count = 0
|
|
self.initial_date = None
|
|
|
|
async def on_stop(self):
|
|
await self.timer.stop()
|
|
self.summary = ""
|
|
if self.actor is not None:
|
|
await self.actor_off(self.actor)
|
|
await self.push_update()
|
|
|
|
async def reset(self):
|
|
self.timer = Timer(1,on_update=self.on_timer_update, on_done=self.on_timer_done)
|
|
|
|
async def run(self):
|
|
timestring = datetime.fromtimestamp(self.start_time)
|
|
if self.actor is not None:
|
|
await self.actor_on(self.actor)
|
|
self.summary="Started: {}".format(timestring.strftime("%H:%M"))
|
|
await self.push_update()
|
|
while self.running == True:
|
|
current_temp = self.get_sensor_value(self.props.get("Sensor", None)).get("value")
|
|
if self.count == 10:
|
|
self.temp_array.append(current_temp)
|
|
current_time = time.time()
|
|
if self.initial_date == None:
|
|
self.initial_date = current_time
|
|
self.time_array.append(current_time)
|
|
self.count = 0
|
|
if time.time() >= self.next_check:
|
|
self.next_check = time.time() + (self.Interval * 60)
|
|
|
|
cooldown_model = np.poly1d(np.polyfit(self.temp_array, self.time_array, 2))
|
|
target_time=cooldown_model(self.target_temp)
|
|
target_timestring= datetime.fromtimestamp(target_time)
|
|
self.summary="ECT: {}".format(target_timestring.strftime("%H:%M"))
|
|
self.cbpi.notify("Cooldown Step","Current: {}°, reaching {}° at {}".format(round(current_temp,1), self.target_temp, target_timestring.strftime("%d.%m %H:%M")), NotificationType.INFO)
|
|
await self.push_update()
|
|
|
|
if current_temp <= self.target_temp and self.timer.is_running is not True:
|
|
self.timer.start()
|
|
self.timer.is_running = True
|
|
|
|
self.count +=1
|
|
await asyncio.sleep(1)
|
|
|
|
return StepResult.DONE
|
|
|
|
def setup(cbpi):
|
|
'''
|
|
This method is called by the server during startup
|
|
Here you need to register your plugins at the server
|
|
|
|
:param cbpi: the cbpi core
|
|
:return:
|
|
'''
|
|
|
|
cbpi.plugin.register("MashInStep", MashInStep)
|
|
cbpi.plugin.register("MashStep", MashStep)
|
|
cbpi.plugin.register("BoilStep", BoilStep)
|
|
cbpi.plugin.register("CooldownStep", CooldownStep)
|
|
cbpi.plugin.register("WaitStep", WaitStep)
|
|
cbpi.plugin.register("ActorStep", ActorStep)
|
|
cbpi.plugin.register("NotificationStep", NotificationStep)
|