edilkamin package
Submodules
edilkamin module
- class edilkamin.Power(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)
Bases:
Enum- OFF = 0
- ON = 1
- edilkamin.check_connection(token: str, mac_address: str) str
Check if the token is still valid. Return a “Command 00030529000154df executed successfully” on success. Raise an HTTPError exception otherwise.
- edilkamin.device_info(token: str, mac: str) Dict
Retrieve device info for a given MAC address in the format aabbccddeeff.
- edilkamin.device_info_get_airkare(info: Dict) bool
Get airkare status from cached info.
- edilkamin.device_info_get_alarm_reset(info: Dict) bool
Get alarm reset value from cached info.
- edilkamin.device_info_get_autonomy_time(info: Dict) int
Get autonomy time from cached info.
- edilkamin.device_info_get_chrono_mode(info: Dict) bool
Get chrono mode status from cached info.
- edilkamin.device_info_get_easy_timer(info: Dict) int
Get easy timer value from cached info.
- edilkamin.device_info_get_environment_temperature(info: Dict) int
Get environment temperature value from cached info.
- edilkamin.device_info_get_fan_speed(info: Dict, fan_id: int) int
Get fan id speed value from cached info.
- edilkamin.device_info_get_manual_power_level(info: Dict) int
Get manual power level value from cached info.
- edilkamin.device_info_get_pellet_reserve(info: Dict) bool
Get pellet reserve status from cached info.
- edilkamin.device_info_get_perform_cochlea_loading(info: Dict) bool
Get perform cochlea loading state from cached info.
- edilkamin.device_info_get_relax_mode(info: Dict) bool
Get relax mode status from cached info.
- edilkamin.device_info_get_standby_mode(info: Dict) bool
Get standby mode status from cached info.
- edilkamin.device_info_get_target_temperature(info: Dict) int
Get target temperature value from cached info.
- edilkamin.discover_devices(convert=True) Tuple[str]
Discover devices using bluetooth. Return the MAC addresses of the discovered devices. Return the addresses converted to device wifi/identifier instead of the BLE ones.
- edilkamin.discover_devices_helper(devices: Tuple[Dict], convert=True) Tuple[str]
Given a list of bluetooth addresses/names return the ones matching for Edilkamin. >>> devices = ( … {“name”: “EDILKAMIN_EP”, “address”: “01:23:45:67:89:AB”}, … {“name”: “another_device”, “address”: “AA:BB:CC:DD:EE:FF”}, … ) >>> discover_devices_helper(devices) (‘01:23:45:67:89:a9’,)
- edilkamin.get_airkare(token: str, mac_address: str) bool
Get airkare status.
- edilkamin.get_autonomy_time(token: str, mac_address: str) int
Get autonomy time.
- edilkamin.get_chrono_mode(token: str, mac_address: str) bool
Get chrono mode status.
- edilkamin.get_easy_timer(token: str, mac_address: str) int
Get easy timer value, return 0 if disabled.
- edilkamin.get_environment_temperature(token: str, mac_address: str) Power
Get environment temperature coming from sensor.
- edilkamin.get_fan_speed(token: str, mac_address: str, fan_id: int) int
Get fan id speed value.
- edilkamin.get_manual_power_level(token: str, mac_address: str) int
Get manual power level value.
- edilkamin.get_pellet_reserve(token: str, mac_address: str) bool
Get pellet reserve status.
- edilkamin.get_perform_cochlea_loading(token: str, mac_address: str) bool
Get perform cochlea loading state.
- edilkamin.get_relax_mode(token: str, mac_address: str) bool
Get relax mode status.
- edilkamin.get_standby_mode(token: str, mac_address: str) bool
Get standby mode status.
- edilkamin.mqtt_command(token: str, mac_address: str, payload: Dict) str
Send a MQTT command to the device identified with the MAC address. Return the response string.
- edilkamin.set_airkare(token: str, mac_address: str, airkare: bool) str
Set airkare. Return response string e.g. “Command 0123456789abcdef executed successfully”.
- edilkamin.set_chrono_mode(token: str, mac_address: str, chrono_mode: bool) str
Set chrono mode. Return response string e.g. “Command 0123456789abcdef executed successfully”.
- edilkamin.set_easy_timer(token: str, mac_address: str, easy_timer: int) str
Set easy timer value. Return response string e.g. “Command 0123456789abcdef executed successfully”.
- edilkamin.set_fan_speed(token: str, mac_address: str, fan_id: int, speed: int) str
Set fan id speed. Return response string e.g. “Command 0123456789abcdef executed successfully”.
- edilkamin.set_manual_power_level(token: str, mac_address: str, manual_power_level: int) str
Set manual power level value. Return response string e.g. “Command 0123456789abcdef executed successfully”.
- edilkamin.set_power(token: str, mac_address: str, power: Power) str
Set device power. Return response string e.g. “Command 0123456789abcdef executed successfully”.
- edilkamin.set_power_off(token: str, mac_address: str) str
- edilkamin.set_power_on(token: str, mac_address: str) str
- edilkamin.set_relax_mode(token: str, mac_address: str, relax_mode: bool) str
Set relax mode. Return response string e.g. “Command 0123456789abcdef executed successfully”.
- edilkamin.set_standby_mode(token: str, mac_address: str, standby_mode: bool) str
Set standby mode. Return response string e.g. “Command 0123456789abcdef executed successfully”.
- edilkamin.set_target_temperature(token: str, mac_address: str, temperature: int) str
Set target temperature in degree. Return response string e.g. “Command 0006052500b558ab executed successfully”.
- edilkamin.sign_in(username: str, password: str) str
Sign in and return token.