Robot

Update robot config

Update a robot's config

POST/api/robot/updateConfig

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-schemeenum<string>headerrequireddefault: api-token

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json · object

Request to update robot configuration.

configUpdateobjectbody

Configuration updates to apply to the device

Show child attributes

audioFacetSettingsobject | nullbody

Update Audio settings

Show child attributes

audio_aec_via_softwareboolean | nullbody

audio_ai_disabledboolean | nullbody

audio_external_mic_boostinteger<int32> | nullbody

audio_external_mic_volumeinteger<int32> | nullbody

audio_external_speaker_volumeinteger<int32> | nullbody

audio_internal_mic_aec_enabledboolean | nullbody

audio_internal_mic_boostinteger<int32> | nullbody

audio_internal_mic_volumeinteger<int32> | nullbody

audio_internal_speaker_volumeinteger<int32> | nullbody

audio_min_echo_amplitudeinteger<int32> | nullbody

audio_playback_gain_percentinteger<int32> | nullbody

audio_recordboolean | nullbody

audio_supportedboolean | nullbody

audio_use_external_micboolean | nullbody

audio_use_external_speakerboolean | nullbody

audio_use_internal_speakerboolean | nullbody

device_mic_enabledboolean | nullbody

device_near_audio_silencedboolean | nullbody

device_speaker_enabledboolean | nullbody

frontendEqualizerHighShelfobjectbody

Show child attributes

frequencyinteger<int32> | nullbody

gaininteger<int32> | nullbody

qinteger<int32> | nullbody

frontendEqualizerLowShelfobjectbody

Show child attributes

frequencyinteger<int32> | nullbody

gaininteger<int32> | nullbody

qinteger<int32> | nullbody

frontendEqualizerPeaking1objectbody

Show child attributes

frequencyinteger<int32> | nullbody

gaininteger<int32> | nullbody

qinteger<int32> | nullbody

frontendEqualizerPeaking2objectbody

Show child attributes

frequencyinteger<int32> | nullbody

gaininteger<int32> | nullbody

qinteger<int32> | nullbody

frontendEqualizerPeaking3objectbody

Show child attributes

frequencyinteger<int32> | nullbody

gaininteger<int32> | nullbody

qinteger<int32> | nullbody

frontendNoiseSuppressionboolean | nullbody

updatedSetMethodMapobject | nullbody

buttonSettingsobjectbody

Update Button settings

Show child attributes

button_emergency_onsite_contactobjectbody

Show child attributes

namestring | nullbodyrequired

The name of the emergency contact.

phoneNumberstring | nullbodyrequired

The phone number for this emergency contact.

button_test_mode_enabledboolean | nullbody

updatedSetMethodMapobject | nullbody

climateSettingsobjectbody

Update Sensor Climate settings

Show child attributes

alert_window_minutesinteger<int32> | nullbody

smoke_ai_thresholdnumber<float> | nullbody

thc_ai_thresholdnumber<float> | nullbody

updatedSetMethodMapobject | nullbody

vape_ai_thresholdnumber<float> | nullbody

deviceSettingsobjectbody

Show child attributes

ai_license_invalidboolean | nullbody

bandwidth_reports_disabledboolean | nullbody

cloud_ai_smart_crop_enabledboolean | nullbody

cloud_ai_stream_enabledboolean | nullbody

core_event_upload_targetenum<string>body

Available options: 0, 1, 2

firmware_dev_settingsobject | nullbody

led_mode_blink_period_msinteger<int64> | nullbody

led_mode_when_activeenum<string>body

Available options: LED_OFF, LED_RED_SOLID, LED_GREEN_SOLID, LED_ORANGE_SOLID, LED_RED_BLINK, LED_GREEN_BLINK, LED_ORANGE_BLINK, LED_NORMAL

led_mode_when_inactiveenum<string>body

Available options: LED_OFF, LED_RED_SOLID, LED_GREEN_SOLID, LED_ORANGE_SOLID, LED_RED_BLINK, LED_GREEN_BLINK, LED_ORANGE_BLINK, LED_NORMAL

led_stealth_modeboolean | nullbody

lightweight_detection_disabledboolean | nullbody

live_license_invalidboolean | nullbody

media_ttl_minutesinteger<int32> | nullbody

on_demand_license_invalidboolean | nullbody

scanner_agent_disabledboolean | nullbody

snapshot_upload_targetenum<string>body

Available options: 0, 1, 2

storage_target_free_megabytesinteger<int32> | nullbody

storage_target_free_space_permyriadinteger<int32> | nullbody

thumbstrip_upload_targetenum<string>body

Available options: 0, 1, 2

updatedSetMethodMapobject | nullbody

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceVideoSettingsobjectbody

Update selective video settings

Show child attributes

alert_rate_limit_human_onlyobjectbody

Show child attributes

