def create_device(name, idx, sensor_type):
params = {
'type': 'createdevice',
'idx': idx,
'sensorname': name,
'sensormappedtype': sensor_type
}
return domoticz.api_call(params)
def get_switch_history(idx: IdxType, time_range=CONSTANTS.LOGS_RANGE_DAY):
'''
Returns history of switch type device.
:param idx: device's idx number in Domoticz
'''
params = {'type': 'lightlog', 'idx': idx, 'range': time_range}
return domoticz.api_call(params)['result']
def get_users():
'''
Returns user's data.
:return: users' data.
'''
params = {'type': 'users'}
return domoticz.api_call(params)['result']
def update_text(idx, value):
params = {
'type': 'command',
'param': 'udevice',
'idx': idx,
'nvalue': '0',
'svalue': value,
}
return domoticz.api_call(params)
def get_all_devices_in_room(idx: IdxType):
'''
Returns all devices for room specified by
idx.
:param idx: room's idx number in Domoticz
'''
params = {'type': 'command', 'param': 'getplandevices', 'idx': idx}
return domoticz.api_call(params)['result']
def get_device(idx: IdxType):
'''
Fetch device information identified by idx from Domoticz API.
:param idx: idx of device.
:return: dict with device information.
'''
params = {'type': 'devices', 'rid': idx}
return domoticz.api_call(params)['result']
def create_virtual_hardware(name):
params = {
'type': 'command',
'param': 'addhardware',
'htype': '15',
'port': '1',
'name': name,
'enabled': 'true'
}
return domoticz.api_call(params)
def get_used_devices():
'''Returns dictionary of device records.
:return: list of devices.
'''
params = {
'displayhidden': '1',
'filter': 'all',
'type': 'devices',
'used': 'all',
}
return domoticz.api_call(params)['result']
def get_user_variables(idx: IdxType = None):
'''
Returns all user variables or returns one
specified by `idx` argument.
:param idx: idx of variable
'''
params = {'type': 'command', 'param': 'getuservariables'}
if idx:
params['idx'] = idx
return domoticz.api_call(params)['result']
def get_temperature_history(idx: IdxType, time_range=CONSTANTS.LOGS_RANGE_DAY):
'''
Gets temperature, humidity and pressure history from device
with idx and given range.
:param idx: device's idx number in Domoticz
:param time_range: time range (day, month, year)
'''
params = {
'type': 'graph',
'sensor': 'temp',
'idx': idx,
'range': time_range
}
return domoticz.api_call(params)['result']
def turn_switch_light(idx: IdxType, switchMode: str):
'''
Command for turning switch or light on/off
:param idx: idx of device.
:param switchMode: On or Off
:return: dict with device information.
'''
params = {
'type': 'command',
'param': 'switchlight',
'idx': idx,
'switchcmd': switchMode
}
return domoticz.api_call(params)
def update_humidity(idx, value):
value = value.split(',')
if len(value) != 1:
nvalue = value[0]
svalue = value[1]
else:
nvalue = svalue = value[0]
params = {
'type': 'command',
'param': 'udevice',
'idx': idx,
'nvalue': nvalue,
'svalue': svalue,
}
return domoticz.api_call(params)
def log_in(login_b64: str, password_b64: str):
'''
Command to log in Domoticz using
login and password.
:param login: base64 encoded Domoticz login
:param password_b64: base64 encoded password
'''
params = {
'username': login_b64,
'password': password_b64,
'type': 'command',
'param': 'getversion'
}
return domoticz.api_call(params, use_auth=False)
def get_all_rooms():
'''
Returns list of all rooms.
'''
params = {'type': 'plans', 'order': 'name', 'used': 'true'}
return domoticz.api_call(params)['result']
def delete_hardware(idx):
params = {'type': 'command', 'param': 'deletehardware', 'idx': idx}
return domoticz.api_call(params)
def get_settings():
'''
Returns Domoticz settings.
'''
return domoticz.api_call({'type': 'settings'})
def list_hardware():
params = {
'type': 'hardware',
}
return domoticz.api_call(params)
