Senseforce 2.0 Manual
  • Welcome to Senseforce 2.0
  • SF MQTT API
  • SF Edge
    • Edge Package Overview
    • Edge Installation
      • Using the SF Edge Service installer in command shell
      • Headless SF Edge Servie execution
    • Edge Configuration
      • Which Plugins to load (appsettings.xml)
      • Edge Data Routing (EventDefinition.xml)
      • OTA configuration (otasettings.xml)
      • Edge Logging
      • Input plugins
        • SQL Plugin
        • SQLite Plugin
        • OPC UA Plugin
          • OPC UA server browser
        • SIEMENS S7/SINUMERIK Plugin
          • Creating connection definition file
        • S7 Plugin
        • REST Plugin
        • TCP Listener Plugin
        • XML File Parsing Plugin
        • Heidenhain Plugin
      • Output Plugins
        • MQTT Plugin
        • SQLite Plugin
    • Edge Compute plugins
      • Creating compute plugins
      • Using compute plugins
  • SF Edge Asset Management
    • Edge version repository
  • SF Platform
    • Navigation
      • Overview Screen
    • Dataset Builder
      • Filters, Aggregations and Groupings
      • Functions of the Formula Editor
      • Additional Settings
      • Special Events
      • FAQ and Troubleshooting
    • Script Editor
      • Details of the Script Editor
      • Installed Packages
      • Working with Timestamps
        • Working with Timestamps in Python
        • Working with Timestamps in R
      • FAQ and Troubleshooting
    • Widgets
      • Text
      • Headline
      • Image
      • Progress Bar & Gauge Chart
      • Table
      • Map
      • Line, Bar, Scatter and Area Chart
      • Pie Chart
      • Gantt Chart
      • Histogram
      • Overview
      • Log
      • Default colors and color conditions
      • FAQ and Troubleshooting
    • Dashboards
      • Dashboard Filters
      • Favorites
      • Data Drilldown & Widget Interaction
      • Editing multiple dashboard widgets
      • Time Zones
      • Synchronized Zooming
      • Sharable Dashboard URL
      • Multi-chart layout options
      • Default sort for table widgets
      • Releases
      • Reporting
      • FAQ and Troubleshooting
      • Applying zoom to global timestamp filter
      • Optimise the layout for different devices
    • Machine Master Data
      • Dimensions
      • Instances
      • Things
      • Use Case
      • FAQ and Troubleshooting
    • Automation
      • Trigger
      • Scheduling overview
      • Actions
      • Test your Automation
      • Zapier integration (necessary internal steps)
      • Zapier integration
      • Subscriptions
      • FAQ and Troubleshooting
    • Event Schema Management
      • Importing a Event Schema
      • FAQ and Troubleshooting
    • Virtual Events
      • Creating a Virtual Event
      • Scheduling Overview
      • Permissions and Data Access
      • FAQ and Troubleshooting
    • Details modal for elements
    • Copy / Duplicate elements
    • Whitelabeling
    • Edge Device Management
    • Element History
    • Public API
      • Get your access token
      • Endpoints
      • Debugging scripts
      • FAQ and Troubleshooting
    • User & Group Management
      • FAQ and Troubleshooting
    • Active Directory & SSO Setup
Powered by GitBook
On this page
  • Windows
  • Register SF Edge as a Windows service
  • Linux

Was this helpful?

  1. SF Edge

Edge Installation

PreviousEdge Package OverviewNextUsing the SF Edge Service installer in command shell

Last updated 2 years ago

Was this helpful?

Senseforce Edge is capable of running on Windows and Linux operating systems, including ARM-based architectures. For Windows, a graphical installer tool is provided, for Linux, the binaries are provided as an archived package.

Windows

Use the Windows installer package which guides you through the process of installation.

Register SF Edge as a Windows service

Open Luna.Setup.exe in the main SF Edge install directory. The installer needs to run with admin privileges.

Press "1" (without "") and press Enter to confirm your selection.

