System Tools

# returns the last gps point
$ sudo apx-gps state | jq .LATEST_POINT
{"lat":25.945318,"lon":-80.452825,"alt":12.492,"speed":0.019,"heading":0,"epoch":1607006801}

# 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}'

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

# 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

# Create a backlog
$ apx-imu backlog create --name=mybacklog
 

# 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:
$ apx-imu CFG_HARSH_FWD_ACCELERATION

# Read the list of parameters configured:
$ apx-imu config_list
{"MOTION_THRESHOLD":30,"CFG_FORWARD_COLLISION":-2000,"CFG_BACKWARD_COLLISION":2000,"CFG_LAT_COLLISION_FROM_RIGHT":-2000,"CFG_LAT_COLLISION_FROM_LEFT":2000,"CFG_HARSH_FWD_ACCELERATION":260,"CFG_HARD_BRAKING":-260,"CFG_CORNERING_RIGHT":-350,"CFG_CORNERING_LEFT":350}

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

# Manual application installation from source

$ cd /data/downloads

$ wget https://server.com/applications/customApp/1.0.0.zip

$ syrus-apps-manager install-app customApp /data/downloads/1.0.0.zip

# SyrusJS example installation

$ wget https://syrus4.dctserver.com/apex/applications/syrusjs/1.34.1.zip -O /data/downloads/1.29.1.zip

$ syrus-apps-manager install-app /data/downloads/1.34.1.zip

$ 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_app_instance_name 1.34.0

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

# if sending the command locally make sure to use single quotes ' around commands with special characters
$ syrus-apps-manager send-message my_app_instance_name 'get value $net_wifi.ip_address'
192.168.1.148

# if sending a command via syrus-cloud or MDT you must use double quotes " and escape special characters
$ syrus-apps-manager send-message my_app_instance_name "get value \$net_cell.connected"
true

# you can send TAIP commands with the send-message
$ syrus-apps-manager send-message my_app_instance_name ">SSSU051<"

# send command to upload using Blackbox feature
syrus-apps-manager send-message my_app_instance_name "upload blackbox protocol=taip destination=my_server from=1708963644 to=1708963654"

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

# Delete the buffer associated to a destination
$ syrus-apps-manager clear-buffer __cloud_hw_lab_tests pegasus

 apx-tts <language> <message>

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

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

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

# 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

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

# 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"}

$ sudo apx-bbs help

$ apx-bbs <command> [<args=value>]

# Check the last scanned devices:
     apx-bbs state
#Enable BLE service and set scanning time:
     apx-bbs set --scan_time=60 --enabled=true
#Get information about the configuration:
     apx-bbs get_config
#Add a new ble device to the whitelist:
     apx-bbs add --mac=AABBCCDDEEFF --alias=Refrigerated_truck
#Remove a ble device from the whitelist:
     apx-bbs remove --mac=AABBCCDDEEFF
#Get information about the devices:
     apx-bbs get --mac=AABBCCDDEEFF
     apx-bbs get_all

 apx-counter [action] [namespace]
 apx-counter [action] [namespace] [key] [value]
 apx-counter [action] [namespace] [key]

# 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

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

# Decode a J1939 data trouble code*
$ apx-ecu decode --unique_id=feca_3-6 --value=2114126001
{"spn":177,"fmi":3,"cm":0,"oc":126}
# *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.
# Remeber to use ecumonitor.conf file to configure the interfaces.
$ apx-ecu restart
$ apx-ecu clear
$ 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

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

# 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=192.168.5.5/24

# Configure the ethernet network with dhcp enabled
$ sudo apx-ethernet set --ip=192.168.5.1/24 --gateway=192.168.5.255 --dns=8.8.8.8 --dhcp --route=none
# Where: 192.168.5.5/24 = Device IP/Mask
#        192.168.5.255  = Gateway address
#        8.8.8.8        = 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
{"state":"Enabled","mac":"9C:1D:58:3D:5A:90","ip":"","bcast":"","mask":"","rx_bytes":"0","tx_bytes":"0","routing":"both"}

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

Examples:

apx-geofences add places parks circular country_village_park 100 -80.305340,25.943784
apx-geofences add --namespace=places --group=parks --type=circular --name=village_park --radius=100 --coord="-80.305340,25.943784"

