curl --request POST \
--url https://api.orbital-systems.com/client/showers/{id}/commands \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"action": "shower_on",
"data": {
"temperature_setpoint": 38,
"flow_setpoint": 8,
"recirculation_mode": 2,
"flow_boost": false
}
}
'import requests
url = "https://api.orbital-systems.com/client/showers/{id}/commands"
payload = {
"action": "shower_on",
"data": {
"temperature_setpoint": 38,
"flow_setpoint": 8,
"recirculation_mode": 2,
"flow_boost": False
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
action: 'shower_on',
data: {
temperature_setpoint: 38,
flow_setpoint: 8,
recirculation_mode: 2,
flow_boost: false
}
})
};
fetch('https://api.orbital-systems.com/client/showers/{id}/commands', 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}/commands",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action' => 'shower_on',
'data' => [
'temperature_setpoint' => 38,
'flow_setpoint' => 8,
'recirculation_mode' => 2,
'flow_boost' => false
]
]),
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}/commands"
payload := strings.NewReader("{\n \"action\": \"shower_on\",\n \"data\": {\n \"temperature_setpoint\": 38,\n \"flow_setpoint\": 8,\n \"recirculation_mode\": 2,\n \"flow_boost\": false\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.orbital-systems.com/client/showers/{id}/commands")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"shower_on\",\n \"data\": {\n \"temperature_setpoint\": 38,\n \"flow_setpoint\": 8,\n \"recirculation_mode\": 2,\n \"flow_boost\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbital-systems.com/client/showers/{id}/commands")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"shower_on\",\n \"data\": {\n \"temperature_setpoint\": 38,\n \"flow_setpoint\": 8,\n \"recirculation_mode\": 2,\n \"flow_boost\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3e2d1c0b-9a8f-4e7d-8c6b-5a4f3e2d1c0b",
"action": "change_temperature_setpoint"
}{
"message": "setpoint must be between 15 and 45",
"statusCode": 400,
"name": "InvalidParameterError"
}{
"message": "Forbidden",
"statusCode": 403,
"name": "ForbiddenError"
}{
"message": "Shower not found",
"statusCode": 404,
"name": "NotFoundError"
}{
"message": "Command not allowed in the current state",
"statusCode": 409,
"name": "ConflictError"
}{
"message": "Internal server error"
}{
"message": "Shower is offline",
"statusCode": 503,
"name": "ServiceUnavailableError"
}{
"message": "Device did not respond",
"statusCode": 504,
"name": "GatewayTimeoutError"
}Send a remote control command to a shower
Waits up to 5 seconds for the shower to accept the command. Accepted means the shower will act on it, not that it already has. The data depends on the action: shower_on takes optional, nullable temperature_setpoint (°C), flow_setpoint, recirculation_mode (0-4) and flow_boost; a missing or null one is the shower’s own default. change_temperature_setpoint (°C) and change_flow_setpoint take a required setpoint. shower_off and end_session take none. Setpoints must be within the shower’s limits.
curl --request POST \
--url https://api.orbital-systems.com/client/showers/{id}/commands \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"action": "shower_on",
"data": {
"temperature_setpoint": 38,
"flow_setpoint": 8,
"recirculation_mode": 2,
"flow_boost": false
}
}
'import requests
url = "https://api.orbital-systems.com/client/showers/{id}/commands"
payload = {
"action": "shower_on",
"data": {
"temperature_setpoint": 38,
"flow_setpoint": 8,
"recirculation_mode": 2,
"flow_boost": False
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
action: 'shower_on',
data: {
temperature_setpoint: 38,
flow_setpoint: 8,
recirculation_mode: 2,
flow_boost: false
}
})
};
fetch('https://api.orbital-systems.com/client/showers/{id}/commands', 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}/commands",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action' => 'shower_on',
'data' => [
'temperature_setpoint' => 38,
'flow_setpoint' => 8,
'recirculation_mode' => 2,
'flow_boost' => false
]
]),
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}/commands"
payload := strings.NewReader("{\n \"action\": \"shower_on\",\n \"data\": {\n \"temperature_setpoint\": 38,\n \"flow_setpoint\": 8,\n \"recirculation_mode\": 2,\n \"flow_boost\": false\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.orbital-systems.com/client/showers/{id}/commands")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"shower_on\",\n \"data\": {\n \"temperature_setpoint\": 38,\n \"flow_setpoint\": 8,\n \"recirculation_mode\": 2,\n \"flow_boost\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbital-systems.com/client/showers/{id}/commands")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"shower_on\",\n \"data\": {\n \"temperature_setpoint\": 38,\n \"flow_setpoint\": 8,\n \"recirculation_mode\": 2,\n \"flow_boost\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3e2d1c0b-9a8f-4e7d-8c6b-5a4f3e2d1c0b",
"action": "change_temperature_setpoint"
}{
"message": "setpoint must be between 15 and 45",
"statusCode": 400,
"name": "InvalidParameterError"
}{
"message": "Forbidden",
"statusCode": 403,
"name": "ForbiddenError"
}{
"message": "Shower not found",
"statusCode": 404,
"name": "NotFoundError"
}{
"message": "Command not allowed in the current state",
"statusCode": 409,
"name": "ConflictError"
}{
"message": "Internal server error"
}{
"message": "Shower is offline",
"statusCode": 503,
"name": "ServiceUnavailableError"
}{
"message": "Device did not respond",
"statusCode": 504,
"name": "GatewayTimeoutError"
}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
- shower_on
- shower_off
- end_session
- change_temperature_setpoint
- change_flow_setpoint
Was this page helpful?