Syruslang Signals, Actions & Fieldsets

adas (serial) for MDAS9

Signals used for adas in serial mode.

PropertyUseTypeDescription
$adas.connectedSignalBooleanConnected state boolean [true,false]
$adas.stateSignalStringConnected state string [connected,disconnected]
$adas.eventSignalStringEvent arrived as shown in signals [left_turn, ...]
$adas.event_stateSignalStringEvent state [ready, recognized]
$adas.speedSignalNumberSpeed [km/h]
$adas.rpmSignalNumberMotor revolutions per minute [rpm]
$adas.left_distanceSignalNumberDistance to objects on the left [cm]
$adas.right_distanceSignalNumberDistance to objects on the right [cm]
$adas.time_to_collisionSignalNumberTime to front collision [s]
$adas.recordSignalStringRecording state [on_with_audio, on_without_audio, disabled]
$adas.ahead_distanceSignalNumberDistance of object ahead
$adas.ahead_speedSignalNumberSpeed of object ahead
$adas.slr_recognizeSignalNumberSpeed limit recognized
$adas.slr_sensitivitySignalNumberSpeed limit recognition sensitivity
@adas.eventSignalBooleanTriggered when any ADAS event arrives
@adas.left_lane_departure_warningSignalBooleanTriggered when the vehicle passes the left lane
@adas.right_lane_departure_warningSignalBooleanTriggered when the vehicle passes the right lane
@adas.safety_distance_alertSignalBooleanTriggered when vehicle breaks the safety distance
@adas.front_vehicle_start_alarmSignalBooleanTriggered when the front vehicle starts to move
@adas.front_proximity_warningSignalBooleanTriggered when the vehicle slowly approaches to front car
@adas.forward_collision_warningSignalBooleanTriggered when the vehicle is close to a front collision
@adas.pedestrian_collision_warningSignalBooleanTriggered when a pedestrian is detected
@adas.left_turnSignalBooleanTriggered on left turn
@adas.right_turnSignalBooleanTriggered on right turn
@adas.brakeSignalBooleanTriggered when brakes are pressed
@adas.speed_limit_recognitionSignalBooleanTriggered when a recognized speed limit is exceeded
@adas.camera_blockedSignalBooleanTriggered when the camera is blocked
@adas.low_visibilitySignalBooleanTriggered when low visibility is detected

accelerometer

Accelerometer related information

propertyusetypedescription
$accelerometerfieldsetObjectjson appends all accelerometer fields
$accelerometerfieldsetStringtaip compatible field
@accelerometer.backward_collision.signalsignalBooleanTrue when detected
@accelerometer.cornering_left.signalsignalBooleanTrue when detected
@accelerometer.cornering_right.signalsignalBooleanTrue when detected
@accelerometer.forward_collision.signalsignalBooleanTrue when detected
@accelerometer.hard_braking.signalsignalBooleanTrue when detected
@accelerometer.harsh_fwd_acceleration.signalsignalBooleanTrue when detected
@accelerometer.lat_collision_from_left.signalsignalBooleanTrue when detected
@accelerometer.lat_collision_from_right.signalsignalBooleanTrue when detected
@accelerometer.motion.signalsignalBooleanTrue when detected
$accelerometer.backward_collision.timefieldsetStringTime of event
$accelerometer.backward_collision.valuefieldset, signalNumberAcceleration force in milli-g
$accelerometer.cornering_left.timefieldsetStringTime of event
$accelerometer.cornering_left.valuefieldset, signalNumberAcceleration force in milli-g
$accelerometer.cornering_right.timefieldsetStringTime of event
$accelerometer.cornering_right.valuefieldset, signalNumberAcceleration force in milli-g
$accelerometer.forward_collision.timefieldsetStringTime of event
$accelerometer.forward_collision.valuefieldset, signalNumberAcceleration force in milli-g
$accelerometer.hard_braking.timefieldsetStringTime of event
$accelerometer.hard_braking.valuefieldset, signalNumberAcceleration force in milli-g
$accelerometer.harsh_fwd_acceleration.timefieldsetStringTime of event
$accelerometer.harsh_fwd_acceleration.valuefieldset, signalNumberAcceleration force in milli-g
$accelerometer.lat_collision_from_left.timefieldsetStringTime of event
$accelerometer.lat_collision_from_left.valuefieldset, signalNumberAcceleration force in milli-g
$accelerometer.lat_collision_from_right.timefieldsetStringTime of event
$accelerometer.lat_collision_from_right.valuefieldset, signalNumberAcceleration force in milli-g
$accelerometer.motionfieldset, signalBooleanAppends the motion state
$accelerometer.timefieldset, signalBooleanTime of motion event
$accelerometer.valuefieldset, signalNumberAcceleration force in milli-g
$accelerometer.valuestateShow the last value of accelerometer in mill
set accelerometer self_alignmentactionExecutes the self alignment

actions

Actions related info.

propertyusedescription
trigger action action_nameactionForce the execution of an action

adas (ecu)

ADAS accessory related info, configured via the ecu monitor.

propertyusetypedescription
$ecu.adas_speedsignalNumberSpeed detected by adas accessory in km/h
$ecu.brakes_enabledsignalBooleanTrue if brakes detected
$ecu.distance_from_front_vehiclesignalNumberDistance from front vehicle in meters
$ecu.failsafesignalBooleanTrue if adas triggers one of the internal FailSafe modes, more info
$ecu.forward_collision_warningsignalBooleanTrue if forward collision warning detected
$ecu.headway_measurementsignalNumberHeadway measurement. Unit 0.1s. Range (0 - 9.9s)
$ecu.headway_validsignalBooleanTrue when CIPV (close in path vehicle) is detected
$ecu.headway_warning_levelsignalNumberHeadway warning level, more info
$ecu.headway_warning_repeatable_enabledsignalBooleanTrue when Headway Warning repeatable feature is ON
$ecu.high_beam_signalsignalBooleanTrue if high beam signal detected
$ecu.lane_departure_warning_disabledsignalBooleanTrue if lane departure warning is disabled
$ecu.left_lane_departure_warningsignalBooleanTrue if left lane departure warning detected
$ecu.left_signalsignalBooleanTrue if left signal is detected
$ecu.low_beam_signalsignalBooleanTrue if low beam signal detected
$ecu.maintenancesignalBooleanTrue if adas accessory is maintenance mode
$ecu.pedestrian_danger_zonesignalBooleanTrue if pedestrian in danger zone is detected
$ecu.pedestrian_forward_collision_warningsignalBooleanTrue if pedestrian forward collision warning is detected
$ecu.relative_speed_from_front_vehiclesignalBooleanTrue if relative speed from front vehicle is detected
$ecu.right_lane_departure_warningsignalBooleanTrue if right lane departure warning is detected
$ecu.right_signalsignalBooleanTrue if right signal is detected
$ecu.sound_typesignalNumberSound type, more info
$ecu.speed_availablesignalBooleanTrue if speed is available
$ecu.speed_limit_recognition_sensitivitysignalNumberSpeed limit recognition sensitivity
$ecu.speed_limit_recognition_statesignalNumberSpeed limit recognition state
$ecu.speed_limit_recognition_valuesignalNumberSpeed limit recognition value
$ecu.tamper_alertsignalBooleanTrue if a tamper alert is detected (fired when camera is blocked)
$ecu.time_indicatorsignalNumberTime indicator, more info
$ecu.traffic_signs_recognition_enabledsignalBooleanTrue when traffic signal recognition feature is on
$ecu.traffic_signs_recognition_warning_levelsignalNumberTraffic signs recognition warning level, more info
$ecu.wipers_signalsignalBooleanTrue when a wiper passes the windshield, 0 if wipers are static
$ecu.zero_speedsignalBooleanTrue if zero speed is detected (vehicle is stopped)