with speed limits:
apx-geofences add --namespace=places --group=parks --type=circular --name=village --radius=100 --speed-limits="uphill,50,100,200" --coord="-80.305340,25.943784"

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

$ apx-geofences remove places parks country_village_park

  apx-geofences remove [namespace]

$ apx-geofences remove places

# Note that it is not possible to remove a group, you would have to remove all the geofences from a group one by one or remove the namespace

$ apx-geofences getns
["places","shopping_malls"]

  apx-geofences getall [namespace]

$ apx-geofences getall places
[{"namespace":"places","group":"group","geo_name":"norman_jean","type":"poly","n_vertices":4,"vertices":["-80.33352400,25.93546900","-80.32843900,25.93494800","-80.32832100,25.93337500","-80.33331000,25.93355800"]}]

  apx-geofences count [namespace]

$ apx-geofences count places
4

  apx-geofences getstatus [namespace]

$ apx-geofences getstatus places
[{"group":"parks","geo_name":"country_village_park","is_inside":false,"time":1623959290}]

$ apx-geofences version
{"version": "0.0.5"}

# 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
[{"namespace":"places","group":"parks","geo_name":"park_norman_jean","type":"poly","n_vertices":4,"vertices":["-80.33352400,25.93546900","-80.32843900,25.93494800","-80.32832100,25.93337500","-80.33331000,25.93355800"]}]

 apx-geofences-manager [option] [arguments]

# Contents of /data/downloads/geofences.syrus.conf 
# polygonal
define geofence terminal_a_1416 group=mygroup1 -80.27661,25.79784 -80.27358,25.79897 -80.27091,25.79904 -80.27083,25.79689 -80.2734,25.79728 -80.27561,25.79676 -80.27638,25.79674 -80.27661,25.79784
# circle
define geofence sample_circle_geofence_27422 group=mygroup2 radius=50mts -122.08570313535118,37.42169546752972

# Import geofences from '/data/downloads/geofences.syrus.conf' with the namespace 'myplaces' to the device.
$ apx-geofences-manager import -p /data/downloads/geofences.syrus.conf -n myplaces

# Export geofences on the device from the namespace: 'myplaces' into Syruslang format with the name: '/data/downloads/geofences_applications.syrus.conf'
$ apx-geofences-manager export -f syruslang -n myplaces -p /data/downloads/geofences_applications.syrus.conf
{"results":"ok","geofences":10}

 apx-gps <command> [<options>]

# Get the gps state
$ apx-gps status
{"TIME":"2023-04-03T20:26:35Z","ENGINE":"xm1110","VERSION":"1.7.4","FIX":3,"LATEST_POINT":{"lat":25.783475,"lon":-80.293563,"alt":17.040,"speed":0.963,"heading":115.27,"epoch":1623959390},"filter":{"hdop":2,"motion":true,"speed":5},"rate":10,"antenna":"disconnected"}
# Where: TIME           = GMT Timestamp in ISOFORMAT
#        ENGINE         = GPS chip
#        VERSION        = GPS version
#        FIX            = Fix quality, 1: 'Fix not available', 2: '2D', 3: '3D' (http://aprs.gids.nl/nmea/)
#        LATEST_POINT
#            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
#        filter         = anti-drift filter settings
#            hdop       = Min hdop
#            motion     = True if it needs to detect motion with accelerometer
#            speed      = Minimum speed
#        rate           = Rate of gps update (in Hz)
#        antenna        = Antenna status (disconnected, connected, or short-circuit)

# 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
"http://maps.google.com/maps?q=25.783560,-80.293480"

# 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

apx-gps-sim <command>

# Start the simulator
apx-gps-sim start 

# actions
set --speed=50
set --head=64
move

 apx-io <action> <key> <value>
 apx-io <action> <key>
 apx-io <action>

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

# Activate output 4, 3 times, ON for 1000ms and OFF for 1000ms
$ apx-io set OUT4 --times=3 --on=1000 --off=1000 

# Get the value of all the analog inputs:
$ apx-io getall analogs
{"BAT":4.047,"DAN":11,"AN1":0,"AN2":0}