Enter a descriptive service name. To make the subsequent configuration of the SF Edge services easier, please choose service names which uniquely identify what the task of this SF Edge service is. Example: EdgeForMachine1234567. Press Enter to confirm.

Choose whether to automatically start the newly created service at Windows startup. For most use-cases, enter "yes" and confirm with enter.

A final summary of your service settings is presented, asking you to confirm your configuration. Enter "yes" and confirm with enter to start the installation.

After the service is registered, the registration results are presented. Please make sure the results state "Successfully registered [yourServiceName]". Otherwise please check whether the installer was executed with admin privileges.

When installing an SF Edge service, the service is registered in the Windows service facilities. Additionally, an SF Edge configuration environment is created for every SF Edge service installed. The service configuration folders are placed in

C:/ProgramDate/Senseforce/Luna Data/[YourServiceName_ID] (Please note, that the ID is automatically generated).

For each installed service, a separate configuration folder is created.

A default set of configurations is automatically placed in the configuration folder.

Do not rename the folders, as the folder names are critical to uniquely identify the configurations for the Windows services.

Open the service configuration file location

To easily manage the SF Edge service configurations, the service installer application provides an easy method to locate the configuration files for the wiservices.

Simply press "2" (without "") and confirm with enter in the SF Edge service installer main menu. A Windows Explorer Window is automatically opened, pointing to the Luna service configuration folders.

Removing an SF Edge Windows service

To uninstall a previously installed SF Edge service, press "3" and confirm with enter in the service installer main menu. (Please note that the service installer application needs to be started with administrator privileges). A list of all installed Luna services is presented:

Enter "all" (without "") and press enter to confirm uninstalling all the listed SF Edge services. If only one of the listed services should be removed, enter the index number of the desired service (e.g. 2) and confirm with enter. Alternatively, enter "abort" (without "") to navigate back to main menu.

In the next step, select whether to delete the configuration and log files of the service chosen. Enter "yes" to delete these files, or "no" to keep them in the configuration folder. Enter "abort" to abort the uninstalling process.

Finally, you see a summary of your selection, and you are asked to finally confirm the uninstallation by entering "yes" or aborting by entering "no".

After deleting the services and log/config-files (if chosen to do so), the uninstallation results are presented.

Please note, that uninstalling the Luna services may take up to 60 seconds per service.

Starting and stopping registered SF Edge services

To start or stop an SF Edge service, open the Windows service environment by entering "4" in the SF Edge service installer application and confirm by pressing enter. The Windows service environment opens.

Navigate to the service which should be started/stopped.

Right-click on the service and select "Start" or "Stop".

Linux

To install Luna as a Linux systemd service, follow the steps below:

The service file has to be called sfedge[postfix].service!

  1. Create a new systemd service file /etc/systemd/system/sfedge.service

  2. The file contains the following lines of configuration

Description=senseforce linux edge service
After=network.target
[Service]
# KillMode is required to tell systemd to NOT kill our updater child process. Otherwise the update will fail. IMPORTANT!
KillMode=process
WorkingDirectory=/path/to/EdgeBinaries
ExecStart=/path/to/EdgeBinaries/Luna.Service -f /path/to/config/appsettings.xml -o /path/to/config/otasettings.xml -s "sfedge"
User=root
SyslogIdentifier=senseforce-edge
Restart=always
RestartSec=10
[Install]
WantedBy=default.target

3. Register the edge for autostart by executing the following command

systemctl enable sfedge.service

4. Start or stop the service with following commands

systemctl start sfedge.service
systemctl stop sfedge.service

The above steps register a systemd service called edge.service.

Make sure to replace /path/to/EdgeBinaries in the above edge.service file with the real disk location of your edge binaries.

Make sure to replace /path/to/config in the above sfedge.service file with the real disk location of your configuration files (appsettings.xml and otasettings.xml)

Windows Installer
SF Edge Windows installer
Choose service name
Automatically start at Windows startup
Successfully registered SF Edge as a Windows service
SF Edge service configuration folders
SF Edge uninstall
SF edge uninstall summary
SF Edge uninstall results
Windows service environment