System Tools

Apex core system tools

The Syrus 4 system tools are applications that are in charge of enabling/disabling and resetting specific hardware functionalities. They can also be used to interact with some Linux applications such as hostapd which is used for bringing up a hotspot. And finally the tools serve as a way to create functionalities such as tracking criterias, geofences and more, which is useful for fleet management.

These applications are accessed via the shell with apx- as a command prefix.

The standard response of these system tool command is JSON, thus you may find it useful to use jq to get a specific result.

# returns the last gps point
$ sudo apx-gps state | jq .LATEST_POINT

# returns the first 5 geofences in the namespace applications
$ sudo apx-geofences getstatus applications | jq '.[0:5]'

# returns the name of all the geofences in the namespace applications
$ sudo apx-geofences getstatus applications | jq '.[] | {name: .geo_name}'

Result codes

They can be consulted by echoing the Linux exit status code $?. The most common result codes are:

  • 0: Action executed
  • 1: Catchall for general errors
  • 2: Misuse of shell builtins (according to bash documentation)
  • 22: Invalid argument
  • 90: Response too long
  • 126: Command invoked cannot execute
  • 127: Command not found
  • 128: Invalid argument to exit
  • 128+n: Fatal error signal “n”
  • 130: Script terminated by Control-C
  • 255+: Exit status out of range


Sudo privileges

Note that all apx commands require special privileges, thus you must use sudo to execute them.



Inertial measurement unit manager for the accelerometer and device's gyroscope. This tool calibrates the accelerometer and sets it's event thresholds.

 apx-imu <command> [<args=value>]
configure [OPTIONS]Set the driver behavior thresholds in milliG units.
calibrate [OPTIONS]Start the device calibration procedure. Take into account that the vehicle must be stopped/stationary on a level surface when starting this process.
testStarts the accelerometer self-test. If second parameter is not used it returns the motion state. It forces some of the events (motion, collision, hard_braking, etc) to be triggered.
statusReturns the list with all the configured parameters.
eventsReturns the list with the last 25 acceleration events.

Use the following options to set/get the different parameters related to the accelerometer. If the second argument is not specified, it returns the value configured

Calibration Options

--statusSet to start or stop to start and stop the calibration procedure

Configuration Options

motion_thresholdFrom 10 to 500, Default: 30 (30*1milli-g=30milli-g)
motion_durationFrom 1 to 8, Default: 2 (2*0.5=1sec)
front_collisionFrom -1000 to -15000, Default: -2000milli-g
back_collisionFrom 1000 to 15000, Default: 2000milli-g
right_collisionFrom -1000 to -15000, Default: -2000milli-g
left_collisionFrom 1000 to 15000, Default: 2000milli-g
harsh_accelerationFrom 200 to 600, Default: 260milli-g
hard_brakingFrom -200 to -600, Default: -260milli-g
cornering_rightFrom -200 to -600, Default: -400milli-g
cornering_leftFrom 200 to 600, Default: 400milli-g

The alignment process can be found in the CONNECT page.


Accelerometer parameters

Note that the self_alignment procedure is required in order to trigger any acceleration related signal with Syruslang.

Query status of alignment procedure

# Configure the hard braking threshold to -240 milli-g and cornering left to 350 milli-g
$ apx-imu configure --hard_braking=-240 --cornering_left=350

# Start the calibration process
$ apx-imu calibrate --status=start

The device will return one of these states

ALIGNMENT_CURRENT_STATE% completeddescription
11%Deleting previous alignment data
210%Waiting for GNSS signal
330%Running initial stage. Computing recorded data
450%Running second stage. Waiting for GNSS signal
570%Waiting for vehicle speed to go over 30kph
680%Waiting for a valid braking event
790%Braking event detected. Computing recorded data
8100%Alignment process done


# Start the self alignment process:
$ apx-imu calibrate --status=start

# Configure the hard braking to -240 milliG and cornering left to 350 milliG:
$ apx-imu configure --hard_braking=-240 --cornering_left=350

# Read the value of the harsh forward acceleration threshold:

# Read the list of parameters configured:
$ apx-imu config_list



Install, run, and manage applications on the device.

 syrus-apps-manager [option] [argument_1] [argument_2] [argument_3]


Syrus application manager

The command syrus-apps-manager does not require sudo in front and can be run by user syrus4g

helpPrints this help message
install-appinstall an app from .zip file on the device, makes it available to create instances, takes as argument_1 the path where the zip file exists
update-app · download-appdownload a new version of the app from the repository declared for the app, takes as argument_1 the name of the app and argument_2 the new version to download, if argument_2 is omitted it will try to download the stable version if available
list-appslist the available apps installed on the device
delete-appdelete an app on a specific version, takes as argument_1 the app and argument_2 the version of the app
check-updateschecks for updates on every app thats exposes a repository on the manifest
list-instanceslist all the instances of apps running on the device
create-instancecreate an instance from a previously installed app on the device, argument_1 is the name of the instance, argument_2 the name of the app, and the argument_3 the version
update-instanceupdate an instance to a different version, takes as argument_1 the name of the instance and argument_2 as the version
delete-instancedelete an instance, takes as argument_1 the name of the instance
start · stop · restartstart,stop or restart one instance, takes as argument_1 the name of the instance
get-runningreturn a list of only running instances
statusreturn the status of one instance, takes as argument_1 the name of the instance
send-messageSend a message (via nc) to applications that expose a unix socket.
start-shellStart a shell (via nc) with applications that expose a unix socket.


Instance naming

Note that instances must start with lowercase, and contain no spaces or special characters.


# Manual application installation from source

$ cd /data/downloads

$ wget

$ syrus-apps-manager install-app customApp /data/downloads/
# SyrusJS example installation

$ wget -O /data/downloads/

$ syrus-apps-manager install-app /data/downloads/

$ syrus-apps-manager create-instance test_instance syrusjs 1.34.1

$ syrus-apps-manager start test_instance
# Update syrusjs application 
$ syrus-apps-manager update-app syrusjs 1.34.0

# Update an instance of syrusjs
$ syrus-apps-manager update-instance my_syrusjs_instance 1.34.0

# Send commands to a syrusjs instance
$ syrus-apps-manager send-message __cloud_syrusjs 'get signal_value isON'
signal value=true

# make sure to use single quotes ' around commands with special characters
$ syrus-apps-manager send-message __cloud_syrusjs 'get value $net_wifi.ip_address'

# Start a shell with syrusjs
$ syrus-apps-manager start-shell __cloud_syrusjs
get signals
define signal ...



Tool to convert text to speech in different languages. Use the apx-bt tool to pair to a compatible bluetooth device first.

 apx-tts [language] [message]
en-GBGreat Britain

[message] is the actual message to say


$ apx-tts en-US 'Testing text to speech'

$ apx-tts es-ES 'Una prueba de texto a voz'



Bluetooth tool with BLE functions and pairing with compatible with bluetooth headsets. If you're looking for the text to speech function, check out the apx-tts tool.

 apx-bt [<action>] [--arguments]


helpReturns this message.
onWill enable the Bluetooth module.
offWill disable the Bluetooth module.
statusWill display core application version, prioritized audio, device MAC, device name, and the mode configured.
scanFollowed by --time in seconds. Application will scan for nearby devices for up to 30 seconds.
pairFollowed by --mac. Will begin the pairing process with the device. Device needs to have been previously scanned.
pair_forcedFollowed by --mac. Will force a pair process with the device.
connectFollowed by --mac. Attempt a connection with a previously paired device
unpairFollowed by --mac. Will unpair a previously paired device.
disconnectFollowed by --mac. Will disconnect a previously connected device.
switch_audioFollowed by --mac. Will declare the device to be the main source of audio.
infoFollowed by --mac. Will display information about the device.
info_allThis will display information about all of the recently discovered devices, if those devices are paired, or if they are paired and connected.
historyThis will display information about all of the devices that were discovered by the scanning process since last activation of the Bluetooth module
list_discoveredReturns the list of all the devices that have been discovered by the scanning process. Note: A device might be scanned and added to the list of paired devices but not appear in the list of discovered devices. Recommended to check both lists.
list_connectedReturns the list of all paired and connected devices.
restartThis will restart the application module.
resetThis command resets everything regarding the application. All information about the devices, connections, and pairs will be lost.
routed_audioThis will display the address of the device producing audio.
soc_audioRoutes prioritized audio device to allow audio from SOC.
mdm_audioRoutes prioritized audio device to allow audio from MDM.
--macDevice MAC address. A single string of hexadecimal is expected for the device
--timeTime in seconds


