fourteatoo.clj-evohome.api — io.github.fourteatoo/clj-evohome 1.1.0

Interface to the current (v1) REST API.

authenticate-client clj

(authenticate-client username password)

cancel-zone-override clj

(cancel-zone-override client zone-id)

Cancel a previous set-zone-temperature. This will effectively resume the normal schedule.

find-location-id clj

(find-location-id name inst)

Return the location ID with name name in installation inst.

find-temperature-control-system-ids clj

(find-temperature-control-system-ids location-name inst)

Find the temperature control system IDs at location-name in installation inst. Return a list.

find-zone-id clj

(find-zone-id location zone inst)

Return the zone ID in inst pointed by the pair of names location zone.

get-domestic-hot-water clj

(get-domestic-hot-water client dhw-id)

Get the status of the domestic hot water.

get-installation clj

(get-installation client user-id & {:keys [tcs?]})

Given a user ID (see get-user-account), query the installation belonging to the user. An installation is a collection of locations. The data returned for each location are name, type, adrress, gateways, etc. If tcs? is true, include the temperature control systems. Return a sequence of maps.

get-location clj

(get-location client location & {:keys [tcs?]})

Given a location ID, query the object tree belonging to that location. The data returned are name, type, adrress, gateways, etc. If tcs? is true, include the temperature control systems. Return a map. See also get-installation.

get-location-status clj

(get-location-status client location-id & {:keys [tcs?]})

Get the status of the specified location location-id. If tcs? is true include the temperature control systems within and their relative zones.

get-system-status clj

(get-system-status client system-id)

Query a specific temperature control system. A system is associated to a gateway and they may be the same physical thing. Return a map.

get-user-account clj

(get-user-account client)

Query the user account basic data, such as name, surname, address, language, user ID, etc. Return a map.

get-zone-schedule clj

(get-zone-schedule client zone-id)

Return the daily schedule of zone with ID zone-id

location-id clj

(location-id loc)

Return the ID of the location loc.

location-name clj

(location-name loc)

Return the name of the location loc.

location-temperature-control-systems clj

(location-temperature-control-systems loc)

Return the list of the temperature control systems belonging to location loc.

print-installation-index clj

(print-installation-index inst)

Print two reference tables for the installation. One with with the name and ID of the locations. The second with the name and ID of the zones.

set-domestic-hot-water clj

(set-domestic-hot-water client dhw-id state & {:keys [until]})

Set the state of the domestic hot water. Set it permanently if until is not specified. If state is :auto the normal schedule is resumed, thus cancelling any previous setting.

set-system-mode clj

(set-system-mode client system-id mode & {:keys [until]})

Set the specific system to mode. The allowed system modes depend on the installation. Refer to the sepcific installation's :allowed-system-modes, as returned by get-installations, for the list of permitted values. Set it permanently if until is not specified.

set-zone-schedule clj

(set-zone-schedule client zone-id schedule)

Set the specified zone-id to have the daily plan schedule. See get-zone-schedule.

set-zone-temperature clj

(set-zone-temperature client zone-id temperature & {:keys [until]})

Set the specific zone's temperature. Set it permanently if until is not specified.