About special settings
About special settings. Some trackers provide additional specific kind of control which is defined with `special_control` field of tracker model.
About special settings
Some trackers provide additional specific kind of control which is defined with special_control field of tracker model.
This field contains type, which identifies a certain kind of settings. (For example "pwr_off_key" or "sos_key", which
you can see below)special_control = "none" means that tracker doesn't have specific kind of control. In other cases you can:
read special settings with api/tracker/settings/special/read,
update special settings with api/tracker/settings/special/update,
perform special control with api/tracker/send_command.
Such control assumes tracker special settings
API actions
API base path: /tracker/settings/special.
read
Gets special settings for the specified tracker.
Parameters
tracker_id
ID of the tracker (aka "object_id"). Tracker must belong to authorized user and not be blocked.
int
123456
Examples
curl -X POST 'https://api.eu.navixy.com/v2/tracker/settings/special/read' \
-H 'Content-Type: application/json' \
-d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "tracker_id": 123456}'https://api.eu.navixy.com/v2/tracker/settings/special/read?hash=a6aa75587e5c59c32d347da438505fc3&tracker_id=123456Responses
If parameter type is present:
value- settings object.
If parameter type omitted:
list- array of objects. Settings object array.
Settings object structures by type:
electronic_lock_password
password- string. Nullable.
hhd_lock_password
password- string. Nullable. 8 digits.
jointech_lock_password
password- string. Nullable. 6 non-space, non-comma symbols.
vg_lock_password
password- string. Nullable. 6 digits.
autofon_sms_alerts
low_battery_mode- enum. Can be "enable" | "disable".ext_input_mode- enum. Can be "enable" | "disable".sos_button_mode- enum. Can be "enable" | "disable".
auto_geofence_telfm
mode- enum. Can be "enable" | "disable".activation_timeout- int. 0-65535 seconds.radius- int. 50 - 10000 meters.
bce_tacho_control
function- enum. Can be "slot1" | "slot2" | "vu_activities" | "vu_no_activities"
call_button
items- Array of phone numbers (10-15 digits) represented as strings.phone- string. Phone number in the international format without "+" sign.
call_buttons_v40
items- Array of phone numbers (10-15 digits) represented as strings.phone- string. Phone number in the international format without "+" sign.
careu_psm
sleep_when_ignition_off- boolean.sleep_when_no_motion- boolean.sleep_when_no_communication- boolean.sleep_conditions_duration– int. Delay between the moment when conditions met and sleep mode activation in minutes. Can be 1-255.deep_sleep_conditions_duration– int. Delay between sleep mode activation and deep sleep mode activation in minutes. Can be 0-65535.wake_up_interval– int. Delay before waking up from sleep mode in minutes. Can be 0-65535.wake_up_from_dsm_interval– int. Delay before waking up from deep sleep mode in hours. Can be 0-255.0in these fields means don't switch.
castel_alarms
report- boolean. Iftruewill send notification to server upon an event.beep- boolean. Iftruewill sound upon an event.threshold- double. Normal values range where event does not occur. Each unit equals 1 g.acceleration- 0.2 - 0.8.deceleration- 0.3 - 1.0.crash- 1.0 - 2.0.sharp_turn- 0.3 - 0.9.
castel_obd
enable_pid_reports- boolean.pid_data_records_per_message- int. Count of records per one message. Can be 1 - 20.pid_data_collect_interval- int. Data collect interval in seconds. Can be 30 - 600.
charging_gmt100
mode- enum. Can be "on_need" | "ign_on_only" | "ign_on" | "low_charge".
ddd_emails
emails- string array. Valid emails. Maximum size 5.
digital_password
password- string. 6 digits.
fcc_telfm
fuel_type- enum. Can be "gasoline" | "diesel" | "lpg".engine_volume- double. Can be 0.0 - 10.0.multiplier- double. Can be 0.0 - 10.0.
galileo_tacho_control
galileo_hds
mode- enum. Can be "enable" | "disable".max_acceleration_force- double. It is a max allowed acceleration force which can be reached while accelerating without triggering harsh acceleration event.Can be 0 - 2.55.max_braking_force- double. It is a max allowed braking force which can be reached while braking without triggering harsh braking event. Can be 0 - 2.55.max_cornering_force- double. It is a max allowed cornering angle which can be reached while cornering without triggering harsh cornering event. Can be 0 - 2.55.
harsh_behavior_hua_sheng
mode- enum. Can be "enable" | "disable".max_acceleration_force- double. It is a max allowed acceleration force which can be reached while accelerating without triggering harsh acceleration event.Can be 0.1 - 1.0.max_braking_force- double. It is a max allowed braking force which can be reached while braking without triggering harsh braking event. Can be 0.1 - 1.0.max_cornering_force- double. It is a max allowed cornering angle which can be reached while cornering without triggering harsh cornering event. Can be 0.1 - 1.0.
hbm_telfm
mode- enum. Can be "enable" | "disable".max_acceleration_force- double. It is a max allowed acceleration force which can be reached while accelerating without triggering harsh acceleration event. Can be 0.25 - 0.85 g.max_braking_force- double. It is a max allowed braking force which can be reached while braking without triggering harsh braking event. Can be 0.25 - 0.85 g.max_cornering_force- double. It is a max allowed cornering angle which can be reached while cornering without triggering harsh cornering event. Can be 0.1 - 1.0 rad/s.
hbm_telfm5x
max_acceleration_force– double. It is a max allowed acceleration force which can be reached while accelerating without triggering harsh acceleration event. Can be 0.5 - 10.0 g.max_braking_force– double. It is a max allowed braking force which can be reached while braking without triggering harsh braking event. Can be 0.5 - 10.0 g.max_angular_velocity– double. It is a max allowed cornering angle which can be reached while cornering without triggering harsh cornering event. Can be 0.5 - 10.0 rad/s.
hbm_ql
mode- enum. Can be "enable" | "disable".high_speed- int. Can be 100 - 400.high_speed_braking_delta- int. Can be 0 - 100.high_speed_acceleration_delta- int. Can be 0 - 100.medium_speed- int. Can be 60 - 100.medium_speed_braking_delta- int. Can be 0 - 100.medium_speed_acceleration_delta- int. Can be 0 - 100.low_speed_braking_delta- int. Can be 0 - 100.low_speed_acceleration_delta- int. Can be 0 - 100.
hbm_ms_ql
mode- enum. Can be "disable" | "gps_only" | "motion_sensor_only" | "gps_and_motion_sensor".high_speed- int. Can be 100 - 400.high_speed_braking_delta- int. Can be 0 - 100.high_speed_acceleration_delta- int. Can be 0 - 100.medium_speed- int. Can be 60 - 100.medium_speed_braking_delta- int. Can be 0 - 100.medium_speed_acceleration_delta- int. Can be 0 - 100.low_speed_braking_delta- int. Can be 0 - 100.low_speed_acceleration_delta- int. Can be 0 - 100.turn_brake_threshold- int. Can be 30 - 70.turn_brake_duration- int. Can be 320 - 800 milliseconds.acceleration_threshold- int. Can be 15 - 50.acceleration_duration- int. Can be 400 - 2000 milliseconds.
harsh_behavior_bce
is_switched_off- boolean.acceleration_limit- double. Can be 0.04 - 3.braking_limit- double. Can be 0.04 - 3.cornering_limit- double. Can be 0.04 - 3.
harsh_behavior_concox_x1
acc_speed- int. Can be 0 - 100.acc_detection_time- int. Can be 0 - 10.braking_speed- int. Can be 0 - 100.braking_detection_time- int. Can be 0 - 10.
harsh_behavior_tramigo
mode- enum. Can be "enable" | "disable".max_acceleration_force- double. Can be 0.1 - 8.max_braking_force- double. Can be 0.1 - 8.
harsh_behavior_ruptela
braking_limit- int. Can be 0 - 100.acceleration_limit- int. Can be 0 - 100.
nimbelink_accel
mode- enum. Can be "enable" | "disable".x- double. Can be 0 - 2.55.y- double. Can be 0 - 2.55.z- double. Can be 0 - 2.55.
hua_sheng_vibration_sensitivity
sensitivity- enum. Can be "easy" | "normal" | "hard" | "hardest".
ign_ruptela
For Ruptela devices. Represents configuration parameters related to ignition detection ("Engine detection" and "Custom ignition", as Ruptela documentation calls them).
ign_src_suntech
mode- enum. Can be "power_voltage" | "din1" | "movement".power_voltage_low_level- int. Can be 0 - 30000.power_voltage_high_level- int. Can be 0 - 30000.
ign_src_telfm
mode- enum. Can be "power_voltage" | "din1" | "movement".power_voltage_low_level- int. Can be 0 - 30000.power_voltage_high_level- int. Can be 0 - 30000.
locus_sec
signature- string. Length 1 - 32.sms_password- string. Length 1 - 32.reset- boolean.
phonebook_gt300
items- array of contacts.name- string. Contact name.phone- string. Phone number in the international format without "+" sign.
phonebook_pt100
items- array of contacts.name- string. Contact name.phone- string. Phone number in the international format without "+" sign.
pwr_off_key
mode- enum. Can be "enable" | "disable".
scat_mayak_bt_control
function- enum. Can be "bt_disable" | "bt_enable" | "bt_clear" | "bt_write".bt_state- boolean.
sos_key
mode- enum. Can be "report" | "call_report".phone- string. SOS phone to call. Phone number in the international format without "+" sign.
starcom_impact
strong_duration- int. Required impact duration to trigger strong impact event. Each unit equals 2.5 milliseconds. Can be 0 - 14.strong_force- int. Required impact force triggering strong impact event. Each unit equals about 1.1g. Can be 1 - 7.strong_impact_enabled- boolean.weak_duration- int. Required impact duration to trigger weak impact event. Each unit equals 2.5 milliseconds. Can be 0 - 14.weak_force- int. Required impact force triggering weak impact event. Each unit equals about 1.1g. Can be 1 - 7.weak_impact_enabled- boolean.
tacho_company_card
company_card_number- string. 16 HEX digits (0-9A-F).
tacho_remote_download
company_card_number- string. 16 HEX digits (0-9A-F).vu_download_interval- int. Min = 0.card_download_interval- int. Min = 0.
teltonika_tacho_request
data_type- enum. Can be "overview" | "activities" | "eventsAndFaults" | "detailedSpeed" | "technicalData" | "card1Download" | "card2Download".activities_start_time- string date. Format = "YYYY-MM-DD", not null only if data_type = "activities".activities_end_time- string date. Format = "YYYY-MM-DD", not null only if data_type = "activities".
temporary_digital_password
password- string. 6 digits.duration_in_min- int. Can be 10 - 255.
time_shift
offset- double. Can be -24.0 - 24.0 hours.
tow_detection_ql
mode- enum. Can be "enable" | "disable".engine_off_to_tow- int. A time parameter to judge whether the device considered towed after the engine off. If the motion sensor doesn't detect stillness within the specified time after the engine off the device is being towed. Can be 0 - 900 seconds.fake_tow_delay- int. After the engine off and stillness detected, if motion sensor detects moving again, the device turns into a state called fake tow. If the device keeps in fake tow after a period defined by this parameter, it is considered towed. Can be 0 - 600 seconds.tow_interval- int. The period to send alarm messages. Can be 0 - 86400 seconds.rest_duration- int. A time parameter to make sure the device enters stillness status, i.e. the status of the device will be changed to stillness if the motion sensor detects stillness and maintains for a period defined by this parameter. Can be 0 - 3825 seconds, step 15.motion_duration- int. A time parameter to make sure the device enters motion status. Can be 0 - 9900 milliseconds, step 100.motion_threshold- int. The threshold for the motion sensor to measure whether the device is moving. Can be 2 - 9.
tow_detection_ql2
mode- enum. Can be "enable" | "disable".engine_off_to_tow- int. A time parameter to judge whether the device considered towed after the engine off. If the motion sensor doesn't detect stillness within the specified time after the engine off the device is being towed. Can be 0 - 900 seconds.fake_tow_delay- int. After the engine off and stillness detected, if motion sensor detects moving again, the device turns into a state called fake tow. If the device keeps in fake tow after a period defined by this parameter, it is considered towed. Can be 0 - 600 seconds.tow_interval- int. The period to send alarm messages. Can be 0 - 86400 seconds.rest_duration- int. A time parameter to make sure the device enters stillness status, i.e. the status of the device will be changed to stillness if the motion sensor detects stillness and maintains for a period defined by this parameter. Can be 0 - 3825 seconds, step 15.motion_duration- int. A time parameter to make sure the device enters motion status. Can be 100 - 1000 milliseconds, step 100.motion_threshold- int. The threshold for the motion sensor to measure whether the device is moving. Can be 2 - 9.
tow_detection_telfm
mode- enum. Can be "enable" | "disable".activation_timeout- int. Can be 0 - 65535 minutes.threshold- double. Can be 0.10 - 5.00.
video_stream_howen
virtual_ign_ql
mode- enum. Can be "disabled" | "power_voltage" | "motion_sensor".ign_on_voltage- int. Can be 250 - 28000.rest_duration_to_off– int. A time parameter to make sure the device enters stillness status, i.e. the status of the device will be changed to stillness if the motion sensor detects stillness and maintains for a period of time defined by this parameter. Can be 1 - 255.motion_duration_to_on– A time parameter to make sure the device enters motion status. Can be 1 - 255.
no_movement_alarm
timeout- int. Can be 30 - 65500. A time parameter when the device doesn't move.pre_alarm_duration- int. Can be 0 - 65500. A time parameter when the device continues not to move after timeout.
Errors
201 – Not found in the database (if there is no tracker with such ID belonging to authorized user).
208 – Device blocked (if tracker exists but was blocked due to tariff restrictions or some other reason).
214 – Requested operation or parameters are not supported by the device.
update
Sets special settings for a specified tracker with the new one.
required sub-user rights: tracker_configure.
Parameters
tracker_id
ID of the tracker (aka "object_id"). Tracker must belong to authorized user and not be blocked.
int
value
Settings object, see above.
JSON object
Examples
cURL
Response
Errors
201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.
208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.
214 – Requested operation or parameters are not supported by the device.
Last updated
Was this helpful?