Switch audio

Note that the switch_audio action is only relevant when you have multiple compatible speakers paired to the Syrus, and you want to switch which speaker to use to playback an audio without having to disconnect them.

# Start a scan for nearby bluetooth devices for 15 seconds.
$ apx-bt scan --time=15

# List discovered Bluetooth devices after scanning
$ apx-bt list_discovered
{"C83432DA6A1C":"Family Room TV","000664EDF530":"CricutAIR2-F530","E8ABFB463615":"Boltune BT-BH010","84A444220FA2":"[TV]Samsung LED55"}

# Pair to a discovered bluetooth device with the MAC address: 02:06:EF:66:43:0A
$ apx-bt pair --mac=0206EF66430A

BLE Actions

$ apx-bt [<action>] [--arguments]
advertisingFollowed by desired parameters to enable or disable advertising, which type of advertising to do, and for how long to advertise (--mode, --flag, and --duration respectively). If not followed by anything it shows the parameters used.
authFollowed by the password. Only usable from the BLE device that is connected.
change_authTakes two arguments. The --old_pass and the --new_pass that BLE devices must use for authentication. Passwords must be of 1 to 30 characters long and cannot contain spaces. Only 0-9,a-z,and A-Z characters are allowed.
sendFollowed --characteristic and --message. This command takes two arguments where the first argument is the characteristic to notify and the second argument is the message to send to the device that is subscribed for notifications. The message can be any NULL terminated string. Refer to Valid Characteristics.
pingUsed for maintaining a keep alive communication between a BLE device and this unit. Will return "pong".
change_nameFollowed by --name. Will change both the Bluetooth name of the device and the BLE name being advertised by the device. The name will always be prefixed with Syrus 4G. The name can be up to 15 alphanumeric characters.
ble_statusNot followed by any arguments. Will display a list of all BLE devices that are currently connected or recently disconnected.
--modeEither 0 or 1 for disable and enable respectively.
--flagTo get the desired on state flag, simply add the hex numbers from Number on the Advertising Table below.
--durationA value in seconds between 30 to 300 seconds. A number more than 300 will force advertising duration to be 600 which means advertising is continuous, meaning advertising will always be on.

Advertising Table:

NumberNot addedAdded
0x001Local Random AddressLocal Public Address
0x002Non DiscoverableDiscoverable
0x004Non ConnectableConnectable
0x010Advertise Name OffAdvertise Name
0x020Advertise Tx Pwr OffAdvertise Tx Pwr
0x040No AppearanceAdvertise Appearance
0x100Peer Random AddressPeer Public Address

Valid Characteristics:

eventsTo be used for events that occurred
user_apps_consoleTo be used by internal user applications that wish to communicate with external user applications.
# Advertising is enabled, discoverable (`0x002`), connectable (`0x004`), and the name is advertised (`0x010`) for 200 seconds.
$ apx-bt advertising --mode=1 --flags=0x16 --duration=200

# Send a json string to the events 
$ apx-bt send --characteristic=events --message={"name":"Joe"}



Start device counters for ignition, distance and other metrics.

 apx-counter [action] [namespace]
 apx-counter [action] [namespace] [key] [value]
startMust be followed by namespace. Will start the desired namespace. Creates it if it doesn't exist.
stopMust be followed by namespace. Will stop the desired namespace.
resetMust be followed by namespace. Will stop the desired namespace and resets the counter key values.
resetallSame as above only that thresholds are reset to default values.
setMust be followed by namespace key value. Key has its value set to value.
getMust be followed by namespace key. Will return the value of the key.
getallMust be followed by namespace. Will return the value of all of the keys.
deleteMust be followed by namespace. Will delete the namespace.
listNot followed by anything. Will list information about all known counters.
helpPrints this help message
ODOMETERDistance traveled in meters with ignition on.
IGNITION_TIMETotal time ignition has been on in seconds.
IDLE_TIMETotal time ignition has been on in seconds with no distance traveled after the time defined in BEGIN_IDLE_TIME.
OVER_SPEEDTotal time in seconds that the speed has exceeded the threshold value defined in SPEED_THRESHOLD
OVER_RPMTotal time in seconds that the RPM has exceeded the threshold value defined in RPM_THRESHOLD
HARD_BRAKESTotal number of hard brakes produced.
HARSH_FWD_ACCELERATIONTotal number of harsh accelerations produced.
DISTANCEThe distance traveled in meters with no ignition.
RPM_THRESHOLDKey to define an RPM value that the vehicle must exceed to begin incrementing OVER_RPM
SPEED_THRESHOLDKey to define a speed value (km/h) that the vehicle must exceed to begin incrementing OVER_SPEED
BEGIN_IDLE_TIMEKey to define how long to wait in minutes before incrementing IDLE_TIME.

The namespace can be up to 50 characters long with no spaces. We recommend you define a schema: type:name:counter like driver:john:0


# start custom counter
$ apx-counter start custom1

# set the speed threshold to 100km/h for custom1
$ apx-counter set custom1 SPEED_THRESHOLD 100

# get all the values of custom1 counters
$ apx-counter getall custom1



Tool to configure and read data from a vehicle's onboard computer using the CAN Bus.

 apx-ecu [<action>] [--arguments]
configureThis may take two arguments to configure the desired CAN interface at the desired baud rate, one argument to configure the read mode of the specified interface, or no arguments.
The valid arguments are --interface and --interface_mode, where --interface is the interface to configure and --interface_mode is the desired mode for that interface.
A singular argument must be used to configure the read mode; this argument is --read_mode.
Read mode refers to allowing ECU monitor to read data when vehicle ignition is off.
When no arguments are used, this will return the current configuration used by the ECU monitor.
listen_modeThis may take one or no arguments.
This will force ECU monitor to not send data to the specified interface.
The valid argument is --listen_mode.
If no argument is given then this will return the current listen_mode being used.
list_parametersNot followed by any arguments. Returns a JSON of all the parameters read with the unique id and value.
logThis takes three arguments.
The valid arguments are --log_time, --file_name, and --log_interface.
Where --log_time is the time in seconds starting from 1 second up to 40 seconds to save to the log file --file_name from the --log_interface.
The file name is a relative file path name and only letters and numbers are allowed for the file name up to 20 characters long.
All logs are saved in /data/users/syrus4g/ecumonitor/ecu_logs/.
stopNot followed by any arguments. Halts operation of ecumonitor until it is reconfigured; this will make the configuration section from ecumonitor.conf obsolete.
restartNot followed by any arguments. Restarts the ecumonitor.
clearNot followed by any arguments. Will clear any previous returned by list_parameters command.
versionNot followed by any arguments. Will return the version of this tool and the version of the ecumonitor core application.
decodeThis may take two arguments. The valid arguments are --unique_id and --value. This will decode the --value from the --unique_id returning a different JSON based on the unique_id to decode. If no arguments are passed then the list of valid unique_ids will be printed.
helpReturns this help message.
configure[--interface=<interface>] [--interface_mode=<interface_mode>] or [--read_mode=<read_mode>]
log[--log_time=<time_in_seconds>] [--file_name=<file_name>] [--log_interface=<interface>]
decode[--unique_id=<unique_id>] [--value=<value>]
Valid interface
Valid interface_mode

Note: Where XXX is the baud rate and Y is either K(Kilo) or M(Mega).

Valid listen_mode


# Configure the primary ECU cables to work with J1939 @ 250 KBPS
$ apx-ecu configure --interface=PRIMARY_CAN --interface_mode=J1939_250KBPS

# Set the listen only mode for SECONDARY CAN 
$ apx-ecu listen_mode --interface=SECONDARY_CAN

# Decode a J1939 data trouble code*
$ apx-ecu decode --unique_id=feca_3-6 --value=2114126001
# *Note this requires the definition of PGN: `feca` start_position: `3-6` in your ecumonitor.conf

