Объекты
В зависимости от указанных флагов формат ответа может различаться.
На этой странице описаны флаги, которые могут быть применены к объектам, и соответствующие им части результирующего JSON, которыми они управляют. Если указано несколько флагов, их соответствующие части объединяются в единый JSON.
Все флаги используются только в DEC формате.
Флаги объектов
К объектам могут быть применены следующие флаги:
| HEX значение | DEC значение | Описание |
|---|---|---|
| 0x00000001 | 1 | Основные свойства (базовый флаг) |
| 0x00000002 | 2 | Пользовательские свойства |
| 0x00000004 | 4 | Информация о биллинге |
| 0x00000008 | 8 | Общие произвольные поля |
| 0x00000010 | 16 | Изображение |
| 0x00000020 | 32 | Сообщения |
| 0x00000040 | 64 | GUID |
| 0x00000080 | 128 | Административные произвольные поля |
| 0x00000100 | 256 | Расширенные свойства |
| 0x00000200 | 512 | Команды, доступные в данный момент |
| 0x00000400 | 1024 | Последнее сообщение и местоположение |
| 0x00000800 | 2048 | Код водителя |
| 0x00001000 | 4096 | Датчики |
| 0x00002000 | 8192 | Счетчики |
| 0x00004000 | 16384 | Маршруты |
| 0x00008000 | 32768 | Техобслуживание |
| 0x00010000 | 65536 | Журналы объекта |
| 0x00020000 | 131072 | Конфигурация объекта в отчетах: детектор поездок и расход топлива |
| 0x00040000 | 262144 | Все остальные настройки объекта: фильтрация валидности сообщений |
| 0x00080000 | 524288 | Список всех возможных команд для этого объекта |
| 0x00100000 | 1048576 | Параметры сообщений |
| 0x00200000 | 2097152 | Состояние подключения объекта |
| 0x00400000 | 4194304 | Местоположение |
| 0x00800000 | 8388608 | Свойства характеристик |
| 0x01000000 | 16777216 | Задачи |
| 0x3FFFFFFFFFFFFFFF | 4611686018427387903 | Установить все возможные флаги объекта |
Основные свойства
Флаг основных свойств — 0x00000001.
{
"mu": <uint>, /* Система измерения:
0 — СИ,
1 — американская,
2 — имперская,
3 — метрическая с галлонами */
"nm": "<text>", /* Имя */
"cls": <uint>, /* ID суперкласса: "avl_unit" */
"id": <uint>, /* ID объекта */
"uacl": <uint> /* Права доступа пользователя к этому объекту */
}
Пользовательские свойства
Флаг пользовательских свойств — 0x00000002.
{
"prp": { /* Пользовательские свойства */
"img_rot": "<text>", /* Поворот изображений: 1 - да, 0 - нет */
"monitoring_sensor_id": "<text>",/* ID датчика, который будет отображаться в системе мониторинга */
"motion_state_sensor_id": "<text>",/* ID датчика, используемого как источник состояния движения */
"sensors_colors_id": "<text>", /* ID датчика, используемого как источник цвета трека */
"use_sensor_color": "<text>", /* Использовать цвет датчика в системе мониторинга: 1 - да, 0 - нет */
/* Используется один из параметров для выбора источника цвета трека */
"sensors_colors": "<text>", /* Таблица цветов для треков, окрашенных на основе значений датчика */
"solid_colors": "<text>", /* Однотонный цвет трека */
"speed_colors": "<text>", /* Таблица цветов для окрашивания треков на основе скорости */
/* Хранение последних использованных цветов */
"track_sensor": "<text>", /* Таблица цветов для треков, окрашенных на основе значений датчика */
"track_solid": "<text>", /* Однотонный цвет трека */
"track_speed": "<text>", /* Таблица цветов для окрашивания треков на основе скорости */
"monitoring_battery_id": "<text>"/* ID датчика, показывающего состояние батареи */
},
"ct": <uint> /* Время создания */
}
Информация о биллинге
Флаг информации о биллинге — 0x00000004.
{
"crt": <uint>, /* ID создателя */
"bact": <uint> /* ID учетной записи */
}
Произвольные поля
Флаг произвольных полей — 0x00000008.
{
"flds": { /* Произвольные поля */
"<text>": { /* Порядковый номер */
"id": <uint>, /* ID */
"n": "<text>", /* Имя */
"v": "<text>" /* Значение */
},
...
},
"fldsmax": <long> /* Максимальное количество произвольных полей (-1 для неограниченного) */
}
Изображение объекта
Флаг изображения объекта — 0x00000010.
{
"uri": "<text>", /* Ссылка на изображение */
"ugi": <uint> /* Количество изменений изображения */
}
Сообщения
Флаг сообщений — 0x00000020.
После указания этого флага вы можете получать сообщения от объекта.
GUID
Флаг GUID — 0x00000040.
{
"gd":<text> /* GUID объекта */
}
Административные поля
Флаг административных полей — 0x00000080.
{
"aflds": { /* Административные поля */
"<text>": { /* Порядковый номер */
"id": <uint>, /* ID */
"n": "<text>", /* Имя */
"v": "<text>" /* Значение */
}
},
"afldsmax": <long> /* Максимальное количество административных полей (-1 для неограниченного) */
}
Расширенные свойства
Флаг расширенных свойств — 0x00000100.
{
"uid": <text>, /* Уникальный ID (устройства) */
"uid2": <text>, /* Второй уникальный ID (устройства) */
"hw": <long>, /* Тип оборудования */
"ph": <text>, /* Номер телефона */
"ph2": <text>, /* Второй номер телефона */
"psw": <text> /* Пароль */
}
Доступные команды
Флаг доступных команд — 0x00000200.
{
"cmds": [ /* Массив команд */
{
"n": <text>, /* Имя */
"a": <uint>, /* Уровень доступа (права доступа, которые должны быть у пользователя для выполнения этой команды) */
"t": <text>, /* Тип связи */
"c": <text> /* Тип команды */
}
]
}
Типы команд и связи описаны на странице unit/update_command_definition. Список флагов доступа для объектов приведен в разделах Основное и Объекты и группы объектов на странице core/check_items_billing.
Последнее сообщение и местоположение
Флаг последнего сообщения и местоположения — 0x00000400.
{
"pos": { /* Последнее известное местоположение */
"t": <uint>, /* Время (UTC) */
"y": <double>, /* Широта */
"x": <double>, /* Долгота */
"z": <double>, /* Высота */
"s": <int>, /* Скорость */
"c": <int>, /* Курс */
"sc": <int> /* Количество спутников */
},
"lmsg": { /* Последнее известное сообщение */
...
}
}
Формат сообщения зависит от типа сообщения. Все типы описаны на странице messages.
Датчики
Флаг датчиков — 0x00001000.
{
"sens": { /* Датчики */
"<text>": { /* Порядковый номер датчика */
"id": <long>, /* ID */
"n": "<text>", /* Имя */
"t": "<text>", /* Тип */
"d": "<text>", /* Описание */
"m": "<text>", /* Единица измерения */
"p": "<text>", /* Параметр */
"f": <uint>, /* Флаги датчика */
"c": "<text>", /* Конфигурация */
"vt": <uint>, /* Тип валидации */
"vs": <uint>, /* ID датчика валидации */
"tbl": [ /* Таблица расчета */
{ /* Параметры */
"x": <double>,
"a": <double>,
"b": <double>
}
]
},
...
},
"sens_max": <long> /* Максимальное количество датчиков (-1 для неограниченного) */
}
Флаги датчиков, типы датчиков и валидации, а также примеры конфигурации приведены на странице unit/update_sensor.
Счетчики
Флаг счетчиков — 0x00002000.
{
"cfl": <uint>, /* Флаги расчета */
"cnm": <uint>, /* Счетчик пробега, км или мили */
"cneh": <uint>, /* Счетчик моточасов, ч */
"cnkb": <uint> /* Счетчик GPRS-трафика, КБ */
}
Флаги расчета описаны на странице unit/update_calc_flags.
Техобслуживание
Флаг интервалов техобслуживания — 0x00008000.
{
"si": { /* интервалы техобслуживания */
"<text>": { /* порядковый номер интервала техобслуживания */
"id": <uint>, /* ID */
"n": "<text>", /* имя */
"t": "<text>", /* описание */
"im": <uint>, /* интервал пробега */
"it": <uint>, /* интервал дней */
"ie": <uint>, /* интервал моточасов */
"pm": <uint>, /* последнее ТО по интервалу пробега, км */
"pt": <uint>, /* последнее ТО по интервалу дней, сек (UTC) */
"pe": <uint>, /* последнее ТО по интервалу моточасов, ч */
"c": <uint> /* количество выполненных ТО */
},
...
},
"simax": <long> /* Максимальное количество интервалов техобслуживания (-1 для неограниченного) */
}
Детектор поездок и расход топлива
Флаг детектора поездок и расхода топлива — 0x00020000.
{
"rtd": { /* Детектор поездок */
"type": <uint>, /* Тип определения движения */
"gpsCorrection": <int>, /* Разрешить GPS-коррекцию: 0 - нет, 1 - да */
"minSat": <uint>, /* Минимальное количество спутников */
"minMovingSpeed": <uint>, /* Минимальная скорость движения, км/ч */
"minStayTime": <uint>, /* Минимальное время стоянки, секунды */
"maxMessagesDistance": <uint>,/* Максимальное расстояние между сообщениями, метры */
"minTripTime": <uint>, /* Минимальное время поездки, секунды */
"minTripDistance": <uint> /* Минимальное расстояние поездки, метры */
},
"rfc": { /* Расход топлива */
"calcTypes": <uint>, /* Тип расчета */
"fuelLevelParams": { /* Определение заправок и сливов */
"flags": <uint>, /* Флаги заправок и сливов */
"ignoreStayTimeout": <uint>, /* Игнорировать сообщения после начала движения, с */
"minFillingVolume": <uint>, /* Минимальный объем заправки, литры */
"minTheftTimeout": <uint>, /* Минимальное время стоянки для определения слива, с */
"minTheftVolume": <uint>, /* Минимальный объем слива, литры */
"filterQuality": <ubyte>, /* Уровень фильтрации (0..255) */
"fillingsJoinInterval": <uint>, /* Таймаут для объединения последовательных заправок, с */
"theftsJoinInterval": <uint>, /* Таймаут для объединения последовательных сливов, с */
"extraFillingTimeout": <uint> /* Таймаут для определения конечного объема заправки, с */
},
"fuelConsMath": { /* Математический расчет */
"idling": <double>, /* Холостой ход, литров в час */
"urban": <double>, /* Городской цикл, литров на 100 км */
"suburban": <double> /* Загородный цикл, литров на 100 км */
},
"fuelConsRates": { /* Расход по нормам */
"consSummer": <int>, /* Летний расход, литров на 100 км */
"consWinter": <int>, /* Зимний расход, литров на 100 км */
"winterMonthFrom": <int>, /* Зима с (месяц: 0-11) */
"winterDayFrom": <int>, /* Зима с (день 1-31) */
"winterMonthTo": <int>, /* Зима по (месяц 0-11) */
"winterDayTo": <int> /* Зима по (день 1-31) */
},
"fuelConsImpulse": { /* Импульсные датчики расхода топлива */
"maxImpulses": <int>, /* Максимальное количество импульсов */
"skipZero": <int> /* Пропускать первое нулевое значение */
}
}
}
Типы определения движения описаны на странице unit/get_trip_detector. Типы расчета расхода топлива, а также флаги заправок и сливов описаны на странице get_fuel_settings.
Команды
Флаг команд — 0x00080000.
{
"cml": { /* Список команд */
"<text>": { /* Порядковый номер команды */
"id": <uint>, /* ID */
"n": "<text>", /* Имя */
"c": "<text>", /* Тип */
"l": "<text>", /* Тип связи */
"p": "<text>", /* Параметры */
"a": <uint>, /* Уровень доступа (права доступа, которые должны быть у пользователя для отправки этой команды) */
"f": <uint> /* Флаги номера телефона: 0 - любой (сначала основной, затем дополнительный), 0x1 - основной, 0x2 - дополнительный */
},
...
},
"cml_max": <long> /* Максимальное количество команд (-1 для неограниченного) */
}
Типы команд и связи описаны на странице unit/update_command_definition. Список флагов доступа для объектов приведен в разделах Основное и Объекты и группы объектов на странице check_items_billing.
Параметры сообщений
Позволяет использовать накопительную систему значений параметров сообщений. Параметры будут храниться в соответствующем разделе JSON-объекта, который будет хранить не только значения параметров из последнего сообщения, но и значения параметров из более ранних сообщений.
Флаг параметров сообщений — 0x00100000.
{
"prms": { /* Список параметров сообщений */
"<text>": { /* Имя параметра */
"v": <any>, /* Значение параметра */
"ct": <uint>, /* Время последнего изменения значения */
"at": <uint> /* Время последнего сообщения с этим параметром */
},
...
}
}
Подключение
Флаг состояния подключения объекта — 0x00200000.
{
"item": {
"netconn": <bool>
}
}
Местоположение
Флаг местоположения объекта — 0x00400000.
{
"pos": { /* Последнее известное местоположение */
"t": <uint>, /* Время (UTC) */
"y": <double>, /* Широта */
"x": <double>, /* Долгота */
"z": <double>, /* Высота */
"s": <int>, /* Скорость */
"c": <int>, /* Курс */
"sc": <int> /* Количество спутников */
}
}
Свойства характеристик
Флаг свойств характеристик — 0x00800000.
{
"pflds": {
"<long>": { /* ID поля */
"id": <long>, /* ID поля */
"n": <text>, /* Имя поля */
"v": <text> /* Значение поля */
}
}
}
Задачи
Флаг задач — 0x01000000.
{
"task_sub_type": <uint>, /* Подтип задачи */
"task_reg_type": <uint>, /* Тип регистрации */
"task_evt_name": <text>, /* Имя задачи */
"task_id": <text>, /* ID задачи */
"task_update_time": <int>, /* Время последнего обновления */
"task_status": <uint>, /* Статус задачи */
"task_priority": <uint>, /* Приоритет задачи */
"task_assignee": <long>, /* Ответственное лицо, назначенное на задачу */
"task_comments": <text>, /* Комментарии к задаче */
"task_account": <long> /* Учетная запись задачи */
}