Update configuration
curl --request PUT \
--url https://api.orbital-systems.com/client/showers/{id}/configuration \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"boost_flow_enabled": false,
"cleaning_program_liters_limit": 2440,
"cleaning_program_sessions_limit": 20,
"cleaning_program_sessions_limit_enabled": true,
"color_mode": 0,
"daily_hot_water_treatment_enabled": true,
"daily_hot_water_treatment_time": "0300",
"default_recirculation_mode": 2,
"default_shower_flow": 9,
"heater_power_available": 3.2,
"hot_water_treatment_per_session_enabled": false,
"is_private_shower": true,
"is_wall_clock_12_hour_format": false,
"is_wall_clock_enabled": true,
"live_data_rate": 2,
"max_shower_water_flow": 12,
"min_conservation_flow": 6.5,
"min_shower_water_flow": 5,
"shower_head_hc_enabled": false,
"shower_water_temperature_fahrenheit": false,
"shower_water_temperature_max": 45,
"shower_water_temperature_min": 15,
"shower_water_temperature_start": 38,
"state_active_showering_timer": 1800,
"state_standby_no_user_wait_timer": 60,
"state_standby_wait_timer": 180,
"time_zone_name": "Europe/Stockholm",
"use_estimation_for_drain_temperature": false,
"water_conservation": false,
"welcome_message_enabled": false,
"welcome_message": "Welcome!",
"water_hardness": 8,
"language": "de"
}
'import requests
url = "https://api.orbital-systems.com/client/showers/{id}/configuration"
payload = {
"boost_flow_enabled": False,
"cleaning_program_liters_limit": 2440,
"cleaning_program_sessions_limit": 20,
"cleaning_program_sessions_limit_enabled": True,
"color_mode": 0,
"daily_hot_water_treatment_enabled": True,
"daily_hot_water_treatment_time": "0300",
"default_recirculation_mode": 2,
"default_shower_flow": 9,
"heater_power_available": 3.2,
"hot_water_treatment_per_session_enabled": False,
"is_private_shower": True,
"is_wall_clock_12_hour_format": False,
"is_wall_clock_enabled": True,
"live_data_rate": 2,
"max_shower_water_flow": 12,
"min_conservation_flow": 6.5,
"min_shower_water_flow": 5,
"shower_head_hc_enabled": False,
"shower_water_temperature_fahrenheit": False,
"shower_water_temperature_max": 45,
"shower_water_temperature_min": 15,
"shower_water_temperature_start": 38,
"state_active_showering_timer": 1800,
"state_standby_no_user_wait_timer": 60,
"state_standby_wait_timer": 180,
"time_zone_name": "Europe/Stockholm",
"use_estimation_for_drain_temperature": False,
"water_conservation": False,
"welcome_message_enabled": False,
"welcome_message": "Welcome!",
"water_hardness": 8,
"language": "de"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
boost_flow_enabled: false,
cleaning_program_liters_limit: 2440,
cleaning_program_sessions_limit: 20,
cleaning_program_sessions_limit_enabled: true,
color_mode: 0,
daily_hot_water_treatment_enabled: true,
daily_hot_water_treatment_time: '0300',
default_recirculation_mode: 2,
default_shower_flow: 9,
heater_power_available: 3.2,
hot_water_treatment_per_session_enabled: false,
is_private_shower: true,
is_wall_clock_12_hour_format: false,
is_wall_clock_enabled: true,
live_data_rate: 2,
max_shower_water_flow: 12,
min_conservation_flow: 6.5,
min_shower_water_flow: 5,
shower_head_hc_enabled: false,
shower_water_temperature_fahrenheit: false,
shower_water_temperature_max: 45,
shower_water_temperature_min: 15,
shower_water_temperature_start: 38,
state_active_showering_timer: 1800,
state_standby_no_user_wait_timer: 60,
state_standby_wait_timer: 180,
time_zone_name: 'Europe/Stockholm',
use_estimation_for_drain_temperature: false,
water_conservation: false,
welcome_message_enabled: false,
welcome_message: 'Welcome!',
water_hardness: 8,
language: 'de'
})
};
fetch('https://api.orbital-systems.com/client/showers/{id}/configuration', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbital-systems.com/client/showers/{id}/configuration",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'boost_flow_enabled' => false,
'cleaning_program_liters_limit' => 2440,
'cleaning_program_sessions_limit' => 20,
'cleaning_program_sessions_limit_enabled' => true,
'color_mode' => 0,
'daily_hot_water_treatment_enabled' => true,
'daily_hot_water_treatment_time' => '0300',
'default_recirculation_mode' => 2,
'default_shower_flow' => 9,
'heater_power_available' => 3.2,
'hot_water_treatment_per_session_enabled' => false,
'is_private_shower' => true,
'is_wall_clock_12_hour_format' => false,
'is_wall_clock_enabled' => true,
'live_data_rate' => 2,
'max_shower_water_flow' => 12,
'min_conservation_flow' => 6.5,
'min_shower_water_flow' => 5,
'shower_head_hc_enabled' => false,
'shower_water_temperature_fahrenheit' => false,
'shower_water_temperature_max' => 45,
'shower_water_temperature_min' => 15,
'shower_water_temperature_start' => 38,
'state_active_showering_timer' => 1800,
'state_standby_no_user_wait_timer' => 60,
'state_standby_wait_timer' => 180,
'time_zone_name' => 'Europe/Stockholm',
'use_estimation_for_drain_temperature' => false,
'water_conservation' => false,
'welcome_message_enabled' => false,
'welcome_message' => 'Welcome!',
'water_hardness' => 8,
'language' => 'de'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbital-systems.com/client/showers/{id}/configuration"
payload := strings.NewReader("{\n \"boost_flow_enabled\": false,\n \"cleaning_program_liters_limit\": 2440,\n \"cleaning_program_sessions_limit\": 20,\n \"cleaning_program_sessions_limit_enabled\": true,\n \"color_mode\": 0,\n \"daily_hot_water_treatment_enabled\": true,\n \"daily_hot_water_treatment_time\": \"0300\",\n \"default_recirculation_mode\": 2,\n \"default_shower_flow\": 9,\n \"heater_power_available\": 3.2,\n \"hot_water_treatment_per_session_enabled\": false,\n \"is_private_shower\": true,\n \"is_wall_clock_12_hour_format\": false,\n \"is_wall_clock_enabled\": true,\n \"live_data_rate\": 2,\n \"max_shower_water_flow\": 12,\n \"min_conservation_flow\": 6.5,\n \"min_shower_water_flow\": 5,\n \"shower_head_hc_enabled\": false,\n \"shower_water_temperature_fahrenheit\": false,\n \"shower_water_temperature_max\": 45,\n \"shower_water_temperature_min\": 15,\n \"shower_water_temperature_start\": 38,\n \"state_active_showering_timer\": 1800,\n \"state_standby_no_user_wait_timer\": 60,\n \"state_standby_wait_timer\": 180,\n \"time_zone_name\": \"Europe/Stockholm\",\n \"use_estimation_for_drain_temperature\": false,\n \"water_conservation\": false,\n \"welcome_message_enabled\": false,\n \"welcome_message\": \"Welcome!\",\n \"water_hardness\": 8,\n \"language\": \"de\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.orbital-systems.com/client/showers/{id}/configuration")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"boost_flow_enabled\": false,\n \"cleaning_program_liters_limit\": 2440,\n \"cleaning_program_sessions_limit\": 20,\n \"cleaning_program_sessions_limit_enabled\": true,\n \"color_mode\": 0,\n \"daily_hot_water_treatment_enabled\": true,\n \"daily_hot_water_treatment_time\": \"0300\",\n \"default_recirculation_mode\": 2,\n \"default_shower_flow\": 9,\n \"heater_power_available\": 3.2,\n \"hot_water_treatment_per_session_enabled\": false,\n \"is_private_shower\": true,\n \"is_wall_clock_12_hour_format\": false,\n \"is_wall_clock_enabled\": true,\n \"live_data_rate\": 2,\n \"max_shower_water_flow\": 12,\n \"min_conservation_flow\": 6.5,\n \"min_shower_water_flow\": 5,\n \"shower_head_hc_enabled\": false,\n \"shower_water_temperature_fahrenheit\": false,\n \"shower_water_temperature_max\": 45,\n \"shower_water_temperature_min\": 15,\n \"shower_water_temperature_start\": 38,\n \"state_active_showering_timer\": 1800,\n \"state_standby_no_user_wait_timer\": 60,\n \"state_standby_wait_timer\": 180,\n \"time_zone_name\": \"Europe/Stockholm\",\n \"use_estimation_for_drain_temperature\": false,\n \"water_conservation\": false,\n \"welcome_message_enabled\": false,\n \"welcome_message\": \"Welcome!\",\n \"water_hardness\": 8,\n \"language\": \"de\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbital-systems.com/client/showers/{id}/configuration")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"boost_flow_enabled\": false,\n \"cleaning_program_liters_limit\": 2440,\n \"cleaning_program_sessions_limit\": 20,\n \"cleaning_program_sessions_limit_enabled\": true,\n \"color_mode\": 0,\n \"daily_hot_water_treatment_enabled\": true,\n \"daily_hot_water_treatment_time\": \"0300\",\n \"default_recirculation_mode\": 2,\n \"default_shower_flow\": 9,\n \"heater_power_available\": 3.2,\n \"hot_water_treatment_per_session_enabled\": false,\n \"is_private_shower\": true,\n \"is_wall_clock_12_hour_format\": false,\n \"is_wall_clock_enabled\": true,\n \"live_data_rate\": 2,\n \"max_shower_water_flow\": 12,\n \"min_conservation_flow\": 6.5,\n \"min_shower_water_flow\": 5,\n \"shower_head_hc_enabled\": false,\n \"shower_water_temperature_fahrenheit\": false,\n \"shower_water_temperature_max\": 45,\n \"shower_water_temperature_min\": 15,\n \"shower_water_temperature_start\": 38,\n \"state_active_showering_timer\": 1800,\n \"state_standby_no_user_wait_timer\": 60,\n \"state_standby_wait_timer\": 180,\n \"time_zone_name\": \"Europe/Stockholm\",\n \"use_estimation_for_drain_temperature\": false,\n \"water_conservation\": false,\n \"welcome_message_enabled\": false,\n \"welcome_message\": \"Welcome!\",\n \"water_hardness\": 8,\n \"language\": \"de\"\n}"
response = http.request(request)
puts response.read_body{
"boost_flow_enabled": false,
"cleaning_program_liters_limit": 2440,
"cleaning_program_sessions_limit": 20,
"cleaning_program_sessions_limit_enabled": true,
"color_mode": 0,
"daily_hot_water_treatment_enabled": true,
"daily_hot_water_treatment_time": "0300",
"default_recirculation_mode": 2,
"default_shower_flow": 9,
"heater_power_available": 3.2,
"hot_water_treatment_per_session_enabled": false,
"is_private_shower": true,
"is_wall_clock_12_hour_format": false,
"is_wall_clock_enabled": true,
"live_data_rate": 2,
"max_shower_water_flow": 12,
"min_conservation_flow": 6.5,
"min_shower_water_flow": 5,
"shower_head_hc_enabled": false,
"shower_water_temperature_fahrenheit": false,
"shower_water_temperature_max": 45,
"shower_water_temperature_min": 15,
"shower_water_temperature_start": 38,
"state_active_showering_timer": 1800,
"state_standby_no_user_wait_timer": 60,
"state_standby_wait_timer": 180,
"time_zone_name": "Europe/Stockholm",
"use_estimation_for_drain_temperature": false,
"water_conservation": false,
"welcome_message_enabled": false,
"welcome_message": "Welcome!",
"water_hardness": 8,
"language": "de",
"available_languages": [
"en",
"de",
"fr"
]
}{
"message": "language must be one of: en, de, fr",
"statusCode": 400,
"name": "InvalidParameterError"
}{
"message": "Unauthorized",
"statusCode": 401,
"name": "UnauthorizedError"
}{
"message": "Shower not found",
"statusCode": 404,
"name": "NotFoundError"
}{
"message": "Internal server error"
}Shower configuration.
Update configuration
PUT
/
client
/
showers
/
{id}
/
configuration
Update configuration
curl --request PUT \
--url https://api.orbital-systems.com/client/showers/{id}/configuration \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"boost_flow_enabled": false,
"cleaning_program_liters_limit": 2440,
"cleaning_program_sessions_limit": 20,
"cleaning_program_sessions_limit_enabled": true,
"color_mode": 0,
"daily_hot_water_treatment_enabled": true,
"daily_hot_water_treatment_time": "0300",
"default_recirculation_mode": 2,
"default_shower_flow": 9,
"heater_power_available": 3.2,
"hot_water_treatment_per_session_enabled": false,
"is_private_shower": true,
"is_wall_clock_12_hour_format": false,
"is_wall_clock_enabled": true,
"live_data_rate": 2,
"max_shower_water_flow": 12,
"min_conservation_flow": 6.5,
"min_shower_water_flow": 5,
"shower_head_hc_enabled": false,
"shower_water_temperature_fahrenheit": false,
"shower_water_temperature_max": 45,
"shower_water_temperature_min": 15,
"shower_water_temperature_start": 38,
"state_active_showering_timer": 1800,
"state_standby_no_user_wait_timer": 60,
"state_standby_wait_timer": 180,
"time_zone_name": "Europe/Stockholm",
"use_estimation_for_drain_temperature": false,
"water_conservation": false,
"welcome_message_enabled": false,
"welcome_message": "Welcome!",
"water_hardness": 8,
"language": "de"
}
'import requests
url = "https://api.orbital-systems.com/client/showers/{id}/configuration"
payload = {
"boost_flow_enabled": False,
"cleaning_program_liters_limit": 2440,
"cleaning_program_sessions_limit": 20,
"cleaning_program_sessions_limit_enabled": True,
"color_mode": 0,
"daily_hot_water_treatment_enabled": True,
"daily_hot_water_treatment_time": "0300",
"default_recirculation_mode": 2,
"default_shower_flow": 9,
"heater_power_available": 3.2,
"hot_water_treatment_per_session_enabled": False,
"is_private_shower": True,
"is_wall_clock_12_hour_format": False,
"is_wall_clock_enabled": True,
"live_data_rate": 2,
"max_shower_water_flow": 12,
"min_conservation_flow": 6.5,
"min_shower_water_flow": 5,
"shower_head_hc_enabled": False,
"shower_water_temperature_fahrenheit": False,
"shower_water_temperature_max": 45,
"shower_water_temperature_min": 15,
"shower_water_temperature_start": 38,
"state_active_showering_timer": 1800,
"state_standby_no_user_wait_timer": 60,
"state_standby_wait_timer": 180,
"time_zone_name": "Europe/Stockholm",
"use_estimation_for_drain_temperature": False,
"water_conservation": False,
"welcome_message_enabled": False,
"welcome_message": "Welcome!",
"water_hardness": 8,
"language": "de"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
boost_flow_enabled: false,
cleaning_program_liters_limit: 2440,
cleaning_program_sessions_limit: 20,
cleaning_program_sessions_limit_enabled: true,
color_mode: 0,
daily_hot_water_treatment_enabled: true,
daily_hot_water_treatment_time: '0300',
default_recirculation_mode: 2,
default_shower_flow: 9,
heater_power_available: 3.2,
hot_water_treatment_per_session_enabled: false,
is_private_shower: true,
is_wall_clock_12_hour_format: false,
is_wall_clock_enabled: true,
live_data_rate: 2,
max_shower_water_flow: 12,
min_conservation_flow: 6.5,
min_shower_water_flow: 5,
shower_head_hc_enabled: false,
shower_water_temperature_fahrenheit: false,
shower_water_temperature_max: 45,
shower_water_temperature_min: 15,
shower_water_temperature_start: 38,
state_active_showering_timer: 1800,
state_standby_no_user_wait_timer: 60,
state_standby_wait_timer: 180,
time_zone_name: 'Europe/Stockholm',
use_estimation_for_drain_temperature: false,
water_conservation: false,
welcome_message_enabled: false,
welcome_message: 'Welcome!',
water_hardness: 8,
language: 'de'
})
};
fetch('https://api.orbital-systems.com/client/showers/{id}/configuration', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbital-systems.com/client/showers/{id}/configuration",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'boost_flow_enabled' => false,
'cleaning_program_liters_limit' => 2440,
'cleaning_program_sessions_limit' => 20,
'cleaning_program_sessions_limit_enabled' => true,
'color_mode' => 0,
'daily_hot_water_treatment_enabled' => true,
'daily_hot_water_treatment_time' => '0300',
'default_recirculation_mode' => 2,
'default_shower_flow' => 9,
'heater_power_available' => 3.2,
'hot_water_treatment_per_session_enabled' => false,
'is_private_shower' => true,
'is_wall_clock_12_hour_format' => false,
'is_wall_clock_enabled' => true,
'live_data_rate' => 2,
'max_shower_water_flow' => 12,
'min_conservation_flow' => 6.5,
'min_shower_water_flow' => 5,
'shower_head_hc_enabled' => false,
'shower_water_temperature_fahrenheit' => false,
'shower_water_temperature_max' => 45,
'shower_water_temperature_min' => 15,
'shower_water_temperature_start' => 38,
'state_active_showering_timer' => 1800,
'state_standby_no_user_wait_timer' => 60,
'state_standby_wait_timer' => 180,
'time_zone_name' => 'Europe/Stockholm',
'use_estimation_for_drain_temperature' => false,
'water_conservation' => false,
'welcome_message_enabled' => false,
'welcome_message' => 'Welcome!',
'water_hardness' => 8,
'language' => 'de'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbital-systems.com/client/showers/{id}/configuration"
payload := strings.NewReader("{\n \"boost_flow_enabled\": false,\n \"cleaning_program_liters_limit\": 2440,\n \"cleaning_program_sessions_limit\": 20,\n \"cleaning_program_sessions_limit_enabled\": true,\n \"color_mode\": 0,\n \"daily_hot_water_treatment_enabled\": true,\n \"daily_hot_water_treatment_time\": \"0300\",\n \"default_recirculation_mode\": 2,\n \"default_shower_flow\": 9,\n \"heater_power_available\": 3.2,\n \"hot_water_treatment_per_session_enabled\": false,\n \"is_private_shower\": true,\n \"is_wall_clock_12_hour_format\": false,\n \"is_wall_clock_enabled\": true,\n \"live_data_rate\": 2,\n \"max_shower_water_flow\": 12,\n \"min_conservation_flow\": 6.5,\n \"min_shower_water_flow\": 5,\n \"shower_head_hc_enabled\": false,\n \"shower_water_temperature_fahrenheit\": false,\n \"shower_water_temperature_max\": 45,\n \"shower_water_temperature_min\": 15,\n \"shower_water_temperature_start\": 38,\n \"state_active_showering_timer\": 1800,\n \"state_standby_no_user_wait_timer\": 60,\n \"state_standby_wait_timer\": 180,\n \"time_zone_name\": \"Europe/Stockholm\",\n \"use_estimation_for_drain_temperature\": false,\n \"water_conservation\": false,\n \"welcome_message_enabled\": false,\n \"welcome_message\": \"Welcome!\",\n \"water_hardness\": 8,\n \"language\": \"de\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.orbital-systems.com/client/showers/{id}/configuration")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"boost_flow_enabled\": false,\n \"cleaning_program_liters_limit\": 2440,\n \"cleaning_program_sessions_limit\": 20,\n \"cleaning_program_sessions_limit_enabled\": true,\n \"color_mode\": 0,\n \"daily_hot_water_treatment_enabled\": true,\n \"daily_hot_water_treatment_time\": \"0300\",\n \"default_recirculation_mode\": 2,\n \"default_shower_flow\": 9,\n \"heater_power_available\": 3.2,\n \"hot_water_treatment_per_session_enabled\": false,\n \"is_private_shower\": true,\n \"is_wall_clock_12_hour_format\": false,\n \"is_wall_clock_enabled\": true,\n \"live_data_rate\": 2,\n \"max_shower_water_flow\": 12,\n \"min_conservation_flow\": 6.5,\n \"min_shower_water_flow\": 5,\n \"shower_head_hc_enabled\": false,\n \"shower_water_temperature_fahrenheit\": false,\n \"shower_water_temperature_max\": 45,\n \"shower_water_temperature_min\": 15,\n \"shower_water_temperature_start\": 38,\n \"state_active_showering_timer\": 1800,\n \"state_standby_no_user_wait_timer\": 60,\n \"state_standby_wait_timer\": 180,\n \"time_zone_name\": \"Europe/Stockholm\",\n \"use_estimation_for_drain_temperature\": false,\n \"water_conservation\": false,\n \"welcome_message_enabled\": false,\n \"welcome_message\": \"Welcome!\",\n \"water_hardness\": 8,\n \"language\": \"de\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbital-systems.com/client/showers/{id}/configuration")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"boost_flow_enabled\": false,\n \"cleaning_program_liters_limit\": 2440,\n \"cleaning_program_sessions_limit\": 20,\n \"cleaning_program_sessions_limit_enabled\": true,\n \"color_mode\": 0,\n \"daily_hot_water_treatment_enabled\": true,\n \"daily_hot_water_treatment_time\": \"0300\",\n \"default_recirculation_mode\": 2,\n \"default_shower_flow\": 9,\n \"heater_power_available\": 3.2,\n \"hot_water_treatment_per_session_enabled\": false,\n \"is_private_shower\": true,\n \"is_wall_clock_12_hour_format\": false,\n \"is_wall_clock_enabled\": true,\n \"live_data_rate\": 2,\n \"max_shower_water_flow\": 12,\n \"min_conservation_flow\": 6.5,\n \"min_shower_water_flow\": 5,\n \"shower_head_hc_enabled\": false,\n \"shower_water_temperature_fahrenheit\": false,\n \"shower_water_temperature_max\": 45,\n \"shower_water_temperature_min\": 15,\n \"shower_water_temperature_start\": 38,\n \"state_active_showering_timer\": 1800,\n \"state_standby_no_user_wait_timer\": 60,\n \"state_standby_wait_timer\": 180,\n \"time_zone_name\": \"Europe/Stockholm\",\n \"use_estimation_for_drain_temperature\": false,\n \"water_conservation\": false,\n \"welcome_message_enabled\": false,\n \"welcome_message\": \"Welcome!\",\n \"water_hardness\": 8,\n \"language\": \"de\"\n}"
response = http.request(request)
puts response.read_body{
"boost_flow_enabled": false,
"cleaning_program_liters_limit": 2440,
"cleaning_program_sessions_limit": 20,
"cleaning_program_sessions_limit_enabled": true,
"color_mode": 0,
"daily_hot_water_treatment_enabled": true,
"daily_hot_water_treatment_time": "0300",
"default_recirculation_mode": 2,
"default_shower_flow": 9,
"heater_power_available": 3.2,
"hot_water_treatment_per_session_enabled": false,
"is_private_shower": true,
"is_wall_clock_12_hour_format": false,
"is_wall_clock_enabled": true,
"live_data_rate": 2,
"max_shower_water_flow": 12,
"min_conservation_flow": 6.5,
"min_shower_water_flow": 5,
"shower_head_hc_enabled": false,
"shower_water_temperature_fahrenheit": false,
"shower_water_temperature_max": 45,
"shower_water_temperature_min": 15,
"shower_water_temperature_start": 38,
"state_active_showering_timer": 1800,
"state_standby_no_user_wait_timer": 60,
"state_standby_wait_timer": 180,
"time_zone_name": "Europe/Stockholm",
"use_estimation_for_drain_temperature": false,
"water_conservation": false,
"welcome_message_enabled": false,
"welcome_message": "Welcome!",
"water_hardness": 8,
"language": "de",
"available_languages": [
"en",
"de",
"fr"
]
}{
"message": "language must be one of: en, de, fr",
"statusCode": 400,
"name": "InvalidParameterError"
}{
"message": "Unauthorized",
"statusCode": 401,
"name": "UnauthorizedError"
}{
"message": "Shower not found",
"statusCode": 404,
"name": "NotFoundError"
}{
"message": "Internal server error"
}Authorizations
Send your API key in the x-api-key header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets 403 with { "message": "Forbidden" }.
Path Parameters
The unique identifier for the shower
Body
application/json
Lets users raise the flow above the normal maximum.
Example:
false
Litres of water the shower can use before it asks for descaling.
Example:
2440
Sessions the shower can run before it asks for descaling. Only used by older showers.
Example:
20
Whether the shower asks for descaling when its limit is reached.
Example:
true
Control dial theme: 0 light, 1 dark.
Required range:
0 <= x <= 1Example:
0
Runs a heat-cycle cleaning every day at daily_hot_water_treatment_time.
Example:
true
Time of the daily heat cycle, as HHMM in the shower’s local time.
Required string length:
4Example:
"0300"
Savings mode a session starts in: 1 Legacy (no recirculation), 2 Earth, 3 Moon, 4 Mars.
Required range:
0 <= x <= 4Example:
2
Flow a session starts at, in L/min. 4–12.
Required range:
4 <= x <= 12Example:
9
Heater power the installation allows, in kW.
Example:
3.2
Runs a heat cycle after every session.
Example:
false
Whether the shower is in a home (true) or a business such as a gym or hotel (false).
Example:
true
Shows the Control dial clock in 12-hour (AM/PM) format.
Example:
false
Shows a clock on the Control dial.
Example:
true
How often the shower sends live data: 0 off, 1 fast (at least once a second), 2 auto (the shower decides).
Example:
2
Highest flow a user can set, in L/min. 4–12.
Required range:
4 <= x <= 12Example:
12
Lowest flow eco flow (water_conservation) may drop to, in L/min.
Example:
6.5
Lowest flow a user can set, in L/min. 4–12.
Required range:
4 <= x <= 12Example:
5
Also flushes the shower head with hot water during the scheduled heat cycle.
Example:
false
Shows temperatures on the Control dial in °F. The API always uses °C.
Example:
false
Highest temperature a user can set, in °C. 0–50.
Required range:
0 <= x <= 50Example:
45
Lowest temperature a user can set, in °C. 0–50.
Required range:
0 <= x <= 50Example:
15
Temperature a session starts at, in °C. 0–50.
Required range:
0 <= x <= 50Example:
38
Seconds of showering before the shower pauses by itself.
Example:
1800
Seconds paused with nobody in the shower before the session ends.
Example:
60
Seconds paused before the session ends.
Example:
180
IANA time zone of the shower, used for its clock and scheduled cleaning.
Example:
"Europe/Stockholm"
Estimates the drain water temperature instead of measuring it.
Example:
false
Eco flow: lowers the flow (down to min_conservation_flow) to keep recirculating instead of switching to fresh water.
Example:
false
Shows a welcome message when someone steps into the shower. Only in businesses (is_private_shower: false).
Example:
false
Text of the welcome message, under 36 bytes in UTF-8. An empty string shows the default message in the shower’s language.
Example:
"Welcome!"
Hardness of the incoming water, in °dH. 1–30. Setting it sets cleaning_program_liters_limit to match. Returned only when the limit matches a hardness.
Required range:
1 <= x <= 30Example:
8
Language shown on the Control dial, as an ISO 639-1 code. Not supported by older showers. One of the codes in available_languages (currently en, de, fr).
Example:
"de"
Response
Configuration updated successfully
Lets users raise the flow above the normal maximum.
Example:
false
Litres of water the shower can use before it asks for descaling.
Example:
2440
Sessions the shower can run before it asks for descaling. Only used by older showers.
Example:
20
Whether the shower asks for descaling when its limit is reached.
Example:
true
Control dial theme: 0 light, 1 dark.
Example:
0
Runs a heat-cycle cleaning every day at daily_hot_water_treatment_time.
Example:
true
Time of the daily heat cycle, as HHMM in the shower’s local time.
Pattern:
^(0[0-9]|1[0-9]|2[0-3])[0-5][0-9]$Example:
"0300"
Savings mode a session starts in: 1 Legacy (no recirculation), 2 Earth, 3 Moon, 4 Mars.
Example:
2
Flow a session starts at, in L/min. 4–12.
Example:
9
Heater power the installation allows, in kW.
Example:
3.2
Runs a heat cycle after every session.
Example:
false
Whether the shower is in a home (true) or a business such as a gym or hotel (false).
Example:
true
Shows the Control dial clock in 12-hour (AM/PM) format.
Example:
false
Shows a clock on the Control dial.
Example:
true
How often the shower sends live data: 0 off, 1 fast (at least once a second), 2 auto (the shower decides).
Example:
2
Highest flow a user can set, in L/min. 4–12.
Example:
12
Lowest flow eco flow (water_conservation) may drop to, in L/min.
Example:
6.5
Lowest flow a user can set, in L/min. 4–12.
Example:
5
Also flushes the shower head with hot water during the scheduled heat cycle.
Example:
false
Shows temperatures on the Control dial in °F. The API always uses °C.
Example:
false
Highest temperature a user can set, in °C. 0–50.
Example:
45
Lowest temperature a user can set, in °C. 0–50.
Example:
15
Temperature a session starts at, in °C. 0–50.
Example:
38
Seconds of showering before the shower pauses by itself.
Example:
1800
Seconds paused with nobody in the shower before the session ends.
Example:
60
Seconds paused before the session ends.
Example:
180
IANA time zone of the shower, used for its clock and scheduled cleaning.
Example:
"Europe/Stockholm"
Estimates the drain water temperature instead of measuring it.
Example:
false
Eco flow: lowers the flow (down to min_conservation_flow) to keep recirculating instead of switching to fresh water.
Example:
false
Shows a welcome message when someone steps into the shower. Only in businesses (is_private_shower: false).
Example:
false
Text of the welcome message, under 36 bytes in UTF-8. An empty string shows the default message in the shower’s language.
Example:
"Welcome!"
Hardness of the incoming water, in °dH. 1–30. Setting it sets cleaning_program_liters_limit to match. Returned only when the limit matches a hardness.
Required range:
1 <= x <= 30Example:
8
Language shown on the Control dial, as an ISO 639-1 code. Not supported by older showers. Left out for older showers or a language without a code.
Example:
"de"
Language codes that can be set (currently en, de, fr). Left out for older showers.
Example:
["en", "de", "fr"]
Was this page helpful?