base_interval_msinteger<int32> | nullbody

burst_token_generation_msinteger<int32> | nullbody

burst_token_initial_countinteger<int32> | nullbody

burst_token_max_countinteger<int32> | nullbody

alert_rate_limit_motion_onlyobjectbody

Show child attributes

base_interval_msinteger<int32> | nullbody

burst_token_generation_msinteger<int32> | nullbody

burst_token_initial_countinteger<int32> | nullbody

burst_token_max_countinteger<int32> | nullbody

alert_rate_limit_vehicle_onlyobjectbody

Show child attributes

base_interval_msinteger<int32> | nullbody

burst_token_generation_msinteger<int32> | nullbody

burst_token_initial_countinteger<int32> | nullbody

burst_token_max_countinteger<int32> | nullbody

ir_double_tapboolean | nullbody

ir_filter_modeenum<string>body

Available options: ON, OFF, AUTO

ir_leds_modeenum<string>body

Available options: ON, OFF, AUTO

updatedSetMethodMapobject | nullbody

doorControllerSettingsobjectbody

Update Door Controller settings

Show child attributes

autocomponentize_readersboolean | nullbody

autoregister_readersboolean | nullbody

flip_display_orientationboolean | nullbody

mdns_advertise_enabledboolean | nullbody

mdns_discover_enabledboolean | nullbody

peer_address_modeenum<string>body

Available options: STRICT, HINT

peer_channel_modeenum<string>body

Available options: DISABLED, PASSIVE, ENABLED

pressure_switch_tamper_normally_openboolean | nullbody

proximity_sensor_tamper_disabledboolean | nullbody

proximity_sensor_tamper_distance_thresholdnumber<float> | nullbody

updatedSetMethodMapobject | nullbody

doorReaderSettingsobjectbody

Update Door Reader settings

Show child attributes

dr_enable_audio_feedbackboolean | nullbody

tof_max_distancenumber<float> | nullbody

tof_min_distancenumber<float> | nullbody

tof_min_signal_over_noisenumber<float> | nullbody

updatedSetMethodMapobject | nullbody

doorSensorSettingsobjectbody

Show child attributes

ajar_threshold_enabledboolean | nullbody

Option to Enabled or Disable the Ajar Threshold. Defaults to Disabled (False).

ajar_threshold_secinteger<int32> | nullbody

Threshold value for Door Sensor Ajar state. Defaults to 30s.

updatedSetMethodMapobject | nullbody

environmentalGatewaySettingsobjectbody

Update Environmental Sensor settings

Show child attributes

data_measurement_interval_secinteger<int64> | nullbody

data_upload_interval_secinteger<int64> | nullbody

false_positive_confidence_thresholdnumber<float> | nullbody

leak_detection_thresholdnumber<float> | nullbody

leak_detector_presentboolean | nullbody

moist_detection_thresholdnumber<float> | nullbody

smoke_confidence_thresholdnumber<float> | nullbody

smoke_thc_confidence_thresholdnumber<float> | nullbody

smoke_tobacco_confidence_thresholdnumber<float> | nullbody

updatedSetMethodMapobject | nullbody

vape_alert_backoff_secinteger<int64> | nullbody

vape_confidence_thresholdnumber<float> | nullbody

vape_thc_confidence_thresholdnumber<float> | nullbody

metricsAgentSettingsobjectbody

Show child attributes

batch_onboolean | nullbodydefault: true

batch_sizeinteger<int32> | nullbodydefault: 100000

Range: 10000 to 1000000

count_flush_intervalinteger<int32> | nullbodydefault: 1

Range: 1 to …

levelenum<string>bodydefault: ESSENTIAL

Available options: OFF, FILE, ESSENTIAL, BASIC, FULL

log_update_intervalinteger<int32> | nullbodydefault: 1800

Range: 1 to …

server_flush_intervalinteger<int32> | nullbodydefault: 15

Range: 1 to …

updatedSetMethodMapobject | nullbody

robotSettingsobjectbody

Show child attributes

battery_recovered_threshold_pctinteger<int32> | nullbody

home_latitudenumber<double> | nullbody

home_longitudenumber<double> | nullbody

low_battery_threshold_pctinteger<int32> | nullbody

map_assigned_at_msinteger<int64> | nullbody

map_assignment_idstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

map_idstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

poseobjectbody

Show child attributes

orientationnumber<double>[] | nullbody

Items: 4 to 4

positionnumber<double>[] | nullbody

Items: 3 to 3

preferred_localization_engineenum<string>body

Available options: AMCL, RTABMAP

updatedSetMethodMapobject | nullbody

tamperSettingsobjectbody

Update Tamper detection settings

Show child attributes

accelerometer_change_tamper_thresholdnumber<float> | nullbody

accelerometer_disabledboolean | nullbody

