https://sdk.wialon.com/wiki/ 2026-04-17T11:07:06+00:00 https://sdk.wialon.com/wiki/ https://sdk.wialon.com/wiki/lib/tpl/arctic/images/favicon.ico text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/calc_last_message?rev=1385731860&do=diff Sensors values from last message To get sensors value from the last message, use the command unit/calc_last_message: svc=unit/calc_last_message&params={"unitId":<long>, "sensors":[<long>]} Parameters Name Description unitId unit ID sensors text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/calc_sensors?rev=1385731860&do=diff Sensors values To get sensors values, use the command unit/calc_sensors: svc=unit/calc_sensors&params={"lname":<text>, "rname":<text>, "indexFrom": <uint>, "indexTo": <uint>, "unitId": <long>, "sensorId": <long>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/exec_cmd?rev=1385731860&do=diff Execute command To send a command to a unit, use the request unit/exec_cmd: svc=unit/exec_cmd&params={"itemId":<long>, "cmdName":<text>, "cmdParam":<text>, "linkType":<text>, "timeout":<uint>} Parameters Name Description itemId text/html 2016-07-01T14:51:54+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/get_fuel_settings?rev=1467384714&do=diff Fuel consumption To get fuel consumption settings of a unit, use the command unit/get_fuel_settings: svc=unit/get_fuel_settings&params={"itemId":<long>} Parameters Name Description itemId unit ID Response [ <uint>, /* method of calculating fuel consumption (see below) */ { /* detection of fuel fillings/thefts */ "fl":<uint>, /* flags of fillings and thefts (see below) */ "fms":<uint>, /* ignore the messages after the start of motion, sec */ "fmv":<double>, /* minimu… text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/get_messages_filter?rev=1385731860&do=diff Get settings of messages filtration To get settings of filtration of unit position information in messages, use the command unit/get_messages_filter: svc=unit/get_messages_filter&params={"itemId":<long>} Parameters Name Description itemId unit ID text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/get_report_settings?rev=1385731860&do=diff Get parameters used in reports To get parameters used in reports, use the command unit/get_report_settings: svc=unit/get_report_settings&params={"itemId":<long>} Parameters Name Description itemId unit ID Response { "speed_limit":<uint>, /* speed limit, km/h */ "max_messages_interval":<uint>, /* maximum interval between messages, seconds */ "daily_engine_hours_rate":<uint>, /* daily engine hours rate, hours */ "urban_max_speed":<uint>, /* urban speed limit, km/h */ "mileage_… text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/get_trip_detector?rev=1385731860&do=diff Trip detection To get trip detection settings, use the command unit/get_trip_detector: svc=unit/get_trip_detector&params={"itemId":<long>} Parameters Name Description itemId unit ID Response { "lock_msgs_to_roads":<uint>, /* lock message to roads: 0 - no, 1 - yes */ "trip_detection":{ /* trip detection */ "type":<uint>, /* type of movement detection (see below) */ "has_gps_correction":<uint>, /* allow GPS correction: 0 - no, 1 - yes */ "min_sat":<uint>, /* min satellites… text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/register_custom_event?rev=1385731860&do=diff Register custom event To register custom event, use the command unit/register_custom_event: svc=unit/register_custom_event&params={"date":<uint>, "x":<double>, "y":<double>, "description":<text>, "violation":<uint>, "itemId":<long>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/register_fuel_filling_event?rev=1385731860&do=diff Register fuel filling To register fuel filling event, use the command unit/register_fuel_filling_event: svc=unit/register_fuel_filling_event&params={"date":<uint>, "volume":<double>, "cost":<double>, "location":<text>, "deviation":<uint>, "x":<double>, "y":<double>, "description":<text>, "itemId":<long>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/register_maintenance_event?rev=1385731860&do=diff Register maintenance work To register maintenance work, use the command unit/register_maintenance_event: svc=unit/register_maintenance_event&params={"date":<uint>, "info":<text>, "duration":<int>, "cost":<double>, "location":<text>, "x":<double>, "y":<double>, "description":<text>, "mileage":<double>, "eh":<int>, "doneSvcs":<text>, "itemId":<long>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/register_status_event?rev=1385731860&do=diff Register unit status To register unit status, use the command unit/register_status_event: svc=unit/register_status_event&params={"date":<uint>, "description":<text>, "itemId":<long>} Parameters Name Description date date text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/unit?rev=1385731860&do=diff Units In this chapter, all commands that can be applied to units are described. Creation of units is examined in the chapter Core: Create unit. . index text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_access_password?rev=1385731860&do=diff Unit access password To update unit access password, use the command unit/update_access_password: svc=unit/update_access_password&params={"itemId":<long>, "accessPassword":<text>} Parameters Name Description itemId unit ID accessPassword text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_calc_flags?rev=1385731860&do=diff Counter calculation parameters To update calculation parameters for counters, use the command unit/update_calc_flags: svc=unit/update_calc_flags&params={"itemId":<long>, "newValue":<uint>} Parameters Name Description itemId unit ID newValue text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_command_alias?rev=1385731860&do=diff Command parameters To update command parameters, use the command unit/update_command_alias: svc=unit/update_command_alias&params={"itemId":<long>, "id":<long>, "callMode":<text>, "n":<text>, "c":<text>, "l":<text>, "p":<text>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_eh_counter?rev=1385731860&do=diff Engine hours counter To set a new value for engine hours counter, use the command unit/update_eh_counter: svc=unit/update_eh_counter&params={"itemId":<long>, "newValue":<uint>} Parameters Name Description itemId unit ID newValue new value of engine hours counter (in seconds) text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_fuel_calc_types?rev=1385731860&do=diff Fuel consumption: type of calculation To change the type of fuel consumption calculation, use the command unit/update_fuel_calc_types: svc=unit/update_fuel_calc_types&params={"itemId":<long>, "calcTypes":<ubyte>} Parameters Name Description text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_fuel_impulse_params?rev=1385731860&do=diff Fuel consumption: impulse fuel consumption sensors To update parameters of impulse fuel consumption sensors, use the command unit/update_fuel_impulse_params: svc=unit/update_fuel_impulse_params&params={"itemId":<long>, "maxImpulses":<uint>, "skipZero":<bool>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_fuel_level_params?rev=1385731860&do=diff Fuel consumption: fuel fillings/thefts detection To update parameters of fuel fillings/thefts detection, use the command unit/update_fuel_level_params: svc=unit/update_fuel_level_params&params={"itemId":<long>, "flags":<uint>, "ignoreStayTimeout":<uint>, "minFillingVolume":<double>, "minTheftTimeout":<uint>, "minTheftVolume":<double>, "filterQuality":<ubyte>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_fuel_math_params?rev=1385731860&do=diff Fuel consumption: consumption math To update parameters of fuel consumption math, use the command unit/update_fuel_math_params: svc=unit/update_fuel_math_params&params={"itemId":<long>, "idling":<double>, "urban":<double>, "suburban":<double>, "loadCoef":<double>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_fuel_rates_params?rev=1385731860&do=diff Fuel consumption: consumption by rates To update parameters of fuel consumption by rates, use the command unit/update_fuel_rates_params: svc=unit/update_fuel_rates_params&params={"itemId":<long>, "consSummer":<double>, "consWinter":<double>, "winterMonthFrom":<ubyte>, "winterDayFrom":<ubyte>, "winterMonthTo":<ubyte>, "winterDayTo":<ubyte>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_hw_params?rev=1385731860&do=diff Hardware configuration To update hardware configuration, use the command unit/update_hw_params: svc=unit/update_hw_params&params={"hwId":<text>, "action":<text>, ...} Parameters Required parameters: Name Description hwId hardware type ID text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_hw_type?rev=1385731860&do=diff Device type To update device (hardware) type of a unit, use the command unit/update_hw_type: svc=unit/update_hw_type&params={"itemId":<long>, "hwType":<uint>} Parameters Name Description itemId unit ID hwType new device type You can get all available hardware types using the command text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_image?rev=1385731860&do=diff Copy image from one unit to another To copy the image from one unit to another (for example, while coping a unit), use the command unit/update_image: svc=unit/update_image&params={"itemId":<long>, "oldItemId":<long>} Parameters Name Description text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_messages_filter?rev=1385731860&do=diff Update settings of messages filtration To update settings of filtration of unit position information in messages, use the command unit/update_messages_filter: svc=unit/update_messages_filter&params={"itemId":<long>, "enabled":<bool>, "skipInvalid":<bool>, "minSats":<ubyte>, "maxHdop":<double>, "maxSpeed":<uint>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_mileage_counter?rev=1385731860&do=diff Mileage counter To set a new value for mileage counter, use the command unit/update_mileage_counter: svc=unit/update_mileage_counter&params={"itemId":<long>, "newValue":<uint>} :!: You can find an example of this request in the sample Creating, editing and deleting items. Parameters text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_phone?rev=1385731860&do=diff Phone number To set a new phone number, use the command unit/update_phone: svc=unit/update_phone&params={"itemId":<long>, "phoneNumber":<text>} :!: Character '+' in phone number should be replaced by code %2B. Parameters Name Description text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_report_settings?rev=1385731860&do=diff Update parameters used in reports To update parameters used in reports, use the command unit/update_report_settings: svc=unit/update_report_settings&params={"itemId":<long>, "params":{ "speed_limit":<uint>, "max_messages_interval":<uint>, "daily_engine_hours_rate":<uint>, "urban_max_speed":<uint>, "mileage_coefficient":<double> }} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_sensor?rev=1385731860&do=diff Sensors To create, edit or delete sensors, use the command unit/update_sensor: svc=unit/update_sensor&params={"itemId":<long>, "id":<long>, "callMode":<text>, "n":<text>, "t":<text>, "d":<text>, "m":<text>, "p":<text>, "f":<uint>, "vt":<uint>, "vs":<long>, "tbl":[ { "x":<double>, "a":<double>, "b":<double> } ]} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_service_interval?rev=1385731860&do=diff Service intervals To create, edit or delete service intervals, use the command unit/update_service_interval: svc=unit/update_service_interval&params={"itemId":<long>, "id":<long>, "callMode":<text>, "n":<text>, "t":<text>, "im":<uint>, "it":<uint>, "ie":<uint>, "pm":<uint>, "pt":<uint>, "pe":<uint>, "c":<uint>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_traffic_counter?rev=1385731860&do=diff GPRS traffic counter To set a new value for GPRS traffic counter, use the command unit/update_traffic_counter: svc=unit/update_traffic_counter&params={"itemId":<long>, "newValue":<uint>, "regReset":<uint>} Parameters Name Description text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_trip_detector?rev=1385731860&do=diff Update trip detection settings To update trip detection settings, use the command unit/update_trip_detector: svc=unit/update_trip_detector&params={"itemId":<long>, "type":<ubyte>, "gpsCorrection":<bool>, "minSat":<uint>, "minMovingSpeed":<uint>, "minStayTime":<uint>, "maxMessagesDistance":<uint>, "minTripTime":<uint>, "minTripDistance":<uint>} text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/update_unique_id?rev=1385731860&do=diff Unique ID To update unique ID of a unit, use the command unit/update_unique_id: svc=unit/update_unique_id&params={"itemId":<long>, "uniqueId":<text>} Parameters Name Description itemId unit ID uniqueId new unique ID Resposne { "uid":<text> /* unique ID */ } text/html 2013-11-29T13:31:00+00:00 https://sdk.wialon.com/wiki/en/pro/remoteapi/apiref/unit/upload_image?rev=1385731860&do=diff Upload unit image To upload an image for a unit, use the command unit/upload_image: svc=unit/upload_image&params={"itemId":<long>, "eventHash":<text>} Parameters Name Description itemId unit ID eventHash event name which will be generated after uploading the image (optional parameter)