pycram.external_interfaces.blum_api

Functions

init_kitchen_interface(→ Callable)	Tries to import the messages and initialize interface.
authenticate_user()	Authenticates a user at the bridge
call_kitchen_service(command, argument)
open_cabinet(kitchen_element)	Opens a cabinet of the apartment kitchen
close_cabinet(kitchen_element)	Closes a cabinet of the apartment kitchen, currently this is only possible for the "oberschrank"
modules_show()	Shows all possible cabinet modules that can be called
kitchen_state(→ Dict[str, Dict[str, str]])	Returns the state of the whole kitchen as a dictionary. The mapping is "name": {"state", "type"}

Module Contents

pycram.external_interfaces.blum_api.init_kitchen_interface(func: Callable) → Callable

Tries to import the messages and initialize interface.

pycram.external_interfaces.blum_api.authenticate_user()

Authenticates a user at the bridge

pycram.external_interfaces.blum_api.call_kitchen_service(command, argument)

pycram.external_interfaces.blum_api.open_cabinet(kitchen_element)

Opens a cabinet of the apartment kitchen

Parameters:

kitchen_element – The cabinet which should be opened

pycram.external_interfaces.blum_api.close_cabinet(kitchen_element)

Closes a cabinet of the apartment kitchen, currently this is only possible for the “oberschrank”

Parameters:

kitchen_element – Cabinet which should be closed

pycram.external_interfaces.blum_api.modules_show()

Shows all possible cabinet modules that can be called :return:

pycram.external_interfaces.blum_api.kitchen_state() → Dict[str, Dict[str, str]]

Returns the state of the whole kitchen as a dictionary. The mapping is “name”: {“state”, “type”}

Returns:

A dict describing the kitchen state