Unidades
Dependiendo de las marcas especificadas, el formato de respuesta puede variar.
Este capítulo describe las marcas que se pueden aplicar a las unidades y las partes correspondientes del JSON resultante que controlan. Si se especifican varias marcas, sus respectivas partes se combinan en un solo JSON.
Todas las marcas se utilizan solo en formato DEC.
Marcas de unidades
Las siguientes marcas pueden aplicarse a las unidades:
| Valor HEX | Valor DEC | Descripción |
|---|---|---|
| 0x00000001 | 1 | Propiedades básicas (marca base) |
| 0x00000002 | 2 | Propiedades personalizadas |
| 0x00000004 | 4 | Información de facturación |
| 0x00000008 | 8 | Campos personalizados comunes |
| 0x00000010 | 16 | Imagen |
| 0x00000020 | 32 | Mensajes |
| 0x00000040 | 64 | GUID |
| 0x00000080 | 128 | Campos personalizados administrativos |
| 0x00000100 | 256 | Propiedades avanzadas |
| 0x00000200 | 512 | Comandos disponibles en el momento |
| 0x00000400 | 1024 | Último mensaje y ubicación |
| 0x00000800 | 2048 | Código de conductor |
| 0x00001000 | 4096 | Sensores |
| 0x00002000 | 8192 | Contadores |
| 0x00004000 | 16384 | Rutas |
| 0x00008000 | 32768 | Mantenimiento |
| 0x00010000 | 65536 | Registros de la unidad |
| 0x00020000 | 131072 | Configuración de la unidad en informes: detector de viajes y consumo de combustible |
| 0x00040000 | 262144 | Todas las demás configuraciones de la unidad: filtrado de validez de mensajes |
| 0x00080000 | 524288 | Lista de todos los comandos posibles para esta unidad |
| 0x00100000 | 1048576 | Parámetros del mensaje |
| 0x00200000 | 2097152 | Estado de conexión de la unidad |
| 0x00400000 | 4194304 | Ubicación |
| 0x00800000 | 8388608 | Propiedades del perfil |
| 0x01000000 | 16777216 | Asuntos |
| 0x3FFFFFFFFFFFFFFF | 4611686018427387903 | Establecer todas las marcas de unidad posibles |
Propiedades básicas
La marca de las propiedades básicas es 0x00000001.
{
"mu": <uint>, /* Sistema de medida:
0 — SI,
1 — US,
2 — imperial,
3 — métrico con galones */
"nm": "<text>", /* Nombre */
"cls": <uint>, /* ID de superclase: "avl_unit" */
"id": <uint>, /* ID de la unidad */
"uacl": <uint> /* Derechos de acceso del usuario a esta unidad */
}
Propiedades personalizadas
La marca de las propiedades personalizadas es 0x00000002.
{
"prp": { /* Propiedades personalizadas */
"img_rot": "<text>", /* Rotar imágenes: 1 = sí, 0 = no */
"monitoring_sensor_id": "<text>", /* ID del sensor mostrado en el sistema de rastreo */
"motion_state_sensor_id": "<text>", /* ID del sensor usado para estado de movimiento */
"sensors_colors_id": "<text>", /* ID del sensor para color del recorrido */
"use_sensor_color": "<text>", /* Usar color del sensor: 1 = sí, 0 = no */
/* Selección de la fuente de color del recorrido */
"sensors_colors": "<text>", /* Tabla de colores según valores del sensor */
"solid_colors": "<text>", /* Color sólido del recorrido */
"speed_colors": "<text>", /* Tabla de colores según velocidad */
/* Últimos colores utilizados */
"track_sensor": "<text>", /* Últimos colores para recorridos según sensor */
"track_solid": "<text>", /* Último color sólido utilizado */
"track_speed": "<text>", /* Últimos colores según velocidad */
"monitoring_battery_id": "<text>" /* ID del sensor del estado de batería */
},
"ct": <uint> /* Hora de creación */
}
Información de facturación
La marca de la información de facturación es 0x00000004.
{
"crt": <uint>, /* ID del creador */
"bact": <uint> /* ID de la cuenta */
}
Campos personalizados
La marca de los campos personalizados es 0x00000008.
{
"flds": { /* Campos personalizados */
<text>: { /* Número de secuencia */
"id": <uint>, /* ID */
"n": <text>, /* Nombre */
"v": <text> /* Valor */
},
...
},
"fldsmax":<long>, /* Cantidad máxima de campos personalizados (-1 para ilimitado) */
}
Imagen de la unidad
La marca de la imagen de la unidad es 0x00000010.
{
"uri": <text> /* Enlace de la imagen */
"ugi": <uint> /* Cantidad de cambios de imagen */
}
Mensajes
La marca de mensajes es 0x00000020.
Después de especificar esta marca, puede recibir mensajes de la unidad.
GUID
La marca del GUID es 0x00000040.
{
"gd":<text> /* GUID de la unidad */
}
Campos administrativos
La marca de los campos administrativos es 0x00000080.
{
"aflds": { /* Campos administrativos */
"<text>": { /* Número de secuencia */
"id": <uint>, /* ID */
"n": "<text>", /* Nombre */
"v": "<text>" /* Valor */
}
},
"afldsmax": <long> /* Cantidad máxima de campos administrativos (-1 para ilimitado) */
}
Propiedades avanzadas
La marca de las propiedades avanzadas es 0x00000100.
{
"uid": <text>, /* ID único (hardware) */
"uid2": <text>, /* Segundo ID único (hardware) */
"hw": <long>, /* Tipo de hardware */
"ph": <text>, /* Número de teléfono */
"ph2": <text>, /* Segundo número de teléfono */
"psw": <text> /* Contraseña */
}
Comandos disponibles
La marca de los comandos disponibles es 0x00000200.
{
"cmds": [ /* Matriz de comandos */
{
"n": <text>, /* Nombre */
"a": <uint>, /* Nivel de acceso (derechos de acceso que el usuario debe tener para ejecutar este comando) */
"t": <text>, /* Tipo de enlace */
"c": <text> /* Tipo de comando */
}
]
}
Los tipos de comandos y enlaces se describen en la página unit/update_command_definition. La lista de marcas de acceso para unidades se proporciona en las secciones General y Unidades y grupos de unidades en la página core/check_items_billing.
Último mensaje y ubicación
La marca del último mensaje y ubicación es 0x00000400.
{
"pos": { /* Última ubicación conocida */
"t": <uint>, /* Hora (UTC) */
"y": <double>, /* Latitud */
"x": <double>, /* Longitud */
"z": <double>, /* Altitud */
"s": <int>, /* Velocidad */
"c": <int>, /* Rumbo */
"sc": <int> /* Cantidad de satélites */
},
"lmsg": { /* Último mensaje conocido */
...
}
}
El formato del mensaje depende del tipo de mensaje. Todos los tipos se describen en la página Mensajes page.
Sensores
La marca de los sensores es 0x00001000.
{
"sens": { /* Sensores */
<text>: { /* Número de secuencia del sensor */
"id": <long>, /* ID */
"n": <text>, /* Nombre */
"t": <text>, /* Tipo */
"d": <text>, /* Descripción */
"m": <text>, /* Unidad de medida */
"p": <text>, /* Parámetro */
"f": <uint>, /* Marcas del sensor */
"c": <text>, /* Configuración */
"vt": <uint>, /* Tipo de validación */
"vs": <uint>, /* ID del sensor de validación */
"tbl": [ /* Tabla de cálculo */
{ /* Parámetros */
"x": <double>,
"a": <double>,
"b": <double>
}
]
},
...
},
"sens_max": <long> /* Cantidad máxima de sensores (-1 para ilimitado) */
}
Las marcas de sensores, tipos de sensores y validación, así como ejemplos de configuración se proporcionan en la página unit/update_sensor page.
Contadores
La marca de los contadores es 0x00002000.
{
"cfl": <uint>, /* Marcas de cálculo */
"cnm": <uint>, /* Contador de kilometraje, km o millas */
"cneh": <uint>, /* Contador de horas de motor, h */
"cnkb": <uint> /* Contador de tráfico GPRS, KB */
}
Las marcas de cálculo se describen en la página unit/update_calc_flags page.
Mantenimiento
La marca de los intervalos de servicio es 0x00008000.
{
"si": { /* intervalos de servicio */
<text>: { /* número de secuencia del intervalo de servicio */
"id": <uint>, /* ID */
"n": <text>, /* nombre */
"t": <text>, /* descripción */
"im": <uint>, /* intervalo de kilometraje */
"it": <uint>, /* intervalo de días */
"ie": <uint>, /* intervalo de horas de motor */
"pm": <uint>, /* último servicio para intervalo de kilometraje, km */
"pt": <uint>, /* último servicio para intervalo de días, seg (UTC) */
"pe": <uint>, /* último servicio para intervalo de horas de motor, h */
"c": <uint> /* veces realizado */
},
...
},
"simax": <long> /* Cantidad máxima de intervalos de servicio (-1 para ilimitado) */
}
Detector de viajes y consumo de combustible
La marca del detector de viajes y consumo de combustible es 0x00020000.
{
"rtd": { /* Detector de viajes */
"type": <uint>, /* Tipo de detección de movimiento */
"gpsCorrection": <int>, /* Permitir corrección GPS: 0 - no, 1 - sí */
"minSat": <uint>, /* Cantidad mínima de satélites */
"minMovingSpeed": <uint>, /* Velocidad de movimiento mínima, km/h */
"minStayTime": <uint>, /* Tiempo de estacionamiento mínimo, segundos */
"maxMessagesDistance": <uint>, /* Distancia máxima entre mensajes, metros */
"minTripTime": <uint>, /* Tiempo de viaje mínimo, segundos */
"minTripDistance": <uint> /* Distancia de viaje mínima, metros */
},
"rfc": { /* Consumo de combustible */
"calcTypes": <uint>, /* Tipo de cálculo */
"fuelLevelParams": { /* Detección de llenados y descargas de combustible */
"flags": <uint>, /* Marcas de llenados y descargas */
"ignoreStayTimeout": <uint>, /* Ignorar mensajes después del inicio del movimiento, s */
"minFillingVolume": <uint>, /* Volumen mínimo de llenado de combustible, litros */
"minTheftTimeout": <uint>, /* Tiempo de inactividad mínimo para detectar descarga de combustible, s */
"minTheftVolume": <uint>, /* Volumen mínimo de descarga de combustible, litros */
"filterQuality": <ubyte>, /* Nivel de filtrado (0..255) */
"fillingsJoinInterval": <uint>, /* Tiempo límite para separar llenados consecutivos, s */
"theftsJoinInterval": <uint>, /* Tiempo límite para separar descargas consecutivas, s */
"extraFillingTimeout": <uint> /* Tiempo límite para detectar volumen final de llenado, s */
},
"fuelConsMath": { /* Consumo matemático */
"idling": <double>, /* En ralentí, litros por hora */
"urban": <double>, /* Ciclo urbano, litros por 100 km */
"suburban": <double> /* Ciclo extraurbano, litros por 100 km */
},
"fuelConsRates": { /* Consumo por tasas */
"consSummer": <int>, /* Consumo de verano, litros por 100 km */
"consWinter": <int>, /* Consumo de invierno, litros por 100 km */
"winterMonthFrom": <int>, /* Invierno desde (mes: 0-11) */
"winterDayFrom": <int>, /* Invierno desde (día 1-31) */
"winterMonthTo": <int>, /* Invierno hasta (mes 0-11) */
"winterDayTo": <int> /* Invierno hasta (día 1-31) */
},
"fuelConsImpulse": { /* Sensores impulsivos del consumo de combustible */
"maxImpulses": <int>, /* Cantidad máxima de impulsos */
"skipZero": <int> /* Omitir el primer valor cero */
}
}
}
Los tipos de detección de movimiento se describen en la página unit/get_trip_detector. Los tipos de cálculo del consumo de combustible, así como las marcas de llenado y descarga se describen en la página get_fuel_settings.
Comandos
La marca de los comandos es 0x00080000.
{
"cml": { /* Lista de comandos */
<text>: { /* Número de secuencia del comando */
"id": <uint>, /* ID */
"n": <text>, /* Nombre */
"c": <text>, /* Tipo */
"l": <text>, /* Tipo de enlace */
"p": <text>, /* Parámetros */
"a": <uint>, /* Nivel de acceso (derechos de acceso que el usuario debe tener para enviar este comando) */
"f": <uint> /* Marcas de número de teléfono: 0 - cualquiera (primario, luego secundario), 0x1 - primario, 0x2 - secundario */
},
...
},
"cml_max": <long> /* Cantidad máxima de comandos (-1 para ilimitado) */
}
Los tipos de comandos y enlaces se describen en la página unit/update_command_definition. La lista de marcas de acceso para unidades se proporciona en las secciones General y Unidades y grupos de unidades en la página check_items_billing.
Parámetros del mensaje
Permite utilizar el sistema acumulativo de valores de parámetros de mensajes. Los parámetros se almacenarán en la sección correspondiente del objeto JSON, que almacenará no solo los valores de los parámetros del último mensaje, sino también los valores de los parámetros de mensajes anteriores.
La marca de los parámetros del mensaje es 0x00100000.
{
"prms": { /* Lista de parámetros del mensaje */
<text>: { /* Nombre del parámetro */
"v": <any>, /* Valor del parámetro */
"ct": <uint>, /* Hora del último cambio de valor */
"at": <uint> /* Hora del último mensaje con este parámetro */
},
...
}
}
Conexión
La marca del estado de conexión de la unidad es 0x00200000.
{
"item": {
"netconn": <bool>
}
}
Ubicación
La marca de la ubicación de la unidad es 0x00400000.
{
"pos":{ /* Última ubicación conocida */
"t":<uint>, /* Hora (UTC) */
"y":<double>, /* Latitud */
"x":<double>, /* Longitud */
"z":<double>, /* Altitud */
"s":<int>, /* Velocidad */
"c":<int>, /* Rumbo */
"sc":<int> /* Cantidad de satélites */
}
}
Propiedades del perfil
La marca de las propiedades del perfil es 0x00800000.
{
"pflds":{
"<long>":{ /* ID del campo */
"id":<long>, /* ID del campo */
"n":<text>, /* Nombre del campo */
"v":<text> /* Valor del campo */
}
}
Asuntos
La marca de los asuntos es 0x01000000.
{
"task_sub_type": <uint>, /* Subtipo de asunto */
"task_reg_type": <uint>, /* Tipo de registro */
"task_evt_name": <text>, /* Nombre del asunto */
"task_id": <text>, /* ID del asunto */
"task_update_time": <int>, /* Hora de la última actualización */
"task_status": <uint>, /* Estado del asunto */
"task_priority": <uint>, /* Prioridad del asunto */
"task_assignee": <long>, /* Responsable del asunto */
"task_comments": <text>, /* Comentarios sobre el asunto */
"task_account": <long>, /* Cuenta del asunto */
}