# Set virtual ignition with Analog Input 2
# Detects ON when the value is above 5000mV for 5 seconds, OFF when below 5000 for 5 seconds
$ apx-io set virtualign --signal=AN2 --on_threshold=5000 --off_threshold=5000 --on_time=5 --off_time=5

# Set and trigger the buzzer for the S4 Lite
# First the user mode must be set.
$ apx-io set BUZZER --mode=user
# Then the buzzer must be trigger.
$ apx-io set BUZZER --times=5 --on=400 --off=500

$ apx-io pulse_counter --start/--stop
$ apx-io pulse_counter --resume/--status/--count

$ apx-io set IN1 --mode=pulse_counter

   apx-seco <command> [<options>]

# enable the safe immobilization mechanism
$ apx-seco set --mode=enable

# activate output 1 safely
$ apx-seco set --trigger=enable

# check the status
$ apx-seco status

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

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

# Set the APN, remove the user and pass
$ apx-mdm set --apn=myapn.com --user=none --pass=none

# 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 --sms='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 status of the LTE modem
$ apx-mdm status
{"MANUFACTURER":"Quectel","REVISION":"EG25GGBR07A07M2G","MODEL":"EG25","IMEI":"867698041061234","MODEM_STATE":"ON","GSM_REG":5,"GPRS_REG":5,"RAT":"FDD LTE","MCC_MNC":310410,"BAND":"LTE BAND 2","OPERATOR":"At&t wireless","SIM_STATE":"READY","eSIM_STATE":"Not in Use","IP":"100.95.54.63","LAC":"3206","CID":"A6D7CC0","eSIM_IMSI":"310260869334233","eSIM_ID":"8901260862393348814F","NO_CONN_TIME":0,"RSSI":31,"SIM_IMSI":"732123200690261","SIM_ID":"89883070000006772525","JAMMING":"NOT_SUPPORTED","TEMPERATURE":32,"SIM_SW_INTERVAL":1,"KEEP_ALIVE":15,"APN":"super","SIM_PRIORITY":"sim-card","JAMMING_LEVEL":-40}

# Set the operator switching mechanism
apx-mdm set --operator-sw=1 --sim-header=89012 --keep-alive=5 --whitelist=[302610,302220]

# Force the device to use 302610 as operator
apx-mdm set --operator=302610

 apx-ppp [option] profile

$ apx-ppp start default

 apx-onewire [type] [action] 
 apx-onewire [type] [action] [argument_1] [argument_2] ... [argument_n]

# 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
{"temperatures":[{"alias":"room1","id":"3501144d2797aa28","value":null,"connected":false,"epoch":1619786506}]}

# read all IO's
$ apx-onewire iosexpander get_all
{"in1":false,"in2":false,"in3":false,"in4":false,"out1":false,"out2":false,"out3":false,"out4":false}

# read one Input or Output
$ apx-onewire iosexpander get IN2
false

# read IO's status
$ apx-onewire iosexpander status
{"status":"connected","in1":false,"in2":false,"in3":false,"in4":false,"out1":false,"out2":false,"out3":false,"out4":false}

# set outputs
$ apx-onewire iosexpander set OUT3 true

 apx-ndm-pc <command> [--<option>=<value>]

# 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

 apx-psm [action] [PSM_string]

# 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"

apx-rfid <command> [<option>=<value>]

   apx-rfid set --mode=drexia
   apx-rfid set --mode=drexia --len=4
   apx-rfid get --id=1234
   apx-rfid get --alias=Driver_1
   apx-rfid get --last
   apx-rfid clear --last

apx-serial <command> [<option>=<value>]

  apx-serial restart
  
  apx-serial get --mode
   
  apx-serial set --mode=console
  apx-serial set --mode=fuel_sensor
  apx-serial set --mode=mdas9
  
  # sending a message over TAIP
  apx-serial send --msg=">RTXmessage<"
  

apx-serial-ftgs <command> [<option=value>]

apx-serial-ftgs state

apx-serial-ftgs list

apx-serial-ftgs upload

apx-serial-ftgs capture_photo

apx-serial-ftgs delete_photos

apx-serial-ftgs get --sensitivity
   
apx-serial-ftgs set --sensitivity=3 --min_speed=20 --speeding=60

apx-serial-fs <command> [<option=value>]

# Note that the threshold value depends on how the fuel sensor was configured
# If the output message of the sensor is in deci-liters then you have to adjust the threshold accordingly

