# Intro

Syrus Cloud is a remote management software that allows you to perform remote actions to the device as well check its diagnostics. Login (opens new window) 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

# Users and Permissions

There are 2 primary users of Syrus Cloud:

  • Admins: also known as an organization's owner or manager
  • Users: which are users within an organization that belong to one or many groups

Admins:

  • All the devices within their organization
  • Create and edit applications, profiles, groups, users, and devices
  • Install applications, upgrade firmwares, send advanced commands

Users:

  • Are limited to what devices they have access to see, assigned by the group the user belongs to
  • Can see a summary of the diagnostic messages, commands sent, dashboard, and videos
  • Can send basic commands

The menu comparison between both users are broken down as follow:

User breakdown

# 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. Linux or apx- commands are accepted.

Send command

Clicking the input reveals 3 options: Upload file, Run script, and Download file. These options allow to remotely synchronize files with the Syrus outside of the management profiles.

You can also build shell/bash scripts to send to the device and automatically execute them.

# Videos

The videos section allows you to see video playback history from your devices. To get started make sure you follow the connect guide on how to connect a video camera to the Syrus.

Once you have the camera profile synchronized with your camera, and the camera is connected you can press on the UPDATE VIDEO LIST button to retrieve the videos.

Video


# Management

# 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

# Profiles

The profiles section allow you to manage important files such as the ECU monitor configuration file, onewire whitelist, and any geofences defined on the device.

Profiles

# Overview

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

Legend Description
black text profile is managed by Syrus Cloud and in sync with device
gray text profile is created locally on the device, NOT managed by Syrus Cloud
red text profile is managed by Syrus Cloud and is NOT in sync with the device

a blue box appears next to the name to indicate what kind of profile it is.

Any gray profile that appears indicates that it's not yet managed by Syrus Cloud, so the idea is to create the profile on Syrus Cloud and synchronize it with the device. Any red profile that appears indicates a device that is out of sync with what's found in Syrus Cloud, it's recommended to resynchronize that profile.

# IBUTTONS

The ibutton profiles are saved locally on the device under /data/users/syrus4g/onewire/ibutton.onewire.conf

This file is considered a 'white list' of ibuttons, and has the following format:

NAME:IBUTTON_ID

example:

driver1:0012331241412401
driver 2:0012331241412501

Using Syrus Cloud you can create and manage the ibutton aliases to authorize them on the whitelist.

iButtons

# GEOFENCES

For geofence profiles, you can use the Syruslang guide for creating a file with up to 3000 geofence definitions.

Example:

# two circular
define geofence hilton_blue_lagoon group=hotels radius=150mts -80.27856,25.78155
define geofence hilton_miami group=hotels radius=165ft -80.18867,25.79092

# one polygon
define geofence dolphin_mall group=malls -80.38476,25.79042 -80.37606,25.79044 -80.37613,25.784339 -80.38449,25.78506

Geofences

# ECU

The ECU profile synchronizes the ecumonitor.conf file for ECU parameters, this file can be found in the following repo (opens new window).

ECU

# CAMERAS

The camera profile synchronizes the video.conf.json file from the apx-video system tool, allowing you to define the cameras and their configuration remotely.

Manage Cloud

To define a camera profile you need to obtain the camera settings, to do so just head to the Management Tool UI -> Video section, click on CONFIGURATION and the menu on the right to download the settings.

Download settings

After you download the settings, upload it to the Camera profile on SyrusCloud, select your device, and press SAVE. The commands are sent remotely to synchronize the camera settings with your device.

Now you're able to share these settings with other devices or make any adjustments, like editing the resolution, remotely.

# PSM

The power saving mode profile allows you to define power saving modes (PSM) and synchronize it remotely with your devices. It's important to consider when to apply this to your solution as you may want something more customizable depending on different conditions and different modes. This method sets one general power saving mode for the device. If you want control over how and when to set it use the power saving commands from Syruslang.

# RS-232

The RS-232 profile allows you to define the serial interface of the device, allowing you to set any serial mode such as modem, console, fatigue_sensor, etc. This method uses the apx-serial system tool for the configuration. Note that there can only be 1 serial profile installed per device, thus if you need to change it you must first remove the original profile before installing a new one.

# Examples

Here are some examples of profiles that are installed on a Syrus 4 device and their different meanings

Applications

# Groups

The groups section allows you to create groups for your Syrus devices and assign users to the group.

# Users

The users section allows you to create and manage users within your organization. Note that these users will be limited in terms of their functionalities, see the Users and Permissions section for more details.

You must contact us if you want to add another admin user to your organization.

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

Last Updated: 8/17/2021, 11:53:50 PM