pressure_switch_tamper_disabledboolean | nullbody

updatedSetMethodMapobject | nullbody

videoDoorbellSettingsobjectbody

Update Video Doorbell settings

Show child attributes

standalone_doorbell_modeboolean | nullbody

updatedSetMethodMapobject | nullbody

videoFacetSettingsobject | nullbody

Update Video Settings

Show child attributes

blocked_debounce_time_msinteger<int32> | nullbody

blocked_thresholdnumber<float> | nullbody

char_thresholdnumber<float> | nullbody

crossing_regionsobject[] | nullbody

Show child attributes

directionsenum<string>[] | nullbody

enabledboolean | nullbody

in_roiobjectbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

namestring | nullbody

object_typeenum<string>body

Available options: HUMAN, VEHICLE, FACE, LPR, POSE, CLIP_EMBED, UNKNOWN

out_roiobjectbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

uuidstring | nullbody

custom_eventsboolean | nullbody

dewarpModeenum<string>body

Available options: NO_TRANSFORM, NORMAL, PANORAMA, SUB_REGION, VERTICAL_PANORAMA, TRANSVERSE_MERCATOR, MERCATOR, EQUIRECTANGULAR

disabled_scheduleobject[] | nullbody

Show child attributes

minuteOfWeekStartinteger<int32> | nullbody

minuteOfWeekStopinteger<int32> | nullbody

disabled_schedule_invertedboolean | nullbody

disabled_schedule_uuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

dwell_reset_ttl_msinteger<int64> | nullbody

dwell_time_msinteger<int64> | nullbody

exposure_levelinteger<int32> | nullbody

fisheye_display_modeenum<string>body

Available options: RAW, IMMERSIVE, TILES, RAW_PANO

floorplan_homographynumber<double>[][] | nullbody

h265_realtime_encoding_enabledboolean | nullbody

h265_vod_encoding_enabledboolean | nullbody

hdr_enabledboolean | nullbody

high_res_detectionboolean | nullbody

human_detectionboolean | nullbody

human_loiteringboolean | nullbody

human_loitering_settingsobjectbody

Show child attributes

roiobject[] | nullbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

img_brightnessinteger<int32> | nullbody

img_contrastinteger<int32> | nullbody

img_saturationinteger<int32> | nullbody

img_sharpnessinteger<int32> | nullbody

inactivity_settingsobjectbody

Show child attributes

object_typeenum<string>body

Available options: HUMAN, VEHICLE

roiobjectbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

threshold_msinteger<int64> | nullbody

max_detections_per_frameinteger<int32> | nullbody

metering_configobjectbody

Show child attributes

rotationinteger<int32> | nullbody

tablestring | nullbody

motor_configobjectbody

Show child attributes

af_enabledboolean | nullbody

af_regionobjectbody

Show child attributes

hinteger<int32> | nullbody

sizeinteger<int32> | nullbody

winteger<int32> | nullbody

xinteger<int32> | nullbody

yinteger<int32> | nullbody

focusinteger<int32> | nullbody

pan_degreesnumber<float> | nullbody

pirisinteger<int32> | nullbody

pt_speedinteger<int32> | nullbody

tilt_degreesnumber<float> | nullbody

zoominteger<int32> | nullbody

mounting_directionenum<string>body

Available options: DOWN, UP, SIDEWAYS, UNKNOWN

night_exposure_levelinteger<int32> | nullbody

night_img_brightnessinteger<int32> | nullbody

night_img_contrastinteger<int32> | nullbody

night_img_saturationinteger<int32> | nullbody

night_img_sharpnessinteger<int32> | nullbody

night_metering_configobjectbody

Show child attributes

rotationinteger<int32> | nullbody

tablestring | nullbody

night_sensor_gain_maxinteger<int32> | nullbody

night_shutter_time_maxinteger<int32> | nullbody

night_shutter_time_mininteger<int32> | nullbody

object_searchboolean | nullbody

occupancy_count_high_thresholdinteger<int32> | nullbody

occupancy_count_low_thresholdinteger<int32> | nullbody

occupancy_countingboolean | nullbody

people_trackingboolean | nullbody

person_reidentificationboolean | nullbody

privacy_window_polygonsobject[] | nullbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

privacy_windowsobject[] | nullbody

Show child attributes

hinteger<int32> | nullbody

sizeinteger<int32> | nullbody

winteger<int32> | nullbody

xinteger<int32> | nullbody

yinteger<int32> | nullbody

ptz_configobjectbody

Show child attributes

offset_x_percentnumber<float> | nullbody

offset_y_percentnumber<float> | nullbody

rotationinteger<int32> | nullbody

size_percentnumber<float> | nullbody

ptz_homeobjectbody

Show child attributes

go_home_seqinteger<int64> | nullbody

pan_degreesnumber<float> | nullbody