blackbox

Blackbox functionality allows you to save data to a file.

propertyusedescription
@logs.eventsignalTriggered when any log event is detected.
$logs.namesignal fieldsetStores log rotation name for apx-logrotate
$logs.pathsignal fieldsetStores log file path
$logs.usedsignal fieldsetStores media used memory
$logs.availablesignal fieldsetStores media available memory
$logs.sizesignal fieldsetStores media total size
$logs.percentagesignal fieldsetStores media memory usage in percentage
$logs.periodsignal fieldsetStores the rotation period configuration (daily, weekly, monthly)
$logs.rotatesignal fieldsetStores the total log files stored before rotation (ex. 5 days)

battery

Device internal battery information.

propertyusetypedescription
$batteryfieldsetObjectjson appends all battery fields
$batteryfieldsetStringtaip compatible field
$battery.connectedfieldset,signalBooleanInternal battery state
@battery.connectedsignalBooleanTrue when the battery is connected
@battery.disconnectedsignalBooleanTrue when the battery is disconnected
@battery.criticalsignalNumberBattery <= 10%
@battery.lowsignalNumberBattery <= 20%
@battery.fullsignalNumberBattery = 100%
$battery.mvfieldset,signalNumberInternal battery voltage in milliVolts
$battery.levelfieldset,signalNumberInternal battery level (%)
$battery.voltagefieldset,signalNumberInternal battery voltage

bluetooth

Bluetooth functionality. To speak via the bluetooth check out the modem speak action.

propertyusedescription
bluetooth connect 'AABBCCDDEEFF'actionConnect to bluetooth device
bluetooth disconnect 'AABBCCDDEEFF'actionDisconnect from bluetooth device
bluetooth pair 'AABBCCDDEEFF'actionPair to a bluetooth device
bluetooth pairforced '_AABBCCDDEEFF'actionForce pairing
bluetooth reset 'AABBCCDDEEFF'action🛑 Resets bluetooth paired devices
bluetooth restart 'AABBCCDDEEFF'actionRestart bluetooth
bluetooth scan secondsactionReplace with amount of seconds
bluetooth switchaudio '_AABBCCDDEEFF'actionSwitch main audio
bluetooth unpair 'AABBCCDDEEFF'actionUnpair from bluetooth device
@bluetooth.button.call_2xsignalBluetooth call button pressed 2 times
@bluetooth.button.volume_upsignalBluetooth volume up
@bluetooth.button.volume_downsignalBluetooth volume down
@bluetooth.button.mutesignalBluetooth mute button pressed

bluetooth sensor (ble)

Bluetooth low energy that can communicate with sensors and tags.

propertyusetypedescription
@ble.event signalTriggered at any ble event
@ble.(MAC or ALIAS).temperature.changesignalTriggered when a change in temperature is detected
@ble.(MAC or ALIAS).macfieldset, signalStringDevice mac address
@ble.(MAC or ALIAS).namefieldset, signalStringAdvertised name
@ble.(MAC or ALIAS).aliasfieldset, signalStringAssigned alias
@ble.(MAC or ALIAS).timestampfieldset, signalNumberScanned time
@ble.(MAC or ALIAS).temperaturefieldset, signalNumberReported temperature value in degrees celsius
@ble.(MAC or ALIAS).humidityfieldset, signalNumberReported humidity value in percentage
@ble.(MAC or ALIAS).movementfieldset, signalNumberReported number of movements detected
$ble.(MAC or ALIAS).rpmstateStringThe rpm value [revolutions per minute]
@ble.(MAC or ALIAS).batterystateStringThe battery value [%]
$blefieldsetObjectJson appends all battery fields ($ble.BlazonDRS.rpm,$ble.BlazonDRS.temperature,$ble.BlazonDRS.battery)

counters

Device counters information.

propertyusetypedescription
$countersfieldsetObjectjson appends all counter fields
$counters.name.odometerfieldset, signalNumberTotal distance traveled with ignition ON (meters)
$counters.name.ignition_timefieldset, signalNumberTotal ignition time (seconds)
$counters.name.idle_timefieldset, signalNumberTotal time spent in idling (seconds)
$counters.name.over_speedfieldset, signalNumberTotal time spent over speed (seconds)
$counters.name.over_rpmfieldset, signalNumberTotal time spent over RPMs (seconds)
$counters.name.hard_brakesfieldset, signalNumberTotal amount of hard brake events (count)
$counters.name.harsh_fwd_accelerationfieldset, signalNumberTotal amount of harsh forward acceleration events (count)
$counters.name.total_countfieldset, signalNumberStores number of times a signal becomes true
$counters.name.total_timefieldset, signalNumberStores the total time a signal stays true, stops counting when false
$counters.name.time_incrementfieldset, signalNumberStores the time passed while a signal is true, reset count when false
$counters.name.total_distancefieldset, signalNumberStores the total distance traveled while a signal is true, stops counting when false
$counters.name.distance_incrementfieldset, signalNumberStores the distance traveled while a signal is true, reset count when false
$counters.name.statefieldset, signalNumberStores the counter state (true when counting)
define counters nameactionCreate a counter definition
start counters nameactionStart/enable the counting function and listen for change in the selected signals
stop counters nameactionStop/disable the counting function, any change in the signals will be ignored
reset counters nameactionReset/restart the states values, like total_count, total_time, etc.
get counters nameactionGet a counter definition
set counters name field=valueactionSet counter threshold

destinations

Destinations related actions.

propertyusedescription
enable destination destination_nameactionEnable the destination
disable destination destination_nameactionDisable the destination

ecu

Engine Control Unit related information. For more info visit: Engine Control Unit (ECU).