# Perform a candump for 40 seconds from 2 CAN interfaces
$ apx-ecu restart
$ apx-ecu clear
$ apx-ecu configure --interface=PRIMARY_CAN --interface_mode=J1939_500KBPS
$ apx-ecu configure --interface=SECONDARY_CAN --interface_mode=J1939_250KBPS
$ apx-ecu log --log_time=40 --log_interface=PRIMARY_CAN --file_name=logTruck500.log
$ apx-ecu log --log_time=40 --log_interface=SECONDARY_CAN --file_name=logTruck250.log
$ apx-ecu list_parameters
# Note that underscores are not allowed for the name of the log file

# clear and list ecu parameters
$ apx-ecu clear
$ apx-ecu list_parameters



Manage the ethernet interface on the device. Allows you to configure DHCP mode or other network configuration.

 apx-ethernet <command> [<args=value>]
restartUse this option for restarting the ethernet interface
statusReturns the current state of the ethernet interface
set [OPTIONS]Returns the current state of the ethernet interface
versionReturns the tool version
helpPrints this help message
-r, --routeUse this option for forwarding the ethernet traffic to another interface, it allows the connected device to have internet access by specifying the output interface. Valid values are: wlan0, ppp0 (Mobile network), both, and none.
-i, --ipUse this option for changing the interface IP address and mask
-g, --gatewayUse this option for changing the gateway address
-d, --dnsUse this option for changing the dns address
-s, --dhcpUse this option for enabling the DHCPServer on this interface. So, when a device is connected to the device ethernet, it assigns an IP address to the connected devices.
-f, --defaultBy using this option the ethernet IP address is assigned by the network.


# Uses the IP address assigned by the network
$ sudo apx-ethernet set --default

# Configure the ethernet in DHCP mode
$ sudo apx-ethernet set --dhcp

# Set the IP address of the ethernet interface
$ sudo apx-ethernet set --ip=

# Configure the ethernet network with dhcp enabled
$ sudo apx-ethernet set --ip= --gateway= --dns= --dhcp --route=none
# Where: = Device IP/Mask
#  = Gateway address
#        = DNS
#        yes            = DHCP server enabled
#        none           = Traffic is not routed to another interface

# Route ethernet traffic to both wlan0 and ppp0 interface
$ sudo apx-ethernet --route=both

# Restart the ethernet inteface
$ sudo apx-ethernet restart

# Check the ethernet status
$ sudo apx-ethernet status



Tool that adds and removes geofences on the device. Note that a maximum of 3000 geofences can be saved as of apex version 20.12

Add a geofence

  apx-geofences add [namespace] [group] [type] [name] [radius] [lon,lat] [...]

$ apx-geofences add places parks circular country_village_park 100 -80.305340,25.943784
namespaceName of the namespace. If no namespace, specify an empty string "". Max 30 characters
groupName of the group. If no group, specify an empty string "". Max 30 characters, min 3 characters
typeType of geofence. Must be circular or poly
nameName of the geofence. Max 50 characters
radiusOptional Radius of the geofence in meters, required for circular geofences. Min 50 meters. Max 20000 meters.
lon,latLongitude and latitude coordinates in the format decimal degrees: -80.3471745,25.917071. Max 500 pairs of coordinates. Minimum of 3 pairs of coordinates for a poly type geofence

Remove a geofence

  apx-geofences remove [namespace] [group] [name]

$ apx-geofences remove places parks country_village_park

Remove all geofences of a namespace

  apx-geofences remove [namespace]

$ apx-geofences remove places

Get a list of all namespaces that exist

$ apx-geofences getns

To get all the information of the geofences of a specific namespace

  apx-geofences getall [namespace]

$ apx-geofences getall places


  • namespace: Name of the namespace
  • group: Name of the group
  • geo_name: Name of the geofence
  • type: poly or circular
  • radius: Radius of circular geofence in meters
  • n_vertices: Number of lon,lat pairs in the geofence
  • vertices: Lon,lat pairs

To count the number of geofences that exist in namespace[s]

  apx-geofences count [namespace]

$ apx-geofences count places

To get the current state of each geofence of a specific namespace

  apx-geofences getstatus [namespace]

$ apx-geofences getstatus places


  • group: Name of group
  • geo_name: Name of geofence
  • is_inside: True if device is currently inside the geofence


Get Status of Geofence Inside

Note that if you create a geofence around the location of your device the getstatus command will return that it's is_inside: true.

To get the current version of the tool

$ apx-geofences version
{"version": "0.0.5"}
22Invalid argument
80Max number of geofences reached
81Geofence not found
82Missing parameter
127Unknown command


# Create a polygonal geofence around 25.935469,-80.333524 25.934948,-80.328439 25.933375,-80.328321 25.933558,-80.333310
$ apx-geofences add places parks poly park_norman_jean -80.333524,25.935469 -80.328439,25.934948 -80.328321,25.933375 -80.333310,25.933558

# Print the geofences that are in the namespace places
$ apx-geofences getall places


Tool to import and export geofences massively on the device.

 apx-geofences-manager [option] [arguments]
importCreate geofences in batch using syruslang scripting command, the tool requires arguments: namespace and path.
exportExport geofences to a single file. Accepts arguments: format, namespace, and file.
--removeRemove all geofences in the namespace before start importing
--dry-runRun command to proccess without creating geofences
--format · -fFormat to be exported, accepted values are: syruslang,geojson
--namespace · -nNamespace to be export or imported
--path · -pPath to file destination where import geofences or path where to export destination. Must be a syrus.conf and contains syruslang script language or a .geojson with valid geojson data
# Import geofences from '/data/downloads/geofences.syrus.conf' with the namespace 'sample_geo' to the device.
$ apx-geofences-manager import -p /data/downloads/geofences.syrus.conf -n sample_geo

# Export geofences on the device from the namespace: 'sample_geo' into Syruslang format with the name: '/data/downloads/geofences_applications.syrus.conf'
$ apx-geofences-manager export -f syruslang -n sample_geo -p /data/users/syrus4g/geofences_applications.syrus.conf



Allows you to control the GNSS/GPS interface on the device.

 apx-gps <command> [<options>]
statusWill display the current position, the GNSS engine, the application version and the configuration parameters
onWill enable the GNSS module
offWill disable the GNSS module
restartWill power off/on the GNSS module
positionUse this option to consult the current position
cold-startWill execute a cold start on the GNSS module
warm-startWill execute a warm start on the GNSS module
hot-startWill execute a hot start on the GNSS module
antenna-onPower on the GNSS antenna, 3.3 Volts are placed on the antenna connector
antenna-offPower off the GNSS antenna
set-filter [options]Use this option to configure the GNSS anti-drift filter, it receives as options the hdop, motion and speed(km/h). Valid ranges: 1.0 <= hdop <= 5.0; motion true/false; 0 <= speed < 100
set-rateUse this option to change the GNSS nmea sentece output frequency. Valid options are 1, 5, and 10 Hz
backlog createWill create a GNSS backlog file, it receives as parameters the file name --name and the time window --time-win, the time window limit is 300 seconds
backlog statusReturns the state of the GNSS backlog file specified with the --name argument
set [options]Use this option to enable or disable the simulation or nmea-log mode
versionReturns the tool version
helpPrints this help
set-filter[--hdop=<value>] [--motion=<value>] [--speed=<value>]
backlog create[--name=<value>] [--time-win=<value>]
backlog status[--name=<value>]
set[--simulation-mode=<true/false>] [--nmea-log=<true/false>]


# Get the gps state
$ apx-gps state
# Where: TIME           = GMT Timestamp in ISOFORMAT
#        ENGINE         = GPS chip
#        VERSION        = GPS version
#        FIX            = Fix quality, 1: 'Fix not available', 2: '2D', 3: '3D' (
#            lat        = Latitude
#            lon        = Longitude
#            alt        = Altitude in meters above mean sea level
#            speed      = Speed in km/h
#            heading    = Heading in degrees from North, increasing eastwardly
#            epoch      = GPS epoch timestamp

# Perform a warm-start on the GPS module
$ apx-gps warm-start

# Change the GPS anti-drift filter to hdop of 1.8, movement detected, with speed of 50 km/h
$ apx-gps set-filter --hdop=1.8 --motion=true --speed=50

# Get the latest location
$ apx-gps position

# Generate a backlog of the last 60 seconds, and next 20 seconds from now
$ apx-gps backlog create --name=mybacklog --time-win=-60,20