tilt_degreesnumber<float> | nullbody

zoominteger<int32> | nullbody

record_on_motionboolean | nullbody

region_for_occupancyobject | nullbody

Show child attributes

invertedboolean | nullbody

polygonsobject[] | nullbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

region_of_interestobject | nullbody

Show child attributes

invertedboolean | nullbody

polygonsobject[] | nullbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

region_of_interest_groupsobject[] | nullbody

Show child attributes

inclusiveboolean | nullbody

If true, regions in this group include specified activities. If false, regions in this group exclude specified activities.

regionsOfInterestobject[] | nullbody

Regions of interest that belong to the group. Group must have at least one region specified.

Show child attributes

activitiesenum<string>[] | nullbody

Region of allowed or disallowed activities. Activities are allowed if region group is inclusive. Activities are disallowed if region group is exclusive. Region must have at least one activity specified.

namestring | nullbody

polygonobjectbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

uuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

scheduleUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>body

Represents type of activity regions in the group. Defaults to 'Activity'.

Available options: ACTIVITY, REPORTING, CROSSING, ALARM_MONITORING, UNKNOWN

resolutionobjectbody

Show child attributes

heightinteger<int32> | nullbody

widthinteger<int32> | nullbody

rotationinteger<int32> | nullbody

rtsp_encoderinteger<int32> | nullbody

segment_max_bytesinteger<int32> | nullbody

sensor_gain_maxinteger<int32> | nullbody

shared_fovstring<DeviceFacetUuid>[] | nullbody

shutter_time_maxinteger<int32> | nullbody

shutter_time_mininteger<int32> | nullbody

snapshot_heightinteger<int32> | nullbody

snapshot_interval_secsinteger<int32> | nullbody

tile_viewsobject[] | nullbody

Show child attributes

aspectRatioobjectbody

Show child attributes

heightinteger<int32> | nullbody

widthinteger<int32> | nullbody

pitchDegreesnumber<float> | nullbody

rollDegreesnumber<float> | nullbody

verticalFieldOfViewDegreesinteger<int32> | nullbody

yawDegreesnumber<float> | nullbody

updatedSetMethodMapobject | nullbody

upload_all_detectionsboolean | nullbody

use_onboard_lprboolean | nullbody

vehicle_detectionboolean | nullbody

video_ai_disabledboolean | nullbody

video_persist_disabledboolean | nullbody

wdr_enabledboolean | nullbody

wdr_strengthinteger<int32> | nullbody

zero_motion_video_bitrate_percentinteger<int32> | nullbody

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/robot/updateConfig' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "configUpdate": {
      "audioFacetSettings": {},
      "buttonSettings": {},
      "climateSettings": {},
      "deviceSettings": {},
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceVideoSettings": {},
      "doorControllerSettings": {},
      "doorReaderSettings": {},
      "doorSensorSettings": {},
      "environmentalGatewaySettings": {},
      "metricsAgentSettings": {},
      "robotSettings": {},
      "tamperSettings": {},
      "videoDoorbellSettings": {},
      "videoFacetSettings": {}
    }
  }'

import requests

url = "https://api2.rhombussystems.com/api/robot/updateConfig"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "configUpdate": {
        "audioFacetSettings": {},
        "buttonSettings": {},
        "climateSettings": {},
        "deviceSettings": {},
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceVideoSettings": {},
        "doorControllerSettings": {},
        "doorReaderSettings": {},
        "doorSensorSettings": {},
        "environmentalGatewaySettings": {},
        "metricsAgentSettings": {},
        "robotSettings": {},
        "tamperSettings": {},
        "videoDoorbellSettings": {},
        "videoFacetSettings": {}
    }
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/robot/updateConfig', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "configUpdate": {
      "audioFacetSettings": {},
      "buttonSettings": {},
      "climateSettings": {},
      "deviceSettings": {},
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceVideoSettings": {},
      "doorControllerSettings": {},
      "doorReaderSettings": {},
      "doorSensorSettings": {},
      "environmentalGatewaySettings": {},
      "metricsAgentSettings": {},
      "robotSettings": {},
      "tamperSettings": {},
      "videoDoorbellSettings": {},
      "videoFacetSettings": {}
    }
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "configUpdate": {
                "audioFacetSettings": {},
                "buttonSettings": {},
                "climateSettings": {},
                "deviceSettings": {},
                "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                "deviceVideoSettings": {},
                "doorControllerSettings": {},
                "doorReaderSettings": {},
                "doorSensorSettings": {},
                "environmentalGatewaySettings": {},
                "metricsAgentSettings": {},
                "robotSettings": {},
                "tamperSettings": {},
                "videoDoorbellSettings": {},
                "videoFacetSettings": {}
              }
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/robot/updateConfig"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

Response indicating the result of updating device configuration.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

warningMsgstring | null