🚧 The Rhombus Developer Documentation is currently in beta. For the official documentation, please visit docs.rhombus.com.
curl --request POST \
--url https://api2.rhombussystems.com/api/deviceconfig/updateFacetedConfig \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"configUpdate": {
"audioFacetSettings": {},
"buttonSettings": {
"button_emergency_onsite_contact": {
"name": "<string>",
"phoneNumber": "<string>"
},
"button_test_mode_enabled": true,
"updatedSetMethodMap": {}
},
"climateSettings": {
"alert_window_minutes": 123,
"smoke_ai_threshold": 123,
"thc_ai_threshold": 123,
"updatedSetMethodMap": {},
"vape_ai_threshold": 123
},
"deviceSettings": {
"ai_license_invalid": true,
"bandwidth_reports_disabled": true,
"firmware_dev_settings": {},
"led_mode_blink_period_ms": 123,
"led_mode_when_active": "LED_OFF",
"led_mode_when_inactive": "LED_OFF",
"led_stealth_mode": true,
"lightweight_detection_disabled": true,
"live_license_invalid": true,
"media_ttl_minutes": 123,
"on_demand_license_invalid": true,
"scanner_agent_disabled": true,
"snapshot_upload_target": "0",
"storage_target_free_megabytes": 123,
"storage_target_free_space_permyriad": 123,
"thumbstrip_upload_target": "0",
"updatedSetMethodMap": {}
},
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceVideoSettings": {
"alert_rate_limit_human_only": {
"base_interval_ms": 123,
"burst_token_generation_ms": 123,
"burst_token_initial_count": 123,
"burst_token_max_count": 123
},
"alert_rate_limit_motion_only": {
"base_interval_ms": 123,
"burst_token_generation_ms": 123,
"burst_token_initial_count": 123,
"burst_token_max_count": 123
},
"alert_rate_limit_vehicle_only": {
"base_interval_ms": 123,
"burst_token_generation_ms": 123,
"burst_token_initial_count": 123,
"burst_token_max_count": 123
},
"ir_double_tap": true,
"ir_filter_mode": "ON",
"ir_leds_mode": "ON",
"updatedSetMethodMap": {}
},
"doorControllerSettings": {
"autocomponentize_readers": true,
"autoregister_readers": true,
"flip_display_orientation": true,
"pressure_switch_tamper_normally_open": true,
"proximity_sensor_tamper_disabled": true,
"proximity_sensor_tamper_distance_threshold": 123,
"updatedSetMethodMap": {}
},
"doorReaderSettings": {
"dr_enable_audio_feedback": true,
"tof_max_distance": 123,
"tof_min_distance": 123,
"tof_min_signal_over_noise": 123,
"updatedSetMethodMap": {}
},
"doorSensorSettings": {
"ajar_threshold_enabled": true,
"ajar_threshold_sec": 123,
"updatedSetMethodMap": {}
},
"environmentalGatewaySettings": {
"data_measurement_interval_sec": 123,
"data_upload_interval_sec": 123,
"false_positive_confidence_threshold": 123,
"leak_detection_threshold": 123,
"leak_detector_present": true,
"moist_detection_threshold": 123,
"smoke_confidence_threshold": 123,
"smoke_thc_confidence_threshold": 123,
"smoke_tobacco_confidence_threshold": 123,
"updatedSetMethodMap": {},
"vape_alert_backoff_sec": 123,
"vape_confidence_threshold": 123,
"vape_thc_confidence_threshold": 123
},
"robotSettings": {
"home_latitude": 123,
"home_longitude": 123,
"map_created_at_ms": 123,
"map_id": "AAAAAAAAAAAAAAAAAAAAAA",
"updatedSetMethodMap": {}
},
"tamperSettings": {
"accelerometer_change_tamper_threshold": 123,
"accelerometer_disabled": true,
"pressure_switch_tamper_disabled": true,
"updatedSetMethodMap": {}
},
"videoDoorbellSettings": {
"standalone_doorbell_mode": true,
"updatedSetMethodMap": {}
},
"videoFacetSettings": {}
}
}
'{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Update a device’s config
curl --request POST \
--url https://api2.rhombussystems.com/api/deviceconfig/updateFacetedConfig \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"configUpdate": {
"audioFacetSettings": {},
"buttonSettings": {
"button_emergency_onsite_contact": {
"name": "<string>",
"phoneNumber": "<string>"
},
"button_test_mode_enabled": true,
"updatedSetMethodMap": {}
},
"climateSettings": {
"alert_window_minutes": 123,
"smoke_ai_threshold": 123,
"thc_ai_threshold": 123,
"updatedSetMethodMap": {},
"vape_ai_threshold": 123
},
"deviceSettings": {
"ai_license_invalid": true,
"bandwidth_reports_disabled": true,
"firmware_dev_settings": {},
"led_mode_blink_period_ms": 123,
"led_mode_when_active": "LED_OFF",
"led_mode_when_inactive": "LED_OFF",
"led_stealth_mode": true,
"lightweight_detection_disabled": true,
"live_license_invalid": true,
"media_ttl_minutes": 123,
"on_demand_license_invalid": true,
"scanner_agent_disabled": true,
"snapshot_upload_target": "0",
"storage_target_free_megabytes": 123,
"storage_target_free_space_permyriad": 123,
"thumbstrip_upload_target": "0",
"updatedSetMethodMap": {}
},
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceVideoSettings": {
"alert_rate_limit_human_only": {
"base_interval_ms": 123,
"burst_token_generation_ms": 123,
"burst_token_initial_count": 123,
"burst_token_max_count": 123
},
"alert_rate_limit_motion_only": {
"base_interval_ms": 123,
"burst_token_generation_ms": 123,
"burst_token_initial_count": 123,
"burst_token_max_count": 123
},
"alert_rate_limit_vehicle_only": {
"base_interval_ms": 123,
"burst_token_generation_ms": 123,
"burst_token_initial_count": 123,
"burst_token_max_count": 123
},
"ir_double_tap": true,
"ir_filter_mode": "ON",
"ir_leds_mode": "ON",
"updatedSetMethodMap": {}
},
"doorControllerSettings": {
"autocomponentize_readers": true,
"autoregister_readers": true,
"flip_display_orientation": true,
"pressure_switch_tamper_normally_open": true,
"proximity_sensor_tamper_disabled": true,
"proximity_sensor_tamper_distance_threshold": 123,
"updatedSetMethodMap": {}
},
"doorReaderSettings": {
"dr_enable_audio_feedback": true,
"tof_max_distance": 123,
"tof_min_distance": 123,
"tof_min_signal_over_noise": 123,
"updatedSetMethodMap": {}
},
"doorSensorSettings": {
"ajar_threshold_enabled": true,
"ajar_threshold_sec": 123,
"updatedSetMethodMap": {}
},
"environmentalGatewaySettings": {
"data_measurement_interval_sec": 123,
"data_upload_interval_sec": 123,
"false_positive_confidence_threshold": 123,
"leak_detection_threshold": 123,
"leak_detector_present": true,
"moist_detection_threshold": 123,
"smoke_confidence_threshold": 123,
"smoke_thc_confidence_threshold": 123,
"smoke_tobacco_confidence_threshold": 123,
"updatedSetMethodMap": {},
"vape_alert_backoff_sec": 123,
"vape_confidence_threshold": 123,
"vape_thc_confidence_threshold": 123
},
"robotSettings": {
"home_latitude": 123,
"home_longitude": 123,
"map_created_at_ms": 123,
"map_id": "AAAAAAAAAAAAAAAAAAAAAA",
"updatedSetMethodMap": {}
},
"tamperSettings": {
"accelerometer_change_tamper_threshold": 123,
"accelerometer_disabled": true,
"pressure_switch_tamper_disabled": true,
"updatedSetMethodMap": {}
},
"videoDoorbellSettings": {
"standalone_doorbell_mode": true,
"updatedSetMethodMap": {}
},
"videoFacetSettings": {}
}
}
'{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Your API key for Rhombus.
Authentication scheme indicator ("api-token").
9Request object for updating a device's faceted user configuration.
Configuration update for the robot
Show child attributes
Was this page helpful?