# Set the consumption threshold to 100 deci-liters (10.0 liters) in 20seconds
apx-serial-fs set --consumption-threshold=100 --consumption-window=20

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

apx-serial set --mode=serial_expander

# IMPORTANT: The value of --port indicates which port the sensor is connected to on the serial expander.
apx-serial-fs set --port-id=1 --consumption-threshold=100  --consumption-window=20 --fuelling-threshold=100
apx-serial-fs set --port-id=2 --consumption-threshold=80  --consumption-window=50 --fuelling-threshold=90
apx-serial-fs set --port-id=3 --consumption-threshold=100  --consumption-window=20 --fuelling-threshold=85

# Max Alias length = 20 chars
apx-serial-fs set --port-id=1 --alias=left

apx-serial-fs status
# For example:
[
  {
    "port_id": 1,
    "alias": "port1",
    "state": "connected",
    "temperature": 24,
    "frequency": 2571,
    "level": 15,
    "timestamp": 1713981201,
    "consumption-threshold": 100,
    "consumption-window": 20,
    "fuelling-threshold": 80
  },
  {
    "port_id": 3,
    "alias": "back",
    "state": "disconnected",
    "temperature": 130,
    "frequency": 2556,
    "level": 19000,
    "timestamp": 1713982342,
    "consumption-threshold": 90,
    "consumption-window": 20,
    "fuelling-threshold": 90
  }
]

apx-serial-mdt <command> [<option=value>]

apx-serial-mdt state

apx-serial-mdt send --msg=AE01CFE45
   
apx-serial-mdt send --msg='hellow world'
   
apx-serial-mdt send --msg='worldtest\r\n'
   
apx-serial-mdt send --msg='world\5ctest\xd\xa'
   
apx-serial-mdt set --baudrate=115200 --type=x --timeout=10 --max_size=20 --header=0a --tail=0b --mask=01 --offset=5

apx-serial-modem <command> [<option=value>]

apx-serial-modem state

apx-serial-modem clear_buffer
   
apx-serial-modem get --buffer_size
   
apx-serial-modem set --buffer_size=150
   
apx-serial-modem send --msg='>REV331852148....;ID=35...<'

$ apx-serial-rfid <command> [<option=value>]

# 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

# Set header and tail to extract the ID when it comes between something like
# SomeDataHereRUN=12346&MoreDataHere
apx-serial-rfid set --header='RUN=' --tail='&'

apx-serial-user <command> [<option=value>]

apx-serial-cnsl <command> [<option=value>]

apx-serial-slctr <command> [<option=value>]

$ apx-serial-slctr set --mode=rs232

apx-serial-exp <command> [<option=value>]

$ apx-serial-exp set --port1=mdsm7 --port2=mdt

apx-serial-flw <command> [<option=value>]

apx-serial-flw status

apx-serial-mdsm7 <command> [<option=value>]

apx-serial-mdsm7 status
apx-serial-mdsm7 list
apx-serial-mdsm7 capture_photo
apx-serial-mdsm7 delete_photos

apx-serial set --mode=mdas9

apx-serial-mdas9 <command>

apx-serial-mdas9 status
apx-serial-mdas9 list
apx-serial-mdas9 last

$ apx-about
{"ram":{"total":506084,"used":107824,"free":229732,"available":404616},"cpu":{"currF":1000,"usage":19.1926,"governor":"ondemand","stats":{"300":1319.28,"600":16152.25,"720":132.79,"800":52.43,"1000":299.93}},"rootfs":{"total":444018,"free":187666},"datafs":{"total":2255680,"free":2078392},"uptime":17958,"loadAvg":[1.83,1.71,1.65],"apexVersion":"apex-20.22-rc.8","releaseDate":"20200604000110","kernelVersion":"5.4.20-g738552d0b0","hostname":"syrusrouter"}

 apx-core <command> [<option=value>]

# 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
apx-core install --packages=[syrus-gps,syrus-ecu]

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

# Upgrade available packages.
apx-core upgrade

apx-eeprom [<command>] [--arguments]

# 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
{"key":"imei","value":"867698040023056"}