# Get the status of the gnss backlog
$ apx-gps backlog status --name=mybacklog

# Set Simulation mode
$ apx-gps set --simulation-mode=true



Tool that manages the device's general purpose inputs and outputs.

 apx-io [action] [key] [value]
setMust be followed by key and value. Will set desired output for the device.
getMust be followed by key. Will obtain the value of the desired key
getallMust be followed by key. Will obtain all of the values for the desired key
helpPrints all the usages


key: OUT1, OUT2, OUT3, and OUT4

value: true or false


key: OUT1, OUT2, OUT3, OUT4, IGN, IN1, IN2, IN3, IN4, IN5, IN6, IN7, PWR, MOT, SO1, SO2, SO3, SO4, TIG, AN1, AN2, DAN, BAT


key: outputs, inputs, analogs


# Get the value of all the analog inputs:
$ apx-io getall analogs

# Activate output 2:
$ apx-io set OUT2 true



Tool to manage the LTE module of the device. Allows you to configure the APN and other configuration related parameters as well as perform actions like sending an SMS, enabling airplane mode, or converting text to speech.

 apx-mdm <command> [<args=value>]


statusUse this option to consult the current state and general information about modem network registration and configuration parameters. It returns a json object
restartUse this option for restarting the modem device.
end-callUse this option for ending an established voice call.
versionReturns the tool version.


set [OPTIONS] - Use this option to configure the parameters used by the modem application

-a, --apnThe access point name.
-p, --pinThe SIM card PIN
-u, --userThe username for the apn
-p, --passThe password to access the apn
-b, --sim_sw_intervalThe time interval in hours for changing from external SIM to embedded when no data connection is reached (default: 4)
-c, --sim_priorityWith this parameter, you can specify the sim card to use: e-sim embedded (default) or sim-card external
-k, --keep_aliveThe time interval in minutes to check the data connection
-v, --call_validationUse true for validating the phone number before answering the call, it depends on the authorized phone list added with phone_book option. By default, the device validates the phone number before answering the call
-m, --sms_validationUse 'true' for validating the phone number before processing the incoming sms, it depends on the authorized phone list added with phone_book option. By default, the device validates the phone number before processing the incoming sms
-f, --airplane_modeUse true for entering in airplane mode and false for returning to normal mode.


phone-book [SUBCOMMAND] [OPTIONS] - Use this command to add, remove and consult the authorized phone book list

addUse this option to add a phone number to the authorized list.
removeUse this option to remove a phone number from the authorized list.
listUse this option to consult the phone number authorized list.
-n, --numberThe phone number to add or remove


send [OPTIONS] - Use this command to send SMSs

-s, --smsThe message to be sent.
-n, --numberThe destination phone number


call [OPTIONS] - Use this option for starting a voice call

-n, --numberThe phone number to call


tts [OPTIONS] - Text to speech. Use this option to turn text into sounding by using the Bluetooth speaker connected

-t, --textThe text to be reproduced


# Set the APN of the regular SIM card (not embedded)
$ apx-mdm set --user=myuser --pass=mypass

# Set the priority of the SIM card used to the regular SIM (not embedded):
$ apx-mdm set --sim-priority=sim-card

# Add phone number to the phone book:
$ apx-mdm phone-book add -n=3013333333

# Send an SMS to 3013333333
$ apx-mdm send --n=3013333333 --text='Testing Syrus4 SMS'

# Start a call with the number: 3013333333
$ apx-mdm call -number='+13013333333'

# Speak command
$ apx-mdm tts --text='Testing text to speech'

# Get the state of the LTE modem
$ apx-mdm state
{"manufacturer":"Quectel","revision":"EG25GGBR07A06M2G","model":"EG25","imei":"867698040023056","sim_imsi":"732123200007701","sim_state":"Not in Use","sim_type":"EMBEDDED","sim_id":"89883234500011949724","gsm_reg":1,"modem_state":"ON","gprs_reg":1,"rat":"FDD LTE","mcc_mnc":310260,"band":"LTE BAND 2","operator":"Wireless","esim_state":"READY","ip":"","esim_imsi":"310260859157280","esim_id":"8901260852391572807F","rssi":15,"no_conn_time":0,"lac":8181,"cid":"24A8F0E","sim_sw_interval":8,"keep_alive":15,"sim_priority":"e-sim","apn":"super"}


Manages the ppp connection to the internet with the specified profile.

 apx-ppp [option] profile
startStarts the pppd deamon with the profile specified
stopStops the pppd process
stateReturns 0 if daemon is running and ppp0 interface has an IP, 1 otherwise
helpPrints this help message


$ apx-ppp start default


Manage devices that communicate via the 1-wire bus system like temperature probes and IButtons.


Use this Apex tool to add/remove onewire devices to or from the whitelists found in /data/users/syrus4g/onewire/. This tool also allows to get information about the onewire devices connected.

 apx-onewire [type] [action] 
 apx-onewire [type] [action] [argument_1] [argument_2] ... [argument_n]
addFollowed by argument_1 and argument_2. Will add the alias found in argument_1 with the onewire id number found in argument_2 to the white list based on the valid type. Alias cannot be empty, must be of 50 characters or less, and cannot contain the character ':'. The onewire id must be exactly 16 characters long therefore you must place padding with leading zeros to complete the 16 digits.
removeFollowed by argument_1. The argument_1 can be either the alias or the onewire id which will be removed from the white list based on the valid type.
remove_allNot followed by any arguments. Will remove all of the onewire devices based on the type specified from the corresponding white list.
remove_lastNot followed by any arguments. Will remove records of the last onewire device discovered.
getFollowed by argument_1. The argument_1 can be either the alias or the onewire id. Returns an object with information about the onewire device based on the type given.
get_allNot followed by any arguments, returns an array of objects for all the onewire devices based on the type specified.
get_lastNot followed by any arguments, returns an object of the last onewire device that was connected based on the type specified.
restartNot followed by any arguments, not preceded by a type, will restart the onewire application.
resetNot followed by any arguments, not preceded by a type, will reset the onewire application. Deleting all white list files as well as previous information about past onewire devices.
helpNot followed by any arguments, not preceded by a type, will print this message.
versionNot followed by any arguments, not preceded by a type, will return the core and the tool version.
statusNot followed by any arguments, not preceded by a type, will return the status of the onewire bus. 0 meaning operation is normal. -1 meaning that there is a fault in the onewire bus.


# add ibutton with alias: 'driver 1'
$ apx-onewire ibutton add 'driver 1' 0123456789123401

# read all ibuttons
$ apx-onewire ibutton get_all
{"ibuttons":[{"alias":"driver 1","id":"0012331241412401","whitelisted":true,"connected":false,"conn_epoch":null,"disc_epoch":null}]}

# add temperature alias for room1
$ apx-onewire temperature add room1 3501144D2797AA28

# read all temperatures
$ apx-onewire temperature get_all

People Counting


Tool to manage the people counting camera.

 apx-ndm-pc <command> [--<option>=<value>]
startstarts the people counting.
stopstops the people counting.
resetreset the internal people counters.
statusget actual counters status.
report [OPTIONS]returns the JSON formatted report.
report[--from=<value>] [--to=<value>]

The report is used to request a summary of the people counted


  • from: epoch format -> 1668798420
  • to: epoch format -> 1668798420
# Start
$ apx-ndm-pc start

# Stop
$ apx-ndm-pc stop

# Reset
$ apx-ndm-pc reset

# Status
$ apx-ndm-pc status

# Report
$ apx-ndm-pc report --from=1665316800 --to=1665331200

Power Save


Tool to manage the device's power save mode. The power save mode is ON by default where the device goes into a low power consumption mode after 5 minutes without the ignition wire detected. This behavior can be overwritten with this tool. Syrus 4 consumes ~200mA when using GNSS, modem and wifi, thus it's recommended to always have a power save mode configured, to avoid any issues with a car's battery for example.

Default PSM_STRING: IGN:0,SLP:300;IGN,MIN:720;300

 apx-psm [action] [PSM_string]
