# Intro

Syrus Cloud is a remote management software that allows you to perform remote actions to the device as well check its diagnostics. Login If it's your first time accessing Syrus Cloud you can click on SIGN UP button and follow the steps to access.

Once logged into Syrus Cloud you'll see on the left hand side a navigation into the different sections, depending on the level of access you have you may see the management section.

All Syrus 4G devices are set up to report to Syrus Cloud periodically, as a sort of 'health-check' to make sure the units are reporting properly. The default time is every 8 hours but that can be changed via the apx-watcher tool. Under normal circumstances the device will connect periodically at the time indicated by the apx-watcher tool, however, in the event of something more critical or generally important the device will connect immediately.

Some important events include:

  • Critical battery level
  • Network change (change from WiFi to LTE for example)
  • Power save mode activated
  • Device out of memory

# Summary

Summary

The summary provides general information on each device that's connected. From the summary you can see information on the last time the device connected as well as the method of connection. Methods of connection:

  • Ethernet
  • Wireless
  • Mobile normal SIM Card
  • Mobile embedded SIM Card

if the device is ONLINE the method connection will be green, otherwise red to indicate offline.

From the list you can click on the menu on the right of the device to access the following options:

  • Remote Access: experimental still in beta
  • Show Diagnostics: navigates to the Diagnostics section
  • Show Commands: navigates to the Commands section to send commands
  • Edit Name: allows you to name the device for easier identification

# Diagnostics

Diagnostics History

The diagnostics section provides information on the last messages reported by the device. In case the device has communication issues you can generally check this section to get an idea of the reason why. Here you would see information such as battery critically low.

# Commands

Commands apx

The commands section will give you access to send and receive commands to one or multiple devices. For 'non-admin' users you're limited to sending only apx- commands.

While admin users are able to essentially have a direct shell console from the Commands section. So you can send linux commamnds or apx commands to the device.

Another feature for admins is the ability to upload files, this allows you to upload a configuration for an application or update the onewire whitelist for example. Start by selecting the devices to upload a file for, select the 'Upload File' menu option and set the path where the uploaded file will go to.

File upload

Here is a list of common files that can be uploaded as well as their path:

SyrusJS configuration and destination file (the default INSTANCE_NAME is syrusjs)

  • configuration.syrus.conf: /data/app_data/<INSTANCE_NAME>/configuration.syrus.conf
  • destinations.syrus.conf: /data/app_data/<INSTANCE_NAME>/destinations.syrus.conf

ECU Parameter file:

  • j1939_params: /data/users/syrus4g/j1939_params

Onewire whitelist for ibutton and temperature sensor accessories:

  • whitelist.txt: /data/users/syrus4g/onewire/whitelist.txt

# Applications

Applications

Applications allows you to manage applications for your Syrus 4 devices.

  • OVERVIEW - tab shows you which devices have which applications installed.
  • APPLICATIONS - tab allows you to create and manage instances of applications.

# Overview

The instances installed on your Syrus 4 can be monitored here using the following legend as reference:

Legend Description
đŸŸĸ app is running
🔴 app is stopped
🟡 app is activating (indicates an error initializing)
red text version is outdated
black text application is up to date
ℹī¸ app is not managed by Syrus Cloud

In order to take full advantage of Syrus Cloud's app management you need to create the instance inside of Syrus Cloud and install it from Syrus Cloud onto your devices. This is a manual process that must be done 1 time in the beginning in order to onboard your devices with the applications.

Here's an example procedure you may follow in order to accomplish this with SyrusJS application (we recommend you perform this locally with a test device before deploying over the air)

  1. Download the current configuration files from commands
  2. Create the application on Syrus Cloud and associate the configuration and destination files
  3. Send a command with syrus-apps-manager stop old_instance_name to stop the other instance of the app running
  4. Add the device to the application instance created on Syrus Cloud to install it
  5. Ensure that the application is running and the device is online (note that Syrus Cloud will install it with an instance name that starts with __cloud_)
  6. Erase the old running instance with syrus-apps-manager delete-instance old_instance_name

# Create Applications

From the Applications tab you can create a new application instance and upload the files necessary for the application to run.

Creating Application

Create or edit files you upload

Edit configuration files

Add devices to install the application

Adding devices

Once you hit save you can head to the Commands to see the progress of the application installation.

# Examples

Here are some examples of applications that are installed on Syrus 4 devices and their different meanings

Syrus 4 Application Examples

# Devices

OS Upgrade

From the devices section you're able to upgrade the Apex OS version. To accomplish this, start by showing the list of Upgradeable devices, then select the devices you want to upgrade and scroll all the way to the bottom to find the Upgrade Devices button. Complete the action by clicking on the checkmark on the right.

Note that the OS upgrade is >100MB in size, so make sure you take this into account when queueing the command.

# Groups

The groups section allows you to create groups for your Syrus 4 devices and assign users to this group. Note that these users will not have a 'management' role in Syrus Cloud, they'll essentially have read-only access to Dashboard, Summary, Diagnostics, and Commands, while also being able to execute apx- commands.

You must contact DCT if you want to add another admin user to your account.

Last Updated: 4/7/2021, 10:44:32 AM