# list all key value pairs in eeprom
$ sudo apx-eeprom list_all
{"pairs":[{"key":"imei","value":"867698040023056"},{"key":"foo","value":"bar"}]}

 apx-ext-memory <command> [<args=value>]

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

$ apx-leds <command> <args=value>

$ apx-leds set --color=blue --mode=low_freq

 apx-logger <level> <message>

$ 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"

$ apx-logger warn "file_not_found"

$ apx-logger error "file_not_found"

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

# 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

 apx-os-update <command> [<args=value>]

# 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

apx-quectel update

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

#To get the complete system status:
$ apx-system status --from=0

#To get the system status since a reference time:
$ apx-system status --from=1599573699

#To change the system name:
$ apx-system set --name=syrus-home

#To flush data:
$ apx-system flush --redis-db

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

$ apx-user validate --user=myuser --pass=mypass
$ apx-user set-pass --user=myuser --pass=mypass --new-pass=mynewpass

$ apx-watcher <command> [<args=value>]

# To change the keep-alive message with Syrus Cloud (https://cloud.digitalcomtech.com) 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
{"conn_time":10,"always_on":0}

# Close the MQTT connection and open a clean session
$ apx-watcher clean --session

 apx-tracking <command> [<options>]

# 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

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

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

# Delete test tracking criteria
$ apx-tracking delete test

 apx-time-window <command> [<args=value>]

# To get all the windows configurations:
$ apx-time-window status --name=all

# To create or modify a window configuration:
$ apx-time-window set --name=syrus_instance --from=13:00:00 --to=14:00:00
$ apx-time-window set --name=syrus_instance --from=13:00:00 --to=14:00:00 --days=0,1,1,1,1,1,0
$ apx-time-window set --name=syrus_instance --from=13:00:00 --to=20:00:00 --start=01/01/2022 --end=31/12/2022 --days=0,1,1,1,1,1,0

# To remove a window configuration:
$ apx-time-window remove --name=syrus_instance

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

# GENERAL CONFIGURATION
# 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 GENERAL CONFIGURATION
# Get Cipia MAC address
$ apx-video get --device=cipia_fs10 --mac

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


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

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

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

# Add a Dashcam
$ sudo apx-video add_camera --type=dashcam --camera_name=dashcam_1 --ip=192.168.0.52 --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 CAMERAS
# 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/STOP RECORDING
# 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 VIDEO CLIPS
# 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


# CLIP STATUS
# 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


# VIDEO STREAMING
$ sudo apx-video stream --status=start --camera=cam_1 --host=videos.pegasusgateway.com --video_port=5006 --audio_port=5007 --timeout=120  --stream_id=817919789179
$ sudo apx-video stream --status=stop

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


# GET TIMELINE
# 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": [
      "1633090417",
      "1633715624"
    ],
    "ranges": [
      [
        "1633501423",
        "1633501499"
      ]
    ]
  },
  {
    "type": "onvif",
    "name": "rear_door",
    "range": [
      "1632753622",
      "1633715624"
    ],
    "ranges": []
  }
]


# UPDATE VIDEO LIST
# 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
# 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
# Status of the cameras
$ sudo apx-video status
{
    destination: "sd",
    reserved_space: 97540,
    n_cams: 2,
    cameras:[
        {
            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
# it's recommended to send this as a script via Syrus Cloud
$ 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=192.168.0.52 --user=admin --pass=admin --codec=H265 --audio=true


# VERSION
# Get video tool version
$ sudo apx-video version

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

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

$ sudo apx-hotspot start
 
$ sudo apx-hotspot stop

# To list the client devices connected to the hotspot:
$ sudo apx-hotspot list
{"stations":[{"mac":"96:f5:bc:51:62:de","rx_bytes":"155189","tx_bytes":"18752","uptime":"79"}]}

$ sudo apx-hotspot set --ssid=mynet --pass=mypass --route=eth0

 sudo apx-wifi <command> [<args=value>]

# 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=192.168.5.1/24 --gateway=192.168.5.255 --dns=8.8.8.8

# Wi-Fi state
$ apx-wifi status
{"state":"Completed","ssid":"MyAwesomeWifi","signal":"-17","key_mgmt":"WPA2-PSK","mac":"50:33:8B:DD:1E:43","ip":"192.168.1.28","rx_bytes":"871399","tx_bytes":"178166"}