immediateThis action is not followed by PSM_string, instead it orders the device to enter Power Save Mode with the previously loaded configuration. When a previous PSM doesn't exist the device will use the default PSM.
modeMust be followed by PSM_string and the only valid format is sleep_condition;wakeup_condition;wait_time. Signals for the conditions are separated by commas (,) and conditions are separated by semicolons (;). All of the sleep_condition signals must have a valid value of 0 or 1 and the colon (:) character must be used to separate between signal and value. Note: MIN is the only signal for wakeup_condition that has a value. SLP signal cannot exist without a MIN signal and vice versa. Be sure to encapsulate PSM_string with "Quotation Marks"
helpPrints this message.
guideGuides the user on how to properly create a Power Save Mode string. Note The device will be configured with the results of this guide.

Configuration of the [PSM_string]
First enter the sleep_condition. This is the condition the device must meet so that it will go into Power Save Mode. This condition is broken into signal:value separated by commas where only the valid signals below are allowed and the only valid values are 0 (inactive) or 1 (active)

sleep_condition signalsdescription
IGNIgnition state.
IN1Input 1 state.
IN2Input 2 state.
IN3Input 3 state.
IN4Input 4 state.
IN5Input 5 state.
IN6Input 6 state.
IN7Input 7 state.
PWRExternal power state.
MOTMotion state.
SO1Short-circuit on output 1.
SO2Short-circuit on output 2.
SO3Short-circuit on output 3.
SO4Short-circuit on output 4.
TIGIgnition from main power supply state.
SLPTime to wait for the device to go back into sleep mode in seconds (300 - 65535 seconds)

Next enter the wakeup_condition. This is the condition that lets the device know how it should return from the Power Save Mode. The device will wake up upon any of the given wake up signals being met. Only use the valid wake up condition signals described below. The only signal that uses a value is 'MIN' and this signal lets the device know how often to wake up. Example: MIN:10 will wake up every 10 minutes.

wakeup_condition signalsdescription
IN1Will wake up based any change detected in input 1.
IN2Will wake up based any change detected in input 2.
IN3Will wake up based any change detected in input 3.
IN4Will wake up based any change detected in input 4.
IN5Will wake up based any change detected in input 5.
IN6Will wake up based any change detected in input 6.
IN7Will wake up based any change detected in input 7.
IGNWill wake up upon ignition signal change.
PWRWill wake up upon external power source signal change.
SO1Wake up due to a short in output 1.
SO2Wake up due to a short in output 2.
SO3Wake up due to a short in output 3.
SO4Wake up due to a short in output 4.
MOTWill let the device wake up upon motion being detected.
MINLets the device know how often, in minutes, to wake up. 1 - 65536 (note this needs a value)

Lastly, enter the wait_time. This is the time the sleep condition must be met and sustained before the device will into Power Save Mode. This number is defined in seconds. The wait time must be between 300 seconds (5 minutes) or 65536 seconds (18 hours) inclusive.


About Power Saving Mode

Note that there is no way to remove the power save mode, however you can configure it in a way so that the device never falls asleep


# Set the power save mode to go to sleep after 240 seconds (4min) (240) of no ignition detected (IGN:0), wake up for 5 minutes (SLP:300) every 10 minutes (MIN:10) or end the power save mode when motion is detected (MOT).
$ apx-psm mode "IGN:0,SLP:300;MOT,MIN:10;240"

# Set the power save mode to go to sleep after 300 seconds (300) of no movement detected (MOT:0), and wake up only when input1 is detected (IN1).
$ apx-psm mode "MOT:0;IN1;300"

# Set the power save mode to go to sleep after 5 minutes (300) of no movement or ignition (MOT:0,IGN:0), wake up every 2 hours (MIN:120) for 3 minutes (SLP:180) or end the power save mode when INPUT 1, or IGNITION, or MOTION is detected (IN1,IGN,MOT).
$ apx-psm mode "MOT:0,IGN:0,SLP:180;IN1,IGN,MOT,MIN:120;300"

Serial Interface

Manage the serial RS-232 interface of the device to communicate with accessories via the serial port.


Configures the RS-232 serial interface in different modes for communication with serial accessories such as Satcom & Sigfox communicator, fatigue sensor, mobile data terminal, rfid reader, or fuel level sensor.

 apx-serial [option]


Fuel Level & RFID commands

Note that there are separate apx commands for fuel level sensor and rfid integration.

modeUse this option to select the mode in which the user serial port will be used. By default the serial port is in console mode. If argument_1 is not found it returns the current mode.

Selecting the mode

apx-serial mode MODE

consoleUse console mode to send apx commands to interact with the device, for example, you can consult the state of the device inputs by sending apx-io getall inputs through a serial terminal at 115200 8 n 1.
modemUsed when Satcom or Sigfox accessories are connected.
fatigue_sensorUsed when communicating with a fatigue sensor accessory.
mdtMobile data terminal mode for communication/data parsing of an external rs-232 accessory.


Send apx commands to the device and receive a response via the serial interface


apx-serial console APX_COMMAND


Used to communicate with other serial capable modem devices/accessories like the Syrus Satcom and Sigfox Communicator.


apx-serial modem [command]

stateUse this option to consult the current state of the serial modem device
sendUse this option to send data through the serial modem device, max 340 characters with the serial-modem satcom.
buffer_sizeFollowed by a number to configure the size of serial modem buffer. Range from 10 to 500. Default 100. If no argument provided it returns the current value.
clear_bufferUse this option to to clear the serial modem buffer.

Fatigue Sensor

Used to communicate with a fatigue sensor. The photos captured by the fatigue sensor are automatically stored in: /data/users/syrus4g/fatigue_sensor.


apx-serial fatigue_sensor [argument_1]

stateUse this option to consult the current state of the sensor
listIt returns the list of the photos stored in the device memory
sensitivityUse this option to consult/configure the sensor sensitivity. Range 2-11. Default 3. If no argument provided it returns the current value.
min_speedUse this option to consult/configure the warning start-up speed. Range 10-60. Default 10 km/h. If no argument provided it returns the current value.
speedingUse this option to consult/configure the sensor speed alarm rate. Range 50-150. Default 50 kph. If no argument provided it returns the current value.
max_photosUse this option to consult/configure the max number of photos that can be stored in the device memory. Range 10-100. Default 25. If no argument provided it returns the current value.
speaker_volumeUse this option to consult/configure the sensor speaker volume. Range 0-2. Default 2. If no argument provided it returns the current value.
auto_uploadUse this option to consult/configure the auto_upload mode, when enabled, the application will automatically upload the photos to the syrus4 server. 0: disabled, 1: enabled. Default disabled
uploadUse this option to upload the photos to the syrus4 server
capture_photoUse this option to capture a photo
delete_photosUse this option to delete all the photos stored
sensitivityapproximate delay time in seconds to alarm
22.2 seconds
32.9 seconds
43.7 seconds
54.5 seconds
65.3 seconds
76.1 seconds
86.9 seconds
97.7 seconds
108.5 seconds
1115 seconds
speaker_volumevolume equivalent
0Speaker Off


The auto-upload feature is used to automatically upload photos to DCT's server. In a future release we'll provide access to download the photos from DCT's server, if you're using Syruslang

Note that the photos captured by the fatigue sensor use the following format:


Where photo description can be any of the following:

  • fatigue_alarm: driver fatigue detected
  • fatigue_remind: driver fatigue reminder
  • fatigue_warning: driver fatigue warning
  • distraction: driver distracted
  • no_portrait: driver not detected
  • photo: regular photo captured with fatigue sensor

MDT mode

Places the device in an MDT mode, which allows you to receive and send data via the serial interface in a packaged format based on different criterias such as the size, time, and header among others.


apx-serial mdt [argument_1]
apx-serial mdt settings [baudrate] [type] [timeout] [max_size] [header] [tail] [mask] [offset]

stateReturns a json with the current state and configuration parameters
sendFor sending data to the serial port
settingsFor setting up the mdt mode

MDT Settings

