Syruslang signals, actions and fieldset list
Documentation page for the Syrus IoT Telematics Gateway
adas (serial) for MDAS9
Signals used for adas in serial mode.
| Property | Use | Type | Description |
|---|---|---|---|
$adas.connected | Signal | Boolean | Connected state boolean [true,false] |
$adas.state | Signal | String | Connected state string [connected,disconnected] |
$adas.event | Signal | String | Event arrived as shown in signals [left_turn, ...] |
$adas.event_state | Signal | String | Event state [ready, recognized] |
$adas.speed | Signal | Number | Speed [km/h] |
$adas.rpm | Signal | Number | Motor revolutions per minute [rpm] |
$adas.left_distance | Signal | Number | Distance to objects on the left [cm] |
$adas.right_distance | Signal | Number | Distance to objects on the right [cm] |
$adas.time_to_collision | Signal | Number | Time to front collision [s] |
$adas.record | Signal | String | Recording state [on_with_audio, on_without_audio, disabled] |
$adas.ahead_distance | Signal | Number | Distance of object ahead |
$adas.ahead_speed | Signal | Number | Speed of object ahead |
$adas.slr_recognize | Signal | Number | Speed limit recognized |
$adas.slr_sensitivity | Signal | Number | Speed limit recognition sensitivity |
@adas.event | Signal | Boolean | Triggered when any ADAS event arrives |
@adas.left_lane_departure_warning | Signal | Boolean | Triggered when the vehicle passes the left lane |
@adas.right_lane_departure_warning | Signal | Boolean | Triggered when the vehicle passes the right lane |
@adas.safety_distance_alert | Signal | Boolean | Triggered when vehicle breaks the safety distance |
@adas.front_vehicle_start_alarm | Signal | Boolean | Triggered when the front vehicle starts to move |
@adas.front_proximity_warning | Signal | Boolean | Triggered when the vehicle slowly approaches to front car |
@adas.forward_collision_warning | Signal | Boolean | Triggered when the vehicle is close to a front collision |
@adas.pedestrian_collision_warning | Signal | Boolean | Triggered when a pedestrian is detected |
@adas.left_turn | Signal | Boolean | Triggered on left turn |
@adas.right_turn | Signal | Boolean | Triggered on right turn |
@adas.brake | Signal | Boolean | Triggered when brakes are pressed |
@adas.speed_limit_recognition | Signal | Boolean | Triggered when a recognized speed limit is exceeded |
@adas.camera_blocked | Signal | Boolean | Triggered when the camera is blocked |
@adas.low_visibility | Signal | Boolean | Triggered when low visibility is detected |
accelerometer
Accelerometer related information
| property | use | type | description |
|---|---|---|---|
$accelerometer | fieldset | Object | json appends all accelerometer fields |
$accelerometer | fieldset | String | taip compatible field |
@accelerometer.backward_collision.signal | signal | Boolean | True when detected |
@accelerometer.cornering_left.signal | signal | Boolean | True when detected |
@accelerometer.cornering_right.signal | signal | Boolean | True when detected |
@accelerometer.forward_collision.signal | signal | Boolean | True when detected |
@accelerometer.hard_braking.signal | signal | Boolean | True when detected |
@accelerometer.harsh_fwd_acceleration.signal | signal | Boolean | True when detected |
@accelerometer.lat_collision_from_left.signal | signal | Boolean | True when detected |
@accelerometer.lat_collision_from_right.signal | signal | Boolean | True when detected |
@accelerometer.motion.signal | signal | Boolean | True when detected |
$accelerometer.backward_collision.time | fieldset | String | Time of event |
$accelerometer.backward_collision.value | fieldset, signal | Number | Acceleration force in milli-g |
$accelerometer.cornering_left.time | fieldset | String | Time of event |
$accelerometer.cornering_left.value | fieldset, signal | Number | Acceleration force in milli-g |
$accelerometer.cornering_right.time | fieldset | String | Time of event |
$accelerometer.cornering_right.value | fieldset, signal | Number | Acceleration force in milli-g |
$accelerometer.forward_collision.time | fieldset | String | Time of event |
$accelerometer.forward_collision.value | fieldset, signal | Number | Acceleration force in milli-g |
$accelerometer.hard_braking.time | fieldset | String | Time of event |
$accelerometer.hard_braking.value | fieldset, signal | Number | Acceleration force in milli-g |
$accelerometer.harsh_fwd_acceleration.time | fieldset | String | Time of event |
$accelerometer.harsh_fwd_acceleration.value | fieldset, signal | Number | Acceleration force in milli-g |
$accelerometer.lat_collision_from_left.time | fieldset | String | Time of event |
$accelerometer.lat_collision_from_left.value | fieldset, signal | Number | Acceleration force in milli-g |
$accelerometer.lat_collision_from_right.time | fieldset | String | Time of event |
$accelerometer.lat_collision_from_right.value | fieldset, signal | Number | Acceleration force in milli-g |
$accelerometer.motion | fieldset, signal | Boolean | Appends the motion state |
$accelerometer.time | fieldset, signal | Boolean | Time of motion event |
$accelerometer.value | fieldset, signal | Number | Acceleration force in milli-g |
$accelerometer.value | state | Show the last value of accelerometer in mill | |
set accelerometer self_alignment | action | Executes the self alignment |
actions
Actions related info.
| property | use | description |
|---|---|---|
| trigger action_action_name_ | action | Force the execution of an action |
adas (ecu)
ADAS accessory related info, configured via the ecu monitor.
| property | use | type | description |
|---|---|---|---|
$ecu.adas_speed | signal | Number | Speed detected by adas accessory in km/h |
$ecu.brakes_enabled | signal | Boolean | True if brakes detected |
$ecu.distance_from_front_vehicle | signal | Number | Distance from front vehicle in meters |
$ecu.failsafe | signal | Boolean | True if adas triggers one of the internal FailSafe modes, more info |
$ecu.forward_collision_warning | signal | Boolean | True if forward collision warning detected |
$ecu.headway_measurement | signal | Number | Headway measurement. Unit 0.1s. Range (0 - 9.9s) |
$ecu.headway_valid | signal | Boolean | True when CIPV (close in path vehicle) is detected |
$ecu.headway_warning_level | signal | Number | Headway warning level, more info |
$ecu.headway_warning_repeatable_enabled | signal | Boolean | True when Headway Warning repeatable feature is ON |
$ecu.high_beam_signal | signal | Boolean | True if high beam signal detected |
$ecu.lane_departure_warning_disabled | signal | Boolean | True if lane departure warning is disabled |
$ecu.left_lane_departure_warning | signal | Boolean | True if left lane departure warning detected |
$ecu.left_signal | signal | Boolean | True if left signal is detected |
$ecu.low_beam_signal | signal | Boolean | True if low beam signal detected |
$ecu.maintenance | signal | Boolean | True if adas accessory is maintenance mode |
$ecu.pedestrian_danger_zone | signal | Boolean | True if pedestrian in danger zone is detected |
$ecu.pedestrian_forward_collision_warning | signal | Boolean | True if pedestrian forward collision warning is detected |
$ecu.relative_speed_from_front_vehicle | signal | Boolean | True if relative speed from front vehicle is detected |
$ecu.right_lane_departure_warning | signal | Boolean | True if right lane departure warning is detected |
$ecu.right_signal | signal | Boolean | True if right signal is detected |
$ecu.sound_type | signal | Number | Sound type, more info |
$ecu.speed_available | signal | Boolean | True if speed is available |
$ecu.speed_limit_recognition_sensitivity | signal | Number | Speed limit recognition sensitivity |
$ecu.speed_limit_recognition_state | signal | Number | Speed limit recognition state |
$ecu.speed_limit_recognition_value | signal | Number | Speed limit recognition value |
$ecu.tamper_alert | signal | Boolean | True if a tamper alert is detected (fired when camera is blocked) |
$ecu.time_indicator | signal | Number | Time indicator, more info |
$ecu.traffic_signs_recognition_enabled | signal | Boolean | True when traffic signal recognition feature is on |
$ecu.traffic_signs_recognition_warning_level | signal | Number | Traffic signs recognition warning level, more info |
$ecu.wipers_signal | signal | Boolean | True when a wiper passes the windshield, 0 if wipers are static |
$ecu.zero_speed | signal | Boolean | True if zero speed is detected (vehicle is stopped) |
blackbox
Blackbox functionality allows you to save data to a file.
| property | use | description |
|---|---|---|
@logs.event | signal | Triggered when any log event is detected. |
$logs.name | signal fieldset | Stores log rotation name for apx-logrotate |
$logs.path | signal fieldset | Stores log file path |
$logs.used | signal fieldset | Stores media used memory |
$logs.available | signal fieldset | Stores media available memory |
$logs.size | signal fieldset | Stores media total size |
$logs.percentage | signal fieldset | Stores media memory usage in percentage |
$logs.period | signal fieldset | Stores the rotation period configuration (daily, weekly, monthly) |
$logs.rotate | signal fieldset | Stores the total log files stored before rotation (ex. 5 days) |
battery
Device internal battery information.
| property | use | type | description |
|---|---|---|---|
$battery | fieldset | Object | json appends all battery fields |
$battery | fieldset | String | taip compatible field |
$battery.connected | fieldset,signal | Boolean | Internal battery state |
@battery.connected | signal | Boolean | True when the battery is connected |
@battery.disconnected | signal | Boolean | True when the battery is disconnected |
@battery.critical | signal | Number | Battery <= 10% |
@battery.low | signal | Number | Battery <= 20% |
@battery.full | signal | Number | Battery = 100% |
$battery.mv | fieldset,signal | Number | Internal battery voltage in milliVolts |
$battery.level | fieldset,signal | Number | Internal battery level (%) |
$battery.voltage | fieldset,signal | Number | Internal battery voltage |
bluetooth
Bluetooth functionality. To speak via the bluetooth check out the modem speak action.
| property | use | description |
|---|---|---|
| bluetooth connect 'AABBCCDDEEFF' | action | Connect to bluetooth device |
| bluetooth disconnect 'AABBCCDDEEFF' | action | Disconnect from bluetooth device |
| bluetooth pair 'AABBCCDDEEFF' | action | Pair to a bluetooth device |
| bluetooth pair_forced 'AABBCCDDEEFF' | action | Force pairing |
| bluetooth reset 'AABBCCDDEEFF' | action | 🛑 Resets bluetooth paired devices |
| bluetooth restart 'AABBCCDDEEFF' | action | Restart bluetooth |
| bluetooth scan_seconds_ | action | Replace with amount of seconds |
| bluetooth switch_audio 'AABBCCDDEEFF' | action | Switch main audio |
| bluetooth unpair 'AABBCCDDEEFF' | action | Unpair from bluetooth device |
@bluetooth.button.call_2x | signal | Bluetooth call button pressed 2 times |
@bluetooth.button.volume_up | signal | Bluetooth volume up |
@bluetooth.button.volume_down | signal | Bluetooth volume down |
@bluetooth.button.mute | signal | Bluetooth mute button pressed |
bluetooth sensor (ble)
Bluetooth low energy that can communicate with sensors and tags.
| property | use | type | description | |
|---|---|---|---|---|
@ble.event | signal | Triggered at any ble event | ||
@ble.(MAC or ALIAS).temperature.change | signal | Triggered when a change in temperature is detected | ||
@ble.(MAC or ALIAS).mac | fieldset, signal | String | Device mac address | |
@ble.(MAC or ALIAS).name | fieldset, signal | String | Advertised name | |
@ble.(MAC or ALIAS).alias | fieldset, signal | String | Assigned alias | |
@ble.(MAC or ALIAS).timestamp | fieldset, signal | Number | Scanned time | |
@ble.(MAC or ALIAS).temperature | fieldset, signal | Number | Reported temperature value in degrees celsius | |
@ble.(MAC or ALIAS).humidity | fieldset, signal | Number | Reported humidity value in percentage | |
@ble.(MAC or ALIAS).movement | fieldset, signal | Number | Reported number of movements detected | |
$ble.(MAC or ALIAS).rpm | state | String | The rpm value [revolutions per minute] | |
@ble.(MAC or ALIAS).battery | state | String | The battery value [%] | |
$ble | fieldset | Object | Json appends all battery fields ($ble.BlazonDRS.rpm,$ble.BlazonDRS.temperature,$ble.BlazonDRS.battery) | |
$ble.ALIAS.degree_x | state | Number | Degrees of inclination in plane X [-90 | +90] |
$ble.ALIAS.degree_y | state | Number | Degrees of inclination in plane Y [-90 | +90] |
$ble.ALIAS.battery | state | Number | Battery percentage [%] | |
$ble.ALIAS.erpm | state | Number | The rpm value [revolutions per minute] | |
$ble.ALIAS.voltage | state | Number | The vehicle battery voltage [mV] | |
$ble.ALIAS.temperature | state | Number | The temperature value [°C] |
counters
Device counters information.
| property | use | type | description |
|---|---|---|---|
$counters | fieldset | Object | json appends all counter fields |
| $counters.name.odometer | fieldset, signal | Number | Total distance traveled with ignition ON (meters) |
| $counters.name.ignition_time | fieldset, signal | Number | Total ignition time (seconds) |
| $counters.name.idle_time | fieldset, signal | Number | Total time spent in idling (seconds) |
| $counters.name.over_speed | fieldset, signal | Number | Total time spent over speed (seconds) |
| $counters.name.over_rpm | fieldset, signal | Number | Total time spent over RPMs (seconds) |
| $counters.name.hard_brakes | fieldset, signal | Number | Total amount of hard brake events (count) |
| $counters.name.harsh_fwd_acceleration | fieldset, signal | Number | Total amount of harsh forward acceleration events (count) |
| $counters.name.total_count | fieldset, signal | Number | Stores number of times a signal becomes true |
| $counters.name.total_time | fieldset, signal | Number | Stores the total time a signal stays true, stops counting when false |
| $counters.name.time_increment | fieldset, signal | Number | Stores the time passed while a signal is true, reset count when false |
| $counters.name.total_distance | fieldset, signal | Number | Stores the total distance traveled while a signal is true, stops counting when false |
| $counters.name.distance_increment | fieldset, signal | Number | Stores the distance traveled while a signal is true, reset count when false |
| $counters.name.state | fieldset, signal | Number | Stores the counter state (true when counting) |
| define counters_name_ | action | Create a counter definition | |
| start counters_name_ | action | Start/enable the counting function and listen for change in the selected signals | |
| stop counters_name_ | action | Stop/disable the counting function, any change in the signals will be ignored | |
| reset counters_name_ | action | Reset/restart the states values, like total_count, total_time, etc. | |
| get counters_name_ | action | Get a counter definition | |
| set counters_name_ field=value | action | Set counter threshold |
destinations
Destinations related actions.
| property | use | description |
|---|---|---|
| enable destination_destination_name_ | action | Enable the destination |
| disable destination_destination_name_ | action | Disable the destination |
ecu
Engine Control Unit related information. For more info visit: Engine Control Unit (ECU).
| property | Use | type | description | |
|---|---|---|---|---|
$ecu | fieldset | Object | json appends all valid ecu parameters | |
$ecu | fieldset | String | taip compatible fieldset | |
| $ecu.id | fieldset, signal | Multiple | id refers to the specific pgn + start_position | |
| $ecu.param_name | fieldset, signal | Multiple | param_name refers to the parameters listed in the SDK ECU.d directory files | |
| $ecu.error_codes.spn | fieldset, signal | Number | ECU diagnostic trouble code SPN number. More info | |
| $ecu.error_codes.fmi | fieldset, signal | Number | ECU diagnostic trouble code FMI number. More info | |
@ecu_warning.disconnected | signal | Boolean | True when disconnected ecu warning is detected (CAN1 and CAN2) | |
@ecu_warning.can1.disconnected | signal | Boolean | True when disconnected ecu warning is detected (CAN1) | |
@ecu.ignition_on | signal | Boolean | Triggers when ecu detected / Ignition on | |
@ecu.ignition_off | signal | Boolean | Triggers when ecu not detected / Ignition off (Max 20 sec without data) | |
$ecu.ignition | state | Boolean | State of the ecu ignition | |
$ecu.ignition_detection | state | Boolean | True when ecu ignition detection |
events
Events related actions.
| property | use | description |
|---|---|---|
| send event_event_name_ | action | Generate an event to the defined destinations |
| fire signal_signal_name_ | action | Simulate a signal |
| event_name | signal | An 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.
| property | use | type | description |
|---|---|---|---|
$fatigue_sensor | fieldset | Object | Akmppends relevant fatigue_sensor information to the payload |
@serial.fatigue_sensor.SIGNAL | signal | Boolean | Serial fatigue sensor specific signals |
@fatigue_sensor.fatigue_remind | signal | Boolean | True when a fatigue reminder was detected |
@fatigue_sensor.fatigue_warning | signal | Boolean | True when yawning or a fatigue warning was detected |
@fatigue_sensor.fatigue_alarm | signal | Boolean | True when drowsiness or fatigue alert was detected |
@fatigue_sensor.no_portrait | signal | Boolean | True when no driver is detected |
@fatigue_sensor.distraction | signal | Boolean | True when the driver is distracted |
@fatigue_sensor.phone | signal | Boolean | True when a driver is on their phone |
@fatigue_sensor.smoking | signal | Boolean | True when a driver is smoking |
@fatigue_sensor.seatbelt_off | signal | Boolean | True when a driver is driving without the seatbelt |
@fatigue_sensor.camera_blocked | signal | Boolean | True when the fatigue sensor's camera is blocked |
@fatigue_sensor.camera_fail | signal | Boolean | True when the MDSM7 fatigue sensor's camera fails. |
@fatigue_sensor.can_fail | signal | Boolean | True when the MDSM7 fatigue sensor's CAN fails. |
@fatigue_sensor.gps_fail | signal | Boolean | True when the MDSM7 fatigue sensor's GPS fails. |
@fatigue_sensor.photo | signal | Boolean | True when a photo was captured manually |
@fatigue_sensor.signal | signal | Boolean | True when any fatigue sensor event is triggered |
@fatigue_sensor.disconnected | signal | Boolean | Triggers when sensor disconnected |
$fatigue_sensor.connected | signal fieldset | Boolean | True if fatigue sensor is connected |
$fatigue_sensor.state | signal fieldset | String | "connected" or "disconnected" |
$fatigue_sensor.sensitivity | signal fieldset | Number | Sensitivity of the fatigue sensor |
$fatigue_sensor.speaker_volume | signal fieldset | Number | Volume of the fatigue sensor |
$fatigue_sensor.min_speed | signal fieldset | Number | Minimum speed to trigger fatigue sensor alerts |
$fatigue_sensor.speeding | signal fieldset | Number | Speeding threshold |
$fatigue_sensor.max_photos | signal fieldset | Number | Total number of photos that can be captured |
$fatigue_sensor.nbr_photos | signal fieldset | Number | Number of photos captured |
$fatigue_sensor.latest_photo | signal fieldset | Number | Latest photo |
$ecu.distraction | signal fieldset | Boolean | True when the driver is distracted |
$ecu.yawning | signal fieldset | Boolean | True if the driver is yawning |
$ecu.drowsiness | signal fieldset | Boolean | True when drowsiness was detected |
$ecu.phone | signal fieldset | Boolean | True if the driver is on their phone |
$ecu.smoking | signal fieldset | Boolean | True when smoking was detected by the driver |
$ecu.driver_absence | signal fieldset | Boolean | True when there's no driver present |
$ecu.camera_blocked | signal fieldset | Boolean | True if the camera is blocked |
$ecu.camera_error | signal fieldset | Boolean | True when a camera error was detected |
$ecu.zero_speed | signal fieldset | Boolean | True when the vehicle is parked |
$ecu.error_valid | signal fieldset | Boolean | True when an error was detected by the fatigue sensor |
$ecu.tamper_alert | signal fieldset | Boolean | True if tampering is detected by the fatigue sensor |
capture fatigue_sensor photo | action | Captures a photo with the fatigue sensor camera | |
upload fatigue_sensor photos | action | Manually upload all photos to an ftp destination | |
set fatigue_sensor sensitivity | action | Change sensitivity (Range: 2-11) | |
set fatigue_sensor speaker_volume | action | Change the speaker volume (Range: 0-2) | |
set fatigue_sensor minimum_speed | action | Change the minimum speed to trigger fatigue alerts (Range: 10-60)kph | |
set fatigue_sensor speeding_alarm | action | Change the speeding alarm (Range: 0-255)kph | |
set fatigue_sensor buffer_size | action | Change the max photos that can be captured (Range: 10-100) | |
set fatigue_sensor autoupload | action | Manage the auto upload of photos to the DCT ftp directory, default is 0 | |
clear fatigue_sensor buffer | action | Deletes all photos in the fatigue_sensor directory | |
@fatigue_sensor.driver_identified | signal | Boolean | True if a new driver is identified |
@fatigue_sensor.driver_changed | signal | Boolean | True if a driver is changed |
@fatigue_sensor.unknown_driver | signal | Boolean | True if a driver is unknown |
@fatigue_sensor.driver_missing | signal | Boolean | True if there is no driver |
@fatigue_sensor.ignition_on | signal | Boolean | True if the ignition is on |
@fatigue_sensor.ignition_off | signal | Boolean | True if the ignition is off |
@fatigue_sensor.tamper_alert | signal | Boolean |
flowmeter
| property | use | type | description |
|---|---|---|---|
$flow_meter | fieldset | adds TAIP or JSON fields to the event messages | |
@flow_meter.signal | signal | Triggered when any flow meter event arrives | |
$flow_meter.state | state | 0 if display is off, 1 if display is on | |
$flow_meter.display_state | state | Show display state | |
$flow_meter.flow | state | Flow rate [liters/minute] | |
$flow_meter.pwr_disconnections | state | Number of power lost | |
$flow_meter.sensor_disconnection | state | Number of disconnections | |
$flow_meter.calibration | state | Calibration pattern, value in cm3/pulse * 100 | |
$flow_meter.liters_dispatched | state | Total liters * 100 | |
$flow_meter.cumulative_liters | state | Cumulative liters * 10 | |
$flow_meter.timestamp | state | Last reading epoch |
fuel sensor (Technoton)
Fuel sensor related information
| property | use | type | description |
|---|---|---|---|
$fuel | fieldset | String | json and taip compatible fieldset. Appends all fuel sensor fields or ;FF tag for TAIP |
@fuel.event | signal | Boolean | Triggered when any fuel event is detected |
@fuel.state | signal | Boolean | Triggered when a state arrives |
@fuel.fueling | signal | Boolean | Triggered when a fueling notification arrives |
@fuel.warning | signal | Boolean | Triggered when a discharge warning notification arrives |
@fuel.connected | signal | Boolean | Triggered when a transition from disconnected to connected is detected |
@fuel.disconnected | signal | Boolean | Triggered when a transition from connected to disconnected is detected |
$fuel.connected | fieldset, signal | Boolean | Stores the last connected state |
$fuel.level | fieldset, signal | Number | Stores the last fuel level (value is in deci-liters) |
$fuel.temperature | fieldset, signal | Number | Stores the last temperature level |
$fuel.frequency | fieldset, signal | Number | Stores the last frequency |
$fuel.timestamp | fieldset, signal | Number | Stores the last notification timestamp |
$fuel.event | fieldset, signal | String | Stores the last event |
$fuel.alias.connected | state | Boolean | Stores the last connected state of tank named alias |
$fuel.alias.level | state | Number | Stores the last fuel level of tank named alias |
$fuel.alias.temperature | state | Number | Stores the last temperature level of tank named alias |
$fuel.alias.frequency | state | Number | Stores the last frequency of tank named alias |
$fuel.alias.timestamp | state | Number | Stores the last notification timestamp of tank named alias |
$fuel.alias.event | state | String | Stores the last event of tank named alias |
@fuel.alias.state | signal | Boolean | Triggered when any fuel signal is detected |
@fuel.alias.fueling | signal | Boolean | Triggered when a state arrives |
@fuel.alias.warning | signal | Boolean | Triggered when a discharge warning notification arrives |
@fuel.alias.fueling | signal | Boolean | Triggered when a fueling notification arrives |
@fuel.alias.connected | signal | Boolean | Triggered when a transition from disconnected to connected is detected |
@fuel.alias.disconnected | signal | Boolean | Triggered when a transition from connected to disconnected is detected |
geofence
Geofences related information
property | use | type | description |
|---|---|---|---|
| fieldset, signal | Boolean | Inside <name> |
| fieldset, signal | Number | Time when device entered <name> |
| signal | Boolean | Inside any fence in <group_name> |
| fieldset | String | Last geofence name |
| fieldset | String | inside, outside |
| fieldset | Number | Time of last geofence |
| signal | Speed limit in the geofence | |
| signal | Triggers when vehicle exceeds the speed limit inside any geofence in the GROUP_NAME group | |
| signal | Triggers when vehicle exceeds the speed limit inside any geofence with limit named SPEED_ALIAS | |
| signal | Triggers when vehicle exceeds the speed limit inside any geofence named GEONAME | |
| signal | Triggers when vehicle exceeds any speed limit | |
| state | Boolean | Speed in geofence warning [true or false] |
| state | Timestamp of speeding event in seconds | |
| state | Type of warning [speeding] | |
| state | Current state [in_progress, finished_by_speed ,finished_by_geofence, finished_by_gps] | |
| state | Namespace of geofence definitions | |
| state | Geofence group | |
| state | Defined name of geofence | |
| state | Elapsed time speeding inside the geofence | |
| state | Elapsed distance speeding inside the geofence | |
| state | Defined Alias for the speed limit | |
| state | Defined minimum degree heading | |
| state | Defined maximum degree heading | |
| state | Defined speed threshold | |
| state | Speed at start of speed limit | |
| state | Heading at start of speed limit | |
| state | Longitude coordinate at start of speed limit | |
| state | Latitude coordinate at start of speed limit | |
| state | Finishing speed [m/s] | |
| state | Finishing heading [degrees] | |
| state | Finishing longitude | |
| state | Finishing latitude | |
| state | Maximum speed inside reached | |
| state | Heading at the maximum speed | |
| state | Longitude coordinate at maximum speed | |
| state | Latitude coordinate at maximum speed |
gnss
GNSS position information
Property | Use | Type | Description | Since |
|---|---|---|---|---|
| fieldset | Object | json appends all gnss fields | |
| fieldset | String | taip compatible fieldset | |
| fieldset, signal | Number | Position accuracy in meters | |
| fieldset, signal | String | Triggered whenever an acceleration event by the GNSS is detected, (this is defined in the tracking_resolution) | |
| fieldset, signal | String |
| |
| fieldset, signal | Number | Acceleration value (can be positive or negative) in km/h/s (kilometer per hour per second), (this is defined in the tracking_resolution) | |
| fieldset, signal | Number | Acceleration value (can be positive or negative) in m/h/s (miles per hour per second) | |
| fieldset, signal | Number | Altitude AMSL | |
| fieldset, signal | Number | Altitude accuracy | |
| fieldset, signal | Number | Relative bearing to a base station | |
| fieldset, signal | String | GNSS criteria | |
| fieldset, signal | Number |
| |
| fieldset, signal | Number | Horizontal DOP | |
| fieldset, signal | Number | Heading 0°N, 90°E, ... | |
| fieldset, signal | Number | Speed in kph (float) | |
| fieldset, signal | Number | WGS84 Latitude | |
| fieldset, signal | Number | WGS84 Longitude | |
| fieldset, signal | Number | Speed in mph (float) | |
| fieldset, signal | Number | Position DOP | |
| fieldset, signal | Number | Satellites used | |
| fieldset, signal | Number | Speed value in m/s (float) | |
| fieldset, signal | Number | Epoch gps timestamp | |
| fieldset, signal | Number | Vertical DOP | |
| signal | String | Current elevation defined with uphill, downhill, constant | SyrusJS 2.3.1 |
| fieldset, signal | Number | Speed in kph (integer) | |
| fieldset, signal | Number | Speed in mph (integer) | |
| fieldset, signal | Number | Speed value in m/s (integer) | |
| fieldset | String | dddd, MMMM D, YYYY h:hh A format | |
| fieldset | String | dddd, D de MMMM de YYYY HH:hh format | |
| fieldset | String | dddd D MMMM YYYY HH:hh format | |
| fieldset | String | dddd, D de MMMM de YYYY HH:hh format | |
| action | Executes a gps hot start | ||
| action | Executes a gps warm start | ||
| action | Executes a gps cold start |
ibutton
IButton component, note that a total of 500 onewire devices can be created (between ibutton and temperature sensors)
| property | Use | type | description |
|---|---|---|---|
$ibutton | fieldset | Object | json appends all ibutton fields |
IB:$ibutton.connected.id | fieldset | String | taip connected ibutton id |
IS:$ibutton.last.id | fieldset | String | taip last connected ibutton id |
$ibutton.authorized.connected.alias | fieldset, signal | String | Alias of authorized ibutton |
$ibutton.authorized.connected.connected | fieldset, signal | Boolean | Authorized ibutton connected |
$ibutton.authorized.connected.id | fieldset, signal | String | ID of the authorized ibutton |
$ibutton.authorized.connected.conn_epoch | fieldset, signal | Number | Epoch of when it was connected |
$ibutton.authorized.last.alias | fieldset, signal | String | Alias of last authorized ibutton |
$ibutton.authorized.last.id | fieldset, signal | String | Current ID of the last authorized ibutton |
$ibutton.authorized.last.conn_epoch | fieldset, signal | Number | Epoch of last authorized ibutton connection |
$ibutton.authorized.last.disc_epoch | fieldset, signal | Number | Epoch of last authorized ibutton disconnection |
$ibutton.connected.alias | fieldset, signal | String | Alias of connected ibutton |
$ibutton.connected.connected | fieldset, signal | Boolean | True if any ibutton is currently detected |
$ibutton.connected.id | fieldset, signal | String | ID of the connected ibutton |
$ibutton.connected.whitelisted | fieldset, signal | Boolean | True while the ibutton connected is authorized |
$ibutton.connected.conn_epoch | fieldset, signal | Number | Epoch of ibutton connection |
$ibutton.last.alias | fieldset, signal | String | Alias of last connected ibutton |
$ibutton.last.connected | fieldset, signal | Boolean | True if ibutton is connected |
$ibutton.last.id | fieldset, signal | String | ID of last connected ibutton |
$ibutton.last.whitelisted | fieldset, signal | Boolean | True if last ibutton is authorized |
$ibutton.last.conn_epoch | fieldset, signal | Number | Epoch of last ibutton connection |
$ibutton.last.disc_epoch | fieldset, signal | Number | Epoch of last ibutton disconnection |
| add ibutton_alias_name_ id | action | add ibutton to authorized list | |
| remove ibutton_alias_name_ | action | remove ibutton from authorized list by alias_name | |
| remove ibutton_id_ | action | remove ibutton from authorized list by id | |
| remove ibuttons | action | 🛑 remove all ibuttons from authorized list | |
| clear ibutton | action | clears the last ibutton read | |
| get ibutton_alias_name_ | action | get ibutton by alias_name | |
| get ibutton_id_ | action | get ibutton by id | |
| get ibuttons | action | get 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.
| property | use | type | description |
|---|---|---|---|
@imu.event | signal | Boolean | Triggered when any accelerometer event arrives |
@imu.periodic | signal | Boolean | Triggered when a specific event arrives |
$imu.motion | state | Boolean | Movement of the vehicle detected |
$imu.value | state | Number | Magnitude of movement RMS |
$imu.event | state | String | The detected ever [hard_braking , periodic ,...] |
$imu.x | state | Number | X-axis raw acceleration value |
$imu.y | state | Number | Y-axis raw acceleration value |
$imu.z | state | Number | Z-axis raw acceleration value |
$imu | fieldset | String | json appends all imu fields |
io
Inputs/Outputs component
| property | Use | type | description |
|---|---|---|---|
$io | fieldset | Object | json appends all io fields |
$io | fieldset | String | taip compatible fieldset |
$ad | fieldset | Number | taip compatible fieldset |
$io.an1 | fieldset, signal | Number | Analog input channel 1 (range: 0-28000mV) |
$io.an2 | fieldset, signal | Number | Analog input channel 2 (range: 0-28000mV) |
$io.dan | fieldset, signal | Number | Differential analog values (range: 0-10000mV) |
$io.ign | fieldset, signal | Boolean | True when the state of the ignition is ON |
$io.in1 | fieldset, signal | Boolean | True when input 1 is ON |
$io.in2 | fieldset, signal | Boolean | True when input 2 is ON |
$io.in3 | fieldset, signal | Boolean | True when input 3 is ON |
$io.in4 | fieldset, signal | Boolean | True when input 4 is ON |
$io.in5 | fieldset, signal | Boolean | True when input 5 is ON |
$io.in6 | fieldset, signal | Boolean | True when input 6 is ON |
$io.in7 | fieldset, signal | Boolean | True when input 7 is ON |
$io.out1 | fieldset, signal | Boolean | True when output 1 is ON |
$io.out2 | fieldset, signal | Boolean | True when output 2 is ON |
$io.out3 | fieldset, signal | Boolean | True when output 3 is ON |
$io.out4 | fieldset, signal | Boolean | True when output 4 is ON |
$io.pwr | fieldset, signal | Boolean | True when external power is ON |
$io.so1 | fieldset, signal | Boolean | True when a short circuit on output 1 is detected |
$io.so2 | fieldset, signal | Boolean | True when a short circuit on output 2 is detected |
$io.so3 | fieldset, signal | Boolean | True when a short circuit on output 3 is detected |
$io.so4 | fieldset, signal | Boolean | True when a short circuit on output 4 is detected |
$io.tig | fieldset, signal | Boolean | True when ignition detected from power |
$safe_immo | variable, signal | Boolean | True when Pegasus sends safe immobilization (SECO) command to device (more information here) |
| set out# on | action | activate output # | |
| set out# off | action | deactivate output # |
io pulse counter
| property | use | type | description |
|---|---|---|---|
@pulse.event | signal | Boolean | Triggered when any pulse event arrives |
$pulse.count | state | Number | The pulse count |
$pulse.value | state | Number | The pulse value |
$pulse | fieldset | Object | Fieldset key name |
io expander
IO Expander for extended inputs and outputs
| property | use | type | description |
|---|---|---|---|
@iox.event | signal | Boolean | Triggered when any IO Expander event arrives |
@iox.connected | signal | Boolean | Triggered when an IO expander is connected |
$iox.state | state | String | State of IO Expander [connected or disconnected] |
$iox.connected | state | Boolean | State of connected |
$iox.id | state | String | Onewire identification [1b0000160f183929] |
$iox.alias | state | String | Assigned alias string [iosexpander] |
$iox.epoch | state | Number | Last connected state epoch [1710169042] |
$iox.in1 - $iox.in4 | state | Boolean | Input state |
$iox.out1 - $iox.out4 | state | Boolean | Output state |
$iox | fieldset | Fieldset key name |
mdt/serial
RS-232 Mobile Data Terminal info
| property | use | type | description | ||
|---|---|---|---|---|---|
$mdt | fieldset | Object | json appends mdt information | ||
$mdt.message | fieldset | String | taip appends MDT message information to taip string (ascii or hex) | ||
@mdt.message | signal | String | True whenever an incoming message is received via MDT mode | ||
@serial.event | signal | Boolean | Triggered when any data arrives to serial port | ||
@serial.message | signal | Boolean | Triggered when a message arrives in console mode | ||
$serial.mode | signal state | String | The serial mode [ mdt | modem | console ] |
$serial.message | signal state | String | The last arrived console message in string | ||
set mdt | action | Set MDT settings | |||
send mdt message | action | Send MDT message |
modem
Modem information.
property | use | type | description |
|---|---|---|---|
| fieldset | Object | json appends all modem fields |
| fieldset | String | taip compatible fieldset (includes ;SC tag) |
| signal | Boolean | Triggered when a voice call starts |
| signal | Boolean | Triggered when a voice call ends |
| fieldset, signal | String | LTE band |
| fieldset, signal | String | Cell ID in hex format |
| fieldset, signal | String | Embedded sim ID |
| fieldset, signal | String | Embedded sim IMSI |
| fieldset, signal | String | Embedded sim card state |
| fieldset, signal | Number | GPRS registration status |
| fieldset, signal | Number | GSM registration status:
|
| fieldset, signal | Number | Unique numeric identifier |
| fieldset, signal | String | IP address assigned by operator |
| signal | Boolean | Triggers when the modem is connected (with internet) [true] |
| signal | Boolean | Triggers when the modem is disconnected (without internet) [true] |
| state | Boolean | State of the modem connection (it has internet) [true|false] |
| signal | Boolean | Triggered when a jamming condition is detected |
| signal | Boolean | Triggered when the jamming condition persist for one minute |
| signal | Boolean | Triggered when jamming action stops |
| fieldset, signal | String | The jamming state |
| fieldset, signal | Boolean | The jamming state |
| fieldset, signal | Boolean | The persistence flag state |
| fieldset, signal | Boolean | The ended flag state |
| fieldset, signal | Number | Location area code |
| fieldset, signal | String | Modem's manufacturer |
| fieldset, signal | Number | Mobile Country and Network Code |
| fieldset, signal | String | Model of modem |
| fieldset, signal | String | State of the modem ("ON", "OFF") |
| fieldset, signal | String | Time 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. |
| fieldset, signal | String | Network operator |
| fieldset, signal | String | Radio Access Technology, depending on the device model it's one of the following strings: Syrus 4G LTE Syrus 4G Lite CATM1 Syrus 4G Lite CAT1 |
| fieldset, signal | String | Modem's revision |
| fieldset, signal | Number | Received Signal Strength Indicator (0-32) |
| fieldset, signal | Number | External sim ID |
| fieldset, signal | Number | External sim IMSI |
| fieldset, signal | Number | External sim State ("READY", "Not in Use") |
| signal | Triggered when sim inserted | |
| signal | Triggered when sim removed | |
| state | Boolean | True if the sim card is present. False if the sim is removed. |
| fieldset, signal | Number | Modem's temperature (generally higher than ambient temperature |
| fieldset, signal | String | The last calling number ["9999123456"] |
| fieldset, signal | Boolean | If there is a call in progress [true |false] |
| action | Set to true to enable airplane_mode | |
| action | Time interval in hours to wait to switch from external to internal sim card | |
| action | Start a phone call | |
| action | End a phone call | |
| action | Send an SMS message to 3013333333 | |
| action | Add phone +1234567890 to phonebook | |
| action | Remove phone +1234567890 from phonebook | |
| action | Enable call validation from phonebook | |
| action | Enable call validation from phonebook | |
| action | Speak via the bluetooth |
net_cell
Cellular interface
| property | use | type | description |
|---|---|---|---|
$net_cell.connected | fieldset, signal | Boolean | True when connected |
$net_cell.iccid | fieldset, signal | Number | SIM card ICCID |
$net_cell.imei | fieldset, signal | Number | Device unique IMEI number |
$net_cell.imsi | fieldset, signal | Number | SIM card IMSI |
$net_cell.ip_address | fieldset, signal | String | IP assigned by MNO |
$net_cell.mcc | fieldset, signal | Number | Mobile country code |
$net_cell.mnc | fieldset, signal | Number | Mobile network code |
$net_cell.operator | fieldset, signal | String | Network operator |
$net_cell.rx_bytes | fieldset, signal | Number | Bytes received |
$net_cell.tx_bytes | fieldset, signal | Number | Bytes transmitted |
net_eth
Ethernet interface
| property | use | type | description |
|---|---|---|---|
$net_eth.connected | fieldset, signal | Boolean | Ethernet connected |
$net_eth.ip_address | fieldset, signal | String | IP address |
$net_eth.rx_bytes | fieldset, signal | Number | Bytes received |
$net_eth.tx_bytes | fieldset, signal | Number | Bytes transmitted |
enable ethernet | action | Enables the ethernet interface | |
disable ethernet | action | Disables the ethernet interface |
net_wifi
Wifi interface
property | use | type | description |
|---|---|---|---|
| fieldset, signal | Boolean | WiFi connected |
| fieldset, signal | String | IP address |
| fieldset, signal | String | Key management protocol |
| fieldset, signal | String | WiFi MAC address |
| fieldset, signal | Number | Bytes received |
| fieldset, signal | Number | Signal strength in dbm |
| fieldset, signal | String | SSID name |
| fieldset, signal | String | Wifi connection
|
| fieldset, signal | Number | Bytes transmitted |
| action | Enables the wifi interface | |
| action | Disables the wifi interface | |
| action | Restarts the wifi interface |
net_wlan1 (hotspot)
Hotspot interface
| property | use | type | description |
|---|---|---|---|
$net_wlan1.connected | fieldset, signal | Boolean | Hotspot connected |
$net_wlan1.ip_address | fieldset, signal | String | IP address |
$net_wlan1.rx_bytes | fieldset, signal | Number | Bytes received |
$net_wlan1.tx_bytes | fieldset, signal | Number | Bytes transmitted |
enable hotspot | action | Enables the hotspot | |
disable hotspot | action | Disables the hotspot | |
@hotspot.started | signal | Boolean | Transient signal |
@hotspot.stopped | signal | Boolean | Transient signal |
$hotspot.active | state | Boolean | |
$hotspot.inactive | state | Boolean |
people_counting
People counting camera signals, actions, and recommended fieldsets.
| property | use | type | description |
|---|---|---|---|
@people.adult_enter | signal | Boolean | Adult entered |
@people.adult_exit | signal | Boolean | Adult exited |
@people.children_enter | signal | Boolean | Child entered |
@people.children_exit | signal | Boolean | Child exited |
@people.requested | signal | Boolean | Type of report obtained, whether daily or weekly |
@people.start | signal | Boolean | Starts people counting |
@people.stop | signal | Boolean | Ends people counting |
@people.restarted | signal | Boolean | People counting camera restarted |
@people.cam_connected | signal | Boolean | Camera connected |
@people.cam_disconnected | signal | Boolean | Camera disconnected |
@people.daily_report | signal | Boolean | Daily report generated |
@people.weekly_report | signal | Boolean | Weekly report generated |
$people.event | signal, fieldset | String | Last people counting event |
$people.adult.enter | signal, fieldset | Number | Adults entered |
$people.adult.exit | signal, fieldset | Number | Adults exited |
$people.children.enter | signal, fieldset | Number | Children entered |
$people.children.exit | signal, fieldset | Number | Children exited |
$people.adults_inside | signal, fieldset | Number | Adults inside |
$people.children_inside | signal, fieldset | Number | Children inside |
$people.global_adult.enter | signal, fieldset | Number | Total adults entered |
$people.global_adult.exit | signal, fieldset | Number | Total adults exited |
$people.global_children.enter | signal, fieldset | Number | Total children entered |
$people.global_children.exit | signal, fieldset | Number | Total children exited |
power_save
Power save mode
| property | use | type | description |
|---|---|---|---|
@power_save.ign | signal | Boolean | Wake up by ignition |
@power_save.in1 | signal | Boolean | Wake up from input 1 |
@power_save.in2 | signal | Boolean | Wake up from input 2 |
@power_save.in3 | signal | Boolean | Wake up from input 3 |
@power_save.in4 | signal | Boolean | Wake up from input 4 |
@power_save.in5 | signal | Boolean | Wake up from input 5 |
@power_save.in6 | signal | Boolean | Wake up from input 6 |
@power_save.in7 | signal | Boolean | Wake up from input 7 |
@power_save.motion | signal | Boolean | Wake up from motion |
@power_save.pwr | signal | Boolean | Wake up from ext power |
@power_save.sleep | signal | Boolean | Entering power save |
@power_save.so1 | signal | Boolean | Wake up from short circuit on out1 |
@power_save.so2 | signal | Boolean | Wake up from short circuit on out2 |
@power_save.so3 | signal | Boolean | Wake up from short circuit on out3 |
@power_save.so4 | signal | Boolean | Wake up from short circuit on out4 |
@power_save.tig | signal | Boolean | Wake up from ignition on power |
@power_save.psm_timeout | signal | Boolean | Wake up by time |
@power_save.electrical_reset | signal | Boolean | Wake up by electrical reset |
@power_save.wakeup | signal | Boolean | Wakes up from power save |
$power_save.time | fieldset | Number | Epoch of wakeup time |
$power_save.mode | fieldset | String | Power save mode string |
$power_save.reason | fieldset | String | Wake up reason |
$power_save.status | fieldset | Boolean | Power save mode status |
set power_save immediate | action | Force start power save mode | |
set power_save mode [PSM_STRING] | action | Modify power save mode |
rfid
Serial RFID component
| property | Use | type | description |
|---|---|---|---|
$rfid | fieldset | Object | json appends all rfid fields |
RI:$rfid.last.id | fieldset | String | taip last connected rfid id |
$rfid.last.id | fieldset, signal | String | ID of last connected rfid |
$rfid.last.alias | fieldset, signal | String | Alias of last connected rfid |
$rfid.last.whitelisted | fieldset, signal | Boolean | True if last rfid is authorized |
$rfid.last.conn_epoch | fieldset, signal | Number | Epoch of the last rfid connection |
$rfid.authorized.last.id | fieldset, signal | String | ID of the last authorized rfid |
$rfid.authorized.last.alias | fieldset, signal | String | Alias of last authorized rfid |
$rfid.authorized.last.whitelisted | fieldset, signal | Boolean | True if last rfid was authorized |
$rfid.authorized.last.conn_epoch | fieldset, signal | Number | Epoch of last authorized rfid |
@rfid.event | signal | Boolean | Triggered when any rfid event is detected |
@rfid.change | signal | Boolean | Triggered when the rfid changed |
@rfid.read | signal | Boolean | Triggered when a card approaches the reader, even if it's the same id |
@rfid.authorized | signal | Boolean | Triggered when the id is whitelisted |
@rfid.unauthorized | signal | Boolean | Triggered when the id is not whitelisted |
| add rfid --id=1234 --alias=driver1 | action | add an RFID to the authorized list, or update alias of existing RFID | |
| clear rfid | action | clears the last RFID read | |
| remove rfid --id=1234 | action | removes an RFID from the authorized list | |
| remove rfids | action | 🛑 removes all RFIDs from the authorized list | |
| get rfid | action | get the last RFID read | |
| get rfids | action | get a list of all RFIDs |
satellite (satcom/sigfox)
property | Use | type | description |
|---|---|---|---|
$satcom | fieldset | Object | json appends all timer fields |
$satcom | fieldset | String | taip appends satellite modem's information |
$satcom.state | signal | String | State is connected when satellite is connected |
$satcom.id | signal | String | Satellite modem's id (imei) |
$satcom.signal | signal | Number | Signal strength:
|
$satcom.buff_size | signal | Number | Maximum allowed messages to be stored |
$satcom.buff_count | signal | Number | Amount of messages stored |
enable destination_destination_name_ | action | Enables a destination | |
disable destination_destination_name_ | action | Disables a destination | |
clear satcom buffer | action | Clears the satellite destination buffer | |
set satcom buffer_size | action | Set the satcom buffer size (Range from 10 to 500). | |
get satcom buffer_size | action | Get the satcom buffer size. |
seco (Safe Engine Cut-off / Immobilization)
| property | use | type | description |
|---|---|---|---|
@seco.event | signal | boolean | Trigger when any seco event arrives. |
@seco.idle | signal | boolean | Trigger when the SECO state changed to '0'. |
@seco.canceled | signal | boolean | User canceled the activation, SECO state changed to '1'. |
@seco.power_restored or @seco.deactivated | signal | boolean | Output has been deactivated or the engine power restored, SECO state changed to '2' |
@seco.power_suspended or @seco.activated | signal | boolean | Output has been activated or the engine power suspended. SECO state changed to '3' |
@seco.activating | signal | boolean | Waiting for conditions to suspend the engine power (speed < 10kph for 20s), SECO state changed to '4'. |
@seco.waiting_no_motion | signal | boolean | Waiting for conditions to suspend the engine power (no motion for 5 min), SECO state changed to '5'. |
@seco.waiting_for_gps | signal | boolean | Safe conditions not met, either motion was detected or vehicle speed is above 10kph, SECO state changed to '6'. |
@seco.periodic_report | signal | boolean | Periodic report, the SECO mechanism is running but waiting for safety conditions, SECO state changed to '7'. |
$seco.mode | states | boolean | True if the Safe Engine Cut Off module enabled. |
$seco.trigger | states | boolean | True if the Safe Engine Cut Off activation is requested. |
$seco.active | states | boolean | Safe engine cut off feature actived, this will be activated if the SECO is enabled, the trigger was enabled and the state is '3'. |
$seco.state | states | boolean | Number of the current state (see apx-seco help). |
enable seco | action | Enables the safe engine module. | |
disable seco | action | Disables the safe engine module. | |
start seco | action | Start safe engine cut off, waiting for conditions for turn off motor. | |
stop seco | action | Stop safe engine cut off, enables the motor again. |
SyrusJS
Property | Use | Type | Description | Min SyrusJS Ver. |
|---|---|---|---|---|
| Signal | Boolean | This signal takes the value 'true' when the buffer starts to fill up and takes the value 'false' when it starts to empty. ° Replace the [destination] for the destination defined in the instance. Example. Use : Note that this signal does not depend on how long the device stayed OFFLINE, rather it is the time since any event was added to the queue because it was not able to be sent to the destination. | 2.2.3 |
system
| property | use | type | description |
|---|---|---|---|
@system.reset | one-shot signal | boolean | Triggered whenever the device comes back from a restart |
@system.netchange | one-shot signal | boolean | Triggered every time the network changed after a Syrusjs restart |
$system.sessionCount | states | Number | Session number counter, increase every restart |
$system.uptime | states | Number | Time powered on |
$system.net | states | String | Netlink name [ eth0,wlan0,ppp0] |
$system.ip | states | String | Current device ip |
timers
| property | use | type | description |
|---|---|---|---|
| $timers | fieldset | Object | json appends all timer fields |
| @timers.timer_name | signal | Boolean | True if timer timer_name reaches its duration |
| start timer_timer_name_ | action | Start a timer | |
| stop timer_timer_name_ | action | Stops and clears a timer (resets the value to 0) | |
| enable timer_timer_name_ | action | Enables a timer | |
| disable timer_timer_name_ | action | Disables a timer |
time windows
| property | use | type | description |
|---|---|---|---|
| @windows.name.start | signal | Boolean | One shot boolean, true when time-window starts |
| @windows.name.end | signal | Boolean | One shot boolean, true when time-window ends |
| $windows.name.in | signal | Boolean | State, true when current time is in time-window |
| $windows.name.out | signal | Boolean | State, 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)
| property | Use | type | description |
|---|---|---|---|
| $temp | fieldset | Object | json appends all temp fields |
| $temp.aliases | fieldset | Object | json Temperature info for all sensors |
| $temp.aliases.alias_name | fieldset | Object | json Temperature info for particular alias |
| $temp.sensor_list | fieldset | Object | json Temperature value for all sensors |
| $temp.sensor_list.n | fieldset | Object | json Temperature value for nth index |
| EA_[A|B|C]:$temp.aliases.alias_name.value | fieldset | Number | taip Temperature value for alias_name |
| EA_[A|B|C]:$temp.sensor_list.n.value | fieldset | Number | taip Temperature value for nth index |
| $temp.aliases.alias_name.id | fieldset, signal | String | ID of temperature sensor alias_name |
| $temp.aliases.alias_name.value | fieldset, signal | Number | Temperature value in °C |
| $temp.aliases.alias_name.connected | fieldset, signal | Boolean | True if alias_name is connected |
| $temp.aliases.alias_name.epoch | fieldset, signal | Number | Timestamp of temperature sensor alias_name reading |
| $temp.sensor_list.n.id | fieldset, signal | String | ID of nth temperature sensor |
| $temp.sensor_list.n.value | fieldset, signal | Number | Temperature value in °C |
| $temp.sensor_list.n.connected | fieldset, signal | Boolean | True if nth sensor is connected |
| $temp.sensor_list.n.epoch | fieldset, signal | Number | Timestamp of nth temperature sensor reading |
| add temperature_sensor alias_name id | action | add temperature sensor | |
| remove temperature_sensor alias_name | action | remove temperature sensor by alias_name | |
| remove temperature_sensor id | action | remove temperature sensor by id | |
| remove temperature_sensors | action | 🛑 remove all temperature sensors defined | |
| get temperature_sensor alias_name | action | get temperature sensor by alias_name | |
| get temperature_sensor id | action | get temperature sensor by id | |
| get temperature_sensors | action | get list of temperature sensors defined | |
| get temperature | action | get last temperature |
tpms (ecu)
TPMS information from the engine control unit.
| property | Use | type | description |
|---|---|---|---|
$ecu | fieldset | Object | json appends all valid ecu data including tpms data |
$tpms | fieldset | Object | json appends all the tpms fields according to each alert reported |
$ecu | fieldset | String | taip compatible fieldset |
| $ecu.id | fieldset, signal | Multiple | id refers to the specific pgn + start_position |
| $ecu.param_name | fieldset, signal | Multiple | param_name refers to the parameters listed in the SDK ECU.d directory files |
| $ecu.$tires.axle_index__X_.tire__Y_.pressure | fieldset, signal | Number | Pressure 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_.pressure | fieldset, signal | Number | Pressure 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.axle_index__X_.tire__Y_.temperature | fieldset, signal | Number | Temperature 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_.temperature | fieldset, signal | Number | Temperature 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_ok | signal | Boolean | True when there's no tpms alerts/alarms detected |
| @tpms.sensor_mute | signal | Boolean | True when any tire reports a missing signal |
| @tpms.sensor_defective | signal | Boolean | True if any tire reports a defective sensor |
| @tpms.tire_leak | signal | Boolean | True if any tire reports a tire leak |
| @tpms.temperature_warning | signal | Boolean | True if a tire reports a temperature warning |
| @tpms.over_inflation_critical | signal | Boolean | True if a tire reports a critical over inflation |
| @tpms.over_inflation_warning | signal | Boolean | True if a tire reports a warning over inflation |
| @tpms.under_inflation_critical | signal | Boolean | True if a tire reports a critical under inflation |
| @tpms.under_inflation_warning | signal | Boolean | True if a tire reports a warning under inflation |
tracking_resolution
Tracking resolution information
| property | use | type | description |
|---|---|---|---|
@tracking_resolution.NAME.distance | signal | Boolean | Distance is met |
@tracking_resolution.NAME.heading | signal | Boolean | Heading is met |
@tracking_resolution.NAME.time | signal | Boolean | Time is met |
@tracking_resolution.NAME.signal | signal | Boolean | Any criteria is met |
set tracking_resolution NAME degrees time distance pacc,nacc | action | Modify a tracking resolution |
variables
Variables related information
| property | use | type | description |
|---|---|---|---|
$variables | fieldset | Object | json appends all valid ecu data including tpms data |
| $variables.name | fieldset, signal | Number or String | Contents of the variable name |
| set variable_name_ VALUE | action | Set variable name to a VALUE | |
| set variable_name_ increment | action | Increments the variable value by 1 | |
| set variable_name_ decrement | action | Decreases the variable value by 1 | |
| set variable_name_ reset | action | Set the variable value to 0 |
video
Video related information, more info
| property | use | type | description |
|---|---|---|---|
start recording | action | Starts a video recording | |
stop recording | action | Stops a video recording | |
create video | action | Creates a video clip |
CAN60 (LinkedCore)
NOTE: The following signals only are available since SyrusJS 2.3.0 and its operation depends on the Syrus package syrus-serial ver. 0.9.0.
| Property | Usage | Type | Description |
|---|---|---|---|
$can60 | Fieldset | Object | Add the TAG's homologated with ECU. |
$can60.rpm | Signal | Numeric | Engine speed RPM |
$can60.speed | Signal | Numeric | Vehicle speed Km/h |
$can60.cruise | Signal | Numeric | Cruise |
$can60.retarder | Signal | Numeric | Retarder |
$can60.pto | Signal | Numeric | PTO |
$can60.odometer | Signal | Numeric | CAN Odometer in Km |
$can60.odoliter | Signal | Numeric | CAN Odoliter in L |
$can60.fuel_level | Signal | Numeric | Fuel tank level in % |
$can60.fuel_temperature | Signal | Numeric | Fuel temperature in °C |
$can60.fuel_presure | Signal | Numeric | Fuel pressure in kPa |
$can60.oil_level | Signal | Numeric | Engine oil level in % |
$can60.oil_temperature | Signal | Numeric | Engine oil temperature in °C |
$can60.oil_pressure | Signal | Numeric | Engine oil pressure in kPa |
$can60.coolant_level | Signal | Numeric | Engine coolant level in % |
$can60.coolant_temperature | Signal | Numeric | Engine coolant temperature in °C |
$can60.coolant_presure | Signal | Numeric | Engine coolant pressure in kPa |
$can60.ads_level | Signal | Numeric | AdBlue/DEF level in % |
Updated 3 days ago