propertyUsetypedescription
$ecufieldsetObjectjson appends all valid ecu parameters
$ecufieldsetStringtaip compatible fieldset
$ecu.idfieldset, signalMultipleid refers to the specific pgn + start_position
$ecu.param_namefieldset, signalMultipleparam_name refers to the parameters listed in the SDK ECU.d directory files
$ecu.error_codes.spnfieldset, signalNumberECU diagnostic trouble code SPN number. More info
$ecu.error_codes.fmifieldset, signalNumberECU diagnostic trouble code FMI number. More info
@ecu_warning.disconnectedsignalBooleanTrue when disconnected ecu warning is detected (CAN1 and CAN2)
@ecu_warning.can1.disconnectedsignalBooleanTrue when disconnected ecu warning is detected (CAN1)

events

Events related actions.

propertyusedescription
send event event_nameactionGenerate an event to the defined destinations
fire signal signal_nameactionSimulate a signal
event_namesignalAn event name can be used as a signal, it will be true when the event's trigger conditions are met

fatigue_sensor

Fatigue sensor accessory related information. Note that the fatigue sensor information can come from either the CAN bus or Serial (RS-232) cables.

propertyusetypedescription
$fatigue_sensorfieldsetObjectAkmppends relevant fatigue_sensor information to the payload
@serial.fatigue_sensor.SIGNALsignalBooleanSerial fatigue sensor specific signals
@fatigue_sensor.fatigue_remindsignalBooleanTrue when a fatigue reminder was detected
@fatigue_sensor.fatigue_warningsignalBooleanTrue when yawning or a fatigue warning was detected
@fatigue_sensor.fatigue_alarmsignalBooleanTrue when drowsiness or fatigue alert was detected
@fatigue_sensor.no_portraitsignalBooleanTrue when no driver is detected
@fatigue_sensor.distractionsignalBooleanTrue when the driver is distracted
@fatigue_sensor.phonesignalBooleanTrue when a driver is on their phone
@fatigue_sensor.smokingsignalBooleanTrue when a driver is smoking
@fatigue_sensor.seatbelt_offsignalBooleanTrue when a driver is driving without the seatbelt
@fatigue_sensor.camera_blockedsignalBooleanTrue when the fatigue sensor's camera is blocked
@fatigue_sensor.photosignalBooleanTrue when a photo was captured manually
@fatigue_sensor.signalsignalBooleanTrue when any fatigue sensor event is triggered
$fatigue_sensor.connectedsignal fieldsetBooleanTrue if fatigue sensor is connected
$fatigue_sensor.statesignal fieldsetString"connected" or "disconnected"
$fatigue_sensor.sensitivitysignal fieldsetNumberSensitivity of the fatigue sensor
$fatigue_sensor.speaker_volumesignal fieldsetNumberVolume of the fatigue sensor
$fatigue_sensor.min_speedsignal fieldsetNumberMinimum speed to trigger fatigue sensor alerts
$fatigue_sensor.speedingsignal fieldsetNumberSpeeding threshold
$fatigue_sensor.max_photossignal fieldsetNumberTotal number of photos that can be captured
$fatigue_sensor.nbr_photossignal fieldsetNumberNumber of photos captured
$fatigue_sensor.latest_photosignal fieldsetNumberLatest photo
$ecu.distractionsignal fieldsetBooleanTrue when the driver is distracted
$ecu.yawningsignal fieldsetBooleanTrue if the driver is yawning
$ecu.drowsinesssignal fieldsetBooleanTrue when drowsiness was detected
$ecu.phonesignal fieldsetBooleanTrue if the driver is on their phone
$ecu.smokingsignal fieldsetBooleanTrue when smoking was detected by the driver
$ecu.driver_absencesignal fieldsetBooleanTrue when there's no driver present
$ecu.camera_blockedsignal fieldsetBooleanTrue if the camera is blocked
$ecu.camera_errorsignal fieldsetBooleanTrue when a camera error was detected
$ecu.zero_speedsignal fieldsetBooleanTrue when the vehicle is parked
$ecu.error_validsignal fieldsetBooleanTrue when an error was detected by the fatigue sensor
$ecu.tamper_alertsignal fieldsetBooleanTrue if tampering is detected by the fatigue sensor
capture fatigue_sensor photoactionCaptures a photo with the fatigue sensor camera
upload fatigue_sensor photosactionManually upload all photos to an ftp destination
set fatigue_sensor sensitivityactionChange sensitivity (Range: 2-11)
set fatigue_sensor speaker_volumeactionChange the speaker volume (Range: 0-2)
set fatigue_sensor minimum_speedactionChange the minimum speed to trigger fatigue alerts (Range: 10-60)kph
set fatigue_sensor speeding_alarmactionChange the speeding alarm (Range: 0-255)kph
set fatigue_sensor buffer_sizeactionChange the max photos that can be captured (Range: 10-100)
set fatigue_sensor autouploadactionManage the auto upload of photos to the DCT ftp directory, default is 0
clear fatigue_sensor bufferactionDeletes all photos in the fatigue_sensor directory

fuel sensor (Technoton)

Fuel sensor related information

propertyusetypedescription
$fuelfieldsetStringjson and taip compatible fieldset. Appends all fuel sensor fields or ;FF tag for TAIP
@fuel.eventsignalBooleanTriggered when any fuel event is detected
@fuel.statesignalBooleanTriggered when a state arrives
@fuel.fuelingsignalBooleanTriggered when a fueling notification arrives
@fuel.warningsignalBooleanTriggered when a discharge warning notification arrives
@fuel.connectedsignalBooleanTriggered when a transition from disconnected to connected is detected
@fuel.disconnectedsignalBooleanTriggered when a transition from connected to disconnected is detected
$fuel.connectedfieldset, signalBooleanStores the last connected state
$fuel.levelfieldset, signalNumberStores the last fuel level (value is in deci-liters)
$fuel.temperaturefieldset, signalNumberStores the last temperature level
$fuel.frequencyfieldset, signalNumberStores the last frequency
$fuel.timestampfieldset, signalNumberStores the last notification timestamp
$fuel.eventfieldset, signalStringStores the last event
$fuel.alias.connectedstateBooleanStores the last connected state of tank named alias
$fuel.alias.levelstateNumberStores the last fuel level of tank named alias
$fuel.alias.temperaturestateNumberStores the last temperature level of tank named alias
$fuel.alias.frequencystateNumberStores the last frequency of tank named alias
$fuel.alias.timestampstateNumberStores the last notification timestamp of tank named alias
$fuel.alias.eventstateStringStores the last event of tank named alias
@fuel.alias.statesignalBooleanTriggered when any fuel signal is detected
@fuel.alias.fuelingsignalBooleanTriggered when a state arrives
@fuel.alias.warningsignalBooleanTriggered when a discharge warning notification arrives
@fuel.alias.fuelingsignalBooleanTriggered when a fueling notification arrives
@fuel.alias.connectedsignalBooleanTriggered when a transition from disconnected to connected is detected
@fuel.alias.disconnectedsignalBooleanTriggered when a transition from connected to disconnected is detected

geofence

Geofences related information

propertyusetypedescription
$geofences._name_.insidefieldset, signalBooleanInside <name>
$geofences._name_.timefieldset, signalNumberTime when device entered <name>
$geofences.$groups._group_name_.insidesignalBooleanInside any fence in <group_name>
@last_geofence.namefieldsetStringLast geofence name
@last_geofence.statefieldsetStringinside, outside
@last_geofence.timefieldsetNumberTime of last geofence
@geofences.group.geofencename.alias.speedingsignalSpeed limit in the geofence
@geofences.GROUP_NAME.*.*.speedingsignalTriggers when vehicle exceeds the speed limit inside any geofence in the GROUP_NAME group
@geofences.*.*.ALIAS.speedingsignalTriggers when vehicle exceeds the speed limit inside any geofence with limit named SPEED_ALIAS
@geofences.*.GEONAME.*.speedingsignalTriggers when vehicle exceeds the speed limit inside any geofence named GEONAME
@geofences.*.*.*.speedingsignalTriggers when vehicle exceeds any speed limit
$geospeed.warningstateBooleanSpeed in geofence warning [true or false]
If false when:
-The speed decreased
-The vehicle is outside the geofence
-The GPS connection is lost
-Change of direction/ turn *(optional, depending on the configuration parameters)
$geospeed.epochstateTimestamp of speeding event in seconds
$geospeed.typestateType of warning [speeding]
$geospeed.statestateCurrent state [in_progress, finished_by_speed ,finished_by_geofence, finished_by_gps]
$geospeed.namespacestateNamespace of geofence definitions
$geospeed.groupstateGeofence group
$geospeed.namestateDefined name of geofence
$geospeed.elapsed_timestateElapsed time speeding inside the geofence
$geospeed.elapsed_distancestateElapsed distance speeding inside the geofence
$geospeed.threshold_aliasstateDefined Alias for the speed limit
$geospeed.threshold_min_headingstateDefined minimum degree heading
$geospeed.threshold_max_headingstateDefined maximum degree heading
$geospeed.threshold_speedstateDefined speed threshold
$geospeed.start_speedstateSpeed at start of speed limit
$geospeed.start_headingstateHeading at start of speed limit
$geospeed.start_lonstateLongitude coordinate at start of speed limit
$geospeed.start_latstateLatitude coordinate at start of speed limit
$geospeed.end_speedstateFinishing speed [m/s]
$geospeed.end_headingstateFinishing heading [degrees]
$geospeed.end_lonstateFinishing longitude
$geospeed.end_latstateFinishing latitude
$geospeed.max_speedstateMaximum speed inside reached
$geospeed.max_headingstateHeading at the maximum speed
$geospeed.max_lonstateLongitude coordinate at maximum speed
$geospeed.max_latstateLatitude coordinate at maximum speed

gnss

GNSS position information

propertyusetypedescription
$gnssfieldsetObjectjson appends all gnss fields
$gnssfieldsetStringtaip compatible fieldset
$gnss.accuracyfieldset, signalNumberPosition accuracy in meters
$gnss.acceleration.eventfieldset, signalStringTriggered whenever an acceleration event by the GNSS is detected, (this is defined in the tracking_resolution)
$gnss.acceleration.reasonfieldset, signalStringpositive_acc or negative_acc depending on the acceleration that was fired by the GNSS, (this is defined in the tracking_resolution)
$gnss.acceleration.valuefieldset, signalNumberAcceleration value (can be positive or negative) in km/h/s (kilometer per hour per second), (this is defined in the tracking_resolution)
$gnss.acceleration.mphsfieldset, signalNumberAcceleration value (can be positive or negative) in m/h/s (miles per hour per second)
$gnss.altitudefieldset, signalNumberAltitude AMSL
$gnss.altitudeAccuracyfieldset, signalNumberAltitude accuracy
$gnss.bearingfieldset, signalNumberRelative bearing to a base station
$gnss.criteriafieldset, signalStringGNSS criteria
$gnss.fixfieldset, signalNumber1: no fix
2: 2D fix
3: 3D fix
$gnss.hdopfieldset, signalNumberHorizontal DOP
$gnss.headingfieldset, signalNumberHeading 0°N, 90°E, ...
$gnss.kphfieldset, signalNumberSpeed in kph (float)
$gnss.latitudefieldset, signalNumberWGS84 Latitude
$gnss.longitudefieldset, signalNumberWGS84 Longitude
$gnss.mphfieldset, signalNumberSpeed in mph (float)
$gnss.pdopfieldset, signalNumberPosition DOP
$gnss.satsActivefieldset, signalNumberSatellites used
$gnss.speedfieldset, signalNumberSpeed value in m/s (float)
$gnss.timestampfieldset, signalNumberEpoch gps timestamp
$gnss.vdopfieldset, signalNumberVertical DOP
$kphfieldset, signalNumberSpeed in kph (integer)
$mphfieldset, signalNumberSpeed in mph (integer)
$speedfieldset, signalNumberSpeed value in m/s (integer)
$timestampfieldsetStringdddd, MMMM D, YYYY h:hh A format
$timestamp.esfieldsetStringdddd, D de MMMM de YYYY HH:hh format
$timestamp.frfieldsetStringdddd D MMMM YYYY HH:hh format
$timestamp.ptfieldsetStringdddd, D de MMMM de YYYY HH:hh format
set gnss hot-startactionExecutes a gps hot start
set gnss warm-startactionExecutes a gps warm start
set gnss cold-startactionExecutes a gps cold start

ibutton

IButton component, note that a total of 500 onewire devices can be created (between ibutton and temperature sensors)

propertyUsetypedescription
$ibuttonfieldsetObjectjson appends all ibutton fields
IB:$ibutton.connected.idfieldsetStringtaip connected ibutton id
IS:$ibutton.last.idfieldsetStringtaip last connected ibutton id
$ibutton.authorized.connected.aliasfieldset, signalStringAlias of authorized ibutton
$ibutton.authorized.connected.connectedfieldset, signalBooleanAuthorized ibutton connected
$ibutton.authorized.connected.idfieldset, signalStringID of the authorized ibutton
$ibutton.authorized.connected.conn_epochfieldset, signalNumberEpoch of when it was connected
$ibutton.authorized.last.aliasfieldset, signalStringAlias of last authorized ibutton
$ibutton.authorized.last.idfieldset, signalStringCurrent ID of the last authorized ibutton
$ibutton.authorized.last.conn_epochfieldset, signalNumberEpoch of last authorized ibutton connection
$ibutton.authorized.last.disc_epochfieldset, signalNumberEpoch of last authorized ibutton disconnection
$ibutton.connected.aliasfieldset, signalStringAlias of connected ibutton
$ibutton.connected.connectedfieldset, signalBooleanTrue if any ibutton is currently detected
$ibutton.connected.idfieldset, signalStringID of the connected ibutton
$ibutton.connected.whitelistedfieldset, signalBooleanTrue while the ibutton connected is authorized
$ibutton.connected.conn_epochfieldset, signalNumberEpoch of ibutton connection
$ibutton.last.aliasfieldset, signalStringAlias of last connected ibutton
$ibutton.last.connectedfieldset, signalBooleanTrue if ibutton is connected
$ibutton.last.idfieldset, signalStringID of last connected ibutton
$ibutton.last.whitelistedfieldset, signalBooleanTrue if last ibutton is authorized
$ibutton.last.conn_epochfieldset, signalNumberEpoch of last ibutton connection
$ibutton.last.disc_epochfieldset, signalNumberEpoch of last ibutton disconnection
add ibutton alias_name idactionadd ibutton to authorized list
remove ibutton alias_nameactionremove ibutton from authorized list by alias_name
remove ibutton idactionremove ibutton from authorized list by id
remove ibuttonsaction🛑 remove all ibuttons from authorized list
clear ibuttonactionclears the last ibutton read
get ibutton alias_nameactionget ibutton by alias_name
get ibutton idactionget ibutton by id
get ibuttonsactionget list of ibutton defined

imu

Inertial measurement unit manager for the device's accelerometer and gyroscope. Allows you to calibrate the accelerometer and set its event thresholds.

propertyusetypedescription
@imu.eventsignalBooleanTriggered when any accelerometer event arrives
@imu.periodicsignalBooleanTriggered when a specific event arrives
$imu.motionstateBooleanMovement of the vehicle detected
$imu.valuestateNumberMagnitude of movement RMS
$imu.eventstateStringThe detected ever [hard_braking , periodic ,...]
$imu.xstateNumberX-axis raw acceleration value
$imu.ystateNumberY-axis raw acceleration value
$imu.zstateNumberZ-axis raw acceleration value
$imufieldsetStringjson appends all imu fields

io

Inputs/Outputs component

propertyUsetypedescription
$iofieldsetObjectjson appends all io fields
$iofieldsetStringtaip compatible fieldset
$adfieldsetNumbertaip compatible fieldset
$io.an1fieldset, signalNumberAnalog input channel 1 (range: 0-28000mV)
$io.an2fieldset, signalNumberAnalog input channel 2 (range: 0-28000mV)
$io.danfieldset, signalNumberDifferential analog values (range: 0-10000mV)
$io.ignfieldset, signalBooleanTrue when the state of the ignition is ON
$io.in1fieldset, signalBooleanTrue when input 1 is ON
$io.in2fieldset, signalBooleanTrue when input 2 is ON
$io.in3fieldset, signalBooleanTrue when input 3 is ON
$io.in4fieldset, signalBooleanTrue when input 4 is ON
$io.in5fieldset, signalBooleanTrue when input 5 is ON
$io.in6fieldset, signalBooleanTrue when input 6 is ON
$io.in7fieldset, signalBooleanTrue when input 7 is ON
$io.out1fieldset, signalBooleanTrue when output 1 is ON
$io.out2fieldset, signalBooleanTrue when output 2 is ON
$io.out3fieldset, signalBooleanTrue when output 3 is ON
$io.out4fieldset, signalBooleanTrue when output 4 is ON
$io.pwrfieldset, signalBooleanTrue when external power is ON
$io.so1fieldset, signalBooleanTrue when a short circuit on output 1 is detected
$io.so2fieldset, signalBooleanTrue when a short circuit on output 2 is detected
$io.so3fieldset, signalBooleanTrue when a short circuit on output 3 is detected
$io.so4fieldset, signalBooleanTrue when a short circuit on output 4 is detected
$io.tigfieldset, signalBooleanTrue when ignition detected from power
$safe_immovariable, signalBooleanTrue when Pegasus sends safe immobilization (SECO) command to device (more information here)
set out# onactionactivate output #
set out# offactiondeactivate output #

io pulse counter

propertyusetypedescription
@pulse.eventsignalBooleanTriggered when any pulse event arrives
$pulse.countstateNumberThe pulse count
$pulse.valuestateNumberThe pulse value
$pulsefieldsetObjectFieldset key name

io expander

IO Expander for extended inputs and outputs

propertyusetypedescription
@iox.eventsignalBooleanTriggered when any IO Expander event arrives
@iox.connectedsignalBooleanTriggered when an IO expander is connected
$iox.statestateStringState of IO Expander [connected or disconnected]
$iox.connectedstateBooleanState of connected
$iox.idstateStringOnewire identification [1b0000160f183929]
$iox.aliasstateStringAssigned alias string [iosexpander]
$iox.epochstateNumberLast connected state epoch [1710169042]
$iox.in1 - $iox.in4stateBooleanInput state
$iox.out1 - $iox.out4stateBooleanOutput state
$ioxfieldsetFieldset key name

mdt/serial

RS-232 Mobile Data Terminal info

propertyusetypedescription
$mdtfieldsetObjectjson appends mdt information
$mdt.messagefieldsetStringtaip appends MDT message information to taip string (ascii or hex)
@mdt.messagesignalStringTrue whenever an incoming message is received via MDT mode
@serial.eventsignalBooleanTriggered when any data arrives to serial port
@serial.messagesignalBooleanTriggered when a message arrives in console mode
$serial.modesignal stateStringThe serial mode [ mdtmodemconsole ]
$serial.messagesignal stateStringThe last arrived console message in string
set mdtactionSet MDT settings
send mdt messageactionSend MDT message

modem

Modem information.

propertyusetypedescription
$modemfieldsetObjectjson appends all modem fields
$modemfieldsetStringtaip compatible fieldset (includes ;SC tag)
@modem.call_startedsignalBooleanTriggered when a voice call starts
@modem.call_endedsignalBooleanTriggered when a voice call ends
$modem.bandfieldset, signalStringLTE band
$modem.cidfieldset, signalStringCell ID in hex format
$modem.esim_idfieldset, signalStringEmbedded sim ID
$modem.esim_imsifieldset, signalStringEmbedded sim IMSI
$modem.esim_statefieldset, signalStringEmbedded sim card state
READY
Not in Use
$modem.gprs_regfieldset, signalNumberGPRS registration status
$modem.gsm_regfieldset, signalNumberGSM registration status:
0 - Not registered and not searching,
1 - Registered to Home Network,
2 - Not registered but device is searching,
3 - Registration denied,
4 - Out of range,
5 - Registered, roaming
$modem.imeifieldset, signalNumberUnique numeric identifier
$modem.ipfieldset, signalStringIP address assigned by operator
@modem.jamming_detectedsignalBooleanTriggered when a jamming condition is detected
@modem.jamming_persistencesignalBooleanTriggered when the jamming condition persist for one minute
@modem.jamming_endedsignalBooleanTriggered when jamming action stops
$modem.statefieldset, signalStringThe jamming state
JAMMED
NOT_JAMMING
$modem.jamming_detectedfieldset, signalBooleanThe jamming state
$modem.jamming_persistencefieldset, signalBooleanThe persistence flag state
$modem.jamming_endedfieldset, signalBooleanThe ended flag state
$modem.lacfieldset, signalNumberLocation area code
$modem.manufacturerfieldset, signalStringModem's manufacturer
$modem.mcc_mncfieldset, signalNumberMobile Country and Network Code
$modem.modelfieldset, signalStringModel of modem
$modem.modem_statefieldset, signalStringState of the modem ("ON", "OFF")
$modem.no_conn_timefieldset, signalStringTime spent with no connection in seconds, note that this is exclusively for the modem, so the device could be connected via ethernet/wifi and not LTE.
Use the latest Apex version in case you're having false positives with this signal
$modem.operatorfieldset, signalStringNetwork operator
$modem.ratfieldset, signalStringRadio Access Technology, depending on the device model it's one of the following strings:

Syrus 4G LTE
"NONE"
"CDMA1X"
"CDMA 1X AND HDR"
"CDMA 1X AND EHRPD"
"HDR"
"HDR-EHRPD"
"GSM"
"GPRS"
"EDGE"
"WCDMA"
"HSDPA"
"HSUPA"
"HSPA+"
"TDSCDMA"
"TDD LTE"
"FDD LTE"

Syrus 4G Lite CATM1
"No Service"
"GSM"
"GPRS"
"EDGE"
"eMTC"
"NBIOT"

Syrus 4G Lite CAT1
"No Service"
"GSM"
"GPRS"
"TDD LTE"
"FDD LTE"
$modem.revisionfieldset, signalStringModem's revision
$modem.rssifieldset, signalNumberReceived Signal Strength Indicator (0-32)
$modem.sim_idfieldset, signalNumberExternal sim ID
$modem.sim_imsifieldset, signalNumberExternal sim IMSI
$modem.sim_statefieldset, signalNumberExternal sim State ("READY", "Not in Use")
@modem.sim_insertedsignalTriggered when sim inserted
@modem.sim_removedsignalTriggered when sim removed
@modem.sim_insertedstateBooleanTrue if the sim card is present. False if the sim is removed.
$modem.temperaturefieldset, signalNumberModem's temperature (generally higher than ambient temperature
$modem.voice_call.phonefieldset, signalStringThe last calling number ["9999123456"]
$modem.voice_call.statefieldset, signalBooleanIf there is a call in progress [true |false]
set airplane_mode trueactionSet to true to enable airplane_mode
set sim_switch_interval 8actionTime interval in hours to wait to switch from external to internal sim card
start call +1234567890actionStart a phone call
end callactionEnd a phone call
send sms 3013333333 'testing sms'actionSend an SMS message to 3013333333
add phone +1234567890actionAdd phone +1234567890 to phonebook
remove phone +1234567890actionRemove phone +1234567890 from phonebook
set call_validation trueactionEnable call validation from phonebook
set sms_validation trueactionEnable call validation from phonebook
speak lang=en 'hello world'actionSpeak via the bluetooth

net_cell

Cellular interface

propertyusetypedescription
$net_cell.connectedfieldset, signalBooleanTrue when connected
$net_cell.iccidfieldset, signalNumberSIM card ICCID
$net_cell.imeifieldset, signalNumberDevice unique IMEI number
$net_cell.imsifieldset, signalNumberSIM card IMSI
$net_cell.ip_addressfieldset, signalStringIP assigned by MNO
$net_cell.mccfieldset, signalNumberMobile country code
$net_cell.mncfieldset, signalNumberMobile network code
$net_cell.operatorfieldset, signalStringNetwork operator
$net_cell.rx_bytesfieldset, signalNumberBytes received
$net_cell.tx_bytesfieldset, signalNumberBytes transmitted

net_eth

Ethernet interface

propertyusetypedescription
$net_eth.connectedfieldset, signalBooleanEthernet connected
$net_eth.ip_addressfieldset, signalStringIP address
$net_eth.rx_bytesfieldset, signalNumberBytes received
$net_eth.tx_bytesfieldset, signalNumberBytes transmitted
enable ethernetactionEnables the ethernet interface
disable ethernetactionDisables the ethernet interface

net_wifi

Wifi interface

propertyusetypedescription
$net_wifi.connectedfieldset, signalBooleanWiFi connected
$net_wifi.ip_addressfieldset, signalStringIP address
$net_wifi.key_mgmtfieldset, signalStringKey management protocol
$net_wifi.macfieldset, signalStringWiFi MAC address
$net_wifi.rx_bytesfieldset, signalNumberBytes received
$net_wifi.signalfieldset, signalNumberSignal strength in dbm
$net_wifi.ssidfieldset, signalStringSSID name
$net_wifi.statefieldset, signalStringWifi connection
Completed
Disabled
Interface_disabled - when hotspot is on
$net_wifi.tx_bytesfieldset, signalNumberBytes transmitted
enable wifiactionEnables the wifi interface
disable wifiactionDisables the wifi interface
restart wifiactionRestarts the wifi interface

net_wlan1 (hotspot)

Hotspot interface

propertyusetypedescription
$net_wlan1.connectedfieldset, signalBooleanHotspot connected
$net_wlan1.ip_addressfieldset, signalStringIP address
$net_wlan1.rx_bytesfieldset, signalNumberBytes received
$net_wlan1.tx_bytesfieldset, signalNumberBytes transmitted
enable hotspotactionEnables the hotspot
disable hotspotactionDisables the hotspot
@hotspot.startedsignalBooleanTransient signal
@hotspot.stoppedsignalBooleanTransient signal
$hotspot.activestateBoolean
$hotspot.inactivestateBoolean

people_counting

People counting camera signals, actions, and recommended fieldsets.

propertyusetypedescription
@people.adult_entersignalBooleanAdult entered
@people.adult_exitsignalBooleanAdult exited
@people.children_entersignalBooleanChild entered
@people.children_exitsignalBooleanChild exited
@people.requestedsignalBooleanType of report obtained, whether daily or weekly
@people.startsignalBooleanStarts people counting
@people.stopsignalBooleanEnds people counting
@people.restartedsignalBooleanPeople counting camera restarted
@people.cam_connectedsignalBooleanCamera connected
@people.cam_disconnectedsignalBooleanCamera disconnected
@people.daily_reportsignalBooleanDaily report generated
@people.weekly_reportsignalBooleanWeekly report generated
$people.eventsignal, fieldsetStringLast people counting event
$people.adult.entersignal, fieldsetNumberAdults entered
$people.adult.exitsignal, fieldsetNumberAdults exited
$people.children.entersignal, fieldsetNumberChildren entered
$people.children.exitsignal, fieldsetNumberChildren exited
$people.adults_insidesignal, fieldsetNumberAdults inside
$people.children_insidesignal, fieldsetNumberChildren inside
$people.global_adult.entersignal, fieldsetNumberTotal adults entered
$people.global_adult.exitsignal, fieldsetNumberTotal adults exited
$people.global_children.entersignal, fieldsetNumberTotal children entered
$people.global_children.exitsignal, fieldsetNumberTotal children exited

power_save

Power save mode

propertyusetypedescription
@power_save.ignsignalBooleanWake up by ignition
@power_save.in1signalBooleanWake up from input 1
@power_save.in2signalBooleanWake up from input 2
@power_save.in3signalBooleanWake up from input 3
@power_save.in4signalBooleanWake up from input 4
@power_save.in5signalBooleanWake up from input 5
@power_save.in6signalBooleanWake up from input 6
@power_save.in7signalBooleanWake up from input 7
@power_save.motionsignalBooleanWake up from motion
@power_save.pwrsignalBooleanWake up from ext power
@power_save.sleepsignalBooleanEntering power save
@power_save.so1signalBooleanWake up from short circuit on out1
@power_save.so2signalBooleanWake up from short circuit on out2
@power_save.so3signalBooleanWake up from short circuit on out3
@power_save.so4signalBooleanWake up from short circuit on out4
@power_save.tigsignalBooleanWake up from ignition on power
@power_save.psm_timeoutsignalBooleanWake up by time
@power_save.electrical_resetsignalBooleanWake up by electrical reset
@power_save.wakeupsignalBooleanWakes up from power save
$power_save.timefieldsetNumberEpoch of wakeup time
$power_save.modefieldsetStringPower save mode string
$power_save.reasonfieldsetStringWake up reason
$power_save.statusfieldsetBooleanPower save mode status
set power_save immediateactionForce start power save mode
set power_save mode [PSM_STRING]actionModify power save mode

rfid

Serial RFID component

propertyUsetypedescription
$rfidfieldsetObjectjson appends all rfid fields
RI:$rfid.last.idfieldsetStringtaip last connected rfid id
$rfid.last.idfieldset, signalStringID of last connected rfid
$rfid.last.aliasfieldset, signalStringAlias of last connected rfid
$rfid.last.whitelistedfieldset, signalBooleanTrue if last rfid is authorized
$rfid.last.conn_epochfieldset, signalNumberEpoch of the last rfid connection
$rfid.authorized.last.idfieldset, signalStringID of the last authorized rfid
$rfid.authorized.last.aliasfieldset, signalStringAlias of last authorized rfid
$rfid.authorized.last.whitelistedfieldset, signalBooleanTrue if last rfid was authorized
$rfid.authorized.last.conn_epochfieldset, signalNumberEpoch of last authorized rfid
@rfid.eventsignalBooleanTriggered when any rfid event is detected
@rfid.changesignalBooleanTriggered when the rfid changed
@rfid.readsignalBooleanTriggered when a card approaches the reader, even if it's the same id
@rfid.authorizedsignalBooleanTriggered when the id is whitelisted
@rfid.unauthorizedsignalBooleanTriggered when the id is not whitelisted
add rfid --id=1234 --alias=driver1 actionadd an RFID to the authorized list, or update alias of existing RFID
clear rfid actionclears the last RFID read
remove rfid --id=1234 actionremoves an RFID from the authorized list
remove rfids action🛑 removes all RFIDs from the authorized list
get rfid actionget the last RFID read
get rfids actionget a list of all RFIDs

satellite (satcom/sigfox)

propertyUsetypedescription
$satcomfieldsetObjectjson appends all timer fields
$satcomfieldsetStringtaip appends satellite modem's information
$satcom.statesignalStringState is connected when satellite is connected
$satcom.idsignalStringSatellite modem's id (imei)
$satcom.signalsignalNumberSignal strength:
0 - no signal
1 - weak signal
2 - fair signal
3 - ok signal
4 - good signal
5 - excellent signal
$satcom.buff_sizesignalNumberMaximum allowed messages to be stored
$satcom.buff_countsignalNumberAmount of messages stored
enable destination destination_nameactionEnables a destination
disable destination destination_nameactionDisables a destination
clear satcom bufferactionClears the satellite destination buffer
set satcom buffer_sizeactionSet the satcom buffer size (Range from 10 to 500).
get satcom buffer_sizeactionGet the satcom buffer size.

seco (Safe Engine Cut-off / Immobilization)

propertyusetypedescription
@seco.eventsignalbooleanTrigger when any seco event arrives
@seco.enabledsignalbooleanTrigger when the feature mode in enabled (powered ON)
@seco.activesignalbooleanTrigger when the feature is waiting for correct moment to realize the engine cut off.
@seco.idlesignalboolean
@seco.canceledsignalbooleanUser canceled the activation
@seco.power_restoredsignalbooleanOutput has been deactivated or the engine power restored
@seco.deactivatedsignalbooleanOutput has been deactivated or the engine power restored
@seco.power_suspendedsignalbooleanOutput has been activated or the engine power suspended
@seco.activatedsignalbooleanOutput has been activated or the engine power suspended
@seco.activatingsignalbooleanWaiting for conditions to suspend the engine power (speed < 10kph for 20s)
@seco.waiting_no_motionsignalbooleanWaiting for conditions to suspend the engine power (no motion for 5 min)
@seco.waiting_for_gpssignalbooleanSafe conditions not met, either motion was detected or vehicle speed is above 10kph
@seco.periodic_reportsignalbooleanPeriodic report, the SECO mechanism is running but waiting for safety conditions
$seco.enabledstatesbooleanSafe engine cut off module enabled
$seco.activestatesbooleanSafe engine cut off feature actived
$seco.statestatesbooleanNumber of the current state (see apx-seco help)
enable secoactionEnables the safe engine module
disable secoactionDisables the safe engine module
start secoactionStart safe engine cut off, waiting for conditions for tunrn off motor
stop secoactionStop safe engine cut off, enables the motor again

system

propertyusetypedescription
@system.resetone-shot signalbooleanTriggered whenever the device comes back from a restart
@system.netchangeone-shot signalbooleanTriggered every time the network changed after a Syrusjs restart
$system.sessionCountstatesNumberSession number counter, increase every restart
$system.uptimestatesNumberTime powered on
$system.netstatesStringNetlink name [ eth0,wlan0,ppp0]
$system.ipstatesStringCurrent device ip

timers

propertyusetypedescription
$timersfieldsetObjectjson appends all timer fields
@timers.timer_namesignalBooleanTrue if timer timer_name reaches its duration
start timer timer_nameactionStart a timer
stop timer timer_nameactionStops and clears a timer
enable timer timer_nameactionEnables a timer
disable timer timer_nameactionDisables a timer

time windows

propertyusetypedescription
@windows.name.startsignalBooleanOne shot boolean, true when time-window starts
@windows.name.endsignalBooleanOne shot boolean, true when time-window ends
$windows.name.insignalBooleanState, true when current time is in time-window
$windows.name.outsignalBooleanState, true when current time out of time-window

temperature

Temperature component, note that a total of 500 onewire devices can be created (between temperature sensors and ibuttons)

propertyUsetypedescription
$tempfieldsetObjectjson appends all temp fields
$temp.aliasesfieldsetObjectjson Temperature info for all sensors
$temp.aliases.alias_namefieldsetObjectjson Temperature info for particular alias
$temp.sensor_listfieldsetObjectjson Temperature value for all sensors
$temp.sensorlist._nfieldsetObjectjson Temperature value for nth index
EA[A|B|C]:$temp.aliases._alias_name.valuefieldsetNumbertaip Temperature value for alias_name
EA[A|B|C]:$temp.sensor_list._n.valuefieldsetNumbertaip Temperature value for nth index
$temp.aliases.alias_name.idfieldset, signalStringID of temperature sensor alias_name
$temp.aliases.alias_name.valuefieldset, signalNumberTemperature value in °C
$temp.aliases.alias_name.connectedfieldset, signalBooleanTrue if alias_name is connected
$temp.aliases.alias_name.epochfieldset, signalNumberTimestamp of temperature sensor alias_name reading
$temp.sensorlist._n.idfieldset, signalStringID of nth temperature sensor
$temp.sensorlist._n.valuefieldset, signalNumberTemperature value in °C
$temp.sensorlist._n.connectedfieldset, signalBooleanTrue if nth sensor is connected
$temp.sensorlist._n.epochfieldset, signalNumberTimestamp of nth temperature sensor reading
add temperaturesensor _alias_name idactionadd temperature sensor
remove temperaturesensor _alias_nameactionremove temperature sensor by alias_name
remove temperaturesensor _idactionremove temperature sensor by id
remove temperature_sensorsaction🛑 remove all temperature sensors defined
get temperaturesensor _alias_nameactionget temperature sensor by alias_name
get temperaturesensor _idactionget temperature sensor by id
get temperature_sensorsactionget list of temperature sensors defined
get temperatureactionget last temperature

tpms (ecu)

TPMS information from the engine control unit.

propertyUsetypedescription
$ecufieldsetObjectjson appends all valid ecu data including tpms data
$tpmsfieldsetObjectjson appends all the tpms fields according to each alert reported
$ecufieldsetStringtaip compatible fieldset
$ecu.idfieldset, signalMultipleid refers to the specific pgn + start_position
$ecu.param_namefieldset, signalMultipleparam_name refers to the parameters listed in the SDK ECU.d directory files
$ecu.$tires.axleindex__X.tire_Y.pressurefieldset, signalNumberPressure in kPa for a specific tire where X refers to the axle index (starts at 0), and Y refers to the tire index
$ecu.$tires.axleX_.tireY_.pressurefieldset, signalNumberPressure in kPa for a specific tire where X refers to the axle index (starts at 1), and Y refers to the tire index
$ecu.$tires.axleindex__X.tire_Y.temperaturefieldset, signalNumberTemperature in °C for a specific tire where X refers to the axle index (starts at 0), and Y refers to the tire index
$ecu.$tires.axleX_.tireY_.temperaturefieldset, signalNumberTemperature in °C for a specific tire where X refers to the axle index (starts at 1), and Y refers to the tire index
@tpms.alarm_oksignalBooleanTrue when there's no tpms alerts/alarms detected
@tpms.sensor_mutesignalBooleanTrue when any tire reports a missing signal
@tpms.sensor_defectivesignalBooleanTrue if any tire reports a defective sensor
@tpms.tire_leaksignalBooleanTrue if any tire reports a tire leak
@tpms.temperature_warningsignalBooleanTrue if a tire reports a temperature warning
@tpms.over_inflation_criticalsignalBooleanTrue if a tire reports a critical over inflation
@tpms.over_inflation_warningsignalBooleanTrue if a tire reports a warning over inflation
@tpms.under_inflation_criticalsignalBooleanTrue if a tire reports a critical under inflation
@tpms.under_inflation_warningsignalBooleanTrue if a tire reports a warning under inflation

tracking_resolution

Tracking resolution information

propertyusetypedescription
@tracking_resolution.NAME.distancesignalBooleanDistance is met
@tracking_resolution.NAME.headingsignalBooleanHeading is met
@tracking_resolution.NAME.timesignalBooleanTime is met
@tracking_resolution.NAME.signalsignalBooleanAny criteria is met
set tracking_resolution NAME degrees time distance pacc,nacc actionModify a tracking resolution

variables

Variables related information

propertyusetypedescription
$variablesfieldsetObjectjson appends all valid ecu data including tpms data
$variables.namefieldset, signalNumber or StringContents of the variable name
set variable name VALUEactionSet variable name to a VALUE
set variable name incrementactionIncrements the variable value by 1
set variable name decrementactionDecreases the variable value by 1
set variable name resetactionSet the variable value to 0

video

Video related information, more info

propertyusetypedescription
start recordingactionStarts a video recording
stop recordingactionStops a video recording
create videoactionCreates a video clip

flow

propertyusetypedescription
@flow_meter.signalsignalTriggered when any flow meter event arrives
$flow_meter.statestateConectConnectionion state [connecteddisconnected]
$flow_meter.display_statestateShow display state
$flow_meter.flowstateFlow rate [liters/minute]
$flow_meter.pwr_disconnectionsstateNumber of power lost
$flow_meter.sensor_disconnectionstateNumber of disconnections
$flow_meter.calibrationstateCalibration pattern, value in cm3/pulse * 100
$flow_meter.liters_dispatchedstateTotal liters * 100
$flow_meter.cumulative_litersstateCumulative liters * 10
$flow_meter.timestampstateLast reading epoch