baudrateThe serial port baud rate. Valid values are 1200, 4800, 9600, 19200, 38400, 57600 and 115200
typeFor this version only x is supported (hexadecimal mode)
timeoutIt is the time that the application waits before sending the packed data when at least one byte has been received. Range 0-900s. Use 0 to ignore this setting
max_sizeWhen this limit is reached the application sends the packed data. Range 0-1024. Use 0 for ignoring this setting
headerThe protocol head, up to 4 bytes, for example 0x0b0c. Up to 4 hexadecimal bytes. Use 0 for ignoring this setting
tailThe protocol tail, up to 4 bytes, for example 0x0d0a. Up to 4 hexadecimal bytes. Use 0 for ignoring this setting
maskThe mask used, up to 4 bytes. Use the mask for filtering the data, depending on it, the application only packages the data if the corresponding byte array changes. The mask is only applied if the header and offset are configured. Use 0 for ignoring this setting.
offsetThe number of bytes after the last byte of the header for applying the mask configured. Range 0-1024. Use 0 for ignoring this setting

Note that if only the tail is configured, the application will package the data every time the tail is received.

For scenarios walking you through some sample MDT configurations refer to the connect section.

# Enable the console mode
$ apx-serial mode console

# Send an apx command
$ apx-serial console apx-gps position
# Configure the serial port in modem mode
$ apx-serial mode modem

# Configure the serial port in modem mode, which is used when Satcom or Sigfox accessories are connected, in the example below, 50 is an optional parameter for configuring the size of the buffer for the serial modem.
# The range of the buffer is from 10 to 500. Default is 100.
$ apx-serial modem buffer_size 50

# Consult the current state of the serial modem device.
$ apx-serial modem state

# To send a message
$ apx-serial modem send ">REV331852148....;ID=35...<"
# Note that it returns an error if the modem mode is not active. and if the message length is greater than 340 characters
# To change the sensitivity so it's more sensitive
$ apx-serial fatigue_sensor sensitivity 2

# To change the minimum speed used to trigger warnings to 25kph
$ apx-serial fatigue_sensor min_speed 25

# To check the state of the fatigue sensor
$ apx-serial fatigue_sensor state

# To list photos captured by fatigue sensor
$ apx-serial fatigue_sensor list
# For setting the serial mode to mdt
$ apx-serial mode mdt

# To set the mdt mode with
# baudrate of 115200, in HEX mode, a timeout of 10 seconds, 
# max size of 20 bytes, a header of 0x0A, tail of 0x0B, 
# a mask of 0x01, and an offset of 5
$ apx-serial mdt settings 115200 x 10 20 0a 0b 01 5

# For getting the state of the serial mode
$ apx-serial mode mdt state

# To send a message with '3132330D0A' to the serial port
$ apx-serial mdt send '3132330d0a'


Fuel sensor mode for the serial port.

$ apx-serial-fs <command> [<options=value>]
set [OPTIONS]Use this command to configure the fueling threshold, consumption threshold, and consumption window
statusUse this command to consult the current sensor state
versionReturns the tool version
helpPrint help message


-f, --fuelling-thresholdThe threshold used for triggering the fueling signal.
-c, --consumption-thresholdThe threshold used for triggering the consumption signal.
-w, --consumption-windowThe time window in seconds used for evaluating the consumption behavior.
# Set the consumption threshold to 100 in 20seconds
$ apx-serial-fs set --consumption-threshold=100 --consumption-window=20

# Get the status of the fuel sensor
$ apx-serial-fs status


RFID connected to serial port.

$ apx-serial-rfid <command> [<options=value>]
set [OPTIONS]Use this command to add an ID to the authorized list. It can also be used for changing the alias of an existing ID.
remove [OPTIONS]Use this command to remove an ID from the authorized list. Use --all for removing the complete list.
listUse this command to list the authorized list.
get [OPTIONS]Use --last to get the last ID read.
clear [OPTIONS]Use --last to clear the information about the last ID read.
versionReturns the tool version.
helpPrint this help.
-i, --idThe ID to be added or removed.
-a, --aliasThe alias to be associated with an ID.
--allTo be used with the remove command.
--lastTo be used with the get/clear commands.
# Set rfid 1234 to driver1
apx-serial-rfid set --id=1234 --alias=driver1

# Remove rfid 1234
apx-serial-rfid remove --id=1234

# Remove all rfid values
apx-serial-rfid remove --all

# Get last rfid value
apx-serial-rfid get --last


Manages the input serial interface of the device. You can only select between one of RS-232, J1708, or RS485.

 apx-serial-slctr [option]
0RS232. It is the default option
1J1708 bus
helpPrints this help message


# Send the following command to enable the J1708 bus as the input serial interface.
$ apx-serial-slctr 1



Information about the system and it's resources.

$ apx-about


Apex package manager for installing and removing software packages.

 apx-core [option]
listList the Apex Core packages installed
updateDownloads the package list from the DCT repository. It gets the list of the newest packages with its dependencies and returns the list of the DCT packages available for updating
recoverAllows to recover from broken packages when installing doesn't finish correctly
installInstall one or several packages at a time by providing their names
removeRemoves a software package from apex system
reinstallRemoves the software package and reinstall it
add_dev_repoAdds the DCT developer repository to the package manager. It enables some linux packages to be installed. To get the list of the available packages, please consult
rm_dev_repoRemoves the DCT developer repository
versionReturns the tool version.
helpPrints the help message


# list dct-apex packages installed
$ apx-core list

# install latest versions of syrus-gps and syrus-ecu packages
$ apx-core install syrus-gps syrus-ecu

# install specific version of syrus-gps
$ apx-core install syrus-gps=1.0-r0.1


Use this tool to primarily manage data inside the EEPROM (electrically erasable programmable read-only memory).

apx-eeprom [<command>] [--arguments]
readTakes one argument --key and it returns the key value pair if it exists.
writeTakes two arguments --key and --value. Will write the key value pair to the EEPROM. Since the EEPROM is of 32768 bytes, the keys are limited to 12 characters, and the value is limited to 50 characters.
This command will OVERWRITE a key if it already exists.
Only valid ASCII characters are allowed.
removeTakes one argument --key and it removes the key defined if it exists.
list_allTakes no arguments and it prints all of the valid key value pairs found inside the eeprom.
write[--key] [--value]


# write keys imei & foo with values into EEPROM
$ sudo apx-eeprom write --key=imei --value=867698040023056
$ sudo apx-eeprom write --key=foo --value=bar            

# read key called imei from EEPROM
$ sudo apx-eeprom read --key=imei

# list all key value pairs in eeprom
$ sudo apx-eeprom list_all


Tool that prepares an external storage device such as an SD card to be compatible with Apex OS.

 apx-ext-memory <command> [<args=value>]
format [OPTIONS]Prepares the external device in order it can be used by the operating system. Warning!, this process will erase all the data stored in this device.
status [OPTIONS]Returns a json object with general information about the state of the external memory selected with --type
helpPrints this help
-t, --typeThe type of external memory conneced (sd or usb)
-yUse this option to force the format without asking for confirmation
-cUse this option to force the format when the memory is being used. This will cause the device to be restarted.


$ apx-ext-memory format --type=sd

$ apx-ext-memory status --type=sd


Tool that manages the device's LEDs.

$ apx-leds [color] [mode]

[color] = red, green, yellow, or blue

onColor led fully on. This option is not valid for red led
offColor led fully off. This option is not valid for red led
heartbeatColor led simulates a heart beat thump-thump-pause
onebeat50ms on - 1000ms off
high_freq10Hz, 50ms on - 50ms off
low_freq1Hz, 500ms on - 500ms off
flash10ms on - 5000ms off


$ apx-leds blue high_freq

$ apx-leds red heartbeat


Tool for communicating with the SyrusCloud remote diagnostic application.

 apx-logger [level] [message]
**crit**Critical level message
**error**Error level message
**warn**Warning level message
**info**Info level message
  • crit, error, warn - types are sent to the syrus-cloud as soon as network connection be ready
  • info - these messages are queued into the syrus-cloud's buffer and when a new connection is established they are transmitted
messageThe message that is going to be sent to the syrus-cloud, enclosed in "quotes"


$ apx-logger info "This is an information message for the cloud, it will be queued"

$ apx-logger crit "This is a critical message for the cloud, it will be sent immediately"


This tool lets you read and configure the log rotation mechanism.

apx-logrotate <command> [<args=value>]
statusReads the current log rotation configuration.
configureConfigure a new or modify a current log rotation.
removeRemove a log configuration.
forceForce log rotation for a specific log configuration.
versionReturns the tool version.
helpPrint this help.
-n, --nameTo select log rotation configuration, (--name=all) to select all at reading.
-p, --pathThe location of the file we want to rotate(--path=/route/to/file.log).
-s, --sizeThe minumum size of the file before compression and rotation (--size=200M) .
-r, --rotateThe total number of compressed files to keep in memory (--rotate=5).
-c, --compressIndicate if files most be compressed (--compress=true).
-f, --forceTo force the rotation based on the current configuration.


# To get all the log configurations:
$ apx-logrotate status --name=all

# To create or modify a log rotation configuration:
$ apx-logrotate configure --name=syrus_instance --path=/data/logs/syrus_instance-out.log

# To remove a log configuration:
$ apx-logrotate remove --name=syrus_instance

# To force rotation for testing:
$ apx-logrotate force --name=syrus_instance


Tool that updates the device's operating system. Careful when forcing the update of the OS over the air as it can consume a lot of data.

 apx-os-update [option]
checkCheck if an update is available in the dctserver
startStart the update by using the dctserver or by specifying the location
-f, --forceThe same as start but without checking the network interface
-p, --pathSpecify the path of the apex OS file
stateReturn the state of the current update process
helpPrints the help message


# Check if there's an update available or if there's one already in progress
$ apx-os-update check
{"mess":"Update available"}
# or 
{"mess":"Update in progress. This will take a few minutes"}

# Start an upgrade to the latest stable version (must be connected via wifi, otherwise use -f flag)
$ apx-os-update start

# Update from an SD card mounted on the device
$ apx-os-update start -f -p /media/mmcblk0p1/apex-22.44.2


Tool to check general system information of the device, and reboot/restart it.

 apx-system [option]
aboutIt returns a json object with general information about the system
rebootUse this option for rebooting/restarting the apex OS
full_stateIt returns the full state of the system depending on the epoch received
set_nameUse this option for changing the system name, it is highly recommended to use a name that starts with syrus. Remember that the user session needs to be restarted in order for the change to be applied
restartUse this option for restarting syrus running services.
set_data_filesUse this option to set syrus4g as the owner of /data applications and configuration files
helpPrints the help message


# Will return a json object with all the information available
$ apx-system full_state 0

# Will return a json object with information that has a timestamp newer than the reference
$ apx-system full_state 1599573699

# Restart the gps module
$ apx-system restart syrus-gps


 apx-user [option] [argument_1] [argument_2] [argument_3]
checkuserIt returns "Valid User" if the user's password validation is successful, receives username as [argument_1] and password as [argument_2]
changepassIt returns "Password Updated" if password has been successfully changed, receives username as [argument_1], the current password as [argument_2], and the new password as [argument_3]
helpPrints the help message

Note that passwords must be between 6 to 63 characters long


$ apx-user changepass syrus4g 123456 mynewpass


Used to manage the keep-alive messages with syrus cloud remote management interface.


$ apx-watcher <command> [<args=value>]
set [OPTIONS]Set the connection time and always on flag
helpPrint this help
statusReturns a json object with general information about the state of the syrus-watcher application
-c, --conn_timeTime in minutes used for sending the keep alive message to the syrus cloud. The default value is 480 minutes = 8 hours. Use 0 for disabling the syrus-watcher task, if this task is disabled the device will not connect with the syrus-cloud
-a, --always_onThe flag used to control the connection with syrus-cloud. 0: Disabled, 1: Enabled (Default)


# To change the keep-alive message with Syrus Cloud ( to every 10 minutes and disable always_on 
$ apx-watcher set --conn_time=10 --always_on=0

# to check the status of apx-watcher 
$ apx-watcher status



Tool that's used to manage tracking criterias' on the device. The tracking notification will trigger whenever any one of the criteria is met. Heading and distance notifications depend on valid GPS.

Create or edit a tracking criteria

 apx-tracking <command> [<options>]


set [options]Command to add or edit the tracking criteria
get namespaceCommand to consult a tracking criteria
getallIt returns a list with all the tracking criteria configured
delete namespaceCommand to delete the tracking criteria
versionReturns the tool version
helpPrint this help


-n --namespaceThe name used as a reference to identify the tracking criteria. Max 60 characters.
-h --headingThe heading delta threshold for triggering notifications based on heading changes. Use 0 to disable. Range (0-180)
-t --timeThe time limit in seconds for triggering tracking notifications. Use 0 to disable. Range (0-86400)
-d --distanceThe distance threshold in meters for triggering tracking notifications based on the traveled distance. Use 0 to disable. Range (0-100000)
-p --paccThis is optional and can be used to set a positive acceleration threshold in kph/s
-o --naccThis is optional and can be used to set a negative acceleration threshold in -kph/s


# To set a tracking criteria for triggering notifications every 45 deg, 5 min or 100 meters
$ apx-tracking set --namespace=test --heading=45 --time=300 --distance=100

# To set a tracking criteria for triggering notifications every 20°, or 120 seconds, or +10 kph/s, or -8 kph/s
$ apx-tracking set --namespace=test --heading=20 --time=120 --pacc=10 --nacc=-8

# Return test tracking criterias configured
$ apx-tracking get test

# Delete test tracking criteria
$ apx-tracking delete test


This tool configures the actions to be carried out in the processing of video files.


 apx-video <command> [<args=value>]
set [OPTIONS]Set the general configuration. (destination, reserved space, audio, mac, and id)
get [OPTIONS]Get the general configuration. (mac and version)
add_camera [OPTIONS]Add a new camera to the configuration file.
rm_camera [OPTIONS]Remove a camera from the configuration file.
record [OPTIONS]Start or stop the video recording for a specified camera/cameras stored in the configuration file.
stream [OPTIONS]Start or stop the video streaming for a specified camera/cameras stored in the configuration file.
create_clip [OPTIONS]Find the video files from history location in a specified time window for one camera or all. Cameras stored in the configuration file and creates a video clip.
update_list [OPTIONS]Shows the event clips information merge with (timeline or history tree) as json
clip_status [OPTIONS]Returns the state of the last 25 clips processed.
cipia_config [OPTIONS]Modify the configuration files of Cipia
timeline [OPTIONS]Get history timeline information per camera in a max range of one day (24 hours).
restart [OPTIONS]Restart the core application of the chosen module.
statusShows the status of the cameras stored in the config file, the values associated with the memory space are given in MB.
versionShows the actual version of the apx-video tool.
always_recording [OPTIONS]Set always run video record at the start of the application.
update [OPTIONS]Update devices managed by NDM application
set[--destination=<value>] [--reserved_percentage=<value>] [--camera=<value>] [--audio=<value>] [--mac=<value>] [--id=<value>] [--device=<value>]
get[--device=<value>] [--mac=<value>] [--version=<value>]
add_camera[--type=<value>] [--camera_name=<value>] [--ip=<value>] [--port=<value>] [--user=<value>] [--pass=<value>] [--resolution=<value>] [--audio=<value>] [--uri=<value>]
rm_camera[--type=<value>] [--camera=<value>] [--delete_files]
record[--status=<value>] [--camera=<value>]
stream[--status=<value>] [--camera=<value>] [--host=<value>] [--video_port=<value>] [--audio_port=<value>] [--timeout=<value>]
create_clip[--name=<value>] [--camera=<value>] [--time_win=<value>] [--from=<value>] [--to=<value>]
clip_status[--camera=<value>] [--name=<value>]
update_list[--since=<value>] [--from=<value>] [--to=<value>] [--include_history]
timeline[--from=<value>] [--to=<value>] [--camera=<value>]
[destination]Micro-sd card -> sd, USB device -> usb, Internal memory -> internal
[reserved_percentage]Reserved space in memory defined in megabytes. e.g --reserved_percentage=5000 (5000 Mb or 5Gb)
[type]Type of camera you work with. IP ONVIF camera -> onvif, Dashcam -> dashcam, Movon MDSM-7 Camera -> mdsm7
[resolution]Preferred resolution in the output videos. 1080p -> FHD, 720p -> HD, 480p -> SD. Default resolution HD -> 720p.
[audio]Set to true to record audio (must be enabled on the camera). --audio=true or false
[time_win]Time before and after to create a video clip, -time_backward,+time_forward in seconds. e.g --time_win=-60,+30. -60sec = 60 seconds before, +30sec = 30 seconds after. (Max ranges: time_backward = 60sec, time_forward=30sec)
[always_recording]Set to true to enable always ON video recording at the start of the application. --status=true or false. Default true.
[from] [to]Epoch timestamp to retrieve video from timeline ranges. Max range between --from and --to is 24 hours
[module]Network device manager ndm or video
[timeout]Duration in seconds of the streaming. e.g --timeout=120
[codec]Video codec h264 or h265


Always recording

The always_recording flag is true by default. To disable it you need to set the --status=false



# Set the destination of video recording to an SD card mounted on the Syrus4 with a max % of 100
$ sudo apx-video set --destination=sd --reserved_percentage=100

# Disable the audio of the camera called: driver cam
$ apx-video set --camera=driver_cam --audio=false 

# Set the Cipia MAC address & ID
$ apx-video set --device=cipia_fs10 --mac=A4:04:50:3C:BD:7C --id=E321290376

# Get Cipia MAC address
$ apx-video get --device=cipia_fs10 --mac

# Get Cipia FW version
$ apx-video get --device=cipia_fs10 --version

# Add an ONVIF IP camera
$ sudo apx-video add_camera --type=onvif --camera_name=cam_1 --ip= --user=admin --pass=admin --resolution=FHD --audio=true

# Add a Movon MDSM-7 fatigue sensor camera
$ sudo apx-video add_camera --type=mdsm7 --ip= --port=6564

# Add a Cipia fatigue sensor camera
$ sudo apx-video add_camera --type=cipia --host_address=

# Add a Dashcam
$ sudo apx-video add_camera --type=dashcam --camera_name=dashcam_1 --ip= --user=admin --pass=admin --resolution=FHD --audio=true

# Add a Dashcam with live stream
$ sudo apx-video add_camera --type=dashcam --camera_name=dashcam_2 --uri=rtsp://USERNAME:[email protected]/ch1/sub/video

# Remove back camera from configuration and delete video files
$ sudo apx-video rm_camera --camera=back_cam --delete_files

# Remove Movon MDSM-7 fatigue camera (keeps files)
$ sudo apx-video rm_camera --type=mdsm7

# Start recording on all cameras
$ sudo apx-video record --status=start

# Stop recording for a particular camera
$ sudo apx-video record --status=stop --camera=front_cam

# Create a video clip on all cameras called '1632141204_crash' for the last 60 seconds and next 30 seconds
$ sudo apx-video create_clip --name=1632141204_crash --time_win=-60,+30

# Create a video clip called '1632141204_crash' for the last 60 seconds
$ sudo apx-video create_clip --name=1632141204_crash --camera=back_cam --time_win=-60

# Create a video clip from all cameras with a from and to date (see timeline to view the available video ranges)
$ sudo apx-video create_clip --name=1632141204-crash --from=1632111204 --to=1632121204

# View the clip status for camera 'front_cam'
$ sudo apx-video clip_status --camera=front_cam

# View the clip status for a particular video clip
$ sudo apx-video clip_status --name=1632141204-crash

$ sudo apx-video stream --status=start --camera=cam_1 --video_port=5006 --audio_port=5007 --timeout=120  --stream_id=817919789179
$ sudo apx-video stream --status=stop

# Set always recording to true
$ sudo apx-video always_recording --status=true

# Get a timeline of the available videos to retrieve a video clip from
$ sudo apx-video timeline --from=1632141204 --to=1632142204

# Get a timeline for a particular camera
$ sudo apx-video timeline --from=1632141204 --to=1632142204 --camera=my_cam
    "type": "onvif",
    "name": "front_door",
    "range": [
    "ranges": [
    "type": "onvif",
    "name": "rear_door",
    "range": [
    "ranges": []

# Update video list since a particular time
$ sudo apx-video update_list --since=164894646

# Update video list from a time range and include history
$ sudo apx-video update_list --include_history --from=164894646 --to=1648978486

# Restart the net device manager module (handles driver fatigue camera mdsm-7 for example)
$ sudo apx-video restart --module=ndm

# Restart the video module
$ sudo apx-video restart --module=video

# Status of the cameras
$ sudo apx-video status
    destination: "sd",
    reserved_space: 97540,
    n_cams: 2,
            name: "CAM1",
            state: 3
            name: "CAM2",
            state: 3

# Modify Cipia config file, note that the settings are set with a flattened key and value inside a json object
$ sudo apx-video cipia_config --object='{"WifiSettings.SSID":"hotspotlab","WifiSettings.Password":"123456","EventsSettings.DriverDistracted.ReportImage":false}'

# Change video codec to h265 when configuring the camera
$ sudo apx-video add_camera --type=onvif --camera_name=cam_1 --ip= --user=admin --pass=admin --codec=H265 --audio=true

# Get video tool version
$ sudo apx-video version



Tool to manage the wifi bluetooth module. Turning it off can help conserve power.

 sudo apx-wl-pwr [action]
onPower on the wl1835 MOD
offPower off the wl1835 MOD. WL1835 is a non-removable device, so it cannot be turned off. This option was preserved for compatibility issues


# Power on wifi/bluetooth module
$ sudo apx-wl-pwr on


Manages the hotspot functionality on the device. Allows you to configure the SSID and password when enabling the hotspot. The password is protected with WPA2-PSK security.

 sudo apx-hotspot [action]
 sudo apx-hotspot [option] [value]
startIt starts the udhcpd and hostapd services used by hotspot app
stopIt stops the hotspot services
resetIt executes a stop-start in the same call
listIt returns the list of the connected clients to the hotspot
stateReturns status: Enabled/Disabled and other info
helpPrints this help message
routeUse this option for forwarding the wlan traffic to another interface, it allows you to have internet access by specifying the output interface, available values: ppp0, eth0
ssidUse this option for changing the network identifier
passUse this option for changing the hotspot password (minimum of 8 characters)
countryUse this option for changing the country_code (2-letter ISO Code)


IP address ranges

Note that the range of IP addresses that the hotspot assigns is from: to

If you require working with static IP addresses you can use from to


# To set or change the ssid:
$ sudo apx-hotspot ssid mySSID

# To set or change the passphrase used for authentication:
$ sudo apx-hotspot pass myNewPass1234

# To restart the hotspot service:
$ sudo apx-hotspot reset

# To get the state of the hotspot:
$ sudo apx-hotspot state

# To list the client devices connected to the hotspot:
$ sudo apx-hotspot list

# To give internet access using the eth0 as the output interface:
$ sudo apx-hotspot route eth0

# To set the country to Argentina:
$ sudo apx-hotspot country AR


Tool to manage the wifi interface of the device. Allows you to connect to a wireless network.

 sudo apx-wifi <command> [<args=value>]
startIt enables the WIFI interface and starts the service for connecting with preconfigured networks
stopIt stops the WIFI service and disables the interface
restartIt executes a stop-start in the same call
listIt returns the list of networks configured
statusIt returns a json response with the current state of the wifi service
scanIt starts a WIFI scan and returns a list of SSIDs
add [OPTIONS]Use this option to add a new network to the wifi configuration file.
remove [OPTIONS]Use this option to remove a network from the wifi configuration file.
set [OPTIONS]Use this option for configuring the wireless interface.
connect [OPTIONS]Use this option to connect to a previously configured network.
versionReturns the tool version
helpPrints this help message
-i, --ipUse this option for changing the interface IP address and mask.
-g, --gatewayUse this option for changing the gateway address.
-d, --dnsUse this option for changing the dns address.
-f, --defaultBy using this option the wireless IP address is assigned by the network.
-s, --ssidThe network identifier.
-p, --passThe network password.
-w, --priorityBy default is 0, set higher priority to prioritize as per you need.
-n, --hiddenUse this flag if the wifi network is hidden


# To scan the WIFI network and get the list of SSIDs:
$ apx-wifi scan

# Connect to a previously configured network
$ apx-wifi connect --ssid=mynet

# To add a new network to the configuration file:
$ apx-wifi add --ssid=mynet --pass=mypass --priority=5

# Add a hidden network
$ apx-wifi add --ssid=mynet --pass=mypass --priority=5 --hidden

# To remove a network from the configuration file:
$ apx-wifi remove --ssid=mynet

# To have the wireless IP assigned by the network 
$ apx-wifi set --default

# Set the parameters of the wireless interface
$ apx-wifi set --ip= --gateway= --dns=

# Wi-Fi state
$